interface ParamConverterInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php \Drupal\Core\ParamConverter\ParamConverterInterface
Interface for parameter converters.
Classes implementing this interface are responsible for converting a path parameter to the object it represents.
Here is an example path: /admin/structure/block/manage/{block}
In this case, '{block}' would be the path parameter which should be turned into a block object representing the block in question.
ParamConverters are defined as services tagged with 'paramconverter', and are managed by the 'paramconverter_manager' service.
Hierarchy
- interface \Drupal\Core\ParamConverter\ParamConverterInterface
Expanded class hierarchy of ParamConverterInterface
All classes that implement ParamConverterInterface
See also
\Drupal\Core\ParamConverter\ParamConverterManagerInterface
\Drupal\Core\ParamConverter\EntityConverter
3 files declare their use of ParamConverterInterface
- LanguageConverter.php in core/
modules/ language/ src/ LanguageConverter.php - Contains \Drupal\language\LanguageConverter.
- NodePreviewConverter.php in core/
modules/ node/ src/ ParamConverter/ NodePreviewConverter.php - Contains \Drupal\node\ParamConverter\NodePreviewConverter.
- ViewUIConverter.php in core/
modules/ views_ui/ src/ ParamConverter/ ViewUIConverter.php - Contains \Drupal\views_ui\ParamConverter\ViewUIConverter.
File
- core/
lib/ Drupal/ Core/ ParamConverter/ ParamConverterInterface.php, line 30 - Contains \Drupal\Core\ParamConverter\ParamConverterInterface.
Namespace
Drupal\Core\ParamConverterView source
interface ParamConverterInterface {
/**
* Converts path variables to their corresponding objects.
*
* @param mixed $value
* The raw value.
* @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 mixed|null
* The converted parameter value.
*/
public function convert($value, $definition, $name, array $defaults);
/**
* Determines if the converter applies to a specific route and variable.
*
* @param mixed $definition
* The parameter definition provided in the route options.
* @param string $name
* The name of the parameter.
* @param \Symfony\Component\Routing\Route $route
* The route to consider attaching to.
*
* @return bool
* TRUE if the converter applies to the passed route and parameter, FALSE
* otherwise.
*/
public function applies($definition, $name, Route $route);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ParamConverterInterface:: |
public | function | Determines if the converter applies to a specific route and variable. | 9 |
ParamConverterInterface:: |
public | function | Converts path variables to their corresponding objects. | 9 |