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

Class: I18N_Arabic_Soundex

Source Location: /Arabic/Soundex.php

Class Overview


This PHP class implement Arabic soundex algorithm


Author(s):

Copyright:

  • 2006-2013 Khaled Al-Sham'aa

Methods



Class Details

[line 120]
This PHP class implement Arabic soundex algorithm



Tags:

author:  Khaled Al-Sham'aa <khaled@ar-php.org>
copyright:  2006-2013 Khaled Al-Sham'aa
link:  http://www.ar-php.org
license:  LGPL


[ Top ]


Class Methods


method getCode [line 246]

string getCode( )

Get the soundex key calculation method used now



Tags:

return:  return current setting for soundex key calculation method
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


[ Top ]

method getLang [line 235]

string getLang( )

Get the soundex key language used now



Tags:

return:  return current setting for soundex key language
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


[ Top ]

method getLen [line 224]

integer getLen( )

Get the soundex key length used now



Tags:

return:  return current setting for soundex key length
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


[ Top ]

method mapCode [line 259]

string mapCode( string $word)

Methode to get soundex/phonix numric code for given word



Tags:

return:  The calculated soundex/phonix numeric code
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  protected


Parameters:

string   $word   The word that we want to encode it

[ Top ]

method setCode [line 202]

object setCode( string $str)

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



Tags:

return:  to build a fluent interface
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


Parameters:

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

[ Top ]

method setLang [line 183]

object setLang( string $str)

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



Tags:

return:  to build a fluent interface
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


Parameters:

string   $str   Soundex key language [ar|en]

[ Top ]

method setLen [line 168]

object setLen( integer $integer)

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



Tags:

return:  to build a fluent interface
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  public


Parameters:

integer   $integer   Soundex key length

[ Top ]

method soundex [line 312]

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-Sham'aa <khaled@ar-php.org>
access:  public


Parameters:

string   $word   Arabic word you want to calculate its soundex

[ Top ]

method trimRep [line 285]

string trimRep( string $word)

Remove any characters replicates



Tags:

return:  Same word without any duplicate chracters
author:  Khaled Al-Sham'aa <khaled@ar-php.org>
access:  protected


Parameters:

string   $word   Arabic word you want to check if it is feminine

[ Top ]


Documentation generated on Mon, 14 Jan 2013 17:49:06 +0100 by phpDocumentor 1.4.0