PHP Интерфейс Newscoop\Search\IndexClientInterface

Показать файл Открыть проект Примеры использования интерфейса

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

Метод Описание
__construct ( Symfony\Component\DependencyInjection\Container $container ) Initialize class
add ( array $item ) : boolean Add given item
delete ( String $itemId ) : boolean Delete given article by id
deleteAll ( ) : boolean Delete all indexed data
flush ( ) : boolean Commit changes to index
isEnabled ( $clientName ) : boolean Checks whether the index client is enabled for the current service
isTypeIndexable ( string $serviceName, $itemSubType ) : boolean Checks whether the subtype is indexable.
setItem ( Newscoop\Search\DocumentInterface $item ) Set item. This method gives the possibility for the indexing client to access extra data in regards to the default indexable content.
setService ( Newscoop\Search\ServiceInterface $service ) Set service for the current client
update ( array $item ) : boolean Update given item

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

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

Initialize class
public __construct ( Symfony\Component\DependencyInjection\Container $container )
$container Symfony\Component\DependencyInjection\Container

add() публичный метод

Add given item
public add ( array $item ) : boolean
$item array
Результат boolean

delete() публичный метод

Delete given article by id
public delete ( String $itemId ) : boolean
$itemId String
Результат boolean

deleteAll() публичный метод

Delete all indexed data
public deleteAll ( ) : boolean
Результат boolean

flush() публичный метод

Commit changes to index
public flush ( ) : boolean
Результат boolean

isEnabled() публичный метод

Checks whether the index client is enabled for the current service
public isEnabled ( $clientName ) : boolean
Результат boolean

isTypeIndexable() публичный метод

Checks whether the subtype is indexable.
public isTypeIndexable ( string $serviceName, $itemSubType ) : boolean
$serviceName string Name of the service
Результат boolean

setItem() публичный метод

Set item. This method gives the possibility for the indexing client to access extra data in regards to the default indexable content.
public setItem ( Newscoop\Search\DocumentInterface $item )
$item Newscoop\Search\DocumentInterface

setService() публичный метод

Set service for the current client
public setService ( Newscoop\Search\ServiceInterface $service )
$service Newscoop\Search\ServiceInterface

update() публичный метод

Update given item
public update ( array $item ) : boolean
$item array
Результат boolean