From a35d61400a646a0c685a98d3fc7eea8721bc404e Mon Sep 17 00:00:00 2001 From: Khaled Al-Shamaa Date: Fri, 17 Jun 2022 20:17:40 +0200 Subject: [PATCH] Update class documentation for v6.3.0 --- docs/classes/ArPHP-I18N-Arabic.html | 366 ++++++++++++++++++++++------ 1 file changed, 288 insertions(+), 78 deletions(-) diff --git a/docs/classes/ArPHP-I18N-Arabic.html b/docs/classes/ArPHP-I18N-Arabic.html index 464824c..05d9e50 100644 --- a/docs/classes/ArPHP-I18N-Arabic.html +++ b/docs/classes/ArPHP-I18N-Arabic.html @@ -37,7 +37,8 @@
-

Ar-PHP

+

Ar-PHP

+

Arabic @@ -49,7 +50,7 @@

----------------------------------------------------------------------

-

Copyright (c) 2006-2021 Khaled Al-Sham'aa.

+

Copyright (c) 2006-2022 Khaled Al-Sham'aa.

http://www.ar-php.org

PHP Version >= 5.6

@@ -107,7 +108,7 @@
-

2006-2021 Khaled Al-Shamaa

+

2006-2022 Khaled Al-Shamaa

@@ -124,9 +125,9 @@
version
- 6.2.0 + 6.3.0 -

released in Jun 20, 2021

+

released in Jun 18, 2022

@@ -153,7 +154,7 @@

$version -  : mixed +  : string
@@ -182,10 +183,17 @@

arIdentify() -  : array<string|int, mixed> +  : array<string|int, int>
Identify Arabic text in a given UTF-8 multi language string
+
+ arNormalizeText() + +  : string +
+
Normalizes the input provided and returns the normalized string.
+
arPlural() @@ -224,7 +232,7 @@

arSentiment() -  : hash +  : array<string|int, bool|float>
Arabic Sentiment Analysis
@@ -319,6 +327,13 @@

7) Morocco style 8) Hijri format (Islamic calendar) in English +
+ getNorm() + +  : bool +
+
Get given normalization form status.
+
getNumberFeminine() @@ -343,7 +358,7 @@

getPrayTime() -  : array<string|int, mixed> +  : array<string|int, string>
Calculate Salat times for the date set in setSalatDate methode, and location set in setSalatLocation.
@@ -358,7 +373,7 @@

getQueryArrFields() -  : array<string|int, mixed> +  : array<string|int, string>
Getting values of $_fields Array in array format
@@ -471,7 +486,7 @@

olc2dd() -  : array<string|int, mixed> +  : array<string|int, null|float>
Decode an Open Location Code string into its location coordinates in decimal degrees.
@@ -482,6 +497,13 @@

Setting value for $_arDateMode scalar
+
+ setNorm() + +  : object +
+
Set given normalization form status.
+
setNumberFeminine() @@ -678,14 +700,16 @@

+ public - mixed + string $version - = '6.2.0' + = '6.3.0' + +
-

@@ -706,6 +730,7 @@

__construct()

+ public @@ -891,7 +916,7 @@

public - arIdentify(string $str) : array<string|int, mixed> + arIdentify(string $str[, bool $html = true ]) : array<string|int, int>
@@ -905,6 +930,15 @@

Parameters

UTF-8 multi language string

+ +
+ $html + : bool + = true
+
+

If True, then ignore the HTML tags (default is TRUE)

+
+
@@ -926,13 +960,70 @@
Return values
- array<string|int, mixed> + array<string|int, int> —

Offset of the beginning and end of each Arabic segment in sequence in the given UTF-8 multi language string

+ +
+

+ arNormalizeText() + +

+ +

Normalizes the input provided and returns the normalized string.

+ + + public + arNormalizeText(string $text) : string + +
+ +
Parameters
+
+
+ $text + : string +
+
+

The input string to normalize.

+
+ +
+
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Khaled Al-Sham'aa khaled@ar-php.org

+
+ +
+
+ +
Return values
+ string + — +

The normalized string.

+
+ +
public - arSentiment(string $text) : hash + arSentiment(string $text) : array<string|int, bool|float>
@@ -1264,9 +1355,10 @@
Return values
- hash + array<string|int, bool|float> — -

of 2 elements: boolean isPositive (negative if false), and float probability (range from 0 to 1)

+

of 2 elements: boolean isPositive (negative if false), +and float probability (range from 0 to 1)

@@ -1286,7 +1378,7 @@

public - arSummary(string $str, string $keywords, int $int, int $mode, int $output[, string $style = null ]) : string + arSummary(string $str, string $keywords, int $int, int $mode, int $output) : string
@@ -1336,15 +1428,6 @@

Parameters

Output mode [1|2] for "summary" and "highlight" modes respectively

- -
- $style - : string - = null
-
-

Name of the CSS class you would like to apply

-
-
@@ -1989,6 +2072,65 @@
Return values
+
+
+

+ getNorm() + +

+ +

Get given normalization form status.

+ + + public + getNorm(string $form) : bool + +
+ +
Parameters
+
+
+ $form + : string +
+
+

One of the normalization forms ['stripTatweel', 'stripTanween', 'stripShadda', +'stripLastHarakat', 'stripWordHarakat', 'normaliseLamAlef', +'normaliseAlef', 'normaliseHamza', 'normaliseTaa']

+
+ +
+
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Khaled Al-Sham'aa khaled@ar-php.org

+
+ +
+
+ +
Return values
+ bool + — +

Selected normalization form status.

+
+ +
public - getPrayTime() : array<string|int, mixed> + getPrayTime() : array<string|int, string>
@@ -2181,7 +2323,7 @@
Return values
- array<string|int, mixed> + array<string|int, string> —

of Salat times + sun rise in the following format hh:mm where hh is the hour in local format and 24 mode @@ -2264,12 +2406,12 @@

getQueryArrFields()

- +

Getting values of $_fields Array in array format

public - getQueryArrFields() : array<string|int, mixed> + getQueryArrFields() : array<string|int, string>
@@ -2292,7 +2434,7 @@
Return values
- array<string|int, mixed> + array<string|int, string> —

Value of $_fields array in Array format

@@ -2309,7 +2451,7 @@

getQueryMode()

- +

Getting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]

@@ -2354,7 +2496,7 @@

getQueryStrFields()

- +

Getting values of $_fields array in String format (comma delimated)

@@ -2399,7 +2541,7 @@

getSoundexCode()

- +

Get the soundex key calculation method used now

@@ -2444,7 +2586,7 @@

getSoundexLang()

- +

Get the soundex key language used now

@@ -2489,7 +2631,7 @@

getSoundexLen()

- +

Get the soundex key length used now

@@ -2534,7 +2676,7 @@

hijriMonthDays()

- +

Calculate how many days in a given Hijri month

@@ -2610,7 +2752,7 @@

int2indic()

- +

Represent integer number in Arabic-Indic digits using HTML entities

@@ -2667,7 +2809,7 @@

int2str()

- +

Spell integer number in Arabic idiom

@@ -2724,7 +2866,7 @@

int2strItem()

- +

Spell integer number in Arabic idiom followed by plural form of the counted item

@@ -2790,7 +2932,7 @@

isArabic()

- +

Find out if given string is Arabic text or not

@@ -2847,7 +2989,7 @@

isFemale()

- +

Arabic Gender Guesser

@@ -2911,7 +3053,7 @@

mktime()

- +

This will return current Unix timestamp for given Hijri date (Islamic calendar)

@@ -3024,7 +3166,7 @@

mktimeCorrection()

- +

Calculate Hijri calendar correction using Um-Al-Qura calendar information

@@ -3090,7 +3232,7 @@

money2str()

- +

Spell number in Arabic idiom as money

@@ -3165,7 +3307,7 @@

noDots()

- +

Strip Dots and Hamzat

@@ -3222,12 +3364,12 @@

olc2dd()

- +

Decode an Open Location Code string into its location coordinates in decimal degrees.

public - olc2dd(string $olc[, int $codeLength = 10 ]) : array<string|int, mixed> + olc2dd(string $olc[, int $codeLength = 10 ]) : array<string|int, null|float>

Ref: https://github.com/google/open-location-code/blob/master/docs/specification.md

@@ -3273,7 +3415,7 @@
Return values
- array<string|int, mixed> + array<string|int, null|float> —

Location coordinates in decimal degrees [latitude, longitude] in WGS84

@@ -3290,7 +3432,7 @@

setDateMode()

- +

Setting value for $_arDateMode scalar

@@ -3346,6 +3488,74 @@
Return values
+
+
+

+ setNorm() + +

+ +

Set given normalization form status.

+ + + public + setNorm(string $form, bool $status) : object + +
+ +
Parameters
+
+
+ $form + : string +
+
+

One of the normalization forms ['stripTatweel', 'stripTanween', 'stripShadda', +'stripLastHarakat', 'stripWordHarakat', 'normaliseLamAlef', +'normaliseAlef', 'normaliseHamza', 'normaliseTaa', 'all']

+
+ +
+
+ $status + : bool +
+
+

Normalization form status [true|false]

+
+ +
+
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Khaled Al-Sham'aa khaled@ar-php.org

+
+ +
+
+ +
Return values
+ object + — +

$this to build a fluent interface.

+
+ +
setNumberFeminine() - +

Set feminine flag of the counted object

@@ -3414,7 +3624,7 @@

setNumberFormat()

- +

Set the grammar position flag of the counted object

@@ -3471,7 +3681,7 @@

setNumberOrder()

- +

Set the ordering flag, is it normal number or ordering number

@@ -3528,12 +3738,12 @@

setQueryArrFields()

- +

Setting value for $_fields array

public - setQueryArrFields(array<string|int, mixed> $arrConfig) : object + setQueryArrFields(array<string|int, string> $arrConfig) : object
@@ -3541,7 +3751,7 @@
Parameters
$arrConfig - : array<string|int, mixed> + : array<string|int, string>

Name of the fields that SQL statement will search @@ -3586,7 +3796,7 @@

setQueryMode()

- +

Setting $mode propority value that refer to search mode [0 for OR logic | 1 for AND logic]

@@ -3643,7 +3853,7 @@

setQueryStrFields()

- +

Setting value for $_fields array

@@ -3701,7 +3911,7 @@

setSalatConf()

- +

Setting rest of Salat calculation configuration

@@ -3807,7 +4017,7 @@

setSalatDate()

- +

Setting date of day for Salat calculation

@@ -3882,7 +4092,7 @@

setSalatLocation()

- +

Setting location information for Salat calculation

@@ -3966,7 +4176,7 @@

setSoundexCode()

- +

Set the mapping code of the soundex key (default value is "soundex")

@@ -4023,7 +4233,7 @@

setSoundexLang()

- +

Set the language of the soundex key (default value is "en")

@@ -4080,7 +4290,7 @@

setSoundexLen()

- +

Set the length of soundex key (default value is 4)

@@ -4137,7 +4347,7 @@

soundex()

- +

Arabic soundex algorithm takes Arabic word as an input and produces a character string which identifies a set words that are (roughly) phonetically alike.

@@ -4196,7 +4406,7 @@

standard()

- +

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 .

@@ -4256,7 +4466,7 @@

str2int()

- +

Convert Arabic idiom number string into Integer

@@ -4313,7 +4523,7 @@

stripHarakat()

- +

Strip Harakat

@@ -4415,7 +4625,7 @@

strtotime()

- +

Arabic arStrToTime Function

@@ -4487,7 +4697,7 @@

swapAe()

- +

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)

@@ -4545,7 +4755,7 @@

swapAf()

- +

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)

@@ -4603,7 +4813,7 @@

swapEa()

- +

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)

@@ -4661,7 +4871,7 @@

swapFa()

- +

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)

@@ -4719,7 +4929,7 @@

utf8Glyphs()

- +

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...)

@@ -4807,7 +5017,7 @@

volc()

- +

Determine if an Open Location Code is valid.