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


Files:
Arabic.php
ArAutoSummarize.class.php
ArCharsetC.class.php
ArCharsetD.class.php
ArCompressStr.class.php
ArDate.class.php
ArGender.class.php
ArGlyphs.class.php
ArIdentifier.class.php
ArKeySwap.class.php
ArMktime.class.php
ArNormalise.class.php
ArNumbers.class.php
ArQuery.class.php
ArSoundex.class.php
ArStandard.class.php
ArStemmer.class.php
ArStrToTime.class.php
ArWordTag.class.php
Hiero.class.php
Salat.class.php
Transliteration.class.php

Classes:
Arabic
ArabicException
ArAutoSummarize
ArCharsetC
ArCharsetD
ArCompressStr
ArDate
ArGender
ArGlyphs
ArIdentifier
ArKeySwap
ArMktime
ArNormalise
ArNumbers
ArQuery
ArSoundex
ArStandard
ArStemmer
ArStrToTime
ArWordTag
Hiero
Salat
Transliteration

Class: Arabic

Source Location: /Arabic.php

Class Overview




Core PHP and Arabic language class




Author(s):






          
          


Copyright:


    
  
  • 2006-2010 Khaled Al-Shamaa
    • 


        




Variables







Methods
























Class Details



[line 76]

Core PHP and Arabic language class





Tags:





  

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

  

    copyright:  2006-2010 Khaled Al-Shamaa
  

  

    link:  http://www.ar-php.org
  

  

    license:  LGPL
  










[ Top ]







Class Variables



	
	

	
$compatible = array('EnTransliteration'=>'Transliteration', 

                                  'ArTransliteration'=>'Transliteration',

                                  'a4_max_chars'=>'a4MaxChars',

                                  'a4_lines'=>'a4Lines',

                                  'swap_ea'=>'swapEa',

                                  'swap_ae'=>'swapAe')

	
[line 85]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$compatibleMode = 

	
[line 83]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$inputCharset =  'utf-8'

	
[line 78]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$myClass = 

	
[line 93]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$myObject = 

	
[line 92]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$outputCharset =  'utf-8'

	
[line 79]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$path = 

	
[line 80]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$useAutoload = 

	
[line 81]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$useException = 

	
[line 82]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method autoload [line 144]

	

    

    

		static null autoload(
string
$className)
    

    


	
		Include file that include requested class





Tags:





  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $className  
        Class name
      

        

    


        
[ Top ]

  

  

	
	
static method myErrorHandler [line 160]

	

    

    

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

    


	
		Error handler function





Tags:





  

    return:  FALSE
  

  

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

  

    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 ]

  


  

	
	
constructor __construct [line 110]

	

    

    

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

    


	
		Load selected library/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|                               Numbers|ArQuery|ArSoundex|ArStrToTime|Mktime|                               ArTransliteration|ArWordTag|EnTransliteration|                               Salat|ArCompressStr|ArStandard|ArStemmer|                               ArNormalise]
      

          

        boolean  
        $useAutoload  
        True to use Autoload (default is false)
      

          

        boolean  
        $useException  
        True to use Exception (default is false)
      

          

          
        $compatibleMode  
        
      

        

    


        
[ Top ]

  

  

	
	
destructor __destruct [line 281]

	

    

    

		void __destruct(
)
    

    


	
		Garbage collection, release child objects directly





Tags:





  

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

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method convert [line 415]

	

    

    

		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 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 369]

	

    

    

		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 would like                               to convert
      

          

        string  
        $inputCharset  
        Input charset
      

          

        string  
        $outputCharset  
        Output charset
      

        

    


        
[ Top ]

  

  

	
	
method getInputCharset [line 342]

	

    

    

		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 353]

	

    

    

		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 185]

	

    

    

		null load(
string
$library)
    

    


	
		Load selected Arabic library and create an instance of its class





Tags:





  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $library  
        Library name
      

        

    


        
[ Top ]

  

  

	
	
method setInputCharset [line 298]

	

    

    

		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 321]

	

    

    

		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 218]

	

    

    

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $methodName  
        Method name
      

          

        array  
        $arguments  
        Array of arguments
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 14 Aug 2010 13:23:51 -0700 by phpDocumentor 1.4.0