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: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: 794: 795: 796: 797: 798: 799: 800: 801: 802: 803: 804: 805: 806: 807: 808: 809: 810: 811: 812: 

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

trait GettersSetters {

    /**
     * @inheritDocs
     * @param \string[] $twoSegmentTlds,... List of two-segment top-level domains without leading dot.
     * @return void
     */
    public static function AddTwoSegmentTlds ($twoSegmentTlds) {
        $tlds = func_get_args();
        if (count($tlds) === 1 && is_array($tlds[0])) $tlds = $tlds[0];
        foreach ($tlds as $tld) self::$twoSegmentTlds[$tld] = TRUE;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsInternalRequest () {
        if ($this->appRequest === NULL) {
            try {
                $ctrl = $this->GetControllerName();
                $action = $this->GetActionName();
            } catch (\Exception $e) { // backward compatibility
                $ctrl = NULL;
                $action = NULL;
            } catch (\Throwable $e) {
                $ctrl = NULL;
                $action = NULL;
            }
            if ($ctrl !== NULL && $action !== NULL) {
                $this->appRequest = FALSE;
                if ($ctrl === 'controller' && $action === 'asset')
                    $this->appRequest = TRUE;
            }
        }
        return $this->appRequest;
    }

    /**
     * @inheritDocs
     * @param string $controllerName
     * @return \MvcCore\Request
     */
    public function SetControllerName ($controllerName) {
        /** @var $this \MvcCore\Request */
        $this->controllerName = $controllerName;
        $routerClass = self::$routerClass;
        $router = $routerClass::GetInstance();
        $this->params[$router::URL_PARAM_CONTROLLER] = $controllerName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetControllerName () {
        /** @var $this \MvcCore\Request */
        if ($this->controllerName === NULL) {
            $routerClass = self::$routerClass;
            $router = $routerClass::GetInstance();
            if (isset($this->globalGet[$router::URL_PARAM_CONTROLLER]))
                $this->controllerName = $this->GetParam($router::URL_PARAM_CONTROLLER, 'a-zA-Z0-9\-_/', '', 'string');
        }
        return $this->controllerName;
    }

    /**
     * @inheritDocs
     * @param string $actionName
     * @return \MvcCore\Request
     */
    public function SetActionName ($actionName) {
        /** @var $this \MvcCore\Request */
        $this->actionName = $actionName;
        $routerClass = self::$routerClass;
        $router = $routerClass::GetInstance();
        $this->params[$router::URL_PARAM_ACTION] = $actionName;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetActionName () {
        /** @var $this \MvcCore\Request */
        if ($this->actionName === NULL) {
            $routerClass = self::$routerClass;
            $router = $routerClass::GetInstance();
            if (isset($this->globalGet[$router::URL_PARAM_ACTION]))
                $this->actionName = $this->GetParam($router::URL_PARAM_ACTION, 'a-zA-Z0-9\-_', '', 'string');
        }
        return $this->actionName;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsCli () {
        /** @var $this \MvcCore\Request */
        return $this->cli;
    }

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

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetLang () {
        /** @var $this \MvcCore\Request */
        if ($this->lang === NULL) $this->initLangAndLocale();
        return $this->lang;
    }

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

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetLocale () {
        /** @var $this \MvcCore\Request */
        if ($this->locale === NULL) $this->initLangAndLocale();
        return $this->locale;
    }

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

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetMediaSiteVersion () {
        /** @var $this \MvcCore\Request */
        return $this->mediaSiteVersion;
    }


    /**
     * @inheritDocs
     * @param string $name
     * @param array  $arguments
     * @throws \InvalidArgumentException
     * @return mixed|\MvcCore\Request
     */
    public function __call ($rawName, $arguments = []) {
        /** @var $this \MvcCore\Request */
        $nameBegin = strtolower(substr($rawName, 0, 3));
        $name = substr($rawName, 3);
        $lcName = lcfirst($name);
        if ($nameBegin == 'get') {
            if (property_exists($this, $lcName)) 
                return $this->{$lcName};
            if (property_exists($this, $name)) 
                return $this->$name;
            return NULL;
        } else if ($nameBegin == 'set') {
            $value = isset($arguments[0]) ? $arguments[0] : NULL;
            if (property_exists($this, $name)) {
                $this->{$name} = $value;
            } else {
                $this->{$lcName} = $value;
            }
            return $this;
        } else {
            throw new \InvalidArgumentException("[".get_class()."] No method `{$rawName}()` defined.");
        }
    }

    /**
     * @inheritDocs
     * @param string $name
     * @return mixed
     */
    public function __get ($name) {
        /** @var $this \MvcCore\Request */
        $lcPropName = lcfirst($name);
        if (isset($this->{$lcPropName}))
            return $this->{$lcPropName};
        if (isset($this->{$name}))
            return $this->{$name};
        return NULL;
    }

    /**
     * @inheritDocs
     * @param string $name
     * @param mixed  $value
     * @return \MvcCore\Request
     */
    public function __set ($name, $value) {
        /** @var $this \MvcCore\Request */
        $lcPropName = lcfirst($name);
        if (property_exists($this, $lcPropName))
            return $this->{$lcPropName} = $value;
        return $this->{$name} = $value;
    }


    /**
     * @inheritDocs
     * @return string
     */
    public function GetScriptName () {
        /** @var $this \MvcCore\Request */
        if ($this->scriptName === NULL) $this->initScriptNameAndBasePath();
        return $this->scriptName;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetAppRoot () {
        /** @var $this \MvcCore\Request */
        if ($this->appRoot === NULL) {
            // `ucfirst()` - cause IIS has lower case drive name here - different from __DIR__ value
            $indexFilePath = ucfirst(str_replace(['\\', '//'], '/', $this->globalServer['SCRIPT_FILENAME']));
            $this->appRoot = strpos(__FILE__, 'phar://') === 0
                ? 'phar://' . $indexFilePath
                : dirname($indexFilePath);
        }
        return $this->appRoot;
    }

    /**
     * @inheritDocs
     * @param string $rawMethod
     * @return \MvcCore\Request
     */
    public function SetMethod ($rawMethod) {
        /** @var $this \MvcCore\Request */
        $this->method = $rawMethod;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetMethod () {
        /** @var $this \MvcCore\Request */
        if ($this->method === NULL) {
            $this->method = strtoupper($this->globalServer['REQUEST_METHOD']);
        }
        return $this->method;
    }

    /**
     * @inheritDocs
     * @param string $rawBasePath
     * @return \MvcCore\Request
     */
    public function SetBasePath ($rawBasePath) {
        /** @var $this \MvcCore\Request */
        $this->basePath = $rawBasePath;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetBasePath () {
        /** @var $this \MvcCore\Request */
        if ($this->basePath === NULL) $this->initScriptNameAndBasePath();
        return $this->basePath;
    }

    /**
     * @inheritDocs
     * @param string $rawProtocol
     * @return \MvcCore\Request
     */
    public function SetScheme ($rawProtocol) {
        /** @var $this \MvcCore\Request */
        $this->scheme = $rawProtocol;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetScheme () {
        /** @var $this \MvcCore\Request */
        if ($this->scheme === NULL) {
            $this->scheme = (
                (isset($this->globalServer['HTTPS']) && strtolower($this->globalServer['HTTPS']) == 'on') ||
                $this->globalServer['SERVER_PORT'] == 443
            )
                ? static::SCHEME_HTTPS
                : static::SCHEME_HTTP;
        }
        return $this->scheme;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsSecure () {
        /** @var $this \MvcCore\Request */
        if ($this->secure === NULL)
            $this->secure = in_array($this->GetScheme(), [
                static::SCHEME_HTTPS,
                static::SCHEME_FTPS,
                static::SCHEME_IRCS,
                static::SCHEME_SSH
            ], TRUE);
        return $this->secure;
    }

    /**
     * @inheritDocs
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetReferer ($rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->referer === NULL) {
            $referer = isset($this->globalServer['HTTP_REFERER'])
                ? $this->globalServer['HTTP_REFERER']
                : '';
            if ($referer) {
                while (mb_strpos($referer, '%') !== FALSE)
                    $referer = rawurldecode($referer);
                $referer = filter_var($referer, FILTER_SANITIZE_URL) ?: '';
            }
            $this->referer = $referer;
        }
        return $rawInput ? $this->referer : static::HtmlSpecialChars($this->referer);
    }

    /**
     * @inheritDocs
     * @return float
     */
    public function GetStartTime () {
        /** @var $this \MvcCore\Request */
        if ($this->microtime === NULL) $this->microtime = $this->globalServer['REQUEST_TIME_FLOAT'];
        return $this->microtime;
    }

    /**
     * @inheritDocs
     * @param string|NULL $topLevelDomain
     * @return \MvcCore\Request
     */
    public function SetTopLevelDomain ($topLevelDomain) {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        $this->domainParts[2] = $topLevelDomain;
        $this->hostName = trim(implode('.', $this->domainParts), '.');
        if ($this->hostName && $this->portDefined)
            $this->host = $this->hostName . ':' . $this->port;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetTopLevelDomain () {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        return $this->domainParts[2];
    }

    /**
     * @inheritDocs
     * @param string|NULL $secondLevelDomain
     * @return \MvcCore\Request
     */
    public function SetSecondLevelDomain ($secondLevelDomain) {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        $this->domainParts[1] = $secondLevelDomain;
        $this->hostName = trim(implode('.', $this->domainParts), '.');
        if ($this->hostName && $this->portDefined)
            $this->host = $this->hostName . ':' . $this->port;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetSecondLevelDomain () {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        return isset($this->domainParts[1]) ? $this->domainParts[1] : NULL;
    }

    /**
     * @inheritDocs
     * @param string|NULL $thirdLevelDomain
     * @return \MvcCore\Request
     */
    public function SetThirdLevelDomain ($thirdLevelDomain) {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        $this->domainParts[0] = $thirdLevelDomain;
        $this->hostName = trim(implode('.', $this->domainParts), '.');
        if ($this->hostName && $this->portDefined)
            $this->host = $this->hostName . ':' . $this->port;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string|NULL
     */
    public function GetThirdLevelDomain () {
        /** @var $this \MvcCore\Request */
        if ($this->domainParts === NULL) $this->initDomainSegments();
        return isset($this->domainParts[0]) ? $this->domainParts[0] : NULL;
    }

    /**
     * @inheritDocs
     * @param string $rawHostName
     * @return \MvcCore\Request
     */
    public function SetHostName ($rawHostName) {
        /** @var $this \MvcCore\Request */
        if ($this->hostName !== $rawHostName) $this->domainParts = NULL;
        $this->hostName = $rawHostName;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        if ($rawHostName && $this->portDefined)
            $this->host = $rawHostName . ':' . $this->port;
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetHostName () {
        /** @var $this \MvcCore\Request */
        if ($this->hostName === NULL)
            $this->hostName = $this->globalServer['SERVER_NAME'];
        return $this->hostName;
    }

    /**
     * @inheritDocs
     * @param string $rawHost
     * @return \MvcCore\Request
     */
    public function SetHost ($rawHost) {
        /** @var $this \MvcCore\Request */
        $this->host = $rawHost;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        $doubleDotPos = mb_strpos($rawHost, ':');
        if ($doubleDotPos !== FALSE) {
            $hostName = mb_substr($rawHost, 0, $doubleDotPos);
            $this->SetPort(mb_substr($rawHost, $doubleDotPos + 1));
        } else {
            $hostName = $rawHost;
            $this->port = '';
            $this->portDefined = FALSE;
        }
        return $this->SetHostName($hostName);
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetHost () {
        /** @var $this \MvcCore\Request */
        if ($this->host === NULL) $this->host = $this->globalServer['HTTP_HOST'];
        return $this->host;
    }

    /**
     * @inheritDocs
     * @param string $rawPort
     * @return \MvcCore\Request
     */
    public function SetPort ($rawPort) {
        /** @var $this \MvcCore\Request */
        $this->port = $rawPort;
        $this->domainUrl = NULL;
        $this->baseUrl = NULL;
        $this->requestUrl = NULL;
        $this->fullUrl = NULL;
        if (strlen($rawPort) > 0) {
            $this->host = $this->hostName . ':' . $rawPort;
            $this->portDefined = TRUE;
        } else {
            $this->host = $this->hostName;
            $this->portDefined = FALSE;
        }
        return $this;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetPort () {
        /** @var $this \MvcCore\Request */
        if ($this->port === NULL) $this->initUrlSegments();
        return $this->port;
    }

    /**
     * @inheritDocs
     * @param string $rawPathValue
     * @return \MvcCore\Request
     */
    public function SetPath ($rawPathValue) {
        /** @var $this \MvcCore\Request */
        $this->path = $rawPathValue;
        $this->requestUrl = NULL;
        $this->requestPath = NULL;
        $this->fullUrl = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetPath ($rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->path === NULL)
            $this->initUrlSegments();
        return $rawInput ? $this->path : static::HtmlSpecialChars($this->path);
    }

    /**
     * @inheritDocs
     * @param string $rawQuery
     * @return \MvcCore\Request
     */
    public function SetQuery ($rawQuery) {
        /** @var $this \MvcCore\Request */
        $this->query = ltrim($rawQuery, '?');
        $this->fullUrl = NULL;
        $this->requestPath = NULL;
        return $this;
    }

    /**
     * @inheritDocs
     * @param bool $withQuestionMark If `FALSE` (by default), query string is returned always without question
     *                             mark character at the beginning.
     *                             If `TRUE`, and query string contains any character(s), query string is returned
     *                             with question mark character at the beginning. But if query string contains no
     *                             character(s), query string is returned as EMPTY STRING WITHOUT question mark character.
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetQuery ($withQuestionMark = FALSE, $rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->query === NULL)
            $this->initUrlSegments();
        $result = ($withQuestionMark && mb_strlen($this->query) > 0)
            ? '?' . $this->query
            : $this->query;
        return $rawInput ? $result : static::HtmlSpecialChars($result);
    }

    /**
     * @inheritDocs
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetRequestPath ($rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->requestPath === NULL) {
            $this->requestPath = $this->GetPath(TRUE) . $this->GetQuery(TRUE, TRUE) . $this->GetFragment(TRUE, TRUE);
        }
        return $rawInput ? $this->requestPath : static::HtmlSpecialChars($this->requestPath);
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetDomainUrl () {
        /** @var $this \MvcCore\Request */
        if ($this->domainUrl === NULL)
            $this->domainUrl = $this->GetScheme() . '//' . $this->GetHost();
        return $this->domainUrl;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetBaseUrl () {
        /** @var $this \MvcCore\Request */
        if ($this->baseUrl === NULL)
            $this->baseUrl = $this->GetDomainUrl() . $this->GetBasePath();
        return $this->baseUrl;
    }

    /**
     * @inheritDocs
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetRequestUrl ($rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->requestUrl === NULL)
            $this->requestUrl = $this->GetBaseUrl() . $this->GetPath(TRUE);
        return $rawInput ? $this->requestUrl : static::HtmlSpecialChars($this->requestUrl);
    }

    /**
     * @inheritDocs
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetFullUrl ($rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->fullUrl === NULL)
            $this->fullUrl = $this->GetRequestUrl(TRUE) . $this->GetQuery(TRUE, TRUE) . $this->GetFragment(TRUE, TRUE);
        return $rawInput ? $this->fullUrl : static::HtmlSpecialChars($this->fullUrl);
    }

    /**
     * @inheritDocs
     * @param bool $withHash If `FALSE` (by default), fragment is returned always without hash character
     *                     at the beginning.
     *                     If `TRUE`, and fragment contains any character(s), fragment is returned
     *                     with hash character at the beginning. But if fragment contains no
     *                     character(s), fragment is returned as EMPTY STRING WITHOUT hash character.
     * @param bool $rawInput Get raw input if `TRUE`. `FALSE` by default to get value through `htmlspecialchars($result);` without ampersand `&` escaping.
     * @return string
     */
    public function GetFragment ($withHash = FALSE, $rawInput = FALSE) {
        /** @var $this \MvcCore\Request */
        if ($this->fragment === NULL)
            $this->initUrlSegments();
        $result = ($withHash && mb_strlen($this->fragment) > 0)
            ? '?' . $this->fragment
            : $this->fragment;
        return $rawInput ? $result : static::HtmlSpecialChars($result);
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetServerIp () {
        /** @var $this \MvcCore\Request */
        if ($this->serverIp === NULL) {
            $this->serverIp = (isset($this->globalServer['SERVER_ADDR'])
                ? $this->globalServer['SERVER_ADDR']
                : (isset($this->globalServer['LOCAL_ADDR'])
                    ? $this->globalServer['LOCAL_ADDR']
                    : ''));
        }
        return $this->serverIp;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetClientIp () {
        /** @var $this \MvcCore\Request */
        if ($this->clientIp === NULL) {
            $this->clientIp = (isset($this->globalServer['REMOTE_ADDR'])
                ? $this->globalServer['REMOTE_ADDR']
                : (isset($this->globalServer['HTTP_X_CLIENT_IP'])
                    ? $this->globalServer['HTTP_X_CLIENT_IP']
                    : ''));
            $this->clientIp = preg_replace("#[^0-9a-zA-Z\.\:\[\]]#", '', $this->clientIp);
        }
        return $this->clientIp;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsAjax () {
        /** @var $this \MvcCore\Request */
        if ($this->ajax === NULL) {
            if (
                isset($this->globalServer['HTTP_X_REQUESTED_WITH']) &&
                strlen($this->globalServer['HTTP_X_REQUESTED_WITH']) > 0
            ) {
                $this->ajax =TRUE;
            } else {
                $rawHeader = $this->GetHeader('X-Requested-With', '\-\. _a-zA-Z0-9', '');
                $this->ajax = strlen($rawHeader) > 0;
            }
        }
        return $this->ajax;
    }

    /**
     * @inheritDocs
     * @return int|NULL
     */
    public function GetContentLength () {
        /** @var $this \MvcCore\Request */
        if ($this->contentLength === NULL) {
            if (
                isset($this->globalServer['CONTENT_LENGTH']) &&
                ctype_digit($this->globalServer['CONTENT_LENGTH'])
            ) {
                $this->contentLength = intval($this->globalServer['CONTENT_LENGTH']);
            } else {
                $rawHeader = $this->GetHeader('Content-Length', '0-9', '');
                if ($rawHeader)
                    $this->contentLength = intval($rawHeader);
            }
        }
        return $this->contentLength;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetBody () {
        /** @var $this \MvcCore\Request */
        if ($this->body === NULL) $this->initBody();
        return $this->body;
    }

    /**
     * @inheritDocs
     * @see http://php.net/manual/en/function.htmlspecialchars.php
     * @param string $str
     * @return string
     */
    public static function HtmlSpecialChars ($str) {
        static $chars = ['"'=>'&quot;',"'"=>'&apos;','<'=>'&lt;','>'=>'&gt;',/*'&' => '&amp;',*/];
        return strtr($str, $chars);
    }
}