Download the PHP package alquran/tools without Composer

On this page you can find all versions of the php package alquran/tools. 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?

Example code of alquran/tools

Informations about the package tools

بِسْمِ اللهِ الرَّحْمٰنِ الرَّحِيْمِ

Quran Tools for Parsing Tajweed and Buck

These PHP tools are to be used with the AlQuran.cloud and GlobalQuran.com APIs. They are made available so you may get the most out of the APIs.

There's a React equivalent of this package @ https://github.com/aamirbhat382/Tajweed.

What do they contain

For now, a Buck helper. Each section is detailed below.

Install and Get Started

The tools add developer libraries you can use in your application. Install using composer:

Tajweed Example

To get tajweed text to become legible, use:

Buckwalter Transliteration example

To get tajweed text to become legible, use:

Tajweed Documentation

See Tajweed Documentation.

Buck (Buckwalter Transliteration) Documentation

See Buck Documentation.

Are there any known Issues

~~Yes, with the Tajweed parser. Webkit has a known bug that breaks Arabic with inline tags. There is an experimental fix in the Tajweed Parse class for this using the Zero Width Joiner (‍), but it still needs some work. I've manually tried this on some Ayahs and ZWJ is not smart enough to parse all the characters and join them properly, so this is not ideal. See See https://stackoverflow.com/questions/11155849/partially-colored-arabic-word-in-html and https://bugs.webkit.org/show_bug.cgi?id=6148.~~ The issue with parsing in Chrome seems to have been resolved with Chrome's new layout implementation (https://www.chromium.org/blink/layoutng). It has been tested on version 77.0.3865.90.

Credits

Most of this code is created using logic from the Global Quran website and codebase.

All versions of tools with dependencies

PHP Build Version
Package Version
No informations.
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 alquran/tools contains the following files

Loading the files please wait ....