Latest 1.0.0-beta.4
Homepage https://github.com/KosratDAhmad/MuslimData
License MIT
Platforms ios 10.0
Dependencies GRDB.swift
Frameworks UIKit
Authors

CI Status
Version
License
Platform

MuslimData is an Islamic library that provides Prayer Times (fixed and calculated), Offline Geocoder, Location Search, Azkars (Hisnul Muslim) and 99 Names of Allah.

Fixed and Calculated Prayer Times:
Most cities around the world find their prayer times by using some calculations which is based on location (longitude and latitude) but some other cities have fixed time table for their prayer times. This library contains most fixed and calculated prayer times. Now you can contribute it to improve it and also you can use it in Muslim communities or Muslim apps.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

MuslimData MuslimData MuslimData MuslimData MuslimData

Requirements

  • iOS 10.0+
  • Xcode 10.0+

Installation

MuslimData is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod 'MuslimData'

Usage

Location Helper

There are some location helper methods that provides offline Location Search, Geocoder, Reverse Geocoder, and check a city for fixed prayer times.

Search for location

You can search for any cities or places around the world and this is useful when a use doesn’t have internet connection or user’s location is turned off so you can search here:

LocationHelper.shared.citySearch(city: "London") { locations, error in
    guard let locations = locations, locations.count > 0 else {
        print("City could not be found!")
        return
    }
    print("locations: (locations)")
}

Important Note: Search results always return false for hasFixedPrayerTimes property in the Location object so you need manualy check selected location in the search result like the following example

// Check the selected location to know that it has fixed prayer times or not.
LocationHelper.shared.cityHasFixedPrayerTimes(countryCode: location.countryCode, city: location.city) { hasFixed in
    location.hasFixedPrayerTimes = hasFixed
}

Geocoder

Use geocoder to find city location by name.

// Use geocoder to find city location by name.
LocationHelper.shared.geocoder(countryCode: "GB", city: "London") { location in
    guard let location = location else {
        print("City name can not be geocode")
        return
    }
    print("location: (location)")
}

Reverse Geocoder

Use reverse geocoder to find city name by latitude and longitude.

// Use reverse geocoder to find city name by latitude and longitude.
LocationHelper.shared.geocoder(latitude: 36.654090, longitude: 44.541278) { location in
    guard let location = location else {
        print("City name can nnot be geocode by latitude and longitude")
        return
    }
    print("location: (location)")
}

Has Fixed Prayer Times

Check a city to know that it has fixed prayer times or not

// Check a city to know that it has fixed prayer times or not
LocationHelper.shared.cityHasFixedPrayerTimes(countryCode: "IQ", city: "Duhok") { hasFixed in
    print("City has fixed prayer times: (hasFixed)")
}

Prayer Times

You can easily get a location prayer times just by passing (Location, PrayerAttribute, and Date) object to getPrayerTimes method.

// Create location object.
let location = Location(latitude: 36.123, longitude: 44.123, city: "Erbil", countryCode: "IQ",
                        countryName: "Iraq", hasFixedPrayerTimes: true)

// Crate prayer attributes object.
let attributes = PrayerAttribute(method: .makkah, asrMethod: .shafii, adjustAngle: .angleBased)

// Get prayer times
PrayerTime.getPrayerTimes(location: location, date: Date(), attributes: attributes) { prayerTime, error in
    guard error == nil else {
        print("Prayer tims didn't found for the specified properties.")
        return
    }
    print("prayer times: (prayerTime!)")
    print("Fromat prayer times: (prayerTime!.formatPrayers(.time12))")
    print("Format one prayer time: (prayerTime!.isha.toTime(format: .time24))")
    print("next prayer index: (prayerTime!.nextPrayerIndex())")
    print("next prayer interval: (prayerTime!.nextPrayerInterval())")
    print("next prayer time remaining: (prayerTime!.nextPrayerTimeRemaining())")
}

Azkars (Hisnul Muslim)

Get all azkars from (Hisnul Muslim book) that is categorized by (Category, Chapter, and Item) and also the azkars are available for these languages (en, ar, ckb, fa, and ru)

Azkar Categories

Get all azkar categories and it is localized for the given language.

// Get azkar categories from MuslimData library
Azkars.azkarCategories(language: .en) { azkarCategories, error in
    guard error == nil else {
        print("Azkar categories didn't find: (error!)")
        return
    }
    print("Azkar Categories: (azkarCategories!)")
}

Azkar Chapters

Get azkar chapters and it is localized for the given language.

// Get azkar chapters from MuslimData library
Azkars.azkarChapters(language: .en) { azkarChapters, error in
    guard error == nil else {
        print("Azkar chapters didn't found: (error!)")
        return
    }
    print("Azkar Chapters: (azkarChapters!)")
}

Get azkar chapters for a specific category and it is localized for the given language.

// Get azkar chapters for a specific category from MuslimData library
Azkars.azkarChapters(language: .en, categoryId: 2) { azkarChapters, error in
    guard error == nil else {
        print("Azkar chapters didn't found: (error!)")
        return
    }
    print("Azkar Chapters for a category: (azkarChapters!)")
}

Azkar Items

Get azkar items for a specific chapter and it is localized for the given language.

// Get azkar items for a specific chapter from MuslimData library
Azkars.azkarItems(language: .en, chapterId: 2) { azkarItems, error in
    guard error == nil else {
        print("Azkar items didn't found: (error!)")
        return
    }
    print("azkar items: (azkarItems!)")
}

Names of Allah

Get 99 Names of Allah with it’s translation and now it is available for these languages (en, ar, ckb, fa, and ru)

// Get 99 names of allah from MuslimData library
Names.names(language: .en) { names, error in
    guard error == nil else {
        print("Names of Allah didn't found: (error!)")
        return
    }
    print("Names of Allah: (names)")
} 

Author

Kosrat D. Ahmad, [email protected]

License

MuslimData is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "MuslimData",
    "version": "1.0.0-beta.4",
    "summary": "Islamic library (Prayer Times [fixed and calculated], Names of Allah, and Azkars).",
    "description": "MuslimData is an Islamic library that provides Prayer Times (fixed and calculated), Offline Geocoder, Location Search, Names of Allah, Azkars (Husnil Muslim).nnFixed and Calculated Prayer TimesnMost cities around the world find their prayer times by using some calculations which is based on location (longitude and latitude) but some other cities have fixed time table for their prayer times. This library contains most fixed and calculated prayer times. Now you can contribute it to improve it and also you can use it in Muslim communities or Muslim apps.",
    "homepage": "https://github.com/KosratDAhmad/MuslimData",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Kosrat D. Ahmad": "[email protected]"
    },
    "source": {
        "git": "https://github.com/KosratDAhmad/MuslimData.git",
        "tag": "v1.0.0-beta.4"
    },
    "platforms": {
        "ios": "10.0"
    },
    "source_files": "MuslimData/Classes/**/*",
    "swift_version": "4.2",
    "resources": "MuslimData/Assets/**/*",
    "frameworks": "UIKit",
    "dependencies": {
        "GRDB.swift": []
    }
}

Pin It on Pinterest

Share This