From 170a4c5649cdf0e5c861cd061d47f7d77207ceb7 Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Sat, 9 Jan 2016 12:08:03 +0100 Subject: [PATCH] better explain getRouteKey method --- RouteObjectInterface.php | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/RouteObjectInterface.php b/RouteObjectInterface.php index d06ea176..db25cd20 100644 --- a/RouteObjectInterface.php +++ b/RouteObjectInterface.php @@ -64,15 +64,17 @@ interface RouteObjectInterface public function getContent(); /** - * Get the route key. + * Get the route name. * - * This key will be used as route name instead of the name specified in the - * route collection. There are no limitations to allowed characters in the - * name. + * Normal symfony routes do not know their name, the name is only known + * from the route collection. In the CMF, it is possible to use route + * documents outside of collections, and thus useful to have routes provide + * their name. * - * Return null if you want to use the default name. + * There are no limitations to allowed characters in the name. * - * @return string|null the route name + * @return string|null the route name or null to use the default name + * (e.g. from route collection if known) */ public function getRouteKey(); }