interface VersatileGeneratorInterface

This generator is able to handle more than string route names as symfony core supports them.

Hierarchy

Expanded class hierarchy of VersatileGeneratorInterface

All classes that implement VersatileGeneratorInterface

File

drupal/core/vendor/symfony-cmf/routing/Symfony/Cmf/Component/Routing/VersatileGeneratorInterface.php, line 11

Namespace

Symfony\Cmf\Component\Routing
View source
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 RouteAwareInterface object
   *
   * @return string
   */
  public function getRouteDebugMessage($name, array $parameters = array());

}

Members

Namesort descending Modifiers Type Description Overrides
RequestContextAwareInterface::getContext public function Gets the request context. 6
RequestContextAwareInterface::setContext public function Sets the request context. 6
UrlGeneratorInterface::ABSOLUTE_PATH constant Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL constant Generates an absolute URL, e.g. "http://example.com/dir/file".
UrlGeneratorInterface::generate public function Generates a URL or path for a specific route based on the given parameters. 4
UrlGeneratorInterface::NETWORK_PATH constant Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH constant Generates a relative path based on the current request path, e.g. "../parent-file".
VersatileGeneratorInterface::getRouteDebugMessage public function Convert a route identifier (name, content object etc) into a string usable for logging and other debug/error messages 2
VersatileGeneratorInterface::supports public function Whether this generator supports the supplied $name. 2