You are here

Home » API reference » View Mode Page 8.3 » ViewmodepagePatternInterface.php

interface ViewmodepagePatternInterface in View Mode Page 8.3

Same name and namespace in other branches
  1. 4.0.x src/ViewmodepagePatternInterface.php \Drupal\view_mode_page\ViewmodepagePatternInterface
  2. 3.2.x src/ViewmodepagePatternInterface.php \Drupal\view_mode_page\ViewmodepagePatternInterface

Provides an interface for defining Viewmodepage pattern entities.

Hierarchy

Expanded class hierarchy of ViewmodepagePatternInterface

All classes that implement ViewmodepagePatternInterface

1 file declares its use of ViewmodepagePatternInterface
ViewmodepagePattern.php in src/Entity/ViewmodepagePattern.php

File

src/ViewmodepagePatternInterface.php, line 11

Namespace

Drupal\view_mode_page
View source 
interface ViewmodepagePatternInterface extends ConfigEntityInterface {

  /**
   * Get the pattern used during path processing.
   *
   * @return string
   *   Returns the pattern used during path processing.
   */
  public function getPattern();

  /**
   * Set the pattern regex to use during path processing.
   *
   * @return string
   *   Returns the pattern regex to use during path processing.
   */
  public function getPatternRegex();

  /**
   * Set the pattern to use during path processing.
   *
   * @param string $pattern
   *   The pattern.
   *
   * @return $this
   *   Returns the pattern to use during path processing.
   */
  public function setPattern($pattern);

  /**
   * Gets the type of view_mode.
   *
   * @return string
   *   Returns the type of view_mode.
   */
  public function getViewMode();

  /**
   * Gets the label of view_mode.
   *
   * @return string
   *   Returns the label of view_mode.
   */
  public function getViewModeLabel();

  /**
   * Gets the type of this pattern.
   *
   * @return string
   *   Returns the type of this pattern.
   */
  public function getType();

  /**
   * Gets the alias type interface.
   *
   * @return \Drupal\view_mode_page\AliasTypeInterface
   *   Returns the alias type interface.
   */
  public function getAliasType();

  /**
   * Gets the weight of this pattern (compared to other patterns of this type).
   *
   * @return int
   *   Returns the weight
   */
  public function getWeight();

  /**
   * Sets the weight of this pattern (compared to other patterns of this type).
   *
   * @param int $weight
   *   The weight of the variant.
   *
   * @return $this
   */
  public function setWeight($weight);

  /**
   * Returns the contexts of this pattern.
   *
   * @return \Drupal\Core\Plugin\Context\ContextInterface[]
   *   Return the context interface.
   */
  public function getContexts();

  /**
   * Returns whether a relationship exists.
   *
   * @param string $token
   *   Relationship identifier.
   *
   * @return bool
   *   TRUE if the relationship exists, FALSE otherwise.
   */
  public function hasRelationship($token);

  /**
   * Adds a relationship.
   *
   * The relationship will not be changed if it already exists.
   *
   * @param string $token
   *   Relationship identifier.
   * @param string|null $label
   *   (optional) A label, will use the label of the referenced context if not
   *   provided.
   *
   * @return $this
   */
  public function addRelationship($token, $label = NULL);

  /**
   * Replaces a relationship.
   *
   * Only already existing relationships are updated.
   *
   * @param string $token
   *   Relationship identifier.
   * @param string|null $label
   *   (optional) A label, will use the label of the referenced context if not
   *   provided.
   *
   * @return $this
   */
  public function replaceRelationship($token, $label);

  /**
   * Removes a relationship.
   *
   * @param string $token
   *   Relationship identifier.
   *
   * @return $this
   */
  public function removeRelationship($token);

  /**
   * Returns a list of relationships.
   *
   * @return array[]
   *   Keys are context tokens, and values are arrays with the following keys:
   *   - label (string|null, optional): The human-readable label of this
   *     relationship.
   */
  public function getRelationships();

  /**
   * Gets the selection condition collection.
   *
   * @return \Drupal\Core\Condition\ConditionInterface[]|\Drupal\Core\Condition\ConditionPluginCollection
   *   Returns a array/collection of condition objects
   */
  public function getSelectionConditions();

  /**
   * Adds selection criteria.
   *
   * @param array $configuration
   *   Configuration of the selection criteria.
   *
   * @return string
   *   The condition id of the new criteria.
   */
  public function addSelectionCondition(array $configuration);

  /**
   * Gets selection criteria by condition id.
   *
   * @param string $condition_id
   *   The id of the condition.
   *
   * @return \Drupal\Core\Condition\ConditionInterface
   *   Returns the condition interface
   */
  public function getSelectionCondition($condition_id);

  /**
   * Removes selection criteria by condition id.
   *
   * @param string $condition_id
   *   The id of the condition.
   *
   * @return $this
   *   Returns the current object
   */
  public function removeSelectionCondition($condition_id);

  /**
   * Gets the selection logic used by the criteria (ie. "and" or "or").
   *
   * @return string
   *   Either "and" or "or"; represents how the selection criteria are combined.
   */
  public function getSelectionLogic();

  /**
   * Determines if this pattern can apply a given object.
   *
   * @param EntityInterface $entity
   *   The entity used to determine if this plugin can apply.
   *
   * @return bool
   *   Returns true or false
   */
  public function applies(EntityInterface $entity);

}

Members

Namesort descending 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
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
ViewmodepagePatternInterface::addRelationship public function Adds a relationship. 1
ViewmodepagePatternInterface::addSelectionCondition public function Adds selection criteria. 1
ViewmodepagePatternInterface::applies public function Determines if this pattern can apply a given object. 1
ViewmodepagePatternInterface::getAliasType public function Gets the alias type interface. 1
ViewmodepagePatternInterface::getContexts public function Returns the contexts of this pattern. 1
ViewmodepagePatternInterface::getPattern public function Get the pattern used during path processing. 1
ViewmodepagePatternInterface::getPatternRegex public function Set the pattern regex to use during path processing. 1
ViewmodepagePatternInterface::getRelationships public function Returns a list of relationships. 1
ViewmodepagePatternInterface::getSelectionCondition public function Gets selection criteria by condition id. 1
ViewmodepagePatternInterface::getSelectionConditions public function Gets the selection condition collection. 1
ViewmodepagePatternInterface::getSelectionLogic public function Gets the selection logic used by the criteria (ie. "and" or "or"). 1
ViewmodepagePatternInterface::getType public function Gets the type of this pattern. 1
ViewmodepagePatternInterface::getViewMode public function Gets the type of view_mode. 1
ViewmodepagePatternInterface::getViewModeLabel public function Gets the label of view_mode. 1
ViewmodepagePatternInterface::getWeight public function Gets the weight of this pattern (compared to other patterns of this type). 1
ViewmodepagePatternInterface::hasRelationship public function Returns whether a relationship exists. 1
ViewmodepagePatternInterface::removeRelationship public function Removes a relationship. 1
ViewmodepagePatternInterface::removeSelectionCondition public function Removes selection criteria by condition id. 1
ViewmodepagePatternInterface::replaceRelationship public function Replaces a relationship. 1
ViewmodepagePatternInterface::setPattern public function Set the pattern to use during path processing. 1
ViewmodepagePatternInterface::setWeight public function Sets the weight of this pattern (compared to other patterns of this type). 1