PHP Класс TextAnalysis\Documents\TokensDocument

Автор: yooper (yooper)
Наследование: extends TextAnalysis\Documents\DocumentAbstract
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$counter
$createdOn time doc was created defaults to now
$id mixed
$metadata array Stores an array of metadata about the document
$tokens type An array of tokens that all Documents have

Открытые методы

Метод Описание
__construct ( array $tokens, mixed $id = null, DateTim\DateTime $createdOn = null, array $metadata = [] )
applyExtract ( TextAnalysis\Interfaces\IExtractStrategy $extract ) : array Apply an extract filter and return the results after filter all the documents in the collection
applyStemmer ( TextAnalysis\Interfaces\IStemmer $stemmer, boolean $removeNulls = true ) : TokensDocument Apply a stemmer
applyTransformation ( TextAnalysis\Interfaces\ITokenTransformation $transformer, $removeNulls = true ) : TokensDocument Apply the transformation
getCreatedOn ( ) : DateTim\DateTime
getDocumentData ( ) : array Return an array of tokens
getId ( ) : mixed
getMetadata ( ) : array
setCreatedOn ( DateTim\DateTime $createdOn ) : TokensDocument
setMetadata ( array $metadata ) : TokensDocument
toArray ( ) : array Return the tokens

Описание методов

__construct() публичный Метод

public __construct ( array $tokens, mixed $id = null, DateTim\DateTime $createdOn = null, array $metadata = [] )
$tokens array
$id mixed
$createdOn DateTim\DateTime
$metadata array

applyExtract() публичный Метод

Apply an extract filter and return the results after filter all the documents in the collection
public applyExtract ( TextAnalysis\Interfaces\IExtractStrategy $extract ) : array
$extract TextAnalysis\Interfaces\IExtractStrategy
Результат array

applyStemmer() публичный Метод

Apply a stemmer
public applyStemmer ( TextAnalysis\Interfaces\IStemmer $stemmer, boolean $removeNulls = true ) : TokensDocument
$stemmer TextAnalysis\Interfaces\IStemmer
$removeNulls boolean
Результат TokensDocument

applyTransformation() публичный Метод

Apply the transformation
public applyTransformation ( TextAnalysis\Interfaces\ITokenTransformation $transformer, $removeNulls = true ) : TokensDocument
$transformer TextAnalysis\Interfaces\ITokenTransformation
Результат TokensDocument

getCreatedOn() публичный Метод

public getCreatedOn ( ) : DateTim\DateTime
Результат DateTim\DateTime

getDocumentData() публичный Метод

Return an array of tokens
public getDocumentData ( ) : array
Результат array

getId() публичный Метод

public getId ( ) : mixed
Результат mixed

getMetadata() публичный Метод

public getMetadata ( ) : array
Результат array

setCreatedOn() публичный Метод

public setCreatedOn ( DateTim\DateTime $createdOn ) : TokensDocument
$createdOn DateTim\DateTime
Результат TokensDocument

setMetadata() публичный Метод

public setMetadata ( array $metadata ) : TokensDocument
$metadata array
Результат TokensDocument

toArray() публичный Метод

Return the tokens
public toArray ( ) : array
Результат array

Описание свойств

$counter защищенное статическое свойство

protected static $counter

$createdOn защищенное свойство

time doc was created defaults to now
protected $createdOn

$id защищенное свойство

protected mixed $id
Результат mixed

$metadata защищенное свойство

Stores an array of metadata about the document
protected array $metadata
Результат array

$tokens защищенное свойство

An array of tokens that all Documents have
protected type $tokens
Результат type