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: 

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

/**
 * Responsibility: configurable protected properties with getters and setters,
 *                 internal protected properties and internal methods used 
 *                 in most extended router implementations bellow.
 * Trait for classes:
 * - `\MvcCore\Ext\Routers\Media`
 * - `\MvcCore\Ext\Routers\Localization`
 * - `\MvcCore\Ext\Routers\MediaAndLocalization`
 */
trait Redirect {

    /**
     * Redirect to target media site version and localization version with path and query string.
     * @param array $systemParams 
     * @return array `string $urlBaseSection, string $urlPathWithQuerySection, array $systemParams, bool|NULL $urlPathWithQueryIsHome`
     */
    protected abstract function redirectToVersionSections ($systemParams);

    /**
     * Redirect to target media site version with path and by cloned request 
     * object global `$_GET` collection. Return always `FALSE`.
     * @param array $systemParams 
     * @return bool
     */
    protected function redirectToVersion ($systemParams) {
        /** @var $this \MvcCore\Ext\Routers\Extended|\MvcCore\Router */
        // get domain with base path url section, 
        // path with query string url section 
        // system params for url prefixes
        // and if path with query string url section targeting `/` or `/index.php`
        list ($urlBaseSection, $urlPathWithQuerySection, $systemParams, $urlPathWithQueryIsHome) 
            = $this->redirectToVersionSections($systemParams);
        
        $targetUrl = $this->urlByRoutePrefixSystemParams(
            $urlBaseSection, $urlPathWithQuerySection, $systemParams, $urlPathWithQueryIsHome
        );

        $questionMarkPos = mb_strpos($targetUrl, '?');
        if ($questionMarkPos !== FALSE) $targetUrl = mb_substr($targetUrl, 0, $questionMarkPos);
        
        /** @var $request \MvcCore\Request */
        $request = $this->request;
        $fullOriginalUrl = $request->GetBaseUrl() . $request->GetOriginalPath() . $request->GetQuery(TRUE);
        
        if ($fullOriginalUrl === $targetUrl) return TRUE;
        
        $this->redirect($targetUrl, $this->redirectStatusCode, 'Extended router redirect');

        return FALSE;
    }
}