ICanBoogie/Routing master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Routing
      • Controller
      • Route
      • RouteDispatcher

Classes

  • Controller
  • FormattedRoute
  • Helpers
  • Pattern
  • Route
  • RouteCollection
  • RouteDefinition
  • RouteDispatcher
  • RouteMaker

Interfaces

  • Exception
  • ToSlug

Exceptions

  • ActionNotDefined
  • ControllerNotDefined
  • PatternNotDefined
  • PatternRequiresValues
  • RouteNotDefined

Functions

  • absolutize_url
  • contextualize
  • decontextualize
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Routing;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * Representation of a formatted route.
 *
 * @property-read string $url Relative URL.
 * @property-read string $absolute_url Absolute URL, absolutized with {@link absolutize_url()}.
 * @property-read Route $route The route that was used to format the URL.
 */
class FormattedRoute
{
    use AccessorTrait;

    /**
     * The relative URL created by {@link Route::format()}.
     *
     * @var string
     */
    protected $url;

    protected function get_url()
    {
        return contextualize((string) $this);
    }

    protected function get_absolute_url()
    {
        return absolutize_url($this->get_url());
    }

    /**
     * The {@link Route} instance that created this instance.
     *
     * @var Route
     */
    protected $route;

    protected function get_route()
    {
        return $this->route;
    }

    /**
     * Initialize the {@link $url} and {@link $route} properties.
     *
     * @param string $url
     * @param Route $route
     */
    public function __construct($url, Route $route)
    {
        $this->url = $url;
        $this->route = $route;
    }

    public function __toString()
    {
        return $this->url;
    }
}
ICanBoogie/Routing master API documentation generated by ApiGen