class SolrMultisiteDocument in Search API Solr 8.3

Defines the "Solr document" data type.

Instances of this class wrap Search API Item objects and allow to deal with items based upon the Typed Data API.

Plugin annotation

@DataType(
  id = "solr_multisite_document",
  label = @Translation("Solr multisite document"),
  description = @Translation("Records from a Solr multisite index."),
  definition_class = "\Drupal\search_api_solr\TypedData\SolrDocumentDefinition"
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\search_api_solr\Plugin\DataType\SolrDocument implements \Drupal\search_api_solr\Plugin\DataType\IteratorAggregate, ComplexDataInterface
    • class \Drupal\search_api_solr\Plugin\DataType\SolrMultisiteDocument

File

src/Plugin/DataType/SolrMultisiteDocument.php, line 18

Namespace

Drupal\search_api_solr\Plugin\DataType

class SolrMultisiteDocument extends SolrDocument {

  /**
   * Field name.
   *
   * @var string
   */
  protected $solrField = 'solr_multisite_field';

  /**
   * Document name.
   *
   * @var string
   */
  protected $solrDocument = 'solr_multisite_document';

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
SolrDocument::$item	protected	property	The wrapped Search API Item.
SolrDocument::createFromItem	public static	function	Creates an instance wrapping the given Item.
SolrDocument::get	public	function	Overrides ComplexDataInterface::get
SolrDocument::getIterator	public	function
SolrDocument::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
SolrDocument::getValue	public	function	Gets the data value. Overrides TypedData::getValue
SolrDocument::isEmpty	public	function	Determines whether the data structure is empty. Overrides ComplexDataInterface::isEmpty
SolrDocument::onChange	public	function	React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange
SolrDocument::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
SolrDocument::setValue	public	function	Sets the data value. Overrides TypedData::setValue
SolrDocument::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray
SolrMultisiteDocument::$solrDocument	protected	property	Document name. Overrides SolrDocument::$solrDocument
SolrMultisiteDocument::$solrField	protected	property	Field name. Overrides SolrDocument::$solrField
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	3
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString	public	function	Returns a string representation of the data. Overrides TypedDataInterface::getString	6
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct	public	function	Constructs a TypedData object given its definition and context.	3
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2