interface SearchPageInterface in Drupal 10

Provides an interface defining a search page entity.

Hierarchy

• interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityInterface
    • interface \Drupal\search\SearchPageInterface

4 files declare their use of SearchPageInterface

SearchController.php in core/modules/search/src/Controller/SearchController.php

SearchPage.php in core/modules/search/src/Entity/SearchPage.php

SearchPageForm.php in core/modules/search/src/Form/SearchPageForm.php

umami.theme in core/profiles/demo_umami/themes/umami/umami.theme

Functions to support theming in the Umami theme.

File

core/modules/search/src/SearchPageInterface.php, line 10

Namespace

Drupal\search

interface SearchPageInterface extends ConfigEntityInterface {

  /**
   * Returns the search plugin.
   *
   * @return \Drupal\search\Plugin\SearchInterface
   *   The search plugin used by this search page entity.
   */
  public function getPlugin();

  /**
   * Sets the search plugin.
   *
   * @param string $plugin_id
   *   The search plugin ID.
   */
  public function setPlugin($plugin_id);

  /**
   * Determines if this search page entity is currently the default search.
   *
   * @return bool
   *   TRUE if this search page entity is the default search, FALSE otherwise.
   */
  public function isDefaultSearch();

  /**
   * Determines if this search page entity is indexable.
   *
   * @return bool
   *   TRUE if this search page entity is indexable, FALSE otherwise.
   */
  public function isIndexable();

  /**
   * Returns the path for the search.
   *
   * @return string
   *   The part of the path for this search page that comes after 'search'.
   */
  public function getPath();

  /**
   * Returns the weight for the page.
   *
   * @return int
   *   The page weight.
   */
  public function getWeight();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	4
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	24
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	24
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	17
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	1
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	1
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	1
EntityInterface::delete	public	function	Deletes an entity permanently.	1
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	1
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	1
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	1
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	1
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	1
EntityInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	1
EntityInterface::getOriginalId	public	function	Gets the original ID.	1
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	1
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	1
EntityInterface::id	public	function	Gets the identifier.	1
EntityInterface::isNew	public	function	Determines whether the entity is new.	1
EntityInterface::label	public	function	Gets the label of the entity.	1
EntityInterface::language	public	function	Gets the language of the entity.	1
EntityInterface::load	public static	function	Loads an entity.	1
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	1
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	1
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	1
EntityInterface::postLoad	public static	function	Acts on loaded entities.	1
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	1
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	1
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	1
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	1
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	1
EntityInterface::save	public	function	Saves an entity permanently.	1
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::toArray	public	function	Gets an array of all property values.	1
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	1
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	1
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	1
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SearchPageInterface::getPath	public	function	Returns the path for the search.	1
SearchPageInterface::getPlugin	public	function	Returns the search plugin.	1
SearchPageInterface::getWeight	public	function	Returns the weight for the page.	1
SearchPageInterface::isDefaultSearch	public	function	Determines if this search page entity is currently the default search.	1
SearchPageInterface::isIndexable	public	function	Determines if this search page entity is indexable.	1
SearchPageInterface::setPlugin	public	function	Sets the search plugin.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	4
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	4
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	4
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	4
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	4