I18N_Arabic
[ class tree: I18N_Arabic ] [ index: I18N_Arabic ] [ all elements ]

Class: I18N_Arabic

Source Location: /Arabic.php

Class Overview


Core PHP and Arabic language class


Author(s):

Copyright:

  • 2006-2012 Khaled Al-Shamaa

Methods



Class Details

[line 76]
Core PHP and Arabic language class



Tags:

author:  Khaled Al-Shamaa <khaled@ar-php.org>
copyright:  2006-2012 Khaled Al-Shamaa
link:  http://www.ar-php.org
license:  LGPL


[ Top ]


Class Methods


static method autoload [line 186]

static null autoload( string $className)

Include file that include requested class



Tags:

author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $className   Class name

[ Top ]

static method getBrowserLang [line 542]

static string getBrowserLang( )

Get web browser chosen/default language using ISO 639-1 codes (2-letter)



Tags:

return:  Language using ISO 639-1 codes (2-letter)
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


[ Top ]

static method getClassFile [line 465]

static string getClassFile( string $class)

Get sub class file path to be included (mapping between class name and file name/path become independent now)



Tags:

return:  Sub class file path
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  protected


Parameters:

string   $class   Sub class name

[ Top ]

static method header [line 482]

static string header( [string $mode = 'http'], [resource $conn = null])

Send/set output charset in several output media in a proper way



Tags:

return:  header formula if there is any (in cases of html, text_email, and html_email)
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $mode   [http|html|mysql|mysqli|pdo|text_email|html_email]
resource   $conn   The MySQL connection handler/the link identifier

[ Top ]

static method isForum [line 613]

static boolean isForum( string $html)

There is still a lack of original, localized, high-quality content and well-structured Arabic websites; This method help in tag HTML result pages from Arabic forum to enable filter it in/out.



Tags:

return:  True if the input HTML is belong to a forum page
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $html   The HTML content of the page in question

[ Top ]

static method myErrorHandler [line 202]

static boolean myErrorHandler( int $errno, string $errstr, string $errfile, int $errline)

Error handler function



Tags:

return:  FALSE
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

int   $errno   The level of the error raised
string   $errstr   The error message
string   $errfile   The filename that the error was raised in
int   $errline   The line number the error was raised at

[ Top ]

static method pregPattern [line 570]

static string pregPattern( string $pattern, [boolean $vowels = true])

Renders regular expression pattern using an enhanced version of syntax and semantics to support arabic version of some specifying generic character types



Tags:

return:  Rendered regular expression pattern
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $pattern   The pattern to search for, as a string using syntax and semantics of the regular expressions enhanced by arabic version of some specifying generic character types: \[ar]w any Arabic letter (including Harakat and Tatweel if $vowels is true) \[ar]d any decimal Arabic-Indic digit \[ar]v any Arabic vowel character (i.e. Harakat including Tatweel) \[ar]p any Arabic puncation character \[ar]W any character that is not an Arabic letter (including Harakat and Tatweel if $vowels is true) \[ar]D any character that is not a decimal Arabic-Indic digit \[ar]V any character that is not an Arabic vowel character (i.e. Harakat including Tatweel) \[ar]P any character that is not an Arabic puncation character
boolean   $vowels   True will include Harakat and Tatweel to the Arabic letters set (default is true)

[ Top ]

constructor __construct [line 139]

I18N_Arabic __construct( string $library, [boolean $useAutoload = false], [boolean $useException = false], [boolean $compatibleMode = true])

Load selected library/class you would like to use its functionality



Tags:

author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $library   [AutoSummarize|CharsetC|CharsetD|Date|Gender| Glyphs|Identifier|KeySwap|Numbers|Query|Salat| Soundex|StrToTime|WordTag|CompressStr|Mktime| Transliteration|Stemmer|Standard|Normalise]
boolean   $useAutoload   True to use Autoload (default is false)
boolean   $useException   True to use Exception (default is false)
boolean   $compatibleMode   True to support old naming style before version 3.0 (default is true)

[ Top ]

destructor __destruct [line 308]

void __destruct( )

Garbage collection, release child objects directly



Tags:

author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


[ Top ]

method convert [line 441]

string convert( string $str, [string $inputCharset = null], [string $outputCharset = null])

Convert Arabic string from one format to another



Tags:

return:  Arabic string in the format set by method setOutputCharset
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $str   Arabic string in the format set by setInput Charset
string   $inputCharset   (optional) Input charset [utf-8|windows-1256|iso-8859-6] default value is NULL (use set input charset)
string   $outputCharset   (optional) Output charset [utf-8|windows-1256|iso-8859-6] default value is NULL (use set output charset)

[ Top ]

method coreConvert [line 395]

string coreConvert( string $str, string $inputCharset, string $outputCharset)

Convert Arabic string from one charset to another



Tags:

return:  Converted Arabic string in defined charset
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $str   Original Arabic string that you would like to convert
string   $inputCharset   Input charset
string   $outputCharset   Output charset

[ Top ]

method getInputCharset [line 368]

string getInputCharset( )

Get the charset used in the input Arabic strings



Tags:

return:  return current setting for class input Arabic charset
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


[ Top ]

method getOutputCharset [line 379]

string getOutputCharset( )

Get the charset used in the output Arabic strings



Tags:

return:  return current setting for class output Arabic charset
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


[ Top ]

method load [line 227]

null load( string $library)

Load selected Arabic library and create an instance of its class



Tags:

author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $library   Library name

[ Top ]

method setInputCharset [line 324]

TRUE setInputCharset( string $charset)

Set charset used in class input Arabic strings



Tags:

return:  if success, or FALSE if fail
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $charset   Input charset [utf-8|windows-1256|iso-8859-6]

[ Top ]

method setOutputCharset [line 347]

boolean setOutputCharset( string $charset)

Set charset used in class output Arabic strings



Tags:

return:  TRUE if success, or FALSE if fail
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $charset   Output charset [utf-8|windows-1256|iso-8859-6]

[ Top ]

method __call [line 262]

The __call( string $methodName, array $arguments)

Magic method __call() allows to capture invocation of non existing methods.

That way __call() can be used to implement user defined method handling that depends on the name of the actual method being called.




Tags:

return:  value returned from the __call() method will be returned to the caller of the method.
author:  Khaled Al-Shamaa <khaled@ar-php.org>
access:  public


Parameters:

string   $methodName   Method name
array   $arguments   Array of arguments

[ Top ]


Documentation generated on Wed, 29 Aug 2012 08:32:46 +0200 by phpDocumentor 1.4.0