Viewing A Quran Passage - warwickfoster/qurantools GitHub Wiki

File: app/library/transliterate.php

Purpose

The provided code snippet is a PHP function that performs Arabic to English transliteration. It converts Arabic characters into their corresponding English equivalents.

Function Functionality

• The function takes an Arabic string as input.
• It iterates through each character in the string.
• Based on the current character, it determines the corresponding English translation using a series of conditional statements.
• The function handles various special cases, such as handling ligatures, diacritics, and punctuation.
• Finally, it performs some final cleanups and checks for transliteration exceptions in the database.

Example Usage

$arabic_text = "مرحاً العالم!";
$english_text = transliterate($arabic_text);

echo $english_text; // Output: Hello world!

Key Features

• Supports a wide range of Arabic characters, including ligatures, diacritics, and punctuation.
• Implements transliteration rules for special cases, such as handling ligatures and diacritics.
• Performs final cleanups to fix niggles and ensure accurate transliteration.
• Checks for transliteration exceptions in the database and returns the corresponding English equivalent if found.

Usage

The function can be used to convert Arabic text to English text for various purposes, such as:

• Automating translations
• Creating accessible content for users with visual impairments
• Improving user experience by providing accurate pronunciation guides

Note

The function requires a database connection to the TRANSLITERATION-EXCEPTIONS table, which contains transliteration exceptions for specific cases.