Beta version

class SolariumDocumentTranslation extends AbstractSolarium

Wrap a Solarium and a DocumenTranslation together to ease indexing.

Constants

TYPE_DISCRIMINATOR

DOCUMENT_TYPE

IDENTIFIER_KEY

Properties

static $availableLocalizedTextFields from AbstractSolarium

Methods

boolean
indexAndCommit()

Index current nodeSource and commit after.

Result
updateAndCommit()

Update current nodeSource document and commit after.

update(Query $update)

Update current nodeSource document with existing update.

boolean
remove(Query $update)

Remove current document from SearchEngine index.

removeAndCommit()

Remove current Solr document and commit after.

cleanAndCommit()

Remove any document linked to current node-source and commit after.

boolean
index()

Index current document with entity data.

DocumentInterface
getDocument()

No description

$this
setDocument(DocumentInterface $document)

No description

$this
createEmptyDocument(Query $update)

No description

boolean
clean(Query $update)

No description

boolean
getDocumentFromIndex()

No description

__construct(DocumentTranslation $documentTranslation, Client $client = null, Logger $logger = null)

Create a new SolariumDocument.

Details

in AbstractSolarium at line 96
boolean indexAndCommit()

Index current nodeSource and commit after.

Use this method only when you need to index single NodeSources.

Return Value

boolean

in AbstractSolarium at line 119
Result updateAndCommit()

Update current nodeSource document and commit after.

Use this method only when you need to re-index a single NodeSources.

Return Value

Result

in AbstractSolarium at line 138
update(Query $update)

Update current nodeSource document with existing update.

Use this method only when you need to re-index bulk NodeSources.

Parameters

Query $update

in AbstractSolarium at line 154
boolean remove(Query $update)

Remove current document from SearchEngine index.

Parameters

Query $update

Return Value

boolean

Exceptions

RuntimeException If no document is available.

in AbstractSolarium at line 170
removeAndCommit()

Remove current Solr document and commit after.

Use this method only when you need to remove a single NodeSources.

in AbstractSolarium at line 184
cleanAndCommit()

Remove any document linked to current node-source and commit after.

Use this method only when you need to remove a single NodeSources.

in AbstractSolarium at line 200
boolean index()

Index current document with entity data.

Return Value

boolean

Exceptions

RuntimeException If no document is available.

in AbstractSolarium at line 221
DocumentInterface getDocument()

Return Value

DocumentInterface

in AbstractSolarium at line 231
$this setDocument(DocumentInterface $document)

Parameters

DocumentInterface $document

Return Value

$this

in AbstractSolarium at line 241
$this createEmptyDocument(Query $update)

Parameters

Query $update

Return Value

$this

at line 189
boolean clean(Query $update)

Parameters

Query $update

Return Value

boolean

at line 84
boolean getDocumentFromIndex()

Return Value

boolean FALSE if no document found linked to current roadiz document.

at line 64
__construct(DocumentTranslation $documentTranslation, Client $client = null, Logger $logger = null)

Create a new SolariumDocument.

Parameters

DocumentTranslation $documentTranslation
Client $client
Logger $logger