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: <?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 CollectionsMethods {
/**
* @inheritDocs
* @param string $type
* @return array
*/
public function & GetGlobalCollection ($type) {
/** @var $this \MvcCore\Request */
$collection = 'global'.ucfirst(strtolower($type));
return $this->{$collection};
}
/**
* @inheritDocs
* @param array $headers
* @return \MvcCore\Request
*/
public function SetHeaders (array & $headers = []) {
/** @var $this \MvcCore\Request */
$this->headers = & $headers;
return $this;
}
/**
* @inheritDocs
* @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.
* @return array
*/
public function & GetHeaders ($pregReplaceAllowedChars = ['#[\<\>\'"]#' => '']) {
/** @var $this \MvcCore\Request */
if ($this->headers === NULL) $this->initHeaders();
if ($pregReplaceAllowedChars === FALSE || $pregReplaceAllowedChars === '' || $pregReplaceAllowedChars === '.*')
return $this->headers;
$cleanedHeaders = [];
foreach ($this->headers as $key => & $value) {
$cleanedKey = $this->cleanParamValue($key, $pregReplaceAllowedChars);
$cleanedHeaders[$cleanedKey] = $this->GetHeader($key, $pregReplaceAllowedChars);
}
return $cleanedHeaders;
}
/**
* @inheritDocs
* @param string $name
* @param string|string[] $value
* @return \MvcCore\Request
*/
public function SetHeader ($name = '', $value = '') {
/** @var $this \MvcCore\Request */
if ($this->headers === NULL) $this->initHeaders();
$this->headers[$name] = $value;
return $this;
}
/**
* @inheritDocs
* @param string $name Http header 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.
* @throws \InvalidArgumentException `$name` must be a `$targetType`, not an `array`.
* @return string|\string[]|int|\int[]|bool|\bool[]|array|mixed
*/
public function GetHeader (
$name = '',
$pregReplaceAllowedChars = "a-zA-Z0-9_;, /\-\.\@\=\+\?\!",
$ifNullValue = NULL,
$targetType = NULL
) {
/** @var $this \MvcCore\Request */
if ($this->headers === NULL) $this->initHeaders();
return $this->getParamFromCollection(
$this->headers, $name, $pregReplaceAllowedChars, $ifNullValue, $targetType
);
}
/**
* @inheritDocs
* @param string $name Http header string name.
* @return bool
*/
public function HasHeader ($name = '') {
/** @var $this \MvcCore\Request */
if ($this->headers === NULL) $this->initHeaders();
return isset($this->headers[$name]);
}
/**
* @inheritDocs
* @param array $params
* @return \MvcCore\Request
*/
public function SetParams (array & $params = []) {
/** @var $this \MvcCore\Request */
$this->params = & $params;
return $this;
}
/**
* @inheritDocs
* @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 array $onlyKeys Array with keys to get only. If empty (by default), all possible params are returned.
* @return array
*/
public function & GetParams ($pregReplaceAllowedChars = ['#[\<\>\'"]#' => ''], $onlyKeys = []) {
/** @var $this \MvcCore\Request */
if ($this->params === NULL) $this->initParams();
if ($pregReplaceAllowedChars === FALSE || $pregReplaceAllowedChars === '' || $pregReplaceAllowedChars === '.*') {
if ($onlyKeys) {
$result = array_intersect_key($this->params, array_flip($onlyKeys));
} else {
$result = & $this->params;
}
return $result;
}
$cleanedParams = [];
foreach ($this->params as $key => & $value) {
if ($onlyKeys && !in_array($key, $onlyKeys, TRUE)) continue;
$cleanedKey = $this->cleanParamValue($key, $pregReplaceAllowedChars);
$cleanedParams[$cleanedKey] = $this->GetParam($key, $pregReplaceAllowedChars);
}
return $cleanedParams;
}
/**
* @inheritDocs
* @param string $name
* @param string|string[] $value
* @return \MvcCore\Request
*/
public function SetParam ($name = '', $value = '') {
/** @var $this \MvcCore\Request */
if ($this->params === NULL) $this->initParams();
$this->params[$name] = $value;
return $this;
}
/**
* @inheritDocs
* @param string $name
* @return \MvcCore\Request
*/
public function RemoveParam ($name = '') {
/** @var $this \MvcCore\Request */
if ($this->params === NULL) $this->initParams();
unset($this->params[$name]);
return $this;
}
/**
* @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.
* @throws \InvalidArgumentException `$name` must be a `$targetType`, not an `array`.
* @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\Request */
if ($this->params === NULL) $this->initParams();
return $this->getParamFromCollection(
$this->params, $name, $pregReplaceAllowedChars, $ifNullValue, $targetType
);
}
/**
* @inheritDocs
* @param string $name Parameter string name.
* @return bool
*/
public function HasParam ($name = '') {
/** @var $this \MvcCore\Request */
if ($this->params === NULL) $this->initParams();
return isset($this->params[$name]);
}
/**
* @inheritDocs
* @param array $files
* @return \MvcCore\Request
*/
public function SetFiles (array & $files = []) {
/** @var $this \MvcCore\Request */
$this->globalFiles = & $files;
return $this;
}
/**
* @inheritDocs
* @return array
*/
public function & GetFiles () {
/** @var $this \MvcCore\Request */
return $this->globalFiles;
}
/**
* @inheritDocs
* @param string $file Uploaded file string name.
* @param array $data
* @return \MvcCore\Request
*/
public function SetFile ($file = '', $data = []) {
/** @var $this \MvcCore\Request */
$this->globalFiles[$file] = $data;
return $this;
}
/**
* @inheritDocs
* @param string $file Uploaded file string name.
* @return array
*/
public function GetFile ($file = '') {
/** @var $this \MvcCore\Request */
if (isset($this->globalFiles[$file])) {
$file = $this->globalFiles[$file];
if (isset($file['error']) && $file['error'] === UPLOAD_ERR_NO_FILE)
return [];
return $file;
}
return [];
}
/**
* @inheritDocs
* @param string $file Uploaded file string name.
* @return bool
*/
public function HasFile ($file = '') {
/** @var $this \MvcCore\Request */
return isset($this->globalFiles[$file]);
}
/**
* @inheritDocs
* @param array $cookies
* @return \MvcCore\Request
*/
public function SetCookies (array & $cookies = []) {
/** @var $this \MvcCore\Request */
$this->globalCookies = & $cookies;
return $this;
}
/**
* @inheritDocs
* @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 array $onlyKeys Array with keys to get only. If empty (by default), all possible cookies are returned.
* @return array
*/
public function & GetCookies ($pregReplaceAllowedChars = ['#[\<\>\'"]#' => ''], $onlyKeys = []) {
/** @var $this \MvcCore\Request */
if ($pregReplaceAllowedChars === FALSE || $pregReplaceAllowedChars === '' || $pregReplaceAllowedChars === '.*') {
if ($onlyKeys) {
$result = array_intersect_key($this->paglobalCookiesrams, array_flip($onlyKeys));
} else {
$result = $this->globalCookies;
}
return $result;
}
$cleanedCookies = [];
foreach ($this->globalCookies as $key => & $value) {
if ($onlyKeys && !in_array($key, $onlyKeys, TRUE)) continue;
$cleanedKey = $this->cleanParamValue($key, $pregReplaceAllowedChars);
$cleanedCookies[$cleanedKey] = $this->GetCookie($key, $pregReplaceAllowedChars);
}
return $cleanedCookies;
}
/**
* @inheritDocs
* @param string $name
* @param string|string[] $value
* @return \MvcCore\Request
*/
public function SetCookie ($name = "", $value = "") {
/** @var $this \MvcCore\Request */
$this->globalCookies[$name] = $value;
return $this;
}
/**
* @inheritDocs
* @param string $name Cookie 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.
* @throws \InvalidArgumentException `$name` must be a `$targetType`, not an `array`.
* @return string|\string[]|int|\int[]|bool|\bool[]|array|mixed
*/
public function GetCookie (
$name = '',
$pregReplaceAllowedChars = "a-zA-Z0-9_;, /\-\.\@\=\+\?\!",
$ifNullValue = NULL,
$targetType = NULL
) {
/** @var $this \MvcCore\Request */
return $this->getParamFromCollection(
$this->globalCookies, $name, $pregReplaceAllowedChars, $ifNullValue, $targetType
);
}
/**
* @inheritDocs
* @param string $name Cookie string name.
* @return bool
*/
public function HasCookie ($name = '') {
/** @var $this \MvcCore\Request */
return isset($this->globalCookies[$name]);
}
/**
* Get filtered param or header value for characters defined as second argument to use them in `preg_replace()`.
* @param string|string[]|NULL $rawValue
* @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
*/
protected function getParamItem (
& $rawValue = NULL,
$pregReplaceAllowedChars = "a-zA-Z0-9_;, /\-\@\:",
$ifNullValue = NULL,
$targetType = NULL
) {
/** @var $this \MvcCore\Request */
if ($rawValue === NULL) {
// if there is NULL in target collection
if ($targetType === NULL) return $ifNullValue;
$result = is_scalar($ifNullValue) ? $ifNullValue : clone $ifNullValue;
settype($result, $targetType);
return $result;
} else {
// if there is not NULL in target collection
if (is_string($rawValue) && mb_strlen(trim($rawValue)) === 0) {
// if value after trim is empty string, return empty string (retyped if necessary)
$result = "";
if ($targetType === NULL) return $result;
$result = is_scalar($ifNullValue) ? $ifNullValue : clone $ifNullValue;
settype($result, $targetType);
return $result;
} else if ($pregReplaceAllowedChars === FALSE || $pregReplaceAllowedChars === '.*') {
// if there is something in target collection and all chars are allowed
$result = $rawValue;
if ($targetType === NULL) return $result;
settype($result, $targetType);
return $result;
} else if (is_array($rawValue)) {
// if there is something in target collection and it's an array
$result = [];
foreach ((array) $rawValue as $key => $value) {
$cleanedKey = $this->cleanParamValue($key, $pregReplaceAllowedChars);
$result[$cleanedKey] = $this->getParamItem(
$value, $pregReplaceAllowedChars, $ifNullValue, $targetType
);
}
return $result;
} else {
// if there is something in target collection and it's not an array
$result = $this->cleanParamValue($rawValue, $pregReplaceAllowedChars);
if ($targetType === NULL) return $result;
settype($result, $targetType);
return $result;
}
}
}
/**
* Clean param value by given list of allowed chars or by given `preg_replace()` pattern and reverse.
* @param string $rawValue
* @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.
* @return string
*/
protected function cleanParamValue ($rawValue, $pregReplaceAllowedChars = "a-zA-Z0-9_;, /\-\@\:") {
/** @var $this \MvcCore\Request */
if ($pregReplaceAllowedChars === FALSE) {
return $rawValue;
} else if (is_array($pregReplaceAllowedChars)) {
foreach ($pregReplaceAllowedChars as $pattern => $replace) {
$replaceFn = mb_substr($pattern, 0, 1) === '#' ? 'preg_replace' : 'str_replace';
$rawValue = $replaceFn($pattern, $replace, $rawValue);
}
return $rawValue;
} else {
return preg_replace("#[^" . $pregReplaceAllowedChars . "]#", "", (string) $rawValue);
}
}
}