Download the PHP package moehrenzahn/scripturekit without Composer
On this page you can find all versions of the php package moehrenzahn/scripturekit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package scripturekit
ScriptureKit PHP
A PHP framework for working with scripture XML files from the Zefania Project and qurandatabase.org.
Requirements
- PHP 7.2 or newer with SimpleXML and mbstring extensions
- Composer package manager
Installation
ScriptureKit can only be installed via the package manager Composer:
composer require moehrenzahn/scripturekit
For more information about how to use Composer in your Project, see the Composer documentation.
Features
You can use ScriptureKit to:
- load the text of a chapter
- load the text of a verse
- load the text of a set of verses
- render a formatted reference string for a chapter, verse set, or verse
- load version details for a scripture file.
When loading verse text, there are the following options available:
- render as
HTML
or plain text - highlight individual verses
- automatically add paragraph-breaks at the end of sentences
- include annotations (ZefaniaXML only)
ScriptureKit is compatible with the following scripture files:
- ZefaniaXML files (.xml)
XML Format (One File-Whole Quran)
exported from qurandatabase.org. (.xml)- Sefaria JSON format concatenated via Sefaria Merger
Usage
Instantiation
Loading the text of a Verse
Loading Version details
Internationalisation
You can internationalise the names for books and chapters, as well as the verse separator (default :
).
Your configured strings will be used when generating verse references.
Testing
ScriptureKit contains a non-exhaustive suite of PHPUnit tests. You can execute the tests via the projects makefile:
make phpunit
Author
Max Melzer
moehrenzahn.de
[email protected]
All versions of scripturekit with dependencies
ext-simplexml Version *
ext-mbstring Version *