Commit 8df466d5 authored by xjm's avatar xjm

Issue #2087103 by Mile23, rickwelch, jhodgdon, Crell, joachim:...

Issue #2087103 by Mile23, rickwelch, jhodgdon, Crell, joachim: ParamConverterInterface one-line description doesn't explain what the class does
parent f559ff78
...@@ -11,11 +11,26 @@ ...@@ -11,11 +11,26 @@
/** /**
* Interface for parameter converters. * 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.
*
* @see menu
* @see \Drupal\Core\ParamConverter\ParamConverterManagerInterface
* @see \Drupal\Core\ParamConverter\EntityConverter
*/ */
interface ParamConverterInterface { interface ParamConverterInterface {
/** /**
* Allows to convert variables to their corresponding objects. * Converts path variables to their corresponding objects.
* *
* @param mixed $value * @param mixed $value
* The raw value. * The raw value.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment