summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorxjm2015-04-26 01:04:15 (GMT)
committerxjm2015-04-26 01:04:15 (GMT)
commit8df466d596d324aaa97b1ea850d7a33776869a41 (patch)
tree42bb0939057f3369ae7e128d2016c7f5ea4a4a6c
parentf559ff78294a4c2b4aa7cc2935b49281cbfe858b (diff)
Issue #2087103 by Mile23, rickwelch, jhodgdon, Crell, joachim: ParamConverterInterface one-line description doesn't explain what the class does
-rw-r--r--core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php17
1 files changed, 16 insertions, 1 deletions
diff --git a/core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php b/core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php
index 141e32a..2194239 100644
--- a/core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php
+++ b/core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php
@@ -11,11 +11,26 @@ use Symfony\Component\Routing\Route;
/**
* 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 {
/**
- * Allows to convert variables to their corresponding objects.
+ * Converts path variables to their corresponding objects.
*
* @param mixed $value
* The raw value.