PHP Class TextAnalysis\Indexes\InvertedIndex

Author: yooper (yooper)

Protected Properties

Property	Type	Description
$index	array	The index

Method	Description
__construct ( TextAnalysis\Interfaces\IDataReader $reader )	Pass in the pre-built indexes for doing lookups
__destruct ( )	clean up
addDocument ( TokensDocument $document ) : void	Add a document
getDocumentIdsByTerm ( string $term ) : array
getIndex ( ) : array	Return the internal index data structure
getTermsByDocumentId ( mixed $docId ) : array	Returns the key value array with the terms found in the document for the given doc id
query ( string $queryStr ) : array	Accepts a string a query and returns the set of documents relevant to the query
removeDocument ( mixed $docId ) : boolean	True if the doc was removed

Pass in the pre-built indexes for doing lookups

public __construct ( TextAnalysis\Interfaces\IDataReader $reader )
$reader	TextAnalysis\Interfaces\IDataReader

clean up

public __destruct ( )

Add a document

public addDocument ( TokensDocument $document ) : void
$document	TextAnalysis\Documents\TokensDocument
return	void

public getDocumentIdsByTerm ( string $term ) : array
$term	string
return	array

Return the internal index data structure

public getIndex ( ) : array
return	array

Returns the key value array with the terms found in the document for the given doc id

public getTermsByDocumentId ( mixed $docId ) : array
$docId	mixed
return	array

Accepts a string a query and returns the set of documents relevant to the query

public query ( string $queryStr ) : array
$queryStr	string
return	array

True if the doc was removed

public removeDocument ( mixed $docId ) : boolean
$docId	mixed
return	boolean

The index

protected array $index
return	array