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: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 

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

trait GettersSetters {

    /**
     *
     * @inheritDocs
     * @return string|array|NULL
     */
    public function GetPattern () {
        /** @var $this \MvcCore\Route */
        return $this->pattern;
    }

    /**
     * @inheritDocs
     * @param string|array $pattern
     * @return \MvcCore\Route
     */
    public function SetPattern ($pattern) {
        /** @var $this \MvcCore\Route */
        $this->pattern = $pattern;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|array|NULL
     */
    public function GetMatch () {
        /** @var $this \MvcCore\Route */
        return $this->match;
    }

    /**
     * @inheritDocs
     * @param string|array $match
     * @return \MvcCore\Route
     */
    public function SetMatch ($match) {
        /** @var $this \MvcCore\Route */
        $this->match = $match;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|array|NULL
     */
    public function GetReverse () {
        /** @var $this \MvcCore\Route */
        return $this->reverse;
    }

    /**
     * @inheritDocs
     * @param string|array $reverse
     * @return \MvcCore\Route
     */
    public function SetReverse ($reverse) {
        /** @var $this \MvcCore\Route */
        $this->reverse = $reverse;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetName () {
        /** @var $this \MvcCore\Route */
        return $this->name;
    }

    /**
     * @inheritDocs
     * @param string|NULL $name
     * @return \MvcCore\Route
     */
    public function SetName ($name) {
        /** @var $this \MvcCore\Route */
        $this->name = $name;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetController () {
        /** @var $this \MvcCore\Route */
        return $this->controller;
    }

    /**
     * @inheritDocs
     * @param string|NULL $controller
     * @return \MvcCore\Route
     */
    public function SetController ($controller) {
        /** @var $this \MvcCore\Route */
        $this->controller = $controller;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetAction () {
        /** @var $this \MvcCore\Route */
        return $this->action;
    }

    /**
     * @inheritDocs
     * @param string|NULL $action
     * @return \MvcCore\Route
     */
    public function SetAction ($action) {
        /** @var $this \MvcCore\Route */
        $this->action = $action;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetControllerAction () {
        /** @var $this \MvcCore\Route */
        return $this->controller . ':' . $this->action;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Route
     */
    public function SetControllerAction ($controllerAction) {
        /** @var $this \MvcCore\Route */
        list($ctrl, $action) = explode(':', $controllerAction);
        if ($ctrl)      $this->controller = $ctrl;
        if ($action)    $this->action = $action;
        return $this;
    }

    /**
     * @inheritDocs
     * @return array|\array[]
     */
    public function & GetDefaults () {
        /** @var $this \MvcCore\Route */
        return $this->defaults;
    }

    /**
     * @inheritDocs
     * @param array|\array[] $defaults
     * @return \MvcCore\Route
     */
    public function SetDefaults ($defaults = []) {
        /** @var $this \MvcCore\Route */
        $this->defaults = $defaults;
        return $this;
    }

    /**
     * @inheritDocs
     * @return array|\array[]
     */
    public function GetConstraints () {
        /** @var $this \MvcCore\Route */
        return $this->constraints;
    }

    /**
     * @inheritDocs
     * @param array|\array[] $constraints
     * @return \MvcCore\Route
     */
    public function SetConstraints ($constraints = []) {
        /** @var $this \MvcCore\Route */
        $this->constraints = $constraints;
        foreach ($constraints as $key => $value)
            if (!isset($this->defaults[$key]))
                $this->defaults[$key] = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return array|\callable[]
     */
    public function & GetFilters () {
        /** @var $this \MvcCore\Route */
        $filters = [];
        foreach ($this->filters as $direction => $handler) 
            $filters[$direction] = $handler[1];
        return $filters;
    }

    /**
     * @inheritDocs
     * @param array|\callable[] $filters 
     * @return \MvcCore\Route
     */
    public function SetFilters (array $filters = []) {
        /** @var $this \MvcCore\Route */
        foreach ($filters as $direction => $handler) 
            $this->SetFilter($handler, $direction);
        return $this;
    }

    /**
     * @inheritDocs
     * @return \callable|NULL
     */
    public function GetFilter ($direction = \MvcCore\IRoute::CONFIG_FILTER_IN) {
        /** @var $this \MvcCore\Route */
        return isset($this->filters[$direction])
            ? $this->filters[$direction]
            : NULL;
    }

    /**
     * @inheritDocs
     * @param \callable $handler 
     * @param string $direction
     * @return \MvcCore\Route
     */
    public function SetFilter ($handler, $direction = \MvcCore\IRoute::CONFIG_FILTER_IN) {
        /** @var $this \MvcCore\Route */
        // there is possible to call any `callable` as closure function in variable
        // except forms like `'ClassName::methodName'` and `['childClassName', 'parent::methodName']`
        // and `[$childInstance, 'parent::methodName']`.
        $closureCalling = (
            (is_string($handler) && strpos($handler, '::') !== FALSE) ||
            (is_array($handler) && strpos($handler[1], '::') !== FALSE)
        ) ? FALSE : TRUE;
        $this->filters[$direction] = [$closureCalling, $handler];
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetMethod () {
        /** @var $this \MvcCore\Route */
        return $this->method;
    }

    /**
     * @inheritDocs
     * @param string|NULL $method
     * @return \MvcCore\Route
     */
    public function SetMethod ($method = NULL) {
        /** @var $this \MvcCore\Route */
        $this->method = strtoupper($method);
        return $this;
    }
    
    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetRedirect () {
        /** @var $this \MvcCore\Route */
        return $this->redirect;
    }

    /**
     * @inheritDocs
     * @param string|NULL $redirectRouteName 
     * @return \MvcCore\Route
     */
    public function SetRedirect ($redirectRouteName = NULL) {
        /** @var $this \MvcCore\Route */
        $this->redirect = $redirectRouteName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function GetAbsolute () {
        /** @var $this \MvcCore\Route */
        return $this->absolute || (isset($this->flags[0]) && ((bool)$this->flags[0]));
    }

    /**
     * @inheritDocs
     * @param bool $absolute 
     * @return \MvcCore\Route
     */
    public function SetAbsolute ($absolute = TRUE) {
        /** @var $this \MvcCore\Route */
        $this->absolute = $absolute;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetGroupName () {
        /** @var $this \MvcCore\Route */
        return $this->groupName;
    }

    /**
     * @inheritDocs
     * @param string|NULL $groupName 
     * @return \MvcCore\Route
     */
    public function SetGroupName ($groupName) {
        /** @var $this \MvcCore\Route */
        $this->groupName = $groupName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \string[]|NULL
     */
    public function GetReverseParams () {
        /** @var $this \MvcCore\Route */
        return $this->reverseParams !== NULL 
            ? array_keys($this->reverseParams)
            : [];
    }

    /**
     * @inheritDocs
     * @param array $matchedParams
     * @return \MvcCore\Route
     */
    public function SetMatchedParams ($matchedParams = []) {
        /** @var $this \MvcCore\Route */
        $this->matchedParams = $matchedParams;
        return $this;
    }

    /**
     * @inheritDocs
     * @return array|NULL
     */
    public function & GetMatchedParams () {
        /** @var $this \MvcCore\Route */
        return $this->matchedParams;
    }
    
    /**
     * @inheritDocs
     * @return \MvcCore\Router
     */
    public function GetRouter () {
        /** @var $this \MvcCore\Route */
        return $this->router;
    }
    
    /**
     * @inheritDocs
     * @param \MvcCore\Router $router 
     * @return \MvcCore\Route
     */
    public function SetRouter (\MvcCore\IRouter $router) {
        /** @var $this \MvcCore\Route */
        /** @var $router \MvcCore\Router */
        $this->router = $router;
        return $this;
    }

    /**
     * @inheritDocs
     * @param string $propertyName 
     * @return mixed
     */
    public function GetAdvancedConfigProperty ($propertyName) {
        /** @var $this \MvcCore\Route */
        $result = NULL;
        if (isset($this->config[$propertyName]))
            $result = $this->config[$propertyName];
        return $result;
    }
}