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_AutoSummarize

Source Location: /I18N_Arabic/I18N_Arabic_AutoSummarize.php

Class Overview




This PHP class do automatic keyphrase extraction to provide a quick  mini-summary for a long Arabic document




Author(s):






          
          


Copyright:


    
  
  • 2009 Khaled Al-Shamaa
    • 


        






Methods
























Class Details



[line 144]

This PHP class do automatic keyphrase extraction to provide a quick  mini-summary for a long Arabic document





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

	

    

    

		I18N_Arabic_AutoSummarize __construct(
)
    

    


	
		Loads initialize values





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method cleanCommon [line 499]

	

    

    

		string cleanCommon(
string
$str, [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Extracting common Arabic words (roughly) from input Arabic string (document content)





Tags:





  

    return:  Arabic document as a string free of common words (roughly)
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input normalized Arabic document as a string
      

          

        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 ]

  

  

	
	
method doRateSummarize [line 323]

	

    

    

		string doRateSummarize(
string
$str, integer
$rate, string
$keywords, [string
$style = null], [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Summarize percentage of the input Arabic string (document content) into output





Tags:





  

    return:  Output summary requested
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input Arabic document as a string
      

          

        integer  
        $rate  
        Rate of output summary sentence number as percentage                                of the input Arabic string (document content)
      

          

        string  
        $keywords  
        List of keywords higlited by search process
      

          

        string  
        $style  
        Name of the CSS class you would like to apply
      

          

        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 ]

  

  

	
	
method doSummarize [line 297]

	

    

    

		string doSummarize(
string
$str, integer
$int, string
$keywords, [string
$style = null], [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Summarize input Arabic string (document content) into specific number of  sentences in the output





Tags:





  

    return:  Output summary requested
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input Arabic document as a string
      

          

        integer  
        $int  
        Number of sentences required in output summary
      

          

        string  
        $keywords  
        List of keywords higlited by search process
      

          

        string  
        $style  
        Name of the CSS class you would like to apply
      

          

        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 ]

  

  

	
	
method getMetaKeywords [line 402]

	

    

    

		string getMetaKeywords(
string
$str, integer
$int, [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Extract keywords from a given Arabic string (document content)





Tags:





  

    return:  List of the keywords extracting from input Arabic string                (document content)
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input Arabic document as a string
      

          

        integer  
        $int  
        Number of keywords required to be extracting from                                input string (document content)
      

          

        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 ]

  

  

	
	
method highlightRateSummary [line 377]

	

    

    

		string highlightRateSummary(
string
$str, integer
$rate, string
$keywords, [string
$style = null], [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Highlight key sentences (summary) as percentage of the input string  (document content) using CSS and send the result back as an output.





Tags:





  

    return:  Output highlighted key sentences summary (using CSS)
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input Arabic document as a string
      

          

        integer  
        $rate  
        Rate of highlighted key sentences summary number as                                percentage of the input Arabic string (document content)
      

          

        string  
        $keywords  
        List of keywords higlited by search process
      

          

        string  
        $style  
        Name of the CSS class you would like to apply
      

          

        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 ]

  

  

	
	
method highlightSummary [line 350]

	

    

    

		string highlightSummary(
string
$str, integer
$int, string
$keywords, [string
$style = null], [string
$inputCharset = null], [string
$outputCharset = null], [object
$main = null])
    

    


	
		Highlight key sentences (summary) of the input string (document content)  using CSS and send the result back as an output





Tags:





  

    return:  Output highlighted key sentences summary (using CSS)
  

  

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

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Input Arabic document as a string
      

          

        integer  
        $int  
        Number of key sentences required to be highlighted in                                the input string (document content)
      

          

        string  
        $keywords  
        List of keywords higlited by search process
      

          

        string  
        $style  
        Name of the CSS class you would like to apply
      

          

        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 ]

  

  

	
	
method loadExtra [line 185]

	

    

    

		void loadExtra(
)
    

    


	
		Load enhanced Arabic stop words list





Tags:





  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 07 Nov 2009 19:52:56 +0200 by phpDocumentor 1.4.0