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


Files:
Arabic.class.php
ArAutoSummarize.class.php
ArCharsetC.class.php
ArCharsetD.class.php
ArDate.class.php
ArGender.class.php
ArGlyphs.class.php
ArIdentifier.class.php
ArKeySwap.class.php
ArMktime.class.php
ArNumbers.class.php
ArQuery.class.php
ArSoundex.class.php
ArTransliteration.class.php
ArWordTag.class.php
EnTransliteration.class.php
Salat.class.php

Classes:
Arabic
ArAutoSummarize
ArCharsetC
ArCharsetD
ArDate
ArGender
ArGlyphs
ArIdentifier
ArKeySwap
ArMktime
ArNumbers
ArQuery
ArSoundex
ArTransliteration
ArWordTag
EnTransliteration
Salat

Class: ArSoundex

Source Location: /sub/ArSoundex.class.php

Class Overview




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




Author(s):






          
      


Copyright:


    
  
  • Khaled Al-Shamaa 2008
    • 


        






Methods
























Class Details



[line 41]

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





Tags:





  

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

  

    copyright:  Khaled Al-Shamaa 2008
  

  

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










[ Top ]








Class Methods




  

	
	
constructor __construct [line 51]

	

    

    

		ArSoundex __construct(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getCode [line 158]

	

    

    

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

	

    

    

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

	

    

    

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

	

    

    

		TRUE setCode(
String
$str)
    

    


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





Tags:





  

    return:  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 100]

	

    

    

		TRUE setLang(
String
$str)
    

    


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





Tags:





  

    return:  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 86]

	

    

    

		TRUE setLen(
Integer
$integer)
    

    


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





Tags:





  

    return:  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 212]

	

    

    

		String soundex(
String
$word)
    

    


	
		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
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 21 Feb 2008 13:58:55 +0200 by phpDocumentor 1.4.0