bootstrap.hh

<?hh
/**
 * @copyright   2010-2015, The Titon Project
 * @license     http://opensource.org/licenses/bsd-license.php
 * @link        http://titon.io
 */

/**
 * --------------------------------------------------------------
 *  Type Aliases
 * --------------------------------------------------------------
 *
 * Defines type aliases that are used by the route package.
 */

namespace Titon\Route {
    use Titon\Route\Group as RouteGroup;

    type Action = shape('class' => string, 'action' => string);
    type ArgumentList = array<mixed>;
    type FilterCallback = (function(Router, Route): void);
    type FilterMap = Map<string, FilterCallback>;
    type GroupCallback = (function(Router, RouteGroup): void);
    type GroupList = Vector<RouteGroup>;
    type ParamMap = Map<string, mixed>;
    type QueryMap = Map<string, mixed>;
    type ResourceMap = Map<string, string>;
    type RouteCallback = (function(...): mixed);
    type RouteMap = Map<string, Route>;
    type SegmentMap = Map<string, mixed>;
    type Token = shape('token' => string, 'optional' => bool);
    type TokenList = Vector<Token>;
}

namespace Titon\Route\Mixin {
    use Titon\Route\Route;

    type ConditionCallback = (function(Route): bool);
    type ConditionList = Vector<ConditionCallback>;
    type FilterList = Vector<string>;
    type MethodList = Vector<string>;
    type PatternMap = Map<string, string>;
}

/**
 * --------------------------------------------------------------
 *  Annotations
 * --------------------------------------------------------------
 *
 * Registers all annotations declared in the route packages.
 */

namespace {
    use Titon\Annotation\Registry;

    if (class_exists('Titon\Annotation\Annotation')) {
        Registry::map('Route', 'Titon\Route\Annotation\Route');
    }
}

/**
 * --------------------------------------------------------------
 *  Helper Functions
 * --------------------------------------------------------------
 *
 * Defines global helper functions for common use cases.
 */

namespace {
    use Titon\Route\ParamMap;
    use Titon\Route\QueryMap;
    use Titon\Route\UrlBuilder;
    use Titon\Context\Depository;

    /**
     * @see Titon\Route\UrlBuilder::getAbsoluteUrl()
     */
    function current_url(): string {
        return builder_context()->getAbsoluteUrl();
    }

    /**
     * @see Titon\Route\UrlBuilder::build()
     */
    function url(string $key, ParamMap $params = Map {}, QueryMap $query = Map {}): string {
        return builder_context()->build($key, $params, $query);
    }

    /**
     * @see Titon\Route\UrlBuilder::getSegment()
     */
    function url_segment(string $segment): mixed {
        return builder_context()->getSegment($segment);
    }

    /**
     * Make and return a `UrlBuilder` instance from the depository.
     *
     * @return \Titon\Route\UrlBuilder
     */
    function builder_context(): UrlBuilder {
        $builder = Depository::getInstance()->make('Titon\Route\UrlBuilder');

        invariant($builder instanceof UrlBuilder, 'Must be a UrlBuilder.');

        return $builder;
    }

}