SilverStripe\SearchService\Services\AppSearch\AppSearchService
Synopsis
class AppSearchService
implements
IndexingInterface,BatchDocumentRemovalInterface
{
- // constants
- const DEFAULT_FIELD_TYPE = 'text';
- // members
- private Client $client;
- private DocumentBuilder $builder;
- private static integer $max_document_size = 102400;
- // methods
- public void __construct()
- public IndexingInterface addDocument()
- public BatchDocumentInterface addDocuments()
- public IndexingInterface removeDocument()
- public BatchDocumentInterface removeDocuments()
- public int removeAllDocuments()
- public int getMaxDocumentSize()
- public DocumentInterface|null getDocument()
- public array getDocuments()
- public array listDocuments()
- public int getDocumentTotal()
- public void configure()
- public void validateField()
- public Client getClient()
- public AppSearchService setClient()
- public DocumentBuilder getBuilder()
- public AppSearchService setBuilder()
- private void findOrMakeIndex()
- private void handleError()
- private array getSchemaForFields()
- private void validateIndex()
- public static string environmentizeIndex()
- public void getExternalURL()
- public void getExternalURLDescription()
- public void getDocumentationURL()
- // Inherited methods from ConfigurationAware
- public $this setConfiguration()
- public IndexConfiguration getConfiguration()
Hierarchy
Uses
- SilverStripe\Core\Config\Configurable
- SilverStripe\SearchService\Service\Traits\ConfigurationAware
- SilverStripe\Core\Injector\Injectable
Implements
Constants
Name | Value |
---|---|
DEFAULT_FIELD_TYPE | 'text' |
Members
private
- $builder — SilverStripe\SearchService\Service\DocumentBuilder
- $client — Elastic\AppSearch\Client\Client
- $max_document_size — int
Methods
private
public
- __construct() — AppSearchService constructor.
- addDocument()
- addDocuments()
- configure() — Ensure all the engines exist
- environmentizeIndex()
- getBuilder()
- getClient()
- getDocument()
- getDocumentTotal()
- getDocumentationURL()
- getDocuments()
- getExternalURL()
- getExternalURLDescription()
- getMaxDocumentSize()
- listDocuments()
- removeAllDocuments() — Forcefully remove all documents from the provided index name. Batches the requests to Elastic based upon the configured batch size, beginning at page 1 and continuing until the index is empty.
- removeDocument()
- removeDocuments()
- setBuilder()
- setClient()
- validateField()