You are here

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

class SolrRequestHandler in Search API Solr 8.3

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

Defines the SolrRequestHandler entity.

Plugin annotation


@ConfigEntityType(
  id = "solr_request_handler",
  label = @Translation("Solr Request Handler"),
  handlers = {
    "list_builder" = "Drupal\search_api_solr\Controller\SolrRequestHandlerListBuilder",
    "form" = {
    }
  },
  config_prefix = "solr_request_handler",
  admin_permission = "administer search_api",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "disabled" = "disabled_request_handlers"
  },
  config_export = {
    "id",
    "label",
    "minimum_solr_version",
    "environments",
    "recommended",
    "request_handler",
    "solr_configs"
  },
  links = {
    "disable-for-server" = "/admin/config/search/search-api/server/{search_api_server}/solr_request_handler/{solr_request_handler}/disable",
    "enable-for-server" = "/admin/config/search/search-api/server/{search_api_server}/solr_request_handler/{solr_request_handler}/enable",
    "collection" = "/admin/config/search/search-api/server/{search_api_server}/solr_request_handler"
  }
)

Hierarchy

Expanded class hierarchy of SolrRequestHandler

1 file declares its use of SolrRequestHandler
Utility.php in src/Utility/Utility.php

File

src/Entity/SolrRequestHandler.php, line 42

Namespace

Drupal\search_api_solr\Entity
View source 
class SolrRequestHandler extends AbstractSolrEntity implements SolrRequestHandlerInterface {

  /**
   * Solr custom request_handler definition.
   *
   * @var array
   */
  protected $request_handler;

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

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

  /**
   * {@inheritdoc}
   */
  public function getName() : string {
    $nested_name = $this->request_handler['lst'][0]['name'] ?? 'default';
    return $this->request_handler['name'] . '_' . $nested_name;
  }

  /**
   *
   */
  public function getPurposeId() : string {
    return $this->request_handler['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getEnvironments() {
    return empty($this->environments) ? [
      'default',
    ] : $this->environments;
  }

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

  /**
   * Get all available environments.
   *
   * @return string[]
   *   An array of environments as strings.
   */
  public static function getAvailableEnvironments() {
    return parent::getAvailableOptions('environments', 'default', 'search_api_solr.solr_request_handler.');
  }

  /**
   * {@inheritdoc}
   */
  public function getAsXml(bool $add_comment = TRUE) : string {
    $comment = '';
    if ($add_comment) {
      $comment = "<!--\n  " . $this
        ->label() . "\n  " . $this
        ->getMinimumSolrVersion() . "\n-->\n";
    }
    $formatted_xml_string = $this
      ->buildXmlFromArray('requestHandler', $this->request_handler);
    return $comment . $formatted_xml_string . "\n";
  }

}

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::getSolrConfigs public function Gets the Solr Field Type specific additions to solrconfig.xml as array. Overrides SolrConfigInterface::getSolrConfigs 1
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
SolrRequestHandler::$environments protected property The targeted environments.
SolrRequestHandler::$request_handler protected property Solr custom request_handler definition.
SolrRequestHandler::getAsXml public function Gets the Solr Entity definition as XML fragment. Overrides SolrConfigInterface::getAsXml
SolrRequestHandler::getAvailableEnvironments public static function Get all available environments.
SolrRequestHandler::getEnvironments public function Gets the environments targeted by this Solr RequestHandler. Overrides SolrRequestHandlerInterface::getEnvironments
SolrRequestHandler::getName public function Gets the Solr Entity name. Overrides AbstractSolrEntity::getName
SolrRequestHandler::getOptions public function Overrides AbstractSolrEntity::getOptions
SolrRequestHandler::getPurposeId public function Gets the identifier that describes Solr Entity's purpose. Overrides AbstractSolrEntity::getPurposeId
SolrRequestHandler::getRequestHandler public function Gets the Solr RequestHandler definition as nested associative array. Overrides SolrRequestHandlerInterface::getRequestHandler
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