class SearchPage in Drupal 10

Same name and namespace in other branches

8 core/modules/search/src/Entity/SearchPage.php \Drupal\search\Entity\SearchPage
9 core/modules/search/src/Entity/SearchPage.php \Drupal\search\Entity\SearchPage

Defines a configured search page.

Plugin annotation


@ConfigEntityType(
  id = "search_page",
  label = @Translation("Search page"),
  label_collection = @Translation("Search pages"),
  label_singular = @Translation("search page"),
  label_plural = @Translation("search pages"),
  label_count = @PluralTranslation(
    singular = "@count search page",
    plural = "@count search pages",
  ),
  handlers = {
    "access" = "Drupal\search\SearchPageAccessControlHandler",
    "list_builder" = "Drupal\search\SearchPageListBuilder",
    "form" = {
      "add" = "Drupal\search\Form\SearchPageAddForm",
      "edit" = "Drupal\search\Form\SearchPageEditForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    }
  },
  admin_permission = "administer search",
  links = {
    "edit-form" = "/admin/config/search/pages/manage/{search_page}",
    "delete-form" = "/admin/config/search/pages/manage/{search_page}/delete",
    "enable" = "/admin/config/search/pages/manage/{search_page}/enable",
    "disable" = "/admin/config/search/pages/manage/{search_page}/disable",
    "set-default" = "/admin/config/search/pages/manage/{search_page}/set-default",
    "collection" = "/admin/config/search/pages",
  },
  config_prefix = "page",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "weight" = "weight",
    "status" = "status"
  },
  config_export = {
    "id",
    "label",
    "path",
    "weight",
    "plugin",
    "configuration",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\search\Entity\SearchPage implements EntityWithPluginCollectionInterface, SearchPageInterface

Expanded class hierarchy of SearchPage

6 files declare their use of SearchPage

ConfigEntityImportTest.php in core/modules/system/tests/src/Kernel/Entity/ConfigEntityImportTest.php
SearchConfigSettingsFormTest.php in core/modules/search/tests/src/Functional/SearchConfigSettingsFormTest.php
SearchPageRepositoryTest.php in core/modules/search/tests/src/Unit/SearchPageRepositoryTest.php: Contains \Drupal\Tests\search\Unit\SearchPageRepositoryTest.
SearchPageResourceTestBase.php in core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php
SearchPageTest.php in core/modules/jsonapi/tests/src/Functional/SearchPageTest.php

... See full list

File

core/modules/search/src/Entity/SearchPage.php, line 61

Namespace

Drupal\search\Entity

View source

class SearchPage extends ConfigEntityBase implements SearchPageInterface, EntityWithPluginCollectionInterface {

  /**
   * The name (plugin ID) of the search page entity.
   *
   * @var string
   */
  protected $id;

  /**
   * The label of the search page entity.
   *
   * @var string
   */
  protected $label;

  /**
   * The configuration of the search page entity.
   *
   * @var array
   */
  protected $configuration = [];

  /**
   * The search plugin ID.
   *
   * @var string
   */
  protected $plugin;

  /**
   * The path this search page will appear upon.
   *
   * This value is appended to 'search/' when building the path.
   *
   * @var string
   */
  protected $path;

  /**
   * The weight of the search page.
   *
   * @var int
   */
  protected $weight;

  /**
   * The plugin collection that stores search plugins.
   *
   * @var \Drupal\search\Plugin\SearchPluginCollection
   */
  protected $pluginCollection;

  /**
   * {@inheritdoc}
   */
  public function getPlugin() {
    return $this
      ->getPluginCollection()
      ->get($this->plugin);
  }

  /**
   * Encapsulates the creation of the search page's LazyPluginCollection.
   *
   * @return \Drupal\Component\Plugin\LazyPluginCollection
   *   The search page's plugin collection.
   */
  protected function getPluginCollection() {
    if (!$this->pluginCollection) {
      $this->pluginCollection = new SearchPluginCollection($this
        ->searchPluginManager(), $this->plugin, $this->configuration, $this
        ->id());
    }
    return $this->pluginCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'configuration' => $this
        ->getPluginCollection(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function setPlugin($plugin_id) {
    $this->plugin = $plugin_id;
    $this
      ->getPluginCollection()
      ->addInstanceID($plugin_id);
  }

  /**
   * {@inheritdoc}
   */
  public function isIndexable() {
    return $this
      ->status() && $this
      ->getPlugin() instanceof SearchIndexingInterface;
  }

  /**
   * {@inheritdoc}
   */
  public function isDefaultSearch() {
    return $this
      ->searchPageRepository()
      ->getDefaultSearchPage() == $this
      ->id();
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function postCreate(EntityStorageInterface $storage) {
    parent::postCreate($storage);

    // @todo Use self::applyDefaultValue() once
    //   https://www.drupal.org/node/2004756 is in.
    if (!isset($this->weight)) {
      $this->weight = $this
        ->isDefaultSearch() ? -10 : 0;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    $this
      ->routeBuilder()
      ->setRebuildNeeded();
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);
    $search_page_repository = \Drupal::service('search.search_page_repository');
    if (!$search_page_repository
      ->isSearchActive()) {
      $search_page_repository
        ->clearDefaultSearchPage();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {

    /** @var \Drupal\search\SearchPageInterface $a */

    /** @var \Drupal\search\SearchPageInterface $b */
    $a_status = (int) $a
      ->status();
    $b_status = (int) $b
      ->status();
    if ($a_status != $b_status) {
      return $b_status <=> $a_status;
    }
    return parent::sort($a, $b);
  }

  /**
   * Wraps the route builder.
   *
   * @return \Drupal\Core\Routing\RouteBuilderInterface
   *   An object for state storage.
   */
  protected function routeBuilder() {
    return \Drupal::service('router.builder');
  }

  /**
   * Wraps the config factory.
   *
   * @return \Drupal\Core\Config\ConfigFactoryInterface
   *   A config factory object.
   */
  protected function configFactory() {
    return \Drupal::service('config.factory');
  }

  /**
   * Wraps the search page repository.
   *
   * @return \Drupal\search\SearchPageRepositoryInterface
   *   A search page repository object.
   */
  protected function searchPageRepository() {
    return \Drupal::service('search.search_page_repository');
  }

  /**
   * Wraps the search plugin manager.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   A search plugin manager object.
   */
  protected function searchPluginManager() {
    return \Drupal::service('plugin.manager.search');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	8
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	6
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	10
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::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::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	6
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	3
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	2
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		1
EntityBase::bundle	public	function		1
EntityBase::create	public static	function		1
EntityBase::delete	public	function		2
EntityBase::enforceIsNew	public	function
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function
EntityBase::getCacheMaxAge	public	function
EntityBase::getCacheTags	public	function
EntityBase::getConfigDependencyKey	public	function
EntityBase::getEntityType	public	function
EntityBase::getEntityTypeId	public	function
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function
EntityBase::getTypedDataClass	private	function	Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate	public	function
EntityBase::id	public	function		10
EntityBase::label	public	function		5
EntityBase::language	public	function		1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.
EntityBase::load	public static	function
EntityBase::loadMultiple	public static	function
EntityBase::postLoad	public static	function		2
EntityBase::preCreate	public static	function		3
EntityBase::referencedEntities	public	function		1
EntityBase::toLink	public	function
EntityBase::uriRelationships	public	function
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
EntityBase::uuid	public	function		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
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SearchPage::$configuration	protected	property	The configuration of the search page entity.
SearchPage::$id	protected	property	The name (plugin ID) of the search page entity.
SearchPage::$label	protected	property	The label of the search page entity.
SearchPage::$path	protected	property	The path this search page will appear upon.
SearchPage::$plugin	protected	property	The search plugin ID.
SearchPage::$pluginCollection	protected	property	The plugin collection that stores search plugins.
SearchPage::$weight	protected	property	The weight of the search page.
SearchPage::configFactory	protected	function	Wraps the config factory.
SearchPage::getPath	public	function	Returns the path for the search. Overrides SearchPageInterface::getPath
SearchPage::getPlugin	public	function	Returns the search plugin. Overrides SearchPageInterface::getPlugin
SearchPage::getPluginCollection	protected	function	Encapsulates the creation of the search page's LazyPluginCollection.
SearchPage::getPluginCollections	public	function	Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
SearchPage::getWeight	public	function	Returns the weight for the page. Overrides SearchPageInterface::getWeight
SearchPage::isDefaultSearch	public	function	Determines if this search page entity is currently the default search. Overrides SearchPageInterface::isDefaultSearch
SearchPage::isIndexable	public	function	Determines if this search page entity is indexable. Overrides SearchPageInterface::isIndexable
SearchPage::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
SearchPage::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
SearchPage::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
SearchPage::routeBuilder	protected	function	Wraps the route builder.
SearchPage::searchPageRepository	protected	function	Wraps the search page repository.
SearchPage::searchPluginManager	protected	function	Wraps the search plugin manager.
SearchPage::setPlugin	public	function	Sets the search plugin. Overrides SearchPageInterface::setPlugin
SearchPage::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase::sort
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

You are here

class SearchPage in Drupal 10

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation