Commit ed1c7bab authored by alexpott's avatar alexpott

Issue #2358369 by balagan, Katiemouse: getParameters() vs. getRawParameters()...

Issue #2358369 by balagan, Katiemouse: getParameters() vs. getRawParameters() on RouteMatch should not be documented the same
parent f51b0290
...@@ -39,7 +39,13 @@ public function getRouteName(); ...@@ -39,7 +39,13 @@ public function getRouteName();
public function getRouteObject(); public function getRouteObject();
/** /**
* Returns the value of a named route parameter. * Returns the processed value of a named route parameter.
*
* Raw URL parameters are processed by the parameter conversion system, which
* does operations such as converting entity ID parameters to fully-loaded
* entities. For example, the path node/12345 would have a raw node ID
* parameter value of 12345, while the processed parameter value would be the
* corresponding loaded node object.
* *
* @param string $parameter_name * @param string $parameter_name
* The parameter name. * The parameter name.
...@@ -47,14 +53,24 @@ public function getRouteObject(); ...@@ -47,14 +53,24 @@ public function getRouteObject();
* @return mixed|null * @return mixed|null
* The parameter value. NULL if the route doesn't define the parameter or * The parameter value. NULL if the route doesn't define the parameter or
* if the parameter value can't be determined from the request. * if the parameter value can't be determined from the request.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getRawParameter()
*/ */
public function getParameter($parameter_name); public function getParameter($parameter_name);
/** /**
* Returns the bag of all route parameters. * Returns the bag of all processed route parameters.
*
* Raw URL parameters are processed by the parameter conversion system, which
* does operations such as converting entity ID parameters to fully-loaded
* entities. For example, the path node/12345 would have a raw node ID
* parameter value of 12345, while the processed parameter value would be the
* corresponding loaded node object.
* *
* @return \Symfony\Component\HttpFoundation\ParameterBag * @return \Symfony\Component\HttpFoundation\ParameterBag
* The parameter bag. * The parameter bag.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getRawParameters()
*/ */
public function getParameters(); public function getParameters();
...@@ -68,6 +84,8 @@ public function getParameters(); ...@@ -68,6 +84,8 @@ public function getParameters();
* The raw (non-upcast) parameter value. NULL if the route doesn't define * The raw (non-upcast) parameter value. NULL if the route doesn't define
* the parameter or if the raw parameter value can't be determined from the * the parameter or if the raw parameter value can't be determined from the
* request. * request.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getParameter()
*/ */
public function getRawParameter($parameter_name); public function getRawParameter($parameter_name);
...@@ -76,6 +94,8 @@ public function getRawParameter($parameter_name); ...@@ -76,6 +94,8 @@ public function getRawParameter($parameter_name);
* *
* @return \Symfony\Component\HttpFoundation\ParameterBag * @return \Symfony\Component\HttpFoundation\ParameterBag
* The parameter bag. * The parameter bag.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getParameters()
*/ */
public function getRawParameters(); public function getRawParameters();
......
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