PHP Interface Newscoop\Search\IndexClientInterface

Afficher le fichier Open project: sourcefabric/newscoop Interface Usage Examples

Méthodes publiques

Méthode Description
__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

Method Details

__construct() public méthode

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

add() public méthode

Add given item
public add ( array $item ) : boolean
$item array
Résultat boolean

delete() public méthode

Delete given article by id
public delete ( String $itemId ) : boolean
$itemId String
Résultat boolean

deleteAll() public méthode

Delete all indexed data
public deleteAll ( ) : boolean
Résultat boolean

flush() public méthode

Commit changes to index
public flush ( ) : boolean
Résultat boolean

isEnabled() public méthode

Checks whether the index client is enabled for the current service
public isEnabled ( $clientName ) : boolean
Résultat boolean

isTypeIndexable() public méthode

Checks whether the subtype is indexable.
public isTypeIndexable ( string $serviceName, $itemSubType ) : boolean
$serviceName string Name of the service
Résultat boolean

setItem() public méthode

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() public méthode

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

update() public méthode

Update given item
public update ( array $item ) : boolean
$item array
Résultat boolean