Download the PHP package faizshukri/phpquran without Composer

On this page you can find all versions of the php package faizshukri/phpquran. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package phpquran

PHP Quran

PHP Quran was created and is maintained by Faiz Shukri. This package allow developer to retrieve quran ayah and translation easily.

PHP Quran

PHPUnit Total Downloads Latest Stable Version Scrutinizer Code Quality Code Coverage License

Installation

PHP 7+/8+ is required. (5.6 is supported in v1.x)

This project can be installed via [Composer]:

Laravel Integration

PHP Quran has optional support for Laravel and comes with a Service Provider and Facades for easy integration.

Laravel version starting 5.5+ can use Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

Laravel without auto-discovery

Open your Laravel config file config/app.php and add the following lines.

In the $providers array add the service providers for this package.

Add the facade of this package to the $aliases array.

Now the Quran Class will be auto-loaded by Laravel.

Configuration

PHP Quran supports optional configuration for Laravel.

To get started, you'll need to publish the config.

This will create a config/quran.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are several config options:

  1. storage_path

    By default, the app will download and store quran files in storage/app/quran directory. You may change the value to your own. However the path will be reside under storage/app directory.

  2. translations

    Specify translations that you want to make available for use. Make sure you add translation here before use in the code.

  3. limit

    Default limits per query are 15 ayah and 3 translations.

  4. structure

    Structure of the data. Default is minimal which remove all unnecessary parent. fixed will make structure more consistent.

Console

PHP Quran also ship a binary file to be used in console. You can access directly from vendor/bin/quran, or if you want to access it from anywhere, you can install PHP Quran globally and put your composer global directory path to your working environment's $PATH.

Usage

Console

PHP Quran can be used in console like this.

Surah name

You can also specify surah by its name. If the surah specified cannot found, it will find the closest one first and will suggest to you if more than a surah is found.

Translation

Translation can also be configured via console. It will be saved in the configuration file. (run quran config:path to see where the file is located).

Contributers

Thanks to the following people and organization for helping out this project;

Name Link
Tanzil Tanzil.Net
Hussaini Zulkifli @hussaini

License

The PHP Quran code is open-sourced software licensed under the MIT license


All versions of phpquran with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
symfony/console Version ^7.0|^6.0|^5.0|^4.0|^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package faizshukri/phpquran contains the following files

Loading the files please wait ....