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

Class: Arabic

Source Location: /Arabic.php

Class Overview


Core PHP and Arabic language class


Author(s):

Copyright:

  • 2009 Khaled Al-Shamaa

Variables

Methods



Class Details

[line 104]
Core PHP and Arabic language class



Tags:

author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
copyright:  2009 Khaled Al-Shamaa
link:  http://www.ar-php.org
license:  LGPL


[ Top ]


Class Variables

$myClass =

[line 111]



Tags:

access:  public

Type:   mixed


[ Top ]

$myObject =

[line 110]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 124]

Arabic __construct( string $library)

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



Tags:

author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
access:  public


Parameters:

string   $library   [ArAutoSummarize|ArCharsetC|ArCharsetD|ArDate| ArGender|ArGlyphs|ArIdentifier|ArKeySwap|ArMktime|ArNumbers| ArQuery|ArSoundex|ArStrToTime|ArTransliteration|ArWordTag| EnTransliteration|Salat|ArCompressStr|ArStandard|ArStemmer]

[ Top ]

destructor __destruct [line 182]

void __destruct( )

Garbage collection, release child objects directly



Tags:

author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>


[ Top ]

method convert [line 305]

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.alshamaa@gmail.com>
access:  public


Parameters:

string   $str   Arabic string in the format set by setInputCharset
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 269]

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.alshamaa@gmail.com>
access:  public


Parameters:

string   $str   Original Arabic string that you wouldliketo convert
string   $inputCharset   Input charset
string   $outputCharset   Output charset

[ Top ]

method getInputCharset [line 243]

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.alshamaa@gmail.com>
access:  public


[ Top ]

method getOutputCharset [line 254]

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.alshamaa@gmail.com>
access:  public


[ Top ]

method load [line 129]

void load( $library)



Tags:

access:  public


Parameters:

   $library  

[ Top ]

method setInputCharset [line 199]

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.alshamaa@gmail.com>
access:  public


Parameters:

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

[ Top ]

method setOutputCharset [line 222]

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.alshamaa@gmail.com>
access:  public


Parameters:

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

[ Top ]

method __call [line 158]

The __call( string $methodName, array $arguments)

The 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.alshamaa@gmail.com>
access:  public


Parameters:

string   $methodName   Method name
array   $arguments   Array of arguments

[ Top ]


Documentation generated on Tue, 18 Aug 2009 00:12:47 +0300 by phpDocumentor 1.4.0