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: 

<?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\Ext\Routers\Module;

trait UrlByRoute {

    /**
     * Complete relative (or absolute) URL by route instance reverse info. If 
     * there is defined any target module in `$params`, absolute URL is returned.
     * Example:
     *  Input (`\MvcCore\Route::$reverse`):
     *      `"/products-list/<name>/<color>"`
     *  Input ($params):
     *      `array(
     *          "name"          => "cool-product-name",
     *          "color"         => "red",
     *          "variant"       => ["L", "XL"],
     *          "media_version" => "mobile",
     *          "localization"  => "en-US",
     *      );`
     *  Output (relative):
     *      `/application/base-bath/products-list/cool-product-name/blue?variant[]=L&amp;variant[]=XL"`
     *  Output (absolute):
     *      `https://domain.com/application/base-bath/products-list/cool-product-name/blue?variant[]=L&amp;variant[]=XL"`
     * @param \MvcCore\Route &$route
     * @param array $params
     * @param string $urlParamRouteName
     * @return string
     */
    public function UrlByRoute (\MvcCore\IRoute $route, array & $params = [], $urlParamRouteName = NULL) {
        /** @var $this \MvcCore\Ext\Routers\Module */
        $moduleParamName = static::URL_PARAM_MODULE;
        $moduleParamDefined = isset($params[$moduleParamName]);
        $currentDomainRouteMatched = $this->currentDomainRoute !== NULL;
        
        if (
            $route->GetAbsolute() && $moduleParamDefined && $currentDomainRouteMatched &&
            $params[$moduleParamName] !== $this->requestedDomainParams[$moduleParamName]
        ) 
            throw new \InvalidArgumentException(
                "[".get_class()."] It's not possible to create URL address "
                ."to different module/domain for route defined as absolute."
            );

        list ($targetModule, $targetDomainRoute, $domainParamsDefault) = $this->urlGetDomainRouteAndDefaultDomainParams(
            $params, $moduleParamDefined, $currentDomainRouteMatched
        );

        $domainUrlBaseSection = NULL;
        if ($targetModule !== NULL) 
            $domainUrlBaseSection = $this->urlGetDomainUrlAndClasifyParamsAndDomainParams(
                $params, $domainParamsDefault, $targetDomainRoute
            );
        
        // get domain with base path URL section, 
        // path with query string URL section 
        // and system params for URL prefixes
        list($urlBaseSection, $urlPathWithQuerySection, $systemParams) = $this->urlByRouteSections(
            $route, $params, $urlParamRouteName
        );

        if ($targetModule !== NULL) 
            $systemParams = array_diff_key($systemParams, $domainParamsDefault);
        
        $urlPathWithQueryIsHome = NULL;
        
        // create prefixed URL
        return $this->urlByRoutePrefixSystemParams(
            $domainUrlBaseSection ?: $urlBaseSection, 
            $urlPathWithQuerySection, 
            $systemParams, 
            $urlPathWithQueryIsHome
        );
    }
}