SilverStripe\SearchService\DataObject\DataObjectDocument
Synopsis
class DataObjectDocument
implements
DocumentInterface,DependencyTracker,Serializable,DocumentRemoveHandler,DocumentAddHandler,DocumentMetaProvider
{
- // members
- private static string $record_id_field = 'record_id';
- private static string $base_class_field = 'record_base_class';
- private static string $page_content_field = 'page_content';
- private DataObject&SearchServiceExtension $dataObject;
- private PageCrawler $pageCrawler;
- private bool $shouldFallbackToLatestVersion = false;
- private static array $dependencies = ;
- // methods
- public void __construct()
- public string getIdentifier()
- public string getSourceClass()
- public $this setShouldFallbackToLatestVersion()
- public bool shouldIndex()
- public void markIndexed()
- public array getIndexes()
- public array toArray()
- public array provideMeta()
- public array getIndexedFields()
- public ViewableData|null getFieldDependency()
- public mixed|null getFieldValue()
- public array getDependentDocuments()
- public DataObject&SearchServiceExtension getDataObject()
- public DataObjectDocument setDataObject()
- public $this setPageCrawler()
- public PageCrawler|null getPageCrawler()
- private array parsePath()
- private ViewableData|null resolveField()
- private array getFieldTuple()
- public void serialize()
- public void unserialize()
- public void onAddToSearchIndexes()
- public void onRemoveFromSearchIndexes()
- // Inherited methods from ConfigurationAware
- public $this setConfiguration()
- public IndexConfiguration getConfiguration()
- // Inherited methods from ServiceAware
- public IndexingInterface getIndexService()
- public $this setIndexService()
- public bool hasIndexService()
Hierarchy
Uses
- SilverStripe\Core\Injector\Injectable
- SilverStripe\Core\Extensible
- SilverStripe\Core\Config\Configurable
- SilverStripe\SearchService\Service\Traits\ConfigurationAware
- SilverStripe\SearchService\Service\Traits\ServiceAware
Implements
- SilverStripe\SearchService\Interfaces\DocumentInterface
- SilverStripe\SearchService\Interfaces\DependencyTracker
- Serializable
- SilverStripe\SearchService\Interfaces\DocumentRemoveHandler
- SilverStripe\SearchService\Interfaces\DocumentAddHandler
- SilverStripe\SearchService\Interfaces\DocumentMetaProvider
Constants
Name | Value |
---|---|
BEFORE_REMOVE | 'before' |
AFTER_REMOVE | 'after' |
BEFORE_ADD | 'before' |
AFTER_ADD | 'after' |
Members
private
- $base_class_field — string
- $dataObject — SilverStripe\SearchService\DataObject\DataObject&SearchServiceExtension
- $dependencies — array
- $pageCrawler — SilverStripe\SearchService\Service\PageCrawler
- $page_content_field — string
- $record_id_field — string
- $shouldFallbackToLatestVersion — SilverStripe\SearchService\DataObject\bool
Methods
private
public
- __construct() — DataObjectDocument constructor.
- getDataObject()
- getDependentDocuments()
- getFieldDependency()
- getFieldValue()
- getIdentifier()
- getIndexedFields()
- getIndexes()
- getPageCrawler()
- getSourceClass()
- markIndexed()
- onAddToSearchIndexes()
- onRemoveFromSearchIndexes()
- provideMeta()
- serialize()
- setDataObject()
- setPageCrawler()
- setShouldFallbackToLatestVersion()
- shouldIndex()
- toArray() — Generates a map of all the fields and values which will be sent.
- unserialize()