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


Files:
I18N_Arabic.php
I18N_Arabic_AutoSummarize.php
I18N_Arabic_CharsetC.php
I18N_Arabic_CharsetD.php
I18N_Arabic_CompressStr.php
I18N_Arabic_Date.php
I18N_Arabic_Gender.php
I18N_Arabic_Glyphs.php
I18N_Arabic_Hiero.php
I18N_Arabic_Identifier.php
I18N_Arabic_KeySwap.php
I18N_Arabic_Mktime.php
I18N_Arabic_Numbers.php
I18N_Arabic_Query.php
I18N_Arabic_Salat.php
I18N_Arabic_Soundex.php
I18N_Arabic_Standard.php
I18N_Arabic_Stemmer.php
I18N_Arabic_StrToTime.php
I18N_Arabic_Transliteration.php
I18N_Arabic_WordTag.php

Classes:
I18N_Arabic
I18N_ArabicException
I18N_Arabic_AutoSummarize
I18N_Arabic_CharsetC
I18N_Arabic_CharsetD
I18N_Arabic_CompressStr
I18N_Arabic_Date
I18N_Arabic_Gender
I18N_Arabic_Glyphs
I18N_Arabic_Hiero
I18N_Arabic_Identifier
I18N_Arabic_KeySwap
I18N_Arabic_Mktime
I18N_Arabic_Numbers
I18N_Arabic_Query
I18N_Arabic_Salat
I18N_Arabic_Soundex
I18N_Arabic_Standard
I18N_Arabic_Stemmer
I18N_Arabic_StrToTime
I18N_Arabic_Transliteration
I18N_Arabic_WordTag

Class: I18N_Arabic_Soundex

Source Location: /I18N_Arabic/I18N_Arabic_Soundex.php

Class Overview




This PHP class implement Arabic soundex algorithm




Author(s):






          
          


Copyright:


    
  
  • 2009 Khaled Al-Shamaa
    • 


        






Methods
























Class Details



[line 109]

This PHP class implement Arabic soundex algorithm





Tags:





  

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

  

    copyright:  2009 Khaled Al-Shamaa
  

  

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

  

    license:  LGPL
  










[ Top ]








Class Methods




  

	
	
constructor __construct [line 123]

	

    

    

		I18N_Arabic_Soundex __construct(
)
    

    


	
		Loads initialize values





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getCode [line 237]

	

    

    

		string getCode(
)
    

    


	
		Get the soundex key calculation method used now





Tags:





  

    return:  return current setting for soundex key calculation method
  

  

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

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLang [line 226]

	

    

    

		string getLang(
)
    

    


	
		Get the soundex key language used now





Tags:





  

    return:  return current setting for soundex key language
  

  

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

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLen [line 215]

	

    

    

		integer getLen(
)
    

    


	
		Get the soundex key length used now





Tags:





  

    return:  return current setting for soundex key length
  

  

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

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setCode [line 189]

	

    

    

		boolean setCode(
string
$str)
    

    


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





Tags:





  

    return:  TRUE if success, or FALSE if fail
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Soundex key mapping code [soundex|phonix]
      

        

    


        
[ Top ]

  

  

	
	
method setLang [line 166]

	

    

    

		boolean setLang(
string
$str)
    

    


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





Tags:





  

    return:  TRUE if success, or FALSE if fail
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Soundex key language [ar|en]
      

        

    


        
[ Top ]

  

  

	
	
method setLen [line 149]

	

    

    

		boolean setLen(
integer
$integer)
    

    


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





Tags:





  

    return:  TRUE if success, or FALSE if fail
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $integer  
        Soundex key length
      

        

    


        
[ Top ]

  

  

	
	
method soundex [line 303]

	

    

    

		string soundex(
string
$word, [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


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





Tags:





  

    return:  Soundex value for a given Arabic word
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $word  
        Arabic word you want to calculate its soundex
      

          

        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)
      

          

        object  
        $main  
        Main Ar-PHP object to access charset converter options
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 07 Nov 2009 19:53:00 +0200 by phpDocumentor 1.4.0