interface FormEntityContextInterface in Flexiform 8

Interface for form entity contexts.

This extends the standard ContextInterface with two methods used to store the entity namespace in a way that can be accessible.

Hierarchy

• interface \Drupal\Component\Plugin\Context\ContextInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\Core\Plugin\Context\ContextInterface
    • interface \Drupal\flexiform\FormEntity\FormEntityContextInterface

File

src/FormEntity/FormEntityContextInterface.php, line 13

Namespace

Drupal\flexiform\FormEntity

interface FormEntityContextInterface extends ContextInterface {

  /**
   * Set the entity namespace.
   *
   * @param string $namespace
   *   The entity namespace.
   */
  public function setEntityNamespace($namespace);

  /**
   * Get the entity namespace.
   *
   * @return string
   *   The entity namespace.
   */
  public function getEntityNamespace();

  /**
   * Get the form entity plugin.
   *
   * @return \Drupal\flexiform\FormEntity\FlexiformFormEntityInterface
   */
  public function getFormEntity();

}

Members

Name	Modifiers	Type	Description	Overrides
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
ContextInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
ContextInterface::createFromContext	public static	function	Creates a new context with a different value.	1
ContextInterface::getConstraints	public	function	Gets a list of validation constraints.	1
ContextInterface::getContextData	public	function	Gets the context value as typed data object.	1
ContextInterface::getContextDefinition	public	function	Overrides ContextInterface::getContextDefinition
ContextInterface::getContextValue	public	function	Gets the context value.	1
ContextInterface::hasContextValue	public	function	Returns whether the context has a value.	1
ContextInterface::validate	public	function	Validates the set context value.	1
FormEntityContextInterface::getEntityNamespace	public	function	Get the entity namespace.	1
FormEntityContextInterface::getFormEntity	public	function	Get the form entity plugin.	1
FormEntityContextInterface::setEntityNamespace	public	function	Set the entity namespace.	1