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: 

<?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\Media;

trait UrlByRouteSectionsMedia {

    /**
     * Return media site version for result URL as media site version param name 
     * string and media site version param value string. 
     * 
     * If media site version is specified in given params array, return this 
     * media site version. If there is not any specific media site version in 
     * params array, try to look into given default params array and if there is 
     * also nothing, use current media site version from router (which could be 
     * from session or from request). Change params array and add special media 
     * site version switch param when router is configured to hold media site 
     * version strictly in session. But do not return any media site version for 
     * not allowed route methods and do not return any not allowed values for 
     * media site version.
     * @param \MvcCore\Route $route 
     * @param array $params 
     * @param string|NULL $routeMethod 
     * @return array `[string $mediaVersionUrlParam, string $mediaSiteUrlValue]`
     */
    protected function urlByRouteSectionsMedia (\MvcCore\IRoute $route, array & $params = [], array & $defaultParams = [], $routeMethod = NULL) {
        /** @var $this \MvcCore\Ext\Routers\Media */
        // separate `$mediaSiteVersion` from `$params` to work with the version more specifically
        $mediaVersionUrlParam = static::URL_PARAM_MEDIA_VERSION;
        if (isset($params[$mediaVersionUrlParam])) {
            $mediaSiteVersion = $params[$mediaVersionUrlParam];
            unset($params[$mediaVersionUrlParam]);
        } else if (isset($defaultParams[$mediaVersionUrlParam])) {
            $mediaSiteVersion = $defaultParams[$mediaVersionUrlParam];
            unset($defaultParams[$mediaVersionUrlParam]);
        } else {
            $mediaSiteVersion = $this->mediaSiteVersion;
        }
        
        // get url version value from application value (only for allowed request types)
        $routeMethod = $route->GetMethod();
        if ($this->routeGetRequestsOnly && $routeMethod !== NULL && $routeMethod !== \MvcCore\IRequest::METHOD_GET) {
            $mediaSiteUrlValue = NULL;
        } else if (isset($this->allowedMediaVersionsAndUrlValues[$mediaSiteVersion])) {
            $mediaSiteUrlValue = $this->allowedMediaVersionsAndUrlValues[$mediaSiteVersion];
        } else {
            $mediaSiteUrlValue = NULL;
            trigger_error(
                '['.get_class().'] Not allowed media site version used to generate url: `'
                .$mediaSiteVersion.'`. Allowed values: `'
                .implode('`, `', array_keys($this->allowedMediaVersionsAndUrlValues)) . '`.',
                E_USER_ERROR
            );
        }
        // add special switching param to global get, if strict session mode and target version is different
        if ($this->stricModeBySession && $mediaSiteVersion !== NULL && $mediaSiteVersion !== $this->mediaSiteVersion) 
            $params[static::URL_PARAM_SWITCH_MEDIA_VERSION] = $mediaSiteVersion;

        return [$mediaVersionUrlParam, $mediaSiteUrlValue];
    }
}