interface AutocompletionConfigurationInterface in Search Autocomplete 2.x

Same name and namespace in other branches

8 src/AutocompletionConfigurationInterface.php \Drupal\search_autocomplete\AutocompletionConfigurationInterface

Provides an interface defining an autocompletion configuration 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_autocomplete\AutocompletionConfigurationInterface

Expanded class hierarchy of AutocompletionConfigurationInterface

All classes that implement AutocompletionConfigurationInterface

1 file declares its use of AutocompletionConfigurationInterface

AutocompletionConfiguration.php in src/Entity/AutocompletionConfiguration.php

File

src/AutocompletionConfigurationInterface.php, line 10

Namespace

Drupal\search_autocomplete

View source

interface AutocompletionConfigurationInterface extends ConfigEntityInterface {

  /* -----------------------------
   * ---------  GETTERS  ---------
   */

  /**
   * Returns the field selector to apply the autocompletion on.
   *
   * @return string
   *   The field selector to apply the autocompletion on.
   */
  public function getSelector();

  /**
   * Returns the configuration status.
   *
   * @return boolean
   *   TRUE/FALSE depending if the configuration is set active.
   */
  public function getStatus();

  /**
   * Define how much characters needs to be entered in the field before
   * autocompletion occurs.
   *
   * @var int
   */
  public function getMinChar();

  /**
   * Returns how many suggestions should be displayed among matching suggestions
   * available.
   *
   * @return int
   *   The maximum number of suggestions to be displayed.
   */
  public function getMaxSuggestions();

  /**
   * Returns a suggestion label displayed when no results are available.
   *
   * @return string
   *   The suggestion label displayed when no results are available.
   */
  public function getNoResultLabel();

  /**
   * Returns a suggestion value entered when "no results" is choosen.
   *
   * @return string
   *   The suggestion value entered when "no results" is choosen.
   */
  public function getNoResultValue();

  /**
   * Returns a suggestion link redirection for when no results is selected.
   *
   * @return string
   *   The link user is redirected to, when "no results" is choosen.
   */
  public function getNoResultLink();

  /**
   * Returns a suggestion label displayed when more results are available.
   *
   * @return string
   *   The suggestion label displayed when more results are available.
   */
  public function getMoreResultsLabel();

  /**
   * Returns a suggestion value entered when "more results" is choosen.
   *
   * @return string
   *   The suggestion value entered when "more results" is choosen.
   */
  public function getMoreResultsValue();

  /**
   * Returns a suggestion link redirection for when "no results" is selected.
   *
   * @return string
   *   The link user is redirected to, when "more results" is selected.
   */
  public function getMoreResultsLink();

  /**
   * Returns the source of to retrieve suggestions.
   *
   * @return string
   *   The source name to retrieve suggestions.
   */
  public function getSource();

  /**
   * Returns the theme to use.
   *
   * @return string
   *   The CSS file name.
   */
  public function getTheme();

  /**
   * Returns whether the configuration is editable by authorized users.
   *
   * @return boolean
   *   TRUE if the configuration is editable, FALSE otherwise.
   */
  public function getEditable();

  /**
   * Returns whether the configuration is deletable by authorized users.
   *
   * @return boolean
   *   TRUE if the configuration is deletable, FALSE otherwise.
   */
  public function getDeletable();

  /* -----------------------------
   * ---------  SETTERS  ---------
   */

  /**
   * Sets the field selector to apply the autocompletion on.
   *
   * @param string $selector
   *   The field selector to apply the autocompletion on.
   */
  public function setSelector($selector);

  /**
   * Sets the configuration status : wheter it is active or not.
   *
   * @param boolean $status
   *   TRUE/FALSE depending if the configuration is set active.
   */
  public function setStatus($status);

  /**
   * Sets how many characters needs to be entered in the field before
   * autocompletion occurs.
   *
   * @param int $min_char
   *   The number of characters to enter before autocompletion starts.
   */
  public function setMinChar($min_char);

  /**
   * Sets how many suggestions should be displayed among matching suggestions
   * available.
   *
   * @param int $max_suggestions
   *   The maximum number of suggestions to be displayed.
   */
  public function setMaxSuggestions($max_suggestions);

  /**
   * Sets a label when no result are available.
   *
   * @param string $no_result_label
   *   The label for "no result available" custom suggestion.
   */
  public function setNoResultLabel($no_result_label);

  /**
   * Sets a value when no result are available.
   *
   * @param string $no_result_value
   *   The value for "no result available" custom suggestion.
   */
  public function setNoResultValue($no_result_value);

  /**
   * Sets a link when no result are available.
   *
   * @param string $no_result_link
   *   The link for "no result available" custom suggestion.
   */
  public function setNoResultLink($no_result_link);

  /**
   * Sets a label when more result are available.
   *
   * @param string $more_results_label
   *   The label for "more result available" custom suggestion.
   */
  public function setMoreResultsLabel($more_results_label);

  /**
   * Sets a value when more result are available.
   *
   * @param string $more_results_value
   *   The value for "more result available" custom suggestion.
   */
  public function setMoreResultsValue($more_results_value);

  /**
   * Sets a link when more result are available.
   *
   * @param string $more_results_link
   *   The link for "more result available" custom suggestion.
   */
  public function setMoreResultsLink($more_results_link);

  /**
   * Sets the source to retrieve suggestions.
   *
   * @param string $source
   *   The source name to retrieve suggestions.
   */
  public function setSource($source);

  /**
   * Sets the theme to use for autocompletion display.
   *
   * @param string $theme
   *   The CSS filename for the theme.
   */
  public function setTheme($theme);

  /**
   * Sets whether the configuration is editable by authorized users.
   * None editable configurations cannot be created from GUI.
   *
   * @param boolean $editable
   *   TRUE if the configuration is $editable, FALSE otherwise.
   */
  public function setEditable($editable);

  /**
   * Sets whether the configuration is deletable by authorized users.
   * None deletable configurations cannot be created from GUI.
   *
   * @param boolean $deletable
   *   TRUE if the configuration is $deletable, FALSE otherwise.
   */
  public function setDeletable($deletable);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
AutocompletionConfigurationInterface::getDeletable	public	function	Returns whether the configuration is deletable by authorized users.	1
AutocompletionConfigurationInterface::getEditable	public	function	Returns whether the configuration is editable by authorized users.	1
AutocompletionConfigurationInterface::getMaxSuggestions	public	function	Returns how many suggestions should be displayed among matching suggestions available.	1
AutocompletionConfigurationInterface::getMinChar	public	function	Define how much characters needs to be entered in the field before autocompletion occurs.	1
AutocompletionConfigurationInterface::getMoreResultsLabel	public	function	Returns a suggestion label displayed when more results are available.	1
AutocompletionConfigurationInterface::getMoreResultsLink	public	function	Returns a suggestion link redirection for when "no results" is selected.	1
AutocompletionConfigurationInterface::getMoreResultsValue	public	function	Returns a suggestion value entered when "more results" is choosen.	1
AutocompletionConfigurationInterface::getNoResultLabel	public	function	Returns a suggestion label displayed when no results are available.	1
AutocompletionConfigurationInterface::getNoResultLink	public	function	Returns a suggestion link redirection for when no results is selected.	1
AutocompletionConfigurationInterface::getNoResultValue	public	function	Returns a suggestion value entered when "no results" is choosen.	1
AutocompletionConfigurationInterface::getSelector	public	function	Returns the field selector to apply the autocompletion on.	1
AutocompletionConfigurationInterface::getSource	public	function	Returns the source of to retrieve suggestions.	1
AutocompletionConfigurationInterface::getStatus	public	function	Returns the configuration status.	1
AutocompletionConfigurationInterface::getTheme	public	function	Returns the theme to use.	1
AutocompletionConfigurationInterface::setDeletable	public	function	Sets whether the configuration is deletable by authorized users. None deletable configurations cannot be created from GUI.	1
AutocompletionConfigurationInterface::setEditable	public	function	Sets whether the configuration is editable by authorized users. None editable configurations cannot be created from GUI.	1
AutocompletionConfigurationInterface::setMaxSuggestions	public	function	Sets how many suggestions should be displayed among matching suggestions available.	1
AutocompletionConfigurationInterface::setMinChar	public	function	Sets how many characters needs to be entered in the field before autocompletion occurs.	1
AutocompletionConfigurationInterface::setMoreResultsLabel	public	function	Sets a label when more result are available.	1
AutocompletionConfigurationInterface::setMoreResultsLink	public	function	Sets a link when more result are available.	1
AutocompletionConfigurationInterface::setMoreResultsValue	public	function	Sets a value when more result are available.	1
AutocompletionConfigurationInterface::setNoResultLabel	public	function	Sets a label when no result are available.	1
AutocompletionConfigurationInterface::setNoResultLink	public	function	Sets a link when no result are available.	1
AutocompletionConfigurationInterface::setNoResultValue	public	function	Sets a value when no result are available.	1
AutocompletionConfigurationInterface::setSelector	public	function	Sets the field selector to apply the autocompletion on.	1
AutocompletionConfigurationInterface::setSource	public	function	Sets the source to retrieve suggestions.	1
AutocompletionConfigurationInterface::setStatus	public	function	Sets the configuration status : wheter it is active or not. Overrides ConfigEntityInterface::setStatus
AutocompletionConfigurationInterface::setTheme	public	function	Sets the theme to use for autocompletion display.	1
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::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::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::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
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 AutocompletionConfigurationInterface in Search Autocomplete 2.x

Hierarchy

File

Namespace

Members

API Navigation