Version 1

[yaffs-website] / vendor / symfony-cmf / routing / VersatileGeneratorInterface.php

diff --git a/vendor/symfony-cmf/routing/VersatileGeneratorInterface.php b/vendor/symfony-cmf/routing/VersatileGeneratorInterface.php
new file mode 100644 (file)
index 0000000..7c42399
--- /dev/null
+++ b/vendor/symfony-cmf/routing/VersatileGeneratorInterface.php
@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Routing;
+
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+/**
+ * This generator is able to handle more than string route names as symfony
+ * core supports them.
+ */
+interface VersatileGeneratorInterface extends UrlGeneratorInterface
+{
+    /**
+     * Whether this generator supports the supplied $name.
+     *
+     * This check does not need to look if the specific instance can be
+     * resolved to a route, only whether the router can generate routes from
+     * objects of this class.
+     *
+     * @param mixed $name The route "name" which may also be an object or anything
+     *
+     * @return bool
+     */
+    public function supports($name);
+
+    /**
+     * Convert a route identifier (name, content object etc) into a string
+     * usable for logging and other debug/error messages.
+     *
+     * @param mixed $name
+     * @param array $parameters which should contain a content field containing
+     *                          a RouteReferrersReadInterface object
+     *
+     * @return string
+     */
+    public function getRouteDebugMessage($name, array $parameters = array());
+}