SearchIndexRecord
class SearchIndexRecord
Properties
| SearchController | $mod | ||
| protected string | $title | ||
| protected string | $summary | ||
| protected string | $indexContent | ||
| protected string[]|int[] | $attachments | ||
| protected string | $locale | ||
| protected int | $relatedPostId | ||
| protected array | $tags | ||
| protected array | $preProcessingData | ||
| protected bool | $removeFromIndex | ||
| protected array | $metaData | Key-value array with meta data delivered by the modules for new faceted filters. |
Methods
SearchIndexRecord is always based on the respective document_index
Adds an additional language variant of this document
Allows to set a single key-value pair in the meta data
No description
No description
Returns an array of localized Content objects containing all available translations for this document
Returns the initial document creation date as UNIX timestamp
No description
No description
Sets the content which shall be additionally be indexed. By default the title and summary are already indexed.
No description
No description
No description
No description
No description
Used by Pre-Processing Logic to store / get additional data during indexing
No description
Returns true of this index record has been marked for index removal
No description
No description
No description
Returns the last document update date as UNIX timestamp
No description
No description
No description
No description
No description
Set additional meta data which allows to filter the search results by additional faceted filters.
No description
No description
Used by Pre-Processing Logic to store / get additional data during indexing
No description
Mark this Index Record for deletion during indexing process
No description
No description
No description
No description
Details
at line 95
__construct(DocumentIndex $documentIndex)
SearchIndexRecord is always based on the respective document_index
at line 296
SearchIndexContentRecord
addLocalizedContent(string $locale, bool $overwriteExistingContentForLocale = true)
Adds an additional language variant of this document
at line 419
$this
addMetaData(string $key, string $value, string $instanceId = null)
Allows to set a single key-value pair in the meta data
at line 168
SearchIndexRecord
appendIndexContent(string $indexContent)
No description
at line 207
int[]|string[]
getAttachments()
No description
at line 310
SearchIndexContentRecord[]
getContentRecords()
Returns an array of localized Content objects containing all available translations for this document
at line 377
int
getCreatedAt()
Returns the initial document creation date as UNIX timestamp
at line 341
DocumentIndex
getDocumentIndex()
No description
at line 362
int
getGroupSecurityId()
No description
at line 159
string
getIndexContent()
Sets the content which shall be additionally be indexed. By default the title and summary are already indexed.
at line 187
string
getLocale()
No description
at line 392
array
getMetaData()
No description
at line 224
array
getNormalizedAttachments()
No description
at line 348
int
getPostId()
No description
at line 355
int
getPostType()
No description
at line 284
getPreProcessingData(string $fieldId)
Used by Pre-Processing Logic to store / get additional data during indexing
at line 239
int
getRelatedPostId()
No description
at line 333
bool
getRemoveFromIndex()
Returns true of this index record has been marked for index removal
at line 140
string
getSummary()
No description
at line 256
array
getTags()
No description
at line 107
string
getTitle()
No description
at line 385
int
getUpdatedAt()
Returns the last document update date as UNIX timestamp
at line 123
string
getUrl()
No description
at line 369
int
getUserId()
No description
at line 216
SearchIndexRecord
setAttachments(int[]|string[] $attachments)
No description
at line 178
SearchIndexRecord
setIndexContent(string $indexContent)
No description
at line 196
SearchIndexRecord
setLocale(string $locale)
No description
at line 404
$this
setMetaData(array $metaData, string $instanceId = null)
Set additional meta data which allows to filter the search results by additional faceted filters.
at line 232
void
setNormalizedAttachment(string $key, string $normalizedAttachment)
No description
at line 228
setNormalizedAttachments(array $normalizedAttachments)
No description
at line 275
setPreProcessingData(string $fieldId, $value)
Used by Pre-Processing Logic to store / get additional data during indexing
at line 248
SearchIndexRecord
setRelatedPostId(int $relatedPostId)
No description
at line 324
SearchIndexRecord
setRemoveFromIndex(bool $removeFromIndex = true)
Mark this Index Record for deletion during indexing process
at line 149
SearchIndexRecord
setSummary(string $summary)
No description
at line 265
SearchIndexRecord
setTags(array $tags)
No description
at line 116
SearchIndexRecord
setTitle(string $title)
No description
at line 132
SearchIndexRecord
setUrl(string $url)
No description