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 74 75 76 77 78 79 80 81 82 83 
<?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;

/**
 * Patchable helpers.
 *
 * @method static string contextualize() contextualize($pathname)
 * @method static string decontextualize() decontextualize($pathname)
 * @method static string absolutize_url() absolutize_url($url)
 */
class Helpers
{
    static private $mapping = [

        'contextualize'   => [ __CLASS__, 'default_contextualize' ],
        'decontextualize' => [ __CLASS__, 'default_decontextualize' ],
        'absolutize_url'  => [ __CLASS__, 'default_absolutize_url' ]

    ];

    /**
     * Calls the callback of a patchable function.
     *
     * @param string $name Name of the function.
     * @param array $arguments Arguments.
     *
     * @return mixed
     */
    static public function __callStatic($name, array $arguments)
    {
        return call_user_func_array(self::$mapping[$name], $arguments);
    }

    /**
     * Patches a patchable function.
     *
     * @param string $name Name of the function.
     * @param callable $callback Callback.
     *
     * @throws \RuntimeException is attempt to patch an undefined function.
     */
    // @codeCoverageIgnoreStart
    static public function patch($name, $callback)
    {
        if (empty(self::$mapping[$name]))
        {
            throw new \RuntimeException("Undefined patchable: $name.");
        }

        self::$mapping[$name] = $callback;
    }
    // @codeCoverageIgnoreEnd

    /*
     * Default implementations
     */

    static protected function default_contextualize($pathname)
    {
        return $pathname;
    }

    static protected function default_decontextualize($pathname)
    {
        return $pathname;
    }

    static protected function default_absolutize_url($url)
    {
        return 'http://' . $_SERVER['HTTP_HOST'] . $url;
    }
}
ICanBoogie/Routing master API documentation generated by ApiGen