PHP Interface Newscoop\Search\ServiceInterface

Provides an interface for Search services

Show file Open project: sourcefabric/newscoop Interface Usage Examples

Public Methods

Method	Description
getDocument ( Newscoop\Search\DocumentInterface $item ) : array	Get document for item
getDocumentId ( Newscoop\Search\DocumentInterface $item ) : string	Get document id
getSubType ( Newscoop\Search\DocumentInterface $item ) : string	Get the subtype of the item
getType ( ) : string	Get the type of the item
isIndexable ( Newscoop\Search\DocumentInterface $item ) : boolean	Test if item can be indexed
isIndexed ( Newscoop\Search\DocumentInterface $item ) : boolean	Test if item is indexed

Method Details

getDocument() public method

Get document for item

public getDocument ( Newscoop\Search\DocumentInterface $item ) : array
$item	Newscoop\Search\DocumentInterface
return	array

getDocumentId() public method

Get document id

public getDocumentId ( Newscoop\Search\DocumentInterface $item ) : string
$item	Newscoop\Search\DocumentInterface
return	string

getSubType() public method

Get the subtype of the item

public getSubType ( Newscoop\Search\DocumentInterface $item ) : string
$item	Newscoop\Search\DocumentInterface
return	string	identifier for subtype

getType() public method

Get the type of the item

public getType ( ) : string
return	string	identifier for type

isIndexable() public method

Test if item can be indexed

public isIndexable ( Newscoop\Search\DocumentInterface $item ) : boolean
$item	Newscoop\Search\DocumentInterface
return	boolean

isIndexed() public method

Test if item is indexed

public isIndexed ( Newscoop\Search\DocumentInterface $item ) : boolean
$item	Newscoop\Search\DocumentInterface
return	boolean