PHP Class TextAnalysis\Collections\DocumentArrayCollection

Inheritance: implements TextAnalysis\Interfaces\ICollection

Datei anzeigen Open project: yooper/php-text-analysis Class Usage Examples

Protected Properties

Property	Type	Description
$currentDocument	TextAnalysis\Documents\DocumentAbstract	When looped through this is the current document
$documents	array	An array of documents

Public Methods

Method	Description
__construct ( array $documents )	An array of DocumentAbstract objects
__destruct ( )
applyExtract ( TextAnalysis\Interfaces\IExtractStrategy $extract ) : array	Apply extract to the document to pull out all the points of interest
applyStemmers ( array $stemmers )
applyTransformations ( array $transformations )
count ( ) : integer
current ( ) : TextAnalysis\Documents\DocumentAbstract
getIterator ( ) : ArrayIterator
next ( )
offsetExists ( mixed $key ) : boolean
offsetGet ( mixed $key ) : TextAnalysis\Documents\DocumentAbstract
offsetSet ( mixed $key, TextAnalysis\Documents\DocumentAbstract $value ) : boolean
offsetUnset ( mixed $key ) : null
rewind ( )
valid ( ) : boolean

Method Details

__construct() public method

An array of DocumentAbstract objects

public __construct ( array $documents )
$documents	array

__destruct() public method

public __destruct ( )

applyExtract() public method

Apply extract to the document to pull out all the points of interest

public applyExtract ( TextAnalysis\Interfaces\IExtractStrategy $extract ) : array
$extract	TextAnalysis\Interfaces\IExtractStrategy
return	array

applyStemmers() public method

public applyStemmers ( array $stemmers )
$stemmers	array	An array of stemmers Apply the collection of stem transformers to the documents

applyTransformations() public method

public applyTransformations ( array $transformations )
$transformations	array	An array of Apply the collection of token transformers to the documents

count() public method

public count ( ) : integer
return	integer

current() public method

public current ( ) : TextAnalysis\Documents\DocumentAbstract
return	TextAnalysis\Documents\DocumentAbstract

getIterator() public method

public getIterator ( ) : ArrayIterator
return	ArrayIterator

next() public method

public next ( )

offsetExists() public method

public offsetExists ( mixed $key ) : boolean
$key	mixed
return	boolean

offsetGet() public method

public offsetGet ( mixed $key ) : TextAnalysis\Documents\DocumentAbstract
$key	mixed
return	TextAnalysis\Documents\DocumentAbstract

offsetSet() public method

public offsetSet ( mixed $key, TextAnalysis\Documents\DocumentAbstract $value ) : boolean
$key	mixed
$value	TextAnalysis\Documents\DocumentAbstract
return	boolean

offsetUnset() public method

public offsetUnset ( mixed $key ) : null
$key	mixed
return	null

rewind() public method

public rewind ( )

valid() public method

public valid ( ) : boolean
return	boolean

Property Details

$currentDocument protected_oe property

When looped through this is the current document

protected DocumentAbstract,TextAnalysis\Documents $currentDocument
return	TextAnalysis\Documents\DocumentAbstract

$documents protected_oe property

An array of documents

protected array $documents
return	array