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

/**
 * 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\Localization;

trait UrlByRouteSections {

    /**
     * Complete semi-finished result URL as two section strings and system 
     * params array. First section as base section with scheme, domain and base 
     * path, second section as application requested path and query string and 
     * third section as system params like `localization`.
     * Those params could be inserted between first two sections as system 
     * params in result URL by localized router behaviour and default values.
     * Example:
     *  Input (`\MvcCore\Route::$reverse`):
     *  `[
     *      "en"    => "/products-list/<name>/<color>"`,
     *      "de"    => "/produkt-liste/<name>/<color>"`,
     *  ]`
     *  Input ($params):
     *      `array(
     *          "name"          => "cool-product-name",
     *          "color"         => "red",
     *          "variant"       => ["L", "XL"],
     *          "localization"  => "en-US",
     *      );`
     *  Output:
     *      `[
     *          "/application/base/bath", 
     *          "/products-list/cool-product-name/blue?variant[]=L&amp;variant[]=XL", 
     *          ["localization" => "en-US"]
     *      ]`
     * @param \MvcCore\Route $route
     * @param array $params
     * @param string $urlParamRouteName
     * @return array `string $urlBaseSection, string $urlPathWithQuerySection, array $systemParams`
     */
    protected function urlByRouteSections (\MvcCore\IRoute $route, array & $params = [], $urlParamRouteName = NULL) {
        /** @var $route \MvcCore\Route */
        $defaultParams = array_merge([], $this->GetDefaultParams() ?: []);
        if ($urlParamRouteName == 'self') 
            $params = array_merge($this->requestedParams, $params);
        $routeMethod = $route->GetMethod();


        $multipleLocalizationsConfigured = count($this->allowedLocalizations) > 1;
        $localizationParamName = $localizationStr = NULL;
        if ($multipleLocalizationsConfigured) 
            list($localizationParamName, $localizationStr) = $this->urlByRouteSectionsLocalization(
                $route, $params, $routeMethod
            );


        // complete by given route base url address part and part with path and query string
        list($urlBaseSection, $urlPathWithQuerySection) = $route->Url(
            $this->request, $params, $defaultParams, $this->getQueryStringParamsSepatator(), TRUE
        );


        $systemParams = [];
        if ($multipleLocalizationsConfigured && $localizationStr !== NULL) 
            $systemParams[$localizationParamName] = $localizationStr;


        return [
            $urlBaseSection, 
            $urlPathWithQuerySection, 
            $systemParams
        ];
    }
}