interface SearchApiPageInterface in Search API Pages 8

Provides an interface for defining Search page entities.

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_api_page\SearchApiPageInterface

Expanded class hierarchy of SearchApiPageInterface

All classes that implement SearchApiPageInterface

2 files declare their use of SearchApiPageInterface

SearchApiPage.php in src/Entity/SearchApiPage.php
SearchApiPageController.php in src/Controller/SearchApiPageController.php

File

src/SearchApiPageInterface.php, line 10

Namespace

Drupal\search_api_page

View source

interface SearchApiPageInterface extends ConfigEntityInterface {

  /**
   * Return the path.
   *
   * @return string
   *   The path.
   */
  public function getPath();

  /**
   * Return the clean URL configuration.
   *
   * @return bool
   *   The clean url.
   */
  public function getCleanUrl();

  /**
   * Return the search api index.
   *
   * @return string
   *   The index.
   */
  public function getIndex();

  /**
   * Return the limit per page.
   *
   * @return int
   *   The page limit.
   */
  public function getLimit();

  /**
   * Return the searched fields.
   *
   * @return string[]
   *   A collection of searched fields.
   */
  public function getSearchedFields();

  /**
   * Retrieves a list of all available fulltext fields.
   *
   * @return string[]
   *   An options list of fulltext field identifiers mapped to their prefixed
   *   labels.
   */
  public function getFullTextFields();

  /**
   * Get the style to render the search results in.
   *
   * @return string
   *   The style.
   */
  public function getStyle();

  /**
   * Get the view mode configuration per entity for rendering.
   *
   * @return string[]
   *   A collection of view mode configuration.
   */
  public function getViewModeConfiguration();

  /**
   * Whether to render the results as view modes.
   *
   * @return bool
   *   TRUE when rendering as view modes.
   */
  public function renderAsViewModes();

  /**
   * Whether to render the results as snippets.
   *
   * @return bool
   *   TRUE when rendering as snippets.
   */
  public function renderAsSnippets();

  /**
   * Whether to show the search form above the search results.
   *
   * @return bool
   *   TRUE when search form needs to be shown.
   */
  public function showSearchForm();

  /**
   * Show all results when no search is performed.
   *
   * @return bool
   *   TRUE when having to show all results.
   */
  public function showAllResultsWhenNoSearchIsPerformed();

  /**
   * Get the view mode configuration object.
   *
   * @return \Drupal\search_api_page\Config\ViewMode
   */
  public function getViewModeConfig();

  /**
   * The parse mode to use for query keywords.
   *
   * @return string
   *   Can be any ID of a parse mode plugin.
   */
  public function getParseMode();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
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.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
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
SearchApiPageInterface::getCleanUrl	public	function	Return the clean URL configuration.	1
SearchApiPageInterface::getFullTextFields	public	function	Retrieves a list of all available fulltext fields.
SearchApiPageInterface::getIndex	public	function	Return the search api index.	1
SearchApiPageInterface::getLimit	public	function	Return the limit per page.	1
SearchApiPageInterface::getParseMode	public	function	The parse mode to use for query keywords.	1
SearchApiPageInterface::getPath	public	function	Return the path.	1
SearchApiPageInterface::getSearchedFields	public	function	Return the searched fields.	1
SearchApiPageInterface::getStyle	public	function	Get the style to render the search results in.	1
SearchApiPageInterface::getViewModeConfig	public	function	Get the view mode configuration object.	1
SearchApiPageInterface::getViewModeConfiguration	public	function	Get the view mode configuration per entity for rendering.	1
SearchApiPageInterface::renderAsSnippets	public	function	Whether to render the results as snippets.	1
SearchApiPageInterface::renderAsViewModes	public	function	Whether to render the results as view modes.	1
SearchApiPageInterface::showAllResultsWhenNoSearchIsPerformed	public	function	Show all results when no search is performed.	1
SearchApiPageInterface::showSearchForm	public	function	Whether to show the search form above the search results.	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.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface SearchApiPageInterface in Search API Pages 8

Hierarchy

File

Namespace

Members

API Navigation