interface ConfigEntityRevisionsConverterBaseInterface in Config Entity Revisions 1.x

Interface for ConfigEntityRevisions parameter converter.

Hierarchy

• interface \Drupal\Core\ParamConverter\ParamConverterInterface
  • interface \Drupal\config_entity_revisions\ConfigEntityRevisionsConverterBaseInterface

File

src/ConfigEntityRevisionsConverterBaseInterface.php, line 12

Namespace

Drupal\config_entity_revisions

interface ConfigEntityRevisionsConverterBaseInterface extends ParamConverterInterface {

  /**
   * {@inheritdoc}
   */
  public function convert($value, $definition, $name, array $defaults);

  /**
   * {@inheritdoc}
   */
  public function applies($definition, $name, Route $route);

  /**
   * Determines the entity type ID given a route definition and route defaults.
   *
   * @param mixed $definition
   *   The parameter definition provided in the route options.
   * @param string $name
   *   The name of the parameter.
   * @param array $defaults
   *   The route defaults array.
   *
   * @return string
   *   The entity type ID.
   *
   * @throws ParamNotConvertedException
   *   Thrown when the dynamic entity type is not found in the route defaults.
   */
  function getEntityTypeFromDefaults($definition, $name, array $defaults);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityRevisionsConverterBaseInterface::applies	public	function	Determines if the converter applies to a specific route and variable. Overrides ParamConverterInterface::applies
ConfigEntityRevisionsConverterBaseInterface::convert	public	function	Converts path variables to their corresponding objects. Overrides ParamConverterInterface::convert
ConfigEntityRevisionsConverterBaseInterface::getEntityTypeFromDefaults		function	Determines the entity type ID given a route definition and route defaults.