관리-도구
편집 파일: ArPHP-I18N-Arabic.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Ar-PHP</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <base href="../"> <link rel="icon" href="images/favicon.ico"/> <link rel="stylesheet" href="css/normalize.css"> <link rel="stylesheet" href="css/base.css"> <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet"> <link rel="stylesheet" href="css/template.css"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" /> <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script> <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script> <script src="js/search.js"></script> <script defer src="js/searchIndex.js"></script> </head> <body id="top"> <section data-search-form class="phpdocumentor-search"> <label> <span class="visually-hidden">Search for</span> <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg"> <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/> <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/> </svg> <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled /> </label> </section> <main class="phpdocumentor"> <div class="phpdocumentor-section"> <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" /> <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button"> Menu </label> <div class="phpdocumentor-column -eight phpdocumentor-content"> <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Ar-PHP</a></h1> <article class="phpdocumentor-element -class"> <h2 class="phpdocumentor-content__title"> Arabic </h2> <p class="phpdocumentor-summary">----------------------------------------------------------------------</p> <section class="phpdocumentor-description"><p>Copyright (c) 2006-2023 Khaled Al-Sham'aa.</p> <p>http://www.ar-php.org</p> <p>PHP Version >= 5.6</p> <hr /> <p>LICENSE</p> <p>This program is open source product; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.</p> <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p> <p>You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/lgpl.txt">http://www.gnu.org/licenses/lgpl.txt</a>.</p> <hr /> <p>Class Name: PHP and Arabic Language</p> <p>Filename: ar-php.php</p> <p>Original Author(s): Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> <p>Purpose: Set of PHP classes developed to enhance Arabic web applications by providing set of tools includes stem-based searching, translitiration, soundex, Hijri calendar, charset detection and converter, spell numbers, keyboard language, Muslim prayer time, auto-summarization, and more...</p> <hr /> </section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">desc</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Set of PHP classes developed to enhance Arabic web applications by providing set of tools includes translitiration, soundex, Hijri calendar, spell numbers, keyboard language, and more...</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Shamaa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">copyright</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>2006-2023 Khaled Al-Shamaa</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">license</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>LGPL <a href="http://www.gnu.org/licenses/lgpl.txt">http://www.gnu.org/licenses/lgpl.txt</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">version</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">6.3.4</span> <section class="phpdocumentor-description"><p>released in Apr 5, 2023</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">link</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <a class="phpdocumentor-tag-link" href="http://www.ar-php.org"> http://www.ar-php.org </a> </dd> </dl> <h3 id="toc"> Table of Contents <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a> </h3> <dl class="phpdocumentor-table-of-contents"> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/ArPHP-I18N-Arabic.html#property_version">$version</a> <span> : string </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method___construct">__construct()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_addGlyphs">addGlyphs()</a> <span> : void </span> </dt> <dd>Add extra glyphs</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_ar2en">ar2en()</a> <span> : string </span> </dt> <dd>Transliterate Arabic string into English by render them in the orthography of the English language</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arIdentify">arIdentify()</a> <span> : array<string|int, int> </span> </dt> <dd>Identify Arabic text in a given UTF-8 multi language string</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arNormalizeText">arNormalizeText()</a> <span> : string </span> </dt> <dd>Normalizes the input provided and returns the normalized string.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arPlural">arPlural()</a> <span> : string </span> </dt> <dd>Get proper Arabic plural form There are 4 plural forms in Arabic language: - Form for 2 - Form for numbers that end with a number between 3 and 10 (like: 103, 1405, 23409) - Form for numbers that end with a number between 11 and 99 (like: 1099, 278) - Form for numbers above 100 ending with 0, 1 or 2 (like: 100, 232, 3001)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryAllForms">arQueryAllForms()</a> <span> : string </span> </dt> <dd>Get most possible Arabic lexical forms of user search keywords</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryOrderBy">arQueryOrderBy()</a> <span> : string </span> </dt> <dd>Get more relevant order by section related to the user search keywords</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryWhereCondition">arQueryWhereCondition()</a> <span> : string </span> </dt> <dd>Build WHERE section of the SQL statement using defind lex's rules, search mode [AND | OR], and handle also phrases (inclosed by "") using normal LIKE condition to match it as it is.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arSentiment">arSentiment()</a> <span> : array<string|int, bool|float> </span> </dt> <dd>Arabic Sentiment Analysis</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arSummary">arSummary()</a> <span> : string </span> </dt> <dd>Core summarize function that implement required steps in the algorithm</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arSummaryKeywords">arSummaryKeywords()</a> <span> : string </span> </dt> <dd>Extract keywords from a given Arabic string (document content)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_arSummaryLoadExtra">arSummaryLoadExtra()</a> <span> : void </span> </dt> <dd>Load enhanced Arabic stop words list</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_date">date()</a> <span> : string </span> </dt> <dd>Format a local time/date in Arabic string</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_dateCorrection">dateCorrection()</a> <span> : int </span> </dt> <dd>Calculate Hijri calendar correction using Um-Al-Qura calendar information</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_dd2dms">dd2dms()</a> <span> : string </span> </dt> <dd>Convert coordinates presented in float number in degree unit scale (e.g. -12.5822 value) into degrees, minutes and seconds (e.g. -12°34'56" formula)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_dd2olc">dd2olc()</a> <span> : string </span> </dt> <dd>Encode a location coordinates (latitude and longitude in WGS84) into Open Location Code Ref: https://github.com/google/open-location-code/blob/master/docs/specification.md</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_diffForHumans">diffForHumans()</a> <span> : string </span> </dt> <dd>Get the difference in a human readable format.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_dms2dd">dms2dd()</a> <span> : float </span> </dt> <dd>Convert coordinates presented in degrees, minutes and seconds (e.g. 12°34'56"S formula) into usual float number in degree unit scale (e.g. -12.5822 value)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_en2ar">en2ar()</a> <span> : string </span> </dt> <dd>Transliterate English string into Arabic by render them in the orthography of the Arabic language</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_fixKeyboardLang">fixKeyboardLang()</a> <span> : string </span> </dt> <dd>This method will automatically detect the language of content supplied in the input string. It will return the suggestion of correct inserted text.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getDateMode">getDateMode()</a> <span> : int </span> </dt> <dd>Getting $mode value that refer to output mode format 1) Hijri format (Islamic calendar) 2) Arabic month names used in Middle East countries 3) Arabic Transliteration of Gregorian month names 4) Both of 2 and 3 formats together 5) Libyan way 6) Algeria and Tunis style 7) Morocco style 8) Hijri format (Islamic calendar) in English</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getNorm">getNorm()</a> <span> : bool </span> </dt> <dd>Get given normalization form status.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberFeminine">getNumberFeminine()</a> <span> : int </span> </dt> <dd>Get the feminine flag of counted object</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberFormat">getNumberFormat()</a> <span> : int </span> </dt> <dd>Get the grammer position flag of counted object</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberOrder">getNumberOrder()</a> <span> : int </span> </dt> <dd>Get the ordering flag value</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getPrayTime">getPrayTime()</a> <span> : array<string|int, string> </span> </dt> <dd>Calculate Salat times for the date set in setSalatDate methode, and location set in setSalatLocation.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getQibla">getQibla()</a> <span> : float </span> </dt> <dd>Determine Qibla direction using basic spherical trigonometric formula</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryArrFields">getQueryArrFields()</a> <span> : array<string|int, string> </span> </dt> <dd>Getting values of $_fields Array in array format</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryMode">getQueryMode()</a> <span> : int </span> </dt> <dd>Getting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryStrFields">getQueryStrFields()</a> <span> : string </span> </dt> <dd>Getting values of $_fields array in String format (comma delimated)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexCode">getSoundexCode()</a> <span> : string </span> </dt> <dd>Get the soundex key calculation method used now</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexLang">getSoundexLang()</a> <span> : string </span> </dt> <dd>Get the soundex key language used now</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexLen">getSoundexLen()</a> <span> : int </span> </dt> <dd>Get the soundex key length used now</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_hijriMonthDays">hijriMonthDays()</a> <span> : int </span> </dt> <dd>Calculate how many days in a given Hijri month</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_int2indic">int2indic()</a> <span> : string </span> </dt> <dd>Represent integer number in Arabic-Indic digits using HTML entities</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_int2str">int2str()</a> <span> : string </span> </dt> <dd>Spell integer number in Arabic idiom</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_int2strItem">int2strItem()</a> <span> : string </span> </dt> <dd>Spell integer number in Arabic idiom followed by plural form of the counted item</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_isArabic">isArabic()</a> <span> : bool </span> </dt> <dd>Find out if given string is Arabic text or not</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_isFemale">isFemale()</a> <span> : bool </span> </dt> <dd>Arabic Gender Guesser</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_mktime">mktime()</a> <span> : int </span> </dt> <dd>This will return current Unix timestamp for given Hijri date (Islamic calendar)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_mktimeCorrection">mktimeCorrection()</a> <span> : int </span> </dt> <dd>Calculate Hijri calendar correction using Um-Al-Qura calendar information</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_money2str">money2str()</a> <span> : string </span> </dt> <dd>Spell number in Arabic idiom as money</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_noDots">noDots()</a> <span> : string </span> </dt> <dd>Strip Dots and Hamzat</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_olc2dd">olc2dd()</a> <span> : array<string|int, null|float> </span> </dt> <dd>Decode an Open Location Code string into its location coordinates in decimal degrees.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setDateMode">setDateMode()</a> <span> : object </span> </dt> <dd>Setting value for $_arDateMode scalar</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setNorm">setNorm()</a> <span> : object </span> </dt> <dd>Set given normalization form status.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberFeminine">setNumberFeminine()</a> <span> : object </span> </dt> <dd>Set feminine flag of the counted object</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberFormat">setNumberFormat()</a> <span> : object </span> </dt> <dd>Set the grammar position flag of the counted object</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberOrder">setNumberOrder()</a> <span> : object </span> </dt> <dd>Set the ordering flag, is it normal number or ordering number</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryArrFields">setQueryArrFields()</a> <span> : object </span> </dt> <dd>Setting value for $_fields array</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryMode">setQueryMode()</a> <span> : object </span> </dt> <dd>Setting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryStrFields">setQueryStrFields()</a> <span> : object </span> </dt> <dd>Setting value for $_fields array</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatConf">setSalatConf()</a> <span> : object </span> </dt> <dd>Setting rest of Salat calculation configuration</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatDate">setSalatDate()</a> <span> : object </span> </dt> <dd>Setting date of day for Salat calculation</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatLocation">setSalatLocation()</a> <span> : object </span> </dt> <dd>Setting location information for Salat calculation</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexCode">setSoundexCode()</a> <span> : object </span> </dt> <dd>Set the mapping code of the soundex key (default value is "soundex")</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexLang">setSoundexLang()</a> <span> : object </span> </dt> <dd>Set the language of the soundex key (default value is "en")</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexLen">setSoundexLen()</a> <span> : object </span> </dt> <dd>Set the length of soundex key (default value is 4)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_soundex">soundex()</a> <span> : string </span> </dt> <dd>Arabic soundex algorithm takes Arabic word as an input and produces a character string which identifies a set words that are (roughly) phonetically alike.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_standard">standard()</a> <span> : string </span> </dt> <dd>This function will standardize Arabic text to follow writing standards (just like magazine/newspapers rules), for example spaces before and after punctuations, brackets and units etc .</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_str2int">str2int()</a> <span> : int </span> </dt> <dd>Convert Arabic idiom number string into Integer</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_stripHarakat">stripHarakat()</a> <span> : string </span> </dt> <dd>Strip Harakat</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_strtotime">strtotime()</a> <span> : int </span> </dt> <dd>Arabic arStrToTime Function</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_swapAe">swapAe()</a> <span> : string </span> </dt> <dd>Make conversion to swap that odd Arabic text by original English sentence you meant when you type on your keyboard (if keyboard language was incorrect)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_swapAf">swapAf()</a> <span> : string </span> </dt> <dd>Make conversion to swap that odd Arabic text by original French sentence you meant when you type on your keyboard (if keyboard language was incorrect)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_swapEa">swapEa()</a> <span> : string </span> </dt> <dd>Make conversion to swap that odd English text by original Arabic sentence you meant when you type on your keyboard (if keyboard language was incorrect)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_swapFa">swapFa()</a> <span> : string </span> </dt> <dd>Make conversion to swap that odd French text by original Arabic sentence you meant when you type on your keyboard (if keyboard language was incorrect)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_utf8Glyphs">utf8Glyphs()</a> <span> : string </span> </dt> <dd>Convert Arabic string into glyph joining in UTF-8 hexadecimals stream (take care of whole the document including English sections as well as numbers and arcs etc...)</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/ArPHP-I18N-Arabic.html#method_volc">volc()</a> <span> : bool </span> </dt> <dd>Determine if an Open Location Code is valid.</dd> </dl> <section class="phpdocumentor-properties"> <h3 class="phpdocumentor-elements__header" id="properties"> Properties <a href="classes/ArPHP-I18N-Arabic.html#properties" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class=" phpdocumentor-element -property -public " > <h4 class="phpdocumentor-element__name" id="property_version"> $version <a href="classes/ArPHP-I18N-Arabic.html#property_version" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$version</span> = <span class="phpdocumentor-signature__default-value">'6.3.4'</span></code> <section class="phpdocumentor-description"></section> </article> </section> <section class="phpdocumentor-methods"> <h3 class="phpdocumentor-elements__header" id="methods"> Methods <a href="classes/ArPHP-I18N-Arabic.html#methods" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___construct"> __construct() <a href="classes/ArPHP-I18N-Arabic.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> </h4> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_addGlyphs"> addGlyphs() <a href="classes/ArPHP-I18N-Arabic.html#method_addGlyphs" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Add extra glyphs</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">addGlyphs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$char</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$hex</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$prevLink</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$nextLink</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$char</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Char to be added</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hex</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>String of 16 hexadecimals digits refers to the letter unicode in the following order ISOLATED FORM, FINAL FORM, INITIAL FORM, MEDIAL FORM (e.g. for Arabic letter HEH 'FEE9FEEAFEEBFEEC')</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$prevLink</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>If TRUE (default), when this letter be previous, then next will be linked to it</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$nextLink</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>If TRUE (default), when this letter be next, then previous will be linked to it</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">void</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_ar2en"> ar2en() <a href="classes/ArPHP-I18N-Arabic.html#method_ar2en" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Transliterate Arabic string into English by render them in the orthography of the English language</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">ar2en</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$standard</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'UNGEGN'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic string you want to transliterate</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$standard</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'UNGEGN'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Transliteration standard, default is UNGEGN and possible values are [UNGEGN, UNGEGN+, RJGC, SES, ISO233]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Out of vocabulary Arabic string in English characters</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arIdentify"> arIdentify() <a href="classes/ArPHP-I18N-Arabic.html#method_arIdentify" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Identify Arabic text in a given UTF-8 multi language string</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arIdentify</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$html</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, int></span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>UTF-8 multi language string</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$html</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>If True, then ignore the HTML tags (default is TRUE)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array<string|int, int></span> — <section class="phpdocumentor-description"><p>Offset of the beginning and end of each Arabic segment in sequence in the given UTF-8 multi language string</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arNormalizeText"> arNormalizeText() <a href="classes/ArPHP-I18N-Arabic.html#method_arNormalizeText" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Normalizes the input provided and returns the normalized string.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arNormalizeText</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$numeral</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The input string to normalize.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$numeral</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Symbols used to represent numerical digits [Arabic, Hindu, or Persian] default is null (i.e., will not normalize digits in the given string).</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The normalized string.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arPlural"> arPlural() <a href="classes/ArPHP-I18N-Arabic.html#method_arPlural" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get proper Arabic plural form There are 4 plural forms in Arabic language: - Form for 2 - Form for numbers that end with a number between 3 and 10 (like: 103, 1405, 23409) - Form for numbers that end with a number between 11 and 99 (like: 1099, 278) - Form for numbers above 100 ending with 0, 1 or 2 (like: 100, 232, 3001)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arPlural</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$singular</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$count</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$plural2</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$plural3</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$plural4</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$singular</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Singular word (e.g., عنصر).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$count</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The number (e.g. item count) to determine the proper plural form.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$plural2</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Plural form 2 (e.g., عنصران). If NULL [default] retrive from internal JSON dataset.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$plural3</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Plural form 3 (e.g., عناصر). If NULL [default] retrive from internal JSON dataset.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$plural4</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Plural form 4 (e.g., عنصرا). If NULL [default] retrive from internal JSON dataset.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Proper plural form of the given singular form</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arQueryAllForms"> arQueryAllForms() <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryAllForms" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get most possible Arabic lexical forms of user search keywords</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arQueryAllForms</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$arg</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$arg</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>String that user search for</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>list of most possible Arabic lexical forms for given keywords</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arQueryOrderBy"> arQueryOrderBy() <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryOrderBy" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get more relevant order by section related to the user search keywords</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arQueryOrderBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$arg</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$arg</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>String that user search for in the database table</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Saleh AlMatrafe <a href="mailto:saleh@saleh.cc">saleh@saleh.cc</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>sub SQL ORDER BY section</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arQueryWhereCondition"> arQueryWhereCondition() <a href="classes/ArPHP-I18N-Arabic.html#method_arQueryWhereCondition" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Build WHERE section of the SQL statement using defind lex's rules, search mode [AND | OR], and handle also phrases (inclosed by "") using normal LIKE condition to match it as it is.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arQueryWhereCondition</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$arg</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$arg</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>String that user search for in the database table</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The WHERE section in SQL statement (MySQL database engine format)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arSentiment"> arSentiment() <a href="classes/ArPHP-I18N-Arabic.html#method_arSentiment" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Arabic Sentiment Analysis</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arSentiment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, bool|float></span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic review string</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array<string|int, bool|float></span> — <section class="phpdocumentor-description"><p>of 2 elements: boolean isPositive (negative if false), and float probability (range from 0 to 1)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arSummary"> arSummary() <a href="classes/ArPHP-I18N-Arabic.html#method_arSummary" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Core summarize function that implement required steps in the algorithm</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arSummary</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$keywords</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$int</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$output</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Input Arabic document as a string</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$keywords</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>List of keywords higlited by search process</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$int</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Sentences value (see $mode effect also)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$mode</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Mode of sentences count [1|2] for "number" and "rate" modes respectively</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$output</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Output mode [1|2] for "summary" and "highlight" modes respectively</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Output summary requested</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arSummaryKeywords"> arSummaryKeywords() <a href="classes/ArPHP-I18N-Arabic.html#method_arSummaryKeywords" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Extract keywords from a given Arabic string (document content)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arSummaryKeywords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$int</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Input Arabic document as a string</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$int</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Number of keywords required to be extracting from input string (document content)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>List of the keywords extracting from input Arabic string (document content)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_arSummaryLoadExtra"> arSummaryLoadExtra() <a href="classes/ArPHP-I18N-Arabic.html#method_arSummaryLoadExtra" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Load enhanced Arabic stop words list</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">arSummaryLoadExtra</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">void</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_date"> date() <a href="classes/ArPHP-I18N-Arabic.html#method_date" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Format a local time/date in Arabic string</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">date</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$format</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$timestamp</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$correction</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$format</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Format string (same as PHP date function)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$timestamp</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Unix timestamp</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$correction</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>To apply correction factor (+/- 1-2) to standard hijri calendar</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Format Arabic date string according to given format string using the given integer timestamp or the current local time if no timestamp is given.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_dateCorrection"> dateCorrection() <a href="classes/ArPHP-I18N-Arabic.html#method_dateCorrection" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Calculate Hijri calendar correction using Um-Al-Qura calendar information</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">dateCorrection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$time</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$time</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Unix timestamp</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Correction factor to fix Hijri calendar calculation using Um-Al-Qura calendar information</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_dd2dms"> dd2dms() <a href="classes/ArPHP-I18N-Arabic.html#method_dd2dms" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Convert coordinates presented in float number in degree unit scale (e.g. -12.5822 value) into degrees, minutes and seconds (e.g. -12°34'56" formula)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">dd2dms</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$value</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Coordinate presented in float number in degree unit scale (e.g. -12.5822 value)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Equivalent coordinate presented in degrees, minutes and seconds (e.g. -12°34'56" formula)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_dd2olc"> dd2olc() <a href="classes/ArPHP-I18N-Arabic.html#method_dd2olc" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Encode a location coordinates (latitude and longitude in WGS84) into Open Location Code Ref: https://github.com/google/open-location-code/blob/master/docs/specification.md</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">dd2olc</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$latitude</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$longitude</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$codeLength</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$latitude</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Coordinate presented in float number in degree unit scale (e.g. 34.67175)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$longitude</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Coordinate presented in float number in degree unit scale (e.g. 36.263625)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$codeLength</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">10</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Code length, default value is 10 (this provides an area that is 1/8000 x 1/8000 degree in size, roughly 14x14 meters)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Open Location Code string (e.g. 8G6RM7C7+PF)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_diffForHumans"> diffForHumans() <a href="classes/ArPHP-I18N-Arabic.html#method_diffForHumans" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the difference in a human readable format.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">diffForHumans</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$time</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$others</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$parts</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">2</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$floor</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$time</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>the timestamp that is being compared.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$others</span> : <span class="phpdocumentor-signature__argument__return-type">int|null</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>if null passed, now will be used as comparison reference; if integer value, it will be used as reference timestamp. (default value is null).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$parts</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">2</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>maximum number of parts to display (default value is 2).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$floor</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>logic for rounding last part, if true then use floor, else use ceiling.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>the difference in a human readable format.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_dms2dd"> dms2dd() <a href="classes/ArPHP-I18N-Arabic.html#method_dms2dd" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Convert coordinates presented in degrees, minutes and seconds (e.g. 12°34'56"S formula) into usual float number in degree unit scale (e.g. -12.5822 value)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">dms2dd</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$value</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Coordinate presented in degrees, minutes and seconds (e.g. 12°34'56"S formula)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">float</span> — <section class="phpdocumentor-description"><p>Equivalent float number in degree unit scale (e.g. -12.5822 value)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_en2ar"> en2ar() <a href="classes/ArPHP-I18N-Arabic.html#method_en2ar" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Transliterate English string into Arabic by render them in the orthography of the Arabic language</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">en2ar</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$locale</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'en_US'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>English string you want to transliterate</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$locale</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'en_US'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Locale information (e.g. 'en_GB' or 'de_DE')</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Out of vocabulary English string in Arabic characters</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_fixKeyboardLang"> fixKeyboardLang() <a href="classes/ArPHP-I18N-Arabic.html#method_fixKeyboardLang" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">This method will automatically detect the language of content supplied in the input string. It will return the suggestion of correct inserted text.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">fixKeyboardLang</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"><p>The accuracy of the automatic language detection increases with the amount of text entered.</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Inserted string from the keyboard</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Fixed string language and letter case to the better guess</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getDateMode"> getDateMode() <a href="classes/ArPHP-I18N-Arabic.html#method_getDateMode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Getting $mode value that refer to output mode format 1) Hijri format (Islamic calendar) 2) Arabic month names used in Middle East countries 3) Arabic Transliteration of Gregorian month names 4) Both of 2 and 3 formats together 5) Libyan way 6) Algeria and Tunis style 7) Morocco style 8) Hijri format (Islamic calendar) in English</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getDateMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Value of $mode properity</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getNorm"> getNorm() <a href="classes/ArPHP-I18N-Arabic.html#method_getNorm" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get given normalization form status.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getNorm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$form</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>One of the normalization forms ['stripTatweel', 'stripTanween', 'stripShadda', 'stripLastHarakat', 'stripWordHarakat', 'normaliseLamAlef', 'normaliseAlef', 'normaliseHamza', 'normaliseTaa']</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> — <section class="phpdocumentor-description"><p>Selected normalization form status.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getNumberFeminine"> getNumberFeminine() <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberFeminine" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the feminine flag of counted object</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getNumberFeminine</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>return current setting of counted object feminine flag</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getNumberFormat"> getNumberFormat() <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberFormat" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the grammer position flag of counted object</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getNumberFormat</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>return current setting of counted object grammer position flag</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getNumberOrder"> getNumberOrder() <a href="classes/ArPHP-I18N-Arabic.html#method_getNumberOrder" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the ordering flag value</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getNumberOrder</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>return current setting of ordering flag value</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getPrayTime"> getPrayTime() <a href="classes/ArPHP-I18N-Arabic.html#method_getPrayTime" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Calculate Salat times for the date set in setSalatDate methode, and location set in setSalatLocation.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getPrayTime</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Hamid Zarrabi-Zadeh <a href="mailto:zarrabi@scs.carleton.ca">zarrabi@scs.carleton.ca</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">source</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array<string|int, string></span> — <section class="phpdocumentor-description"><p>of Salat times + sun rise in the following format hh:mm where hh is the hour in local format and 24 mode mm is minutes with leading zero to be 2 digits always array items is [$Fajr, $Sunrise, $Dhuhr, $Asr, $Maghrib, $Isha, $Sunset, $Midnight, $Imsak, array $timestamps]</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getQibla"> getQibla() <a href="classes/ArPHP-I18N-Arabic.html#method_getQibla" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Determine Qibla direction using basic spherical trigonometric formula</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getQibla</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>S. Kamal Abdali <a href="mailto:k.abdali@acm.org">k.abdali@acm.org</a></p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">source</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">float</span> — <section class="phpdocumentor-description"><p>Qibla Direction (from the north direction) in degrees</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getQueryArrFields"> getQueryArrFields() <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryArrFields" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Getting values of $_fields Array in array format</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getQueryArrFields</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array<string|int, string></span> — <section class="phpdocumentor-description"><p>Value of $_fields array in Array format</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getQueryMode"> getQueryMode() <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryMode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Getting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getQueryMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Value of $mode properity</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getQueryStrFields"> getQueryStrFields() <a href="classes/ArPHP-I18N-Arabic.html#method_getQueryStrFields" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Getting values of $_fields array in String format (comma delimated)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getQueryStrFields</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Values of $_fields array in String format (comma delimated)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getSoundexCode"> getSoundexCode() <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexCode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the soundex key calculation method used now</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getSoundexCode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>return current setting for soundex key calculation method</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getSoundexLang"> getSoundexLang() <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexLang" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the soundex key language used now</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getSoundexLang</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>return current setting for soundex key language</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getSoundexLen"> getSoundexLen() <a href="classes/ArPHP-I18N-Arabic.html#method_getSoundexLen" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Get the soundex key length used now</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getSoundexLen</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>return current setting for soundex key length</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_hijriMonthDays"> hijriMonthDays() <a href="classes/ArPHP-I18N-Arabic.html#method_hijriMonthDays" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Calculate how many days in a given Hijri month</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">hijriMonthDays</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$m</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$umAlqoura</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$m</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri month (Islamic calendar)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$y</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri year (Islamic calendar), valid range[1320-1459]</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$umAlqoura</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Should we implement Um-Al-Qura calendar correction in this calculation (default value is true)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Days in a given Hijri month</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_int2indic"> int2indic() <a href="classes/ArPHP-I18N-Arabic.html#method_int2indic" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Represent integer number in Arabic-Indic digits using HTML entities</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">int2indic</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$number</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$number</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The number you want to present in Arabic-Indic digits using HTML entities</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The Arabic-Indic digits represent inserted integer number using HTML entities</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_int2str"> int2str() <a href="classes/ArPHP-I18N-Arabic.html#method_int2str" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Spell integer number in Arabic idiom</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">int2str</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$number</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$number</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The number you want to spell in Arabic idiom</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The Arabic idiom that spells inserted number</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_int2strItem"> int2strItem() <a href="classes/ArPHP-I18N-Arabic.html#method_int2strItem" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Spell integer number in Arabic idiom followed by plural form of the counted item</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">int2strItem</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$count</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$word</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$count</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The number you want to spell in Arabic idiom</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$word</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The counted item</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The Arabic idiom that spells inserted number followed by plural form of the counted item.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_isArabic"> isArabic() <a href="classes/ArPHP-I18N-Arabic.html#method_isArabic" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Find out if given string is Arabic text or not</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">isArabic</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>String</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> — <section class="phpdocumentor-description"><p>True if given string is UTF-8 Arabic, else will return False</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_isFemale"> isFemale() <a href="classes/ArPHP-I18N-Arabic.html#method_isFemale" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Arabic Gender Guesser</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">isFemale</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code> <section class="phpdocumentor-description"><p>This function attempts to guess the gender of Arabic names.</p> <p>Arabic nouns are either masculine or feminine. Usually when referring to a male, a masculine noun is usually used and when referring to a female, a feminine noun is used. In most cases the feminine noun is formed by adding a special characters to the end of the masculine noun. Its not just nouns referring to people that have gender. Inanimate objects (doors, houses, cars, etc.) is either masculine or feminine. Whether an inanimate noun is masculine or feminine is mostly arbitrary.</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic word you would like to check if it is feminine</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> — <section class="phpdocumentor-description"><p>Return true if input Arabic word is feminine</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_mktime"> mktime() <a href="classes/ArPHP-I18N-Arabic.html#method_mktime" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">This will return current Unix timestamp for given Hijri date (Islamic calendar)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">mktime</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$hour</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$minute</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$second</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$hj_month</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$hj_day</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$hj_year</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$correction</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hour</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Time hour</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$minute</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Time minute</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$second</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Time second</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hj_month</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri month (Islamic calendar)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hj_day</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri day (Islamic calendar)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hj_year</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri year (Islamic calendar)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$correction</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>To apply correction factor (+/- 1-2) to standard Hijri calendar</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Returns the current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_mktimeCorrection"> mktimeCorrection() <a href="classes/ArPHP-I18N-Arabic.html#method_mktimeCorrection" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Calculate Hijri calendar correction using Um-Al-Qura calendar information</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">mktimeCorrection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$m</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$m</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri month (Islamic calendar)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$y</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Hijri year (Islamic calendar), valid range [1420-1459]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Correction factor to fix Hijri calendar calculation using Um-Al-Qura calendar information</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_money2str"> money2str() <a href="classes/ArPHP-I18N-Arabic.html#method_money2str" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Spell number in Arabic idiom as money</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">money2str</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$number</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$iso</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'SYP'</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$lang</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'ar'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$number</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The number you want to spell in Arabic idiom as money</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$iso</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'SYP'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The three-letter Arabic country code defined in ISO 3166 standard</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$lang</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'ar'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The two-letter language code in ISO 639-1 standard [ar|en]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>The Arabic idiom that spells inserted number as money</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_noDots"> noDots() <a href="classes/ArPHP-I18N-Arabic.html#method_noDots" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Strip Dots and Hamzat</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">noDots</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic text you would like to strip Dots and Hamzat from it.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Arabic text written using letters without dots and Hamzat</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_olc2dd"> olc2dd() <a href="classes/ArPHP-I18N-Arabic.html#method_olc2dd" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Decode an Open Location Code string into its location coordinates in decimal degrees.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">olc2dd</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$olc</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$codeLength</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, null|float></span></code> <section class="phpdocumentor-description"><p>Ref: https://github.com/google/open-location-code/blob/master/docs/specification.md</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$olc</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Open Location Code string (e.g. 8G6RM7C7+PF)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$codeLength</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">10</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Code length, default value is 10 (this provides an area that is 1/8000 x 1/8000 degree in size, roughly 14x14 meters)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array<string|int, null|float></span> — <section class="phpdocumentor-description"><p>Location coordinates in decimal degrees [latitude, longitude] in WGS84</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setDateMode"> setDateMode() <a href="classes/ArPHP-I18N-Arabic.html#method_setDateMode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting value for $_arDateMode scalar</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setDateMode</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$mode</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">1</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Output mode of date function where:</p> <ol> <li>Hijri format (Islamic calendar)</li> <li>Arabic month names used in Middle East countries</li> <li>Arabic Transliteration of Gregorian month names</li> <li>Both of 2 and 3 formats together</li> <li>Libya style</li> <li>Algeria and Tunis style</li> <li>Morocco style</li> <li>Hijri format (Islamic calendar) in English</li> </ol> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setNorm"> setNorm() <a href="classes/ArPHP-I18N-Arabic.html#method_setNorm" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set given normalization form status.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setNorm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$status</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$form</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>One of the normalization forms ['stripTatweel', 'stripTanween', 'stripShadda', 'stripLastHarakat', 'stripWordHarakat', 'normaliseLamAlef', 'normaliseAlef', 'normaliseHamza', 'normaliseTaa', 'all']</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$status</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Normalization form status [true|false]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setNumberFeminine"> setNumberFeminine() <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberFeminine" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set feminine flag of the counted object</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setNumberFeminine</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$value</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Counted object feminine (1 for masculine & 2 for feminine)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setNumberFormat"> setNumberFormat() <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberFormat" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set the grammar position flag of the counted object</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setNumberFormat</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$value</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Grammar position of counted object (1 if Marfoua & 2 if Mansoub or Majrour)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setNumberOrder"> setNumberOrder() <a href="classes/ArPHP-I18N-Arabic.html#method_setNumberOrder" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set the ordering flag, is it normal number or ordering number</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setNumberOrder</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$value</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Is it an ordering number? default is 1 (use 1 if no and 2 if yes)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setQueryArrFields"> setQueryArrFields() <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryArrFields" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting value for $_fields array</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setQueryArrFields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </span><span class="phpdocumentor-signature__argument__name">$arrConfig</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$arrConfig</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, string></span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Name of the fields that SQL statement will search them (in array format where items are those fields names)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setQueryMode"> setQueryMode() <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryMode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setQueryMode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$mode</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Setting value to be saved in the $mode propority [0 for OR logic | 1 for AND logic]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setQueryStrFields"> setQueryStrFields() <a href="classes/ArPHP-I18N-Arabic.html#method_setQueryStrFields" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting value for $_fields array</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setQueryStrFields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$strConfig</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$strConfig</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Name of the fields that SQL statement will search them (in string format using comma as delimated)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSalatConf"> setSalatConf() <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatConf" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting rest of Salat calculation configuration</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSalatConf</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$sch</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'Shafi'</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$sunriseArc</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-0.833333</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$ishaArc</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-17.5</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$fajrArc</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-19.5</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$view</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'Sunni'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"><p>Convention [Fajr Angle, Isha Angle]</p> <ul> <li>Muslim World League [-18, -17]</li> <li>Islamic Society of North America (ISNA) [-15, -15]</li> <li>Egyptian General Authority of Survey [-19.5, -17.5]</li> <li>Umm al-Qura University, Makkah [-18.5, Isha 90 min after Maghrib, 120 min during Ramadan]</li> <li>University of Islamic Sciences, Karachi [-18, -18]</li> <li>Institute of Geophysics, University of Tehran [-17.7, -14*]</li> <li>Shia Ithna Ashari, Leva Research Institute, Qum [-16, -14]</li> </ul> <p>(*) Isha angle is not explicitly defined in Tehran method Fajr Angle = $fajrArc, Isha Angle = $ishaArc</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$sch</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'Shafi'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>[Shafi|Hanafi] to define Muslims Salat calculation method (affect Asr time)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$sunriseArc</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> = <span class="phpdocumentor-signature__argument__default-value">-0.833333</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Sun rise arc (default value is -0.833333)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$ishaArc</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> = <span class="phpdocumentor-signature__argument__default-value">-17.5</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Isha arc (default value is -18)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$fajrArc</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> = <span class="phpdocumentor-signature__argument__default-value">-19.5</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Fajr arc (default value is -18)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$view</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'Sunni'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>[Sunni|Shia] to define Muslims Salat calculation method (affect Maghrib and Midnight time)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSalatDate"> setSalatDate() <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatDate" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting date of day for Salat calculation</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSalatDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$m</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">8</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$d</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">2</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1975</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$m</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">8</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Month of date you want to calculate Salat in</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$d</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">2</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Day of date you want to calculate Salat in</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$y</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">1975</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Year (four digits) of date you want to calculate Salat in</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSalatLocation"> setSalatLocation() <a href="classes/ArPHP-I18N-Arabic.html#method_setSalatLocation" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Setting location information for Salat calculation</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSalatLocation</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$l1</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">36.20278</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$l2</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">37.15861</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$z</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">2</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$e</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$l1</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> = <span class="phpdocumentor-signature__argument__default-value">36.20278</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Latitude of location you want to calculate Salat time in</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$l2</span> : <span class="phpdocumentor-signature__argument__return-type">float</span> = <span class="phpdocumentor-signature__argument__default-value">37.15861</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Longitude of location you want to calculate Salat time in</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$z</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">2</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Time Zone, offset from UTC (see also Greenwich Mean Time)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$e</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Elevation, it is the observer's height in meters.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSoundexCode"> setSoundexCode() <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexCode" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set the mapping code of the soundex key (default value is "soundex")</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSoundexCode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Soundex key mapping code [soundex|phonix]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSoundexLang"> setSoundexLang() <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexLang" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set the language of the soundex key (default value is "en")</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSoundexLang</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Soundex key language [ar|en]</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_setSoundexLen"> setSoundexLen() <a href="classes/ArPHP-I18N-Arabic.html#method_setSoundexLen" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Set the length of soundex key (default value is 4)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">setSoundexLen</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$integer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$integer</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Soundex key length</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">object</span> — <section class="phpdocumentor-description"><p>$this to build a fluent interface</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_soundex"> soundex() <a href="classes/ArPHP-I18N-Arabic.html#method_soundex" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Arabic soundex algorithm takes Arabic word as an input and produces a character string which identifies a set words that are (roughly) phonetically alike.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">soundex</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$word</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$word</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic word you want to calculate its soundex</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Soundex value for a given Arabic word</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_standard"> standard() <a href="classes/ArPHP-I18N-Arabic.html#method_standard" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">This function will standardize Arabic text to follow writing standards (just like magazine/newspapers rules), for example spaces before and after punctuations, brackets and units etc .</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">standard</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"><p>..</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic text you would like to standardize</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Standardized version of input Arabic text</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_str2int"> str2int() <a href="classes/ArPHP-I18N-Arabic.html#method_str2int" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Convert Arabic idiom number string into Integer</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">str2int</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$str</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The Arabic idiom that spells input number</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>The number you spell it in the Arabic idiom</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_stripHarakat"> stripHarakat() <a href="classes/ArPHP-I18N-Arabic.html#method_stripHarakat" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Strip Harakat</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">stripHarakat</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$tatweel</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$tanwen</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$shadda</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$last</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$harakat</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic text you would like to strip Harakat from it.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$tatweel</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Strip Tatweel (default is TRUE).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$tanwen</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Strip Tanwen (default is TRUE).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$shadda</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Strip Shadda (default is TRUE).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$last</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Strip last Harakat (default is TRUE).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$harakat</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Strip in word Harakat (default is TRUE).</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Arabic string clean from selected Harakat</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_strtotime"> strtotime() <a href="classes/ArPHP-I18N-Arabic.html#method_strtotime" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Arabic arStrToTime Function</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">strtotime</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$now</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <section class="phpdocumentor-description"><p>Function to parse about any Arabic textual datetime description into a Unix timestamp.</p> <p>The function expects to be given a string containing an Arabic date format and will try to parse that format into a Unix timestamp (the number of seconds since January 1 1970 00:00:00 GMT), relative to the timestamp given in now, or the current time if none is supplied.</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The string to parse, according to the GNU Date Input Formats syntax (in Arabic).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$now</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The timestamp used to calculate the returned value.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">int</span> — <section class="phpdocumentor-description"><p>Returns a timestamp on success, FALSE otherwise</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_swapAe"> swapAe() <a href="classes/ArPHP-I18N-Arabic.html#method_swapAe" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Make conversion to swap that odd Arabic text by original English sentence you meant when you type on your keyboard (if keyboard language was incorrect)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">swapAe</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Odd Arabic string</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Normal English string</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_swapAf"> swapAf() <a href="classes/ArPHP-I18N-Arabic.html#method_swapAf" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Make conversion to swap that odd Arabic text by original French sentence you meant when you type on your keyboard (if keyboard language was incorrect)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">swapAf</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Odd Arabic string</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Normal French string</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_swapEa"> swapEa() <a href="classes/ArPHP-I18N-Arabic.html#method_swapEa" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Make conversion to swap that odd English text by original Arabic sentence you meant when you type on your keyboard (if keyboard language was incorrect)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">swapEa</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Odd English string</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Normal Arabic string</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_swapFa"> swapFa() <a href="classes/ArPHP-I18N-Arabic.html#method_swapFa" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Make conversion to swap that odd French text by original Arabic sentence you meant when you type on your keyboard (if keyboard language was incorrect)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">swapFa</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Odd French string</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Normal Arabic string</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_utf8Glyphs"> utf8Glyphs() <a href="classes/ArPHP-I18N-Arabic.html#method_utf8Glyphs" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Convert Arabic string into glyph joining in UTF-8 hexadecimals stream (take care of whole the document including English sections as well as numbers and arcs etc...)</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">utf8Glyphs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$max_chars</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">50</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$hindo</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$forcertl</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$text</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Arabic string</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$max_chars</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">50</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Max number of chars you can fit in one line</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$hindo</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>If true use Hindo digits else use Arabic digits</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$forcertl</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">false</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>If true forces RTL in the bidi algorithm</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Arabic glyph joining in UTF-8 hexadecimals stream (take care of whole document including English sections as well as numbers and arcs etc...)</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_volc"> volc() <a href="classes/ArPHP-I18N-Arabic.html#method_volc" class="headerlink"><i class="fas fa-link"></i></a> </h4> <p class="phpdocumentor-summary">Determine if an Open Location Code is valid.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">volc</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$olc</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$codeLength</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code> <section class="phpdocumentor-description"><p>Ref: https://github.com/google/open-location-code/blob/master/docs/specification.md</p> </section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$olc</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Open Location Code string (e.g. 8G6RM7C7+PF)</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$codeLength</span> : <span class="phpdocumentor-signature__argument__return-type">int</span> = <span class="phpdocumentor-signature__argument__default-value">10</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Code length, default value is 10 (this provides an area that is 1/8000 x 1/8000 degree in size, roughly 14x14 meters)</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">author</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Khaled Al-Sham'aa <a href="mailto:khaled@ar-php.org">khaled@ar-php.org</a></p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> — <section class="phpdocumentor-description"><p>String represents a valid Open Location Code.</p> </section> </article> </section> </article> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section class="phpdocumentor-search-results__dialog"> <header class="phpdocumentor-search-results__header"> <h2 class="phpdocumentor-search-results__title">Search results</h2> <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button> </header> <section class="phpdocumentor-search-results__body"> <ul class="phpdocumentor-search-results__entries"></ul> </section> </section> </section> </div> </div> <a href="classes/ArPHP-I18N-Arabic.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> </main> <script> cssVars({}); </script> </body> </html>