You are here

class SolrMultisiteField in Search API Solr 8.3

Same name and namespace in other branches
  1. 4.x src/Plugin/DataType/SolrMultisiteField.php \Drupal\search_api_solr\Plugin\DataType\SolrMultisiteField

Defines the "Solr multisite field" data type.

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

Plugin annotation


@DataType(
  id = "solr_multisite_field",
  label = @Translation("Solr multisite field"),
  description = @Translation("Fields from a multisite Solr document."),
  definition_class = "\Drupal\search_api_solr\TypedData\SolrMultisiteFieldDefinition"
)

Hierarchy

Expanded class hierarchy of SolrMultisiteField

File

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

Namespace

Drupal\search_api_solr\Plugin\DataType
View source
class SolrMultisiteField extends SolrField {

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

}

Members

Namesort descending 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
SolrField::$value protected property The field value(s).
SolrField::createFromField public static function Creates an instance wrapping the given Field.
SolrField::getIterator public function
SolrMultisiteField::$solrField protected static property Field name. Overrides SolrField::$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::getValue public function Gets the data value. Overrides TypedDataInterface::getValue 10
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::setValue public function Sets the data value. Overrides TypedDataInterface::setValue 10
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