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: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 

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

trait GettersSetters {

    /**
     * @inheritDocs
     * @param string $name Parameter string name.
     * @param string|array|bool $pregReplaceAllowedChars If String - list of regular expression characters to only keep, if array - `preg_replace()` pattern and reverse, if `FALSE`, raw value is returned.
     * @param mixed $ifNullValue Default value returned if given param name is null.
     * @param string $targetType Target type to retype param value or default if-null value. If param is an array, every param item will be retyped into given target type.
     * @return string|\string[]|int|\int[]|bool|\bool[]|array|mixed
     */
    public function GetParam (
        $name = "",
        $pregReplaceAllowedChars = "a-zA-Z0-9_;, /\-\@\:",
        $ifNullValue = NULL,
        $targetType = NULL
    ) {
        /** @var $this \MvcCore\Controller */
        return $this->request->GetParam(
            $name, $pregReplaceAllowedChars, $ifNullValue, $targetType
        );
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Application
     */
    public function GetApplication () {
        /** @var $this \MvcCore\Controller */
        return $this->application;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Application $application
     * @return \MvcCore\Controller
     */
    public function SetApplication (\MvcCore\IApplication $application) {
        /** @var $this \MvcCore\Controller */
        /** @var $application \MvcCore\Application */
        $this->application = $application;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Environment
     */
    public function GetEnvironment() {
        /** @var $this \MvcCore\Controller */
        return $this->environment;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Environment $environment
     * @return \MvcCore\Controller
     */
    public function SetEnvironment (\MvcCore\IEnvironment $environment) {
        /** @var $this \MvcCore\Controller */
        /** @var $environment \MvcCore\Environment */
        $this->environment = $environment;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Request
     */
    public function GetRequest () {
        /** @var $this \MvcCore\Controller */
        return $this->request;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Request $request
     * @return \MvcCore\Controller
     */
    public function SetRequest (\MvcCore\IRequest $request) {
        /** @var $this \MvcCore\Controller */
        /** @var $request \MvcCore\Request */
        $this->request = $request;
        $this->controllerName = ltrim($request->GetControllerName(), '/');
        $this->actionName = $request->GetActionName();
        $this->ajax = $request->IsAjax();
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetControllerName () {
        /** @var $this \MvcCore\Controller */
        return $this->controllerName;
    }

    /**
     * @inheritDocs
     * @param string $controllerName 
     * @return \MvcCore\Controller
     */
    public function SetControllerName ($controllerName) {
        /** @var $this \MvcCore\Controller */
        $this->controllerName = $controllerName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetActionName () {
        /** @var $this \MvcCore\Controller */
        return $this->actionName;
    }

    /**
     * @inheritDocs
     * @param string $actionName
     * @return \MvcCore\Controller
     */
    public function SetActionName ($actionName) {
        /** @var $this \MvcCore\Controller */
        $this->actionName = $actionName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Response
     */
    public function GetResponse () {
        /** @var $this \MvcCore\Controller */
        return $this->response;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Response $response
     * @return \MvcCore\Controller
     */
    public function SetResponse (\MvcCore\IResponse $response) {
        /** @var $this \MvcCore\Controller */
        /** @var $response \MvcCore\Response */
        $this->response = $response;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Router
     */
    public function GetRouter () {
        /** @var $this \MvcCore\Controller */
        return $this->router;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Router $router
     * @return \MvcCore\Controller
     */
    public function SetRouter (\MvcCore\IRouter $router) {
        /** @var $this \MvcCore\Controller */
        /** @var $router \MvcCore\Router */
        $this->router = $router;
        return $this;
    }

    /**
     * @inheritDocs
     * @return boolean
     */
    public function IsAjax () {
        /** @var $this \MvcCore\Controller */
        return $this->ajax;
    }
    
    /**
     * @inheritDocs
     * @param boolean $ajax 
     * @return \MvcCore\Controller
     */
    public function SetIsAjax ($ajax) {
        /** @var $this \MvcCore\Controller */
        $this->ajax = $ajax;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Model
     */
    public function GetUser () {
        /** @var $this \MvcCore\Controller */
        return $this->user;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Model $user
     * @return \MvcCore\Controller
     */
    public function SetUser ($user) {
        /** @var $this \MvcCore\Controller */
        $this->user = $user;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\View|NULL
     */
    public function GetView () {
        /** @var $this \MvcCore\Controller */
        return $this->view;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\View $view
     * @return \MvcCore\Controller
     */
    public function SetView (\MvcCore\IView $view) {
        /** @var $this \MvcCore\Controller */
        /** @var $view \MvcCore\View */
        $this->view = $view;
        return $this;
    }

    /**
     * @inheritDocs
     * @return int
     */
    public function GetRenderMode () {
        /** @var $this \MvcCore\Controller */
        return $this->renderMode;
    }

    /**
     * @inheritDocs
     * @param int $renderMode
     * @return \MvcCore\Controller
     */
    public function SetRenderMode ($renderMode = \MvcCore\IView::RENDER_WITH_OB_FROM_ACTION_TO_LAYOUT) {
        /** @var $this \MvcCore\Controller */
        $this->renderMode = $renderMode;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetLayout () {
        /** @var $this \MvcCore\Controller */
        return $this->layout;
    }

    /**
     * @inheritDocs
     * @param string $layout
     * @return \MvcCore\Controller
     */
    public function SetLayout ($layout = '') {
        /** @var $this \MvcCore\Controller */
        $this->layout = $layout;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetViewScriptsPath () {
        /** @var $this \MvcCore\Controller */
        return $this->viewScriptsPath;
    }

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

    /**
     * @inheritDocs
     * @return bool
     */
    public function GetViewEnabled () {
        /** @var $this \MvcCore\Controller */
        return $this->viewEnabled;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Controller
     */
    public function SetViewEnabled ($viewEnabled = TRUE) {
        /** @var $this \MvcCore\Controller */
        $this->viewEnabled = $viewEnabled;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Controller|NULL
     */
    public function GetParentController () {
        /** @var $this \MvcCore\Controller */
        return $this->parentController;
    }

    /**
     * @inheritDocs
     * @param \MvcCore\Controller|NULL $parentController
     * @return \MvcCore\Controller
     */
    public function SetParentController (\MvcCore\IController $parentController = NULL) {
        /** @var $this \MvcCore\Controller */
        /** @var $parentController \MvcCore\Controller */
        $this->parentController = $parentController;
        return $this;
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Controller[]
     */
    public function GetChildControllers () {
        /** @var $this \MvcCore\Controller */
        return $this->childControllers;
    }

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

    /**
     * @inheritDocs
     * @param string|int $index
     * @return \MvcCore\Controller
     */
    public function GetChildController ($index = NULL) {
        /** @var $this \MvcCore\Controller */
        return $this->childControllers[$index];
    }

    /**
     * @inheritDocs
     * @param string $appRootRelativePath Any config relative path like `'/%appPath%/website.ini'`.
     * @return \MvcCore\Config|NULL
     */
    public function GetConfig ($appRootRelativePath) {
        /** @var $this \MvcCore\Controller */
        $configClass = $this->application->GetConfigClass();
        return $configClass::GetConfig($appRootRelativePath);
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Config|NULL
     */
    public function GetSystemConfig () {
        /** @var $this \MvcCore\Controller */
        $configClass = $this->application->GetConfigClass();
        return $configClass::GetSystem();
    }

    /**
     * @inheritDocs
     * @param string $controllerActionOrRouteName   Should be `"Controller:Action"` combination or just any route name as custom specific string.
     * @param array  $params                        Optional, array with params, key is param name, value is param value.
     * @return string
     */
    public function Url ($controllerActionOrRouteName = 'Index:Index', array $params = []) {
        /** @var $this \MvcCore\Controller */
        return $this->router->Url($controllerActionOrRouteName, $params);
    }

    /**
     * @inheritDocs
     * @param string $path
     * @return string
     */
    public function AssetUrl ($path = '') {
        /** @var $this \MvcCore\Controller */
        return $this->router->Url('Controller:Asset', ['path' => $path]);
    }
}