kernel/search/plugins/ezsearchengine/ezsearchengine.php

Show: inherited
Table of Contents

File containing the eZSearchEngine class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
kernel  
Version
4.6.0  

\eZSearchEngine

Package: kernel

File containing the eZSearchEngine class.

Parent(s)
\ezpSearchEngine
Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Version
4.6.0  

Properties

Propertypublic  $CreatedTempTablesNames= 'array()'
Default valuearray()Details
Type
n/a
Propertypublic  $TempTablesCount= '0'
Default value0Details
Type
n/a

Methods

methodpublicaddObject( \eZContentObject $contentObject, bool $commit = true ) : bool

Adds object $contentObject to the search database.

Parameters
Name Type Description
$contentObject \eZContentObject

Object to add to search engine

$commit bool

Whether to commit after adding the object

Returns
Type Description
bool True if the operation succeed.
methodpublicbuildPhraseSqlQueryPart(  $phraseIDArray,  $identifier = false ) : void

Parameters
Name Type Description
$phraseIDArray
$identifier
methodpublicbuildSearchPartArray(  $phraseTextArray,  $nonPhraseText,  $wordIDHash,  $wildIDArray,  $identifier = false ) : void

Parameters
Name Type Description
$phraseTextArray
$nonPhraseText
$wordIDHash
$wildIDArray
$identifier
methodpublicbuildSearchPartArrayForPhrases(  $phraseTextArray,  $wordIDHash,  $identifier = false ) : void

Parameters
Name Type Description
$phraseTextArray
$wordIDHash
$identifier
methodpublicbuildSearchPartArrayForWords(  $nonPhraseText,  $wordIDHash,  $wildIDArray,  $identifier = false ) : void

Parameters
Name Type Description
$nonPhraseText
$wordIDHash
$wildIDArray
$identifier
methodpublicbuildSortSQL(  $sortArray ) : void

Parameters
Name Type Description
$sortArray
methodpublicbuildSqlPartForWord(  $wordID,  $identifier = false ) : void

Parameters
Name Type Description
$wordID
$identifier
methodpublicbuildTempTablesForFullTextSearch(  $searchPartsArray,  $generalFilterList = array() ) : void

Parameters
Name Type Description
$searchPartsArray
$generalFilterList
methodpublicbuildWordIDArray(  $indexArrayOnlyWords ) : void

Parameters
Name Type Description
$indexArrayOnlyWords
methodpubliccallMethod(  $methodName,  $parameterArray ) : void

Parameters
Name Type Description
$methodName
$parameterArray
methodpubliccleanup( ) : void

methodpubliccommit( ) : void

Commit the changes to the search engine

methodpublicconstructMethodName(  $searchTypeData ) : void

Parameters
Name Type Description
$searchTypeData
methodpubliccreateTemporaryTable(  $searchPartText ) : void

Parameters
Name Type Description
$searchPartText
methodpubliceZSearchEngine( ) : void

methodpublicfetchTotalObjectCount( ) : void

methodpublicgetPhrases(  $searchText ) : void

Parameters
Name Type Description
$searchText
methodpublicgetSavedTempTableName(  $index ) : void

Parameters
Name Type Description
$index
methodpublicgetSavedTempTablesList( ) : void

methodpublicindexWords(  $contentObject,  $indexArray,  $wordIDArray,  $placement = 0 ) : void

Parameters
Name Type Description
$contentObject
$indexArray
$wordIDArray
$placement
methodpublicisSearchPartIncomplete(  $part ) : void

Parameters
Name Type Description
$part
methodpublicneedCommit( ) : void

methodpublicneedRemoveWithUpdate( ) : void

methodpublicnormalizeText(  $text,  $isMetaData = false ) : void

Parameters
Name Type Description
$text
$isMetaData
methodpublicprepareWordIDArrays(  $searchText ) : void

Parameters
Name Type Description
$searchText
methodpublicprepareWordIDArraysForPattern(  $searchText ) : void

Parameters
Name Type Description
$searchText
methodpublicremoveObject( \eZContentObject $contentObject, bool $commit = true ) : bool

Removes object $contentObject from the search database.

Parameters
Name Type Description
$contentObject \eZContentObject

the content object to remove

$commit bool

Whether to commit after removing the object

Returns
Type Description
bool True if the operation succeed.
methodpublicsaveCreatedTempTableName(  $index,  $tableName ) : void

Parameters
Name Type Description
$index
$tableName
methodpublicsearch(  $searchText,  $params = array(),  $searchTypes = array() ) : void

Parameters
Name Type Description
$searchText
$params
$searchTypes
methodpublicsearchAttributeByIdentifier(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeByIdentifierRange(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeByRange(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeFulltext(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeInteger(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeIntegers(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributeIntegersByIdentifier(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsearchAttributePatternText(  $searchParams ) : void

Parameters
Name Type Description
$searchParams
methodpublicsplitString(  $text ) : void

Parameters
Name Type Description
$text
methodpublicsupportedSearchTypes( ) : void

methodpublicupdateObjectsSection(  $objectIDs, int $sectionID ) : void

Update the section in the search engine

Parameters
Name Type Description
$objectIDs
$sectionID int
Details
See
\eZSearch::updateObjectsSection()  
Documentation was generated by DocBlox 0.18.1.