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:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Router;

trait UrlBuilding {

    /**
     * @inheritDocs
     * @param string $controllerActionOrRouteName
     *              Should be `"Controller:Action"` combination or just any 
     *              route name as custom specific string.
     * @param array  $params
     *              Optional, array with params, key is param name, value is 
     *              param value.
     * @throws \InvalidArgumentException
     * @return string
     */
    public function Url ($controllerActionOrRouteName = 'Index:Index', array $params = []) {
        /** @var $this \MvcCore\Router */
        $result = '';
        $ctrlActionOrRouteNameKey = $this->urlGetCompletedCtrlActionKey(
            $controllerActionOrRouteName
        );
        if ($this->anyRoutesConfigured && !(
            $this->routeByQueryString && 
            $ctrlActionOrRouteNameKey === static::DEFAULT_ROUTE_NAME
        )) {
            // try to found URL route in global `$this->urlRoutes` store
            if (
                isset($this->urlRoutes[$controllerActionOrRouteName]) && 
                $this->urlRoutes[$controllerActionOrRouteName]->GetName() !== static::DEFAULT_ROUTE_NAME
            ) {
                // if there was a route under `$controllerActionOrRouteName` key already, 
                // we can complete URL by this route
                $result = $this->UrlByRoute(
                    $this->urlRoutes[$controllerActionOrRouteName], 
                    $params, $controllerActionOrRouteName
                );
            } else if (
                isset($this->urlRoutes[$ctrlActionOrRouteNameKey]) && 
                $this->urlRoutes[$ctrlActionOrRouteNameKey]->GetName() !== static::DEFAULT_ROUTE_NAME
            ) {
                // if there was a route under `$ctrlActionOrRouteNameKey` key already, 
                // we can complete URL by this route
                $result = $this->UrlByRoute(
                    $this->urlRoutes[$ctrlActionOrRouteNameKey], 
                    $params, $controllerActionOrRouteName
                );
            } else {
                // if there is no route under key `$ctrlActionOrRouteNameKey` yet, 
                // try to call configured `$this->preRouteUrlBuildingHandler` if any
                // to load more routes for example from database and than, try to
                // find route under key `$ctrlActionOrRouteNameKey` again
                $urlRouteFound = FALSE;
                if (!isset($this->noUrlRoutes)) {
                    if ($this->preRouteUrlBuildingHandler !== NULL) {
                        $newUrlRoutes = call_user_func(
                            $this->preRouteUrlBuildingHandler, 
                            $this, $ctrlActionOrRouteNameKey, $params
                        );
                        if (is_array($newUrlRoutes) && $newUrlRoutes) 
                            $this->urlRoutes = array_merge($newUrlRoutes, $this->urlRoutes);
                    }
                    // try to found URL route again
                    if (isset($this->urlRoutes[$ctrlActionOrRouteNameKey]) && $this->urlRoutes[$ctrlActionOrRouteNameKey]->GetName() !== static::DEFAULT_ROUTE_NAME) {
                        $urlRouteFound = TRUE;
                    } else {
                        $this->noUrlRoutes[$ctrlActionOrRouteNameKey] = TRUE;
                    }
                }
                if ($urlRouteFound) {
                    // if route under key `$ctrlActionOrRouteNameKey` has been loaded by calling
                    // configured handler `$this->preRouteUrlBuildingHandler`, complete URL by this route
                    $result = $this->UrlByRoute(
                        $this->urlRoutes[$ctrlActionOrRouteNameKey], 
                        $params, $controllerActionOrRouteName
                    );
                } else {
                    // there is probably no route for given key `$ctrlActionOrRouteNameKey`,
                    // so complete result URL with query string logic
                    $result = $this->UrlByQueryString(
                        $ctrlActionOrRouteNameKey, 
                        $params, $controllerActionOrRouteName
                    );
                }
            }
        } else {
            // if there are no URL routes configured - complete URL with query string logic
            $result = $this->UrlByQueryString(
                $ctrlActionOrRouteNameKey, 
                $params, $controllerActionOrRouteName
            );
        }
        return $result;
    }

    /**
     * Correct `Url()` method first argument. Given controller and/or action
     * combination could have missing controller or missing actions. If there is
     * colon character in first Url() method argument, complete missing value 
     * with default controller name or default action. 
     * If first `Url()` method argument is `self` keyword, return self route name
     * value from routing process.
     * @param string $controllerActionOrRouteName Should be `"Controller:Action"` combination or just any route name as custom specific string.
     * @return mixed
     */
    protected function urlGetCompletedCtrlActionKey ($controllerActionOrRouteName) {
        /** @var $this \MvcCore\Router */
        $result = $controllerActionOrRouteName;
        if (strpos($controllerActionOrRouteName, ':') !== FALSE) {
            list($ctrlPc, $actionPc) = explode(':', $controllerActionOrRouteName);
            if (!$ctrlPc) {
                $toolClass = self::$toolClass;
                $ctrlPc = str_replace('/', '\\', 
                    $toolClass::GetPascalCaseFromDashed($this->request->GetControllerName())
                );
            }
            if (!$actionPc) {
                $toolClass = self::$toolClass;
                $actionPc = $toolClass::GetPascalCaseFromDashed($this->request->GetActionName());
            }
            $result = "{$ctrlPc}:{$actionPc}";
        } else if ($controllerActionOrRouteName == 'self') {
            $result = $this->selfRouteName;
        }
        return $result;
    }
}