You are here

Home » API reference » Search API Solr 8.3 » SolrFieldType.php

class SolrFieldType in Search API Solr 8.3

Same name and namespace in other branches
  1. 8.2 src/Entity/SolrFieldType.php \Drupal\search_api_solr\Entity\SolrFieldType
  2. 4.x src/Entity/SolrFieldType.php \Drupal\search_api_solr\Entity\SolrFieldType

Defines the SolrFieldType entity.

Plugin annotation


@ConfigEntityType(
  id = "solr_field_type",
  label = @Translation("Solr Field Type"),
  handlers = {
    "list_builder" = "Drupal\search_api_solr\Controller\SolrFieldTypeListBuilder",
    "form" = {
      "add" = "Drupal\search_api_solr\Form\SolrFieldTypeForm",
      "edit" = "Drupal\search_api_solr\Form\SolrFieldTypeForm",
      "delete" = "Drupal\search_api_solr\Form\SolrFieldTypeDeleteForm"
    }
  },
  config_prefix = "solr_field_type",
  admin_permission = "administer search_api",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "disabled" = "disabled_field_types"
  },
  config_export = {
    "id",
    "label",
    "minimum_solr_version",
    "custom_code",
    "field_type_language_code",
    "domains",
    "field_type",
    "unstemmed_field_type",
    "spellcheck_field_type",
    "collated_field_type",
    "solr_configs",
    "text_files"
  },
  links = {
    "edit-form" = "/admin/config/search/search-api/solr_field_type/{solr_field_type}",
    "delete-form" = "/admin/config/search/search-api/solr_field_type/{solr_field_type}/delete",
    "disable-for-server" = "/admin/config/search/search-api/server/{search_api_server}/solr_field_type/{solr_field_type}/disable",
    "enable-for-server" = "/admin/config/search/search-api/server/{search_api_server}/solr_field_type/{solr_field_type}/enable",
    "collection" = "/admin/config/search/search-api/server/{search_api_server}/solr_field_type"
  }
)

Hierarchy

Expanded class hierarchy of SolrFieldType

3 files declare their use of SolrFieldType
CustomTextDataType.php in src/Plugin/Derivative/CustomTextDataType.php
OmitNormsCustomTextDataType.php in src/Plugin/Derivative/OmitNormsCustomTextDataType.php
SearchApiSolrBackend.php in src/Plugin/search_api/backend/SearchApiSolrBackend.php

File

src/Entity/SolrFieldType.php, line 56

Namespace

Drupal\search_api_solr\Entity
View source 
class SolrFieldType extends AbstractSolrEntity implements SolrFieldTypeInterface {

  /**
   * Solr Field Type definition.
   *
   * @var array
   */
  protected $field_type;

  /**
   * Solr Spellcheck Field Type definition.
   *
   * @var array
   */
  protected $spellcheck_field_type;

  /**
   * Solr Collated Field Type definition.
   *
   * @var array
   */
  protected $collated_field_type;

  /**
   * Solr Unstemmed Field Type definition.
   *
   * @var array
   */
  protected $unstemmed_field_type;

  /**
   * The custom code targeted by this Solr Field Type.
   *
   * @var string
   */
  protected $custom_code;

  /**
   * The language targeted by this Solr Field Type.
   *
   * @var string
   */
  protected $field_type_language_code;

  /**
   * The targeted content domains.
   *
   * @var string[]
   */
  protected $domains;

  /**
   * {@inheritdoc}
   */
  public function getFieldType() {
    return $this->field_type;
  }

  /**
   * {@inheritdoc}
   */
  public function setFieldType(array $field_type) {
    $this->field_type = $field_type;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() : string {
    return $this->field_type['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getSpellcheckFieldType() {
    return $this->spellcheck_field_type;
  }

  /**
   * {@inheritdoc}
   */
  public function setSpellcheckFieldType(array $spellcheck_field_type) {
    $this->spellcheck_field_type = $spellcheck_field_type;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCollatedFieldType() {
    return $this->collated_field_type;
  }

  /**
   * {@inheritdoc}
   */
  public function setCollatedFieldType(array $collated_field_type) {
    $this->collated_field_type = $collated_field_type;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getUnstemmedFieldType() {
    return $this->unstemmed_field_type;
  }

  /**
   * {@inheritdoc}
   */
  public function setUnstemmedFieldType(array $unstemmed_field_type) {
    $this->unstemmed_field_type = $unstemmed_field_type;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCustomCode() {
    return $this->custom_code;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypeLanguageCode() {
    return $this->field_type_language_code;
  }

  /**
   * {@inheritdoc}
   */
  public function getDomains() {
    return empty($this->domains) ? [
      'generic',
    ] : $this->domains;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this
      ->getDomains();
  }

  /**
   * Get all available domains form solr filed type configs.
   *
   * @return string[]
   *   An array of domains as strings.
   */
  public static function getAvailableDomains() {
    return parent::getAvailableOptions('domains', 'generic', 'search_api_solr.solr_field_type.');
  }

  /**
   * Get all available custom codes.
   *
   * @return string[]
   *   An array of custom codes as strings.
   */
  public static function getAvailableCustomCodes() {
    $custom_codes = [];
    $config_factory = \Drupal::configFactory();
    foreach ($config_factory
      ->listAll('search_api_solr.solr_field_type.') as $field_type_name) {
      $config = $config_factory
        ->get($field_type_name);
      if ($custom_code = $config
        ->get('custom_code')) {
        $custom_codes[] = $custom_code;
      }
    }
    return array_unique($custom_codes);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypeAsJson(bool $pretty = FALSE) {

    // Unfortunately the JSON encoded field type definition still uses the
    // element names "indexAnalyzer", "queryAnalyzer" and "multiTermAnalyzer"
    // which are deprecated in the XML format. Therefor we need to add some
    // conversion logic.
    $field_type = $this->field_type;
    unset($field_type['analyzers']);
    foreach ($this->field_type['analyzers'] as $analyzer) {
      $type = 'analyzer';
      if (!empty($analyzer['type'])) {
        if ('multiterm' === $analyzer['type']) {
          $type = 'multiTermAnalyzer';
        }
        else {
          $type = $analyzer['type'] . 'Analyzer';
        }
        unset($analyzer['type']);
      }
      $field_type[$type] = $analyzer;
    }

    /** @noinspection PhpComposerExtensionStubsInspection */
    return $pretty ? json_encode($field_type, JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT) : Json::encode($field_type);
  }

  /**
   * {@inheritdoc}
   */
  public function setFieldTypeAsJson($field_type) {
    $field_type = $this->field_type = Json::decode($field_type);

    // Unfortunately the JSON encoded field type definition still uses the
    // element names "indexAnalyzer", "queryAnalyzer" and "multiTermAnalyzer"
    // which are deprecated in the XML format. Therefore we need to add some
    // conversion logic.
    $analyzers = [
      'index' => 'indexAnalyzer',
      'query' => 'queryAnalyzer',
      'multiterm' => 'multiTermAnalyzer',
      'analyzer' => 'analyzer',
    ];
    foreach ($analyzers as $type => $analyzer) {
      if (!empty($field_type[$analyzer])) {
        unset($this->field_type[$analyzer]);
        if ($type != $analyzer) {
          $field_type[$analyzer]['type'] = $type;
        }
        $this->field_type['analyzers'][] = $field_type[$analyzer];
      }
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSpellcheckFieldTypeAsJson(bool $pretty = FALSE) {
    if ($this->spellcheck_field_type) {

      /** @noinspection PhpComposerExtensionStubsInspection */
      return $pretty ? json_encode($this->spellcheck_field_type, JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT) : Json::encode($this->spellcheck_field_type);
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function setSpellcheckFieldTypeAsJson($spellcheck_field_type) {
    $this->spellcheck_field_type = Json::decode($spellcheck_field_type);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCollatedFieldTypeAsJson(bool $pretty = FALSE) {
    if ($this->collated_field_type) {

      /** @noinspection PhpComposerExtensionStubsInspection */
      return $pretty ? json_encode($this->collated_field_type, JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT) : Json::encode($this->collated_field_type);
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function setCollatedFieldTypeAsJson($collated_field_type) {
    $this->collated_field_type = Json::decode($collated_field_type);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getUnstemmedFieldTypeAsJson(bool $pretty = FALSE) {
    if ($this->unstemmed_field_type) {

      /** @noinspection PhpComposerExtensionStubsInspection */
      return $pretty ? json_encode($this->unstemmed_field_type, JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT) : Json::encode($this->unstemmed_field_type);
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function setUnstemmedFieldTypeAsJson($unstemmed_field_type) {
    $this->unstemmed_field_type = Json::decode($unstemmed_field_type);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAsXml(bool $add_comment = TRUE) : string {
    return $this
      ->getSubFieldTypeAsXml($this->field_type);
  }

  /**
   * {@inheritdoc}
   */
  public function getSpellcheckFieldTypeAsXml($add_comment = TRUE) {
    return $this->spellcheck_field_type ? $this
      ->getSubFieldTypeAsXml($this->spellcheck_field_type, ' spellcheck') : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getCollatedFieldTypeAsXml($add_comment = TRUE) {
    return $this->collated_field_type ? $this
      ->getSubFieldTypeAsXml($this->collated_field_type, ' collated') : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getUnstemmedFieldTypeAsXml($add_comment = TRUE) {
    return $this->unstemmed_field_type ? $this
      ->getSubFieldTypeAsXml($this->unstemmed_field_type, ' unstemmed') : '';
  }

  /**
   * Serializes a filed type as XML fragment as required by Solr.
   *
   * @param array $field_type
   * @param string $additional_label
   * @param bool $add_comment
   *
   * @return string
   */
  protected function getSubFieldTypeAsXml(array $field_type, string $additional_label = '', bool $add_comment = TRUE) {
    $formatted_xml_string = $this
      ->buildXmlFromArray('fieldType', $field_type);
    $comment = '';
    if ($add_comment) {
      $comment = "<!--\n  " . $this
        ->label() . $additional_label . "\n  " . $this
        ->getMinimumSolrVersion() . "\n-->\n";
    }
    return $comment . $formatted_xml_string;
  }

  /**
   * {@inheritdoc}
   */
  public function getSolrConfigs() {
    return $this->solr_configs;
  }

  /**
   * {@inheritdoc}
   */
  public function getDynamicFields(?int $solr_major_version = NULL) {
    $dynamic_fields = [];
    $prefixes = $this->custom_code ? [
      'tc' . $this->custom_code,
      'toc' . $this->custom_code,
      'tuc' . $this->custom_code,
    ] : [
      't',
      'to',
      'tu',
    ];
    foreach ($prefixes as $prefix_without_cardinality) {
      foreach ([
        's',
        'm',
      ] as $cardinality) {
        $prefix = $prefix_without_cardinality . $cardinality;
        $name = $prefix . SolrBackendInterface::SEARCH_API_SOLR_LANGUAGE_SEPARATOR . $this->field_type_language_code . '_';
        $dynamic_fields[] = $dynamic_field = [
          'name' => SearchApiSolrUtility::encodeSolrName($name) . '*',
          'type' => strpos($prefix, 'tu') === 0 && !empty($this->unstemmed_field_type) ? $this->unstemmed_field_type['name'] : $this->field_type['name'],
          'stored' => TRUE,
          'indexed' => TRUE,
          'multiValued' => 'm' === $cardinality,
          'termVectors' => TRUE,
          'omitNorms' => strpos($prefix, 'to') === 0,
        ];
        if (LanguageInterface::LANGCODE_NOT_SPECIFIED === $this->field_type_language_code) {

          // Add a language-unspecific default dynamic field as fallback for
          // languages we don't have a dedicated config for.
          $dynamic_field['name'] = SearchApiSolrUtility::encodeSolrName($prefix) . '_*';
          $dynamic_fields[] = $dynamic_field;
        }
      }
    }
    if ($spellcheck_field = $this
      ->getSpellcheckField()) {

      // Spellcheck fields need to be dynamic to have a language fallback, for
      // example de-at => de.
      $dynamic_fields[] = $spellcheck_field;
      if (LanguageInterface::LANGCODE_NOT_SPECIFIED === $this->field_type_language_code) {

        // Add a language-unspecific default dynamic spellcheck field as
        // fallback for languages we don't have a dedicated config for.
        $spellcheck_field['name'] = 'spellcheck_*';
        $dynamic_fields[] = $spellcheck_field;
      }
    }
    if ($collated_field = $this
      ->getCollatedField($solr_major_version)) {
      $dynamic_fields[] = $collated_field;
      if (LanguageInterface::LANGCODE_NOT_SPECIFIED === $this->field_type_language_code) {

        // Add a language-unspecific default dynamic sort field as fallback for
        // languages we don't have a dedicated config for.
        $collated_field['name'] = 'sort_*';
        $dynamic_fields[] = $collated_field;
      }
    }
    return $dynamic_fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getStaticFields() {
    return [];
  }

  /**
   * Returns the spellcheck field definition.
   *
   * @return array|null
   *   The array containing the spellcheck field definition or null if is
   *   not configured for this field type.
   */
  protected function getSpellcheckField() {
    $spellcheck_field = NULL;
    if ($this->spellcheck_field_type) {
      $spellcheck_field = [
        // Don't use the language separator here! This field name is used
        // without it in the solrconfig.xml. Due to the fact that we leverage a
        // dynamic field here to enable the language fallback we need to append
        // '*', but not '_*' because we'll never append a field name!
        'name' => 'spellcheck_' . $this->field_type_language_code . '*',
        'type' => $this->spellcheck_field_type['name'],
        'stored' => TRUE,
        'indexed' => TRUE,
        'multiValued' => TRUE,
        'termVectors' => TRUE,
        'omitNorms' => TRUE,
      ];
    }
    return $spellcheck_field;
  }

  /**
   * Returns the collated field definition.
   *
   * @param int|null $solr_major_version
   *
   * @return array|null
   *   The array containing the collated field definition or null if is
   *   not configured for this field type.
   */
  protected function getCollatedField(?int $solr_major_version = NULL) {
    $collated_field = NULL;
    if ($this->collated_field_type) {
      $collated_field = [
        'name' => SearchApiSolrUtility::encodeSolrName('sort' . SolrBackendInterface::SEARCH_API_SOLR_LANGUAGE_SEPARATOR . $this->field_type_language_code) . '_*',
        'type' => $this->collated_field_type['name'],
        'stored' => FALSE,
        'indexed' => $solr_major_version === 4,
      ];
      if ($solr_major_version !== 4) {
        $collated_field['docValues'] = TRUE;
      }
    }
    return $collated_field;
  }

  /**
   * {@inheritdoc}
   */
  public function getCopyFields() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypeName() {
    return isset($this->field_type['name']) ? $this->field_type['name'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function requiresManagedSchema() {
    if (isset($this->field_type['analyzers'])) {
      foreach ($this->field_type['analyzers'] as $analyzer) {
        if (isset($analyzer['filters'])) {
          foreach ($analyzer['filters'] as $filter) {
            if (strpos($filter['class'], 'solr.Managed') === 0) {
              return TRUE;
            }
          }
        }
      }
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbstractSolrEntity::$id protected property The ID.
AbstractSolrEntity::$label protected property The label.
AbstractSolrEntity::$minimum_solr_version protected property Minimum Solr version required by this config.
AbstractSolrEntity::$recommended protected property
AbstractSolrEntity::$solr_configs protected property Solr Field Type specific additions to solrconfig.xml.
AbstractSolrEntity::$text_files protected property Array of various text files required by the Solr Field Type definition.
AbstractSolrEntity::addTextFile public function
AbstractSolrEntity::buildXmlFromArray protected function Formats a given array to an XML string.
AbstractSolrEntity::buildXmlFromArrayRecursive protected static function Builds a SimpleXMLElement recursively from an array of attributes.
AbstractSolrEntity::getAvailableOptions protected static function Get all available options.
AbstractSolrEntity::getMinimumSolrVersion public function Gets the minimum Solr version that is supported by this Solr Field Type. Overrides SolrConfigInterface::getMinimumSolrVersion
AbstractSolrEntity::getPurposeId public function Gets the identifier that describes Solr Entity's purpose. Overrides SolrConfigInterface::getPurposeId 2
AbstractSolrEntity::getSolrConfigsAsXml public function Gets the Solr Field Type specific additions to solrconfig.xml as XML. Overrides SolrConfigInterface::getSolrConfigsAsXml
AbstractSolrEntity::getTextFiles public function
AbstractSolrEntity::isRecommended public function Indicates if a Config Entity is recommended to be used. Overrides SolrConfigInterface::isRecommended
AbstractSolrEntity::setMinimumSolrVersion public function Sets the minimum Solr version that is supported by this Solr Field Type. Overrides SolrConfigInterface::setMinimumSolrVersion
AbstractSolrEntity::setSolrConfigs public function Sets the Solr Field Type specific additions to solrconfig.xml as array. Overrides SolrConfigInterface::setSolrConfigs
AbstractSolrEntity::setTextFiles public function
AbstractSolrEntity::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SolrFieldType::$collated_field_type protected property Solr Collated Field Type definition.
SolrFieldType::$custom_code protected property The custom code targeted by this Solr Field Type.
SolrFieldType::$domains protected property The targeted content domains.
SolrFieldType::$field_type protected property Solr Field Type definition.
SolrFieldType::$field_type_language_code protected property The language targeted by this Solr Field Type.
SolrFieldType::$spellcheck_field_type protected property Solr Spellcheck Field Type definition.
SolrFieldType::$unstemmed_field_type protected property Solr Unstemmed Field Type definition.
SolrFieldType::getAsXml public function Gets the Solr Entity definition as XML fragment. Overrides SolrConfigInterface::getAsXml
SolrFieldType::getAvailableCustomCodes public static function Get all available custom codes.
SolrFieldType::getAvailableDomains public static function Get all available domains form solr filed type configs.
SolrFieldType::getCollatedField protected function Returns the collated field definition.
SolrFieldType::getCollatedFieldType public function Gets the Solr Collated Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::getCollatedFieldType
SolrFieldType::getCollatedFieldTypeAsJson public function Gets the Solr Collated Field Type definition as JSON. Overrides SolrFieldTypeInterface::getCollatedFieldTypeAsJson
SolrFieldType::getCollatedFieldTypeAsXml public function Gets the Solr Collated Field Type definition as XML fragment. Overrides SolrFieldTypeInterface::getCollatedFieldTypeAsXml
SolrFieldType::getCopyFields public function Gets a list of copy fields. Overrides SolrFieldTypeInterface::getCopyFields
SolrFieldType::getCustomCode public function Gets the custom code targeted by this Solr Field Type. Overrides SolrFieldTypeInterface::getCustomCode
SolrFieldType::getDomains public function Gets the domains the field type is suitable for. Overrides SolrFieldTypeInterface::getDomains
SolrFieldType::getDynamicFields public function Gets a list of dynamic Solr fields that will use this Solr Field Type. Overrides SolrFieldTypeInterface::getDynamicFields
SolrFieldType::getFieldType public function Gets the Solr Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::getFieldType
SolrFieldType::getFieldTypeAsJson public function Gets the Solr Field Type definition as JSON. Overrides SolrFieldTypeInterface::getFieldTypeAsJson
SolrFieldType::getFieldTypeLanguageCode public function Gets the language targeted by this Solr Field Type. Overrides SolrFieldTypeInterface::getFieldTypeLanguageCode
SolrFieldType::getFieldTypeName public function Gets the Solr Field Type name. Overrides SolrFieldTypeInterface::getFieldTypeName
SolrFieldType::getName public function Gets the Solr Entity name. Overrides AbstractSolrEntity::getName
SolrFieldType::getOptions public function Overrides AbstractSolrEntity::getOptions
SolrFieldType::getSolrConfigs public function Gets the Solr Field Type specific additions to solrconfig.xml as array. Overrides AbstractSolrEntity::getSolrConfigs
SolrFieldType::getSpellcheckField protected function Returns the spellcheck field definition.
SolrFieldType::getSpellcheckFieldType public function Gets the Solr Spellcheck Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::getSpellcheckFieldType
SolrFieldType::getSpellcheckFieldTypeAsJson public function Gets the Solr Spellcheck Field Type definition as JSON. Overrides SolrFieldTypeInterface::getSpellcheckFieldTypeAsJson
SolrFieldType::getSpellcheckFieldTypeAsXml public function Gets the Solr Spellcheck Spellcheck Field Type definition as XML fragment. Overrides SolrFieldTypeInterface::getSpellcheckFieldTypeAsXml
SolrFieldType::getStaticFields public function Gets a list of static fields that will use this Solr Field Type. Overrides SolrFieldTypeInterface::getStaticFields
SolrFieldType::getSubFieldTypeAsXml protected function Serializes a filed type as XML fragment as required by Solr.
SolrFieldType::getUnstemmedFieldType public function Gets the Solr Unstemmed Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::getUnstemmedFieldType
SolrFieldType::getUnstemmedFieldTypeAsJson public function Gets the Solr Unstemmed Field Type definition as JSON. Overrides SolrFieldTypeInterface::getUnstemmedFieldTypeAsJson
SolrFieldType::getUnstemmedFieldTypeAsXml public function Gets the Solr Unstemmed Field Type definition as XML fragment. Overrides SolrFieldTypeInterface::getUnstemmedFieldTypeAsXml
SolrFieldType::requiresManagedSchema public function Indicates if the field type requires a managed Solr schema. Overrides SolrFieldTypeInterface::requiresManagedSchema
SolrFieldType::setCollatedFieldType public function Sets the Solr Collated Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::setCollatedFieldType
SolrFieldType::setCollatedFieldTypeAsJson public function Sets the Solr Collated Field Type definition as JSON. Overrides SolrFieldTypeInterface::setCollatedFieldTypeAsJson
SolrFieldType::setFieldType public function Sets the Solr Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::setFieldType
SolrFieldType::setFieldTypeAsJson public function Sets the Solr Field Type definition as JSON. Overrides SolrFieldTypeInterface::setFieldTypeAsJson
SolrFieldType::setSpellcheckFieldType public function Sets the Solr Spellcheck Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::setSpellcheckFieldType
SolrFieldType::setSpellcheckFieldTypeAsJson public function Sets the Solr Spellcheck Field Type definition as JSON. Overrides SolrFieldTypeInterface::setSpellcheckFieldTypeAsJson
SolrFieldType::setUnstemmedFieldType public function Sets the Solr Unstemmed Field Type definition as nested associative array. Overrides SolrFieldTypeInterface::setUnstemmedFieldType
SolrFieldType::setUnstemmedFieldTypeAsJson public function Sets the Solr Unstemmed Field Type definition as JSON. Overrides SolrFieldTypeInterface::setUnstemmedFieldTypeAsJson
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function