interface SavedSearchTypeInterface in Search API Saved Searches 8

Provides an interface for saved search types.

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_saved_searches\SavedSearchTypeInterface

Expanded class hierarchy of SavedSearchTypeInterface

All classes that implement SavedSearchTypeInterface

5 files declare their use of SavedSearchTypeInterface

NotificationPluginBase.php in src/Notification/NotificationPluginBase.php
NotificationPluginInterface.php in src/Notification/NotificationPluginInterface.php
NotificationPluginManager.php in src/Notification/NotificationPluginManager.php
NotificationPluginManagerInterface.php in src/Notification/NotificationPluginManagerInterface.php
SavedSearchType.php in src/Entity/SavedSearchType.php

File

src/SavedSearchTypeInterface.php, line 12

Namespace

Drupal\search_api_saved_searches

View source

interface SavedSearchTypeInterface extends ConfigEntityInterface {

  /**
   * Retrieves the type's description.
   *
   * @return string
   *   The (admin) description of this saved search type.
   */
  public function getDescription();

  /**
   * Retrieves this saved search type's notification plugins.
   *
   * @return \Drupal\search_api_saved_searches\Notification\NotificationPluginInterface[]
   *   The notification plugins used by this saved search type, keyed by plugin
   *   ID.
   */
  public function getNotificationPlugins();

  /**
   * Retrieves the IDs of all notification plugins enabled for this type.
   *
   * @return string[]
   *   The IDs of the notification plugins used by this saved search type.
   */
  public function getNotificationPluginIds();

  /**
   * Determines whether the given notification plugin ID is valid for this type.
   *
   * The general contract of this method is that it should return TRUE if, and
   * only if, a call to getNotificationPlugin() with the same ID would not
   * result in an exception.
   *
   * @param string $notification_plugin_id
   *   A notification plugin ID.
   *
   * @return bool
   *   TRUE if the notification plugin with the given ID is enabled for this
   *   saved search type and can be loaded. FALSE otherwise.
   */
  public function isValidNotificationPlugin($notification_plugin_id);

  /**
   * Retrieves a specific notification plugin for this saved search type.
   *
   * @param string $notification_plugin_id
   *   The ID of the notification plugin to return.
   *
   * @return \Drupal\search_api_saved_searches\Notification\NotificationPluginInterface
   *   The notification plugin with the given ID.
   *
   * @throws \Drupal\search_api_saved_searches\SavedSearchesException
   *   Thrown if the specified notification plugin isn't enabled for this saved
   *   search type, or couldn't be loaded.
   */
  public function getNotificationPlugin($notification_plugin_id);

  /**
   * Adds a notification plugin to this saved search type.
   *
   * An existing notification plugin with the same ID will be replaced.
   *
   * @param \Drupal\search_api_saved_searches\Notification\NotificationPluginInterface $notification_plugin
   *   The notification plugin to be added.
   *
   * @return $this
   */
  public function addNotificationPlugin(NotificationPluginInterface $notification_plugin);

  /**
   * Removes a notification plugin from this saved search type.
   *
   * @param string $notification_plugin_id
   *   The ID of the notification plugin to remove.
   *
   * @return $this
   */
  public function removeNotificationPlugin($notification_plugin_id);

  /**
   * Sets this saved search type's notification plugins.
   *
   * @param \Drupal\search_api_saved_searches\Notification\NotificationPluginInterface[] $notification_plugins
   *   An array of notification plugins.
   *
   * @return $this
   */
  public function setNotificationPlugins(array $notification_plugins);

  /**
   * Retrieves all field definitions defined by notification plugins.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   All field definitions defined by notification plugins for this type,
   *   keyed by field name.
   */
  public function getNotificationPluginFieldDefinitions();

  /**
   * Retrieves the type options.
   *
   * @return array
   *   The options set for this type.
   */
  public function getOptions();

  /**
   * Retrieves a single, possibly nested, option.
   *
   * @param string $key
   *   The key of the option. Can contain periods (.) to access nested options.
   * @param mixed $default
   *   (optional) The value to return if the option wasn't set.
   *
   * @return mixed
   *   The value of the specified option if it exists, $default otherwise.
   */
  public function getOption($key, $default = NULL);

  /**
   * Retrieves an active search query that can be saved with this type.
   *
   * @param \Drupal\search_api\Utility\QueryHelperInterface|null $query_helper
   *   (optional) The query helper service to use. Otherwise, it will be
   *   retrieved from the container.
   *
   * @return \Drupal\search_api\Query\QueryInterface|null
   *   A search query that was executed in this page request and which can be
   *   saved with this saved search type. Or NULL if no such query could be
   *   found.
   */
  public function getActiveQuery(QueryHelperInterface $query_helper = NULL);

}

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
SavedSearchTypeInterface::addNotificationPlugin	public	function	Adds a notification plugin to this saved search type.	1
SavedSearchTypeInterface::getActiveQuery	public	function	Retrieves an active search query that can be saved with this type.	1
SavedSearchTypeInterface::getDescription	public	function	Retrieves the type's description.	1
SavedSearchTypeInterface::getNotificationPlugin	public	function	Retrieves a specific notification plugin for this saved search type.	1
SavedSearchTypeInterface::getNotificationPluginFieldDefinitions	public	function	Retrieves all field definitions defined by notification plugins.	1
SavedSearchTypeInterface::getNotificationPluginIds	public	function	Retrieves the IDs of all notification plugins enabled for this type.	1
SavedSearchTypeInterface::getNotificationPlugins	public	function	Retrieves this saved search type's notification plugins.	1
SavedSearchTypeInterface::getOption	public	function	Retrieves a single, possibly nested, option.	1
SavedSearchTypeInterface::getOptions	public	function	Retrieves the type options.	1
SavedSearchTypeInterface::isValidNotificationPlugin	public	function	Determines whether the given notification plugin ID is valid for this type.	1
SavedSearchTypeInterface::removeNotificationPlugin	public	function	Removes a notification plugin from this saved search type.	1
SavedSearchTypeInterface::setNotificationPlugins	public	function	Sets this saved search type's notification plugins.	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 SavedSearchTypeInterface in Search API Saved Searches 8

Hierarchy

File

Namespace

Members

API Navigation