wearedevtical / laravel-quran
Laravel Quran static Eloquent model
Fund package maintenance!
Kristories
Requires
- calebporzio/sushi: ^2.2
- friendsofphp/php-cs-fixer: ^3.0
- illuminate/support: ~7|~8
- league/csv: ^9.7
Requires (Dev)
- orchestra/testbench: ~5|~6
- phpunit/phpunit: ~9.0
This package is auto-updated.
Last update: 2024-10-04 16:46:06 UTC
README
بِسْمِ ٱللّٰهِ الرَّحْمٰنِ الرَّحِيْمِ
Laravel Quran is static Eloquent model for Quran.
The Quran has never changed and never will, because Allah protecting it. (15:9) إِنَّا نَحۡنُ نَزَّلۡنَا ٱلذِّكۡرَ وَإِنَّا لَهُۥ لَحَـٰفِظُونَ
. All data is fetched from the API. Changes only occur in translation and transliteration.
Installation
Via Composer
$ composer require wearedevtical/laravel-quran
Usage
Find surah by ID
$surah = Surah::find(36);
[ "id" => 36 "title" => "سُورَةُ يسٓ" "transliteration" => "Yaseen" ]
Get all ayah(s) from surah
$surah->ayahs;
[ 0 => array:7 [ "id" => 3706 "surah_id" => "36" "content" => "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ يسٓ" "translate_en" => "O THOU human being!" "translate_id" => "Yaa siin" "number" => "1" "juz" => "22" ] 1 => array:7 [ "id" => 3707 "surah_id" => "36" "content" => "وَٱلْقُرْءَانِ ٱلْحَكِيمِ" "translate_en" => "Consider this Qur’an full of wisdom:" "translate_id" => "Demi Al Quran yang penuh hikmah," "number" => "2" "juz" => "22" ] ... ]
Find ayah by ID
$ayah = Ayah::find(3787);
[ "id" => 3787 "surah_id" => "36" "content" => "إِنَّمَآ أَمْرُهُۥٓ إِذَآ أَرَادَ شَيْـًٔا أَن يَقُولَ لَهُۥ كُن فَيَكُونُ" "translate_en" => "His Being alone is such that when He wills a thing to be, He but says unto it, “Be” — and it is." "translate_id" => "Sesungguhnya keadaan-Nya apabila Dia menghendaki sesuatu hanyalah berkata kepadanya: "Jadilah!" maka terjadilah ia." "number" => "82" "juz" => "23" ]
Change log
Please see the changelog for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING.md for details.
Security
If you discover any security related issues, please email author instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see the license file for more information.