ContextDefinitionInterface.php in Drupal 8

Namespace

Drupal\Core\Plugin\Context

File

core/lib/Drupal/Core/Plugin/Context/ContextDefinitionInterface.php

<?php

namespace Drupal\Core\Plugin\Context;

use Drupal\Component\Plugin\Context\ContextDefinitionInterface as ComponentContextDefinitionInterface;

/**
 * Interface to define definition objects in ContextInterface via TypedData.
 *
 * @see \Drupal\Component\Plugin\Context\ContextDefinitionInterface
 * @see \Drupal\Core\Plugin\Context\ContextInterface
 */
interface ContextDefinitionInterface extends ComponentContextDefinitionInterface {

  /**
   * Returns the data definition of the defined context.
   *
   * @return \Drupal\Core\TypedData\DataDefinitionInterface
   *   The data definition object.
   */
  public function getDataDefinition();

  /**
   * Determines if this definition is satisfied by a context object.
   *
   * @param \Drupal\Core\Plugin\Context\ContextInterface $context
   *   The context object.
   *
   * @return bool
   *   TRUE if this definition is satisfiable by the context object, FALSE
   *   otherwise.
   */
  public function isSatisfiedBy(ContextInterface $context);

}

Interfaces

Name	Description
ContextDefinitionInterface	Interface to define definition objects in ContextInterface via TypedData.