Overview

Namespaces

  • Coast
    • App
      • Access
      • Executable
    • Controller
    • Csrf
    • Dir
    • Feed
    • File
    • Filter
      • Rule
    • Http
    • Image
    • Model
      • Exception
    • Resolver
    • Router
    • Sitemap
    • Transformer
      • Rule
    • Validator
      • Rule
    • View

Classes

  • Coast\Acl
  • Coast\App
  • Coast\App\Subpath
  • Coast\Coast
  • Coast\Collection
  • Coast\Config
  • Coast\Controller
  • Coast\Controller\Action
  • Coast\Csp
  • Coast\Csrf
  • Coast\Dir
  • Coast\Dir\Iterator
  • Coast\Feed
  • Coast\Feed\Content
  • Coast\Feed\Item
  • Coast\Feed\Person
  • Coast\File
  • Coast\File\Path
  • Coast\Filter
  • Coast\Filter\Rule
  • Coast\Filter\Rule\CamelCase
  • Coast\Filter\Rule\CamelCaseSplit
  • Coast\Filter\Rule\Custom
  • Coast\Filter\Rule\DecimalType
  • Coast\Filter\Rule\EmailAddress
  • Coast\Filter\Rule\EncodeSpecialChars
  • Coast\Filter\Rule\FloatType
  • Coast\Filter\Rule\IntegerType
  • Coast\Filter\Rule\LowerCase
  • Coast\Filter\Rule\NumberType
  • Coast\Filter\Rule\Slugify
  • Coast\Filter\Rule\StripTags
  • Coast\Filter\Rule\TitleCase
  • Coast\Filter\Rule\Trim
  • Coast\Filter\Rule\UpperCase
  • Coast\Filter\Rule\Url
  • Coast\Http
  • Coast\Http\Request
  • Coast\Http\Response
  • Coast\Image
  • Coast\Lazy
  • Coast\Model
  • Coast\Model\Metadata
  • Coast\Path
  • Coast\Request
  • Coast\Resolver
  • Coast\Response
  • Coast\Router
  • Coast\Session
  • Coast\Sitemap
  • Coast\Sitemap\Url
  • Coast\Transformer
  • Coast\Transformer\Rule
  • Coast\Transformer\Rule\BooleanType
  • Coast\Transformer\Rule\Custom
  • Coast\Transformer\Rule\DateTime
  • Coast\Transformer\Rule\IntegerType
  • Coast\Transformer\Rule\NullType
  • Coast\Transformer\Rule\Url
  • Coast\Url
  • Coast\Validator
  • Coast\Validator\Rule
  • Coast\Validator\Rule\ArrayType
  • Coast\Validator\Rule\BooleanType
  • Coast\Validator\Rule\Count
  • Coast\Validator\Rule\Custom
  • Coast\Validator\Rule\DateTime
  • Coast\Validator\Rule\DecimalType
  • Coast\Validator\Rule\EmailAddress
  • Coast\Validator\Rule\Equals
  • Coast\Validator\Rule\File
  • Coast\Validator\Rule\FloatType
  • Coast\Validator\Rule\Func
  • Coast\Validator\Rule\Hostname
  • Coast\Validator\Rule\In
  • Coast\Validator\Rule\IntegerType
  • Coast\Validator\Rule\IpAddress
  • Coast\Validator\Rule\Length
  • Coast\Validator\Rule\Max
  • Coast\Validator\Rule\Min
  • Coast\Validator\Rule\Not
  • Coast\Validator\Rule\NumberType
  • Coast\Validator\Rule\ObjectType
  • Coast\Validator\Rule\Password
  • Coast\Validator\Rule\Range
  • Coast\Validator\Rule\Recaptcha
  • Coast\Validator\Rule\Regex
  • Coast\Validator\Rule\Set
  • Coast\Validator\Rule\StringType
  • Coast\Validator\Rule\Upload
  • Coast\Validator\Rule\Url
  • Coast\View
  • Coast\View\Content
  • Coast\Xml

Interfaces

  • Coast\App\Access
  • Coast\App\Executable
  • Coast\Router\Routable

Traits

  • Coast\App\Access\Implementation
  • Coast\App\Executable\Implementation

Exceptions

  • Coast\App\Exception
  • Coast\Controller\Exception
  • Coast\Controller\Failure
  • Coast\Csrf\Exception
  • Coast\Exception
  • Coast\Http\Exception
  • Coast\Image\Exception
  • Coast\Model\Exception
  • Coast\Model\Exception\NotDefined
  • Coast\Resolver\Exception
  • Coast\Router\Exception
  • Coast\Router\Failure
  • Coast\View\Exception
  • Coast\View\Failure
  • Overview
  • Namespace
  • Class
  • Deprecated
  • Todo
  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: 
<?php
/*
 * Copyright 2017 Jack Sleight <http://jacksleight.com/>
 * This source file is subject to the MIT license that is bundled with this package in the file LICENCE. 
 */

namespace Coast;

class Request
{
    const PROTOCOL_10   = 'HTTP/1.0';
    const PROTOCOL_11   = 'HTTP/1.1';
    
    const METHOD_HEAD   = 'HEAD';
    const METHOD_GET    = 'GET';
    const METHOD_POST   = 'POST';
    const METHOD_PUT    = 'PUT';
    const METHOD_DELETE = 'DELETE';
    
    const SCHEME_HTTP   = 'http';
    const SCHEME_HTTPS  = 'https';
    
    const PORT_HTTP     = 80;
    const PORT_HTTPS    = 443;
    
    protected $_params      = [];
    protected $_servers     = [];
    protected $_protocol;
    protected $_method;
    protected $_headers     = [];
    protected $_scheme;
    protected $_host;
    protected $_port;
    protected $_base;
    protected $_path;
    protected $_pathParams  = [];
    protected $_queryParams = [];
    protected $_bodyParams  = [];
    protected $_body        = [];
    protected $_cookies     = [];

    public function fromGlobals()
    {
        global $argv;
        $this->params(isset($argv) ? $argv : []);
        
        $this->servers($_SERVER);

        $this->protocol(strtoupper($this->server('SERVER_PROTOCOL')));
        $this->method(strtoupper($this->server('REQUEST_METHOD')));

        foreach ($this->servers() as $name => $value) {
            if (preg_match('/^HTTP_(.*)$/', $name, $match)) {
                $this->header(str_replace('_', '-', $match[1]), $value);
            }
        }
        if (function_exists('apache_request_headers')) {
            foreach (apache_request_headers() as $name => $value) {
                $this->header($name, $value);
            }
        }

        $this->scheme($this->server('HTTPS') == 'on' ? self::SCHEME_HTTPS : self::SCHEME_HTTP);
        $this->host($this->server('SERVER_NAME'));
        $this->port($this->server('SERVER_PORT'));
    
        list($full) = explode('?', $this->server('REQUEST_URI'));    
        $path = isset($_GET['_']) ? $_GET['_'] : ltrim($full, '/');
        $full = explode('/', $full);
        $path = explode('/', $path);
        $base = array_slice($full, 0, count($full) - count($path));
        $this->base(implode('/', $base) . '/');
        $this->path(implode('/', $path));

        $this->pathParams($path);
        $this->queryParams($this->_clean($_GET));
        $this->bodyParams(\Coast\array_merge_smart(
            $this->_clean($_POST),
            $this->_restructure($_FILES)
        ));
        $this->body(file_get_contents('php://input'));
        $this->cookies($_COOKIE);

        return $this;
    }

    protected function _clean(array $params)
    {
        foreach ($params as $name => $value) {
            if (preg_match('/^_/', $name)) {
                unset($params[$name]);
            }
        }
        return $params;
    }

    protected function _restructure(array $params)
    {
        $output = [];
        foreach ($params as $name => $array) {
            foreach ($array as $field => $value) {
                $pointer = &$output[$name];
                if (!is_array($value)) {
                    $pointer[$field] = $value;
                    continue;
                }
                $stack = [&$pointer];
                $iterator = new \RecursiveIteratorIterator(
                    new \RecursiveArrayIterator($value),
                    \RecursiveIteratorIterator::SELF_FIRST
                );
                foreach ($iterator as $key => $value) {
                    array_splice($stack, $iterator->getDepth() + 1);
                    $pointer = &$stack[count($stack) - 1];
                    $pointer = &$pointer[$key];
                    $stack[] = &$pointer;
                    if (!$iterator->hasChildren()) {
                        $pointer[$field] = $value;
                    }
                }
            }
        }
        return $output;
    }

    public function param($name, $value = null)
    {
        if (func_num_args() > 1) {
            if (isset($value)) {
                $this->_params[$name] = $value;
            } else {
                unset($this->_params[$name]);
            }
            return $this;
        }
        $sources = [
            '_params',
            '_bodyParams',
            '_queryParams',
            '_pathParams',
        ];
        foreach ($sources as $source) {
            if (isset($this->{$source}[$name])) {
                return $this->{$source}[$name];
            }
        }
        return null;
    }

    public function params(array $params = null)
    {
        if (func_num_args() > 0) {
            foreach ($params as $name => $value) {
                $this->param($name, $value);
            }
            return $this;
        }
        return $this->_params;
    }

    public function server($name, $value = null)
    {
        if (func_num_args() > 1) {
            $this->_servers[$name] = $value;
            return $this;
        }
        return isset($this->_servers[$name])
            ? $this->_servers[$name]
            : null;
    }

    public function servers(array $servers = null)
    {
        if (func_num_args() > 0) {
            foreach ($servers as $name => $value) {
                $this->server($name, $value);
            }
            return $this;
        }
        return $this->_servers;
    }

    public function protocol($protocol = null)
    {
        if (func_num_args() > 0) {
            $this->_protocol = $protocol;
            return $this;
        }
        return $this->_protocol;
    }

    public function method($method = null)
    {
        if (func_num_args() > 0) {
            $this->_method = $method;
            return $this;
        }
        return $this->_method;
    }

    public function isHead()
    {
        return $this->method() == self::METHOD_HEAD;
    }

    public function isGet()
    {
        return $this->method() == self::METHOD_GET;
    }

    public function isPost()
    {
        return $this->method() == self::METHOD_POST;
    }

    public function isPut()
    {
        return $this->method() == self::METHOD_PUT;
    }

    public function isDelete()
    {
        return $this->method() == self::METHOD_DELETE;
    }

    public function isAjax()
    {
        return $this->header('X-Requested-With') == 'XMLHttpRequest';
    }

    public function header($name, $value = null)
    {
        $name = strtolower($name);
        if (isset($value)) {
            $this->_headers[$name] = $value;
            return $this;
        }
        return isset($this->_headers[$name])
            ? $this->_headers[$name]
            : null;
    }

    public function headers(array $headers = null)
    {
        if (func_num_args() > 0) {
            foreach ($headers as $name => $value) {
                $this->header($name, $value);
            }
            return $this;
        }
        return $this->_headers;
    }

    public function scheme($scheme = null)
    {
        if (func_num_args() > 0) {
            $this->_scheme = $scheme;
            return $this;
        }
        return $this->_scheme;
    }

    public function isSecure()
    {
        return $this->scheme() == self::SCHEME_HTTPS;
    }

    public function host($host = null)
    {
        if (func_num_args() > 0) {
            $this->_host = $host;
            return $this;
        }
        return $this->_host;
    }

    public function port($port = null)
    {
        if (func_num_args() > 0) {
            $this->_port = $port;
            return $this;
        }
        return $this->_port;
    }

    public function base($base = null)
    {
        if (func_num_args() > 0) {
            $this->_base = $base;
            return $this;
        }
        return $this->_base;
    }

    public function path($path = null)
    {
        if (func_num_args() > 0) {
            $this->_path = $path;
            return $this;
        }
        return $this->_path;
    }

    public function pathParam($name, $value = null)
    {
        if (func_num_args() > 1) {
            if (isset($value)) {
                $this->_pathParams[$name] = $value;
            } else {
                unset($this->_pathParams[$name]);
            }
            return $this;
        }
        return isset($this->_pathParams[$name])
            ? $this->_pathParams[$name]
            : null;
    }

    public function pathParams(array $pathParams = null)
    {
        if (func_num_args() > 0) {
            foreach ($pathParams as $name => $value) {
                $this->pathParam($name, $value);
            }
            return $this;
        }
        return $this->_pathParams;
    }

    public function queryParam($name, $value = null)
    {
        if (func_num_args() > 1) {
            if (isset($value)) {
                $this->_queryParams[$name] = $value;
            } else {
                unset($this->_queryParams[$name]);
            }
            return $this;
        }
        return isset($this->_queryParams[$name])
            ? $this->_queryParams[$name]
            : null;
    }

    public function queryParams(array $queryParams = null)
    {
        if (func_num_args() > 0) {
            foreach ($queryParams as $name => $value) {
                $this->queryParam($name, $value);
            }
            return $this;
        }
        return $this->_queryParams;
    }

    public function bodyParam($name, $value = null)
    {
        if (func_num_args() > 1) {
            if (isset($value)) {
                $this->_bodyParams[$name] = $value;
            } else {
                unset($this->_bodyParams[$name]);
            }
            return $this;
        }
        return isset($this->_bodyParams[$name])
            ? $this->_bodyParams[$name]
            : null;
    }

    public function bodyParams(array $bodyParams = null)
    {
        if (func_num_args() > 0) {
            foreach ($bodyParams as $name => $value) {
                $this->bodyParam($name, $value);
            }
            return $this;
        }
        return $this->_bodyParams;
    }

    public function body($body = null)
    {
        if (func_num_args() > 0) {
            $this->_body = $body;
            return $this;
        }
        return $this->_body;
    }

    public function json($assoc = false, $depth = 512, $options = 0)
    {
        return json_decode($this->_body, $assoc, $depth, $options);
    }

    public function xml($class = '\Coast\Xml', $options = 0, $namespace = '', $prefix = false)
    {
        return new $class($this->_body, $options, false, $namespace, $prefix);
    }

    public function type()
    {
        return current(explode(';', $this->header('Content-Type')));
    }

    public function isJson()
    {
        return (bool) preg_match('/^application\/json$/i', $this->type());
    }

    public function isXml()
    {
        return (bool) preg_match('/^application\/([-\w]+\+)?xml$/i', $this->type());
    }

    public function cookie($name, $value = null)
    {
        if (func_num_args() > 1) {
            $this->_cookies[$name] = $value;
            return $this;
        }
        return isset($this->_cookies[$name])
            ? $this->_cookies[$name]
            : null;
    }

    public function cookies(array $cookies = null)
    {
        if (func_num_args() > 0) {
            foreach ($cookies as $name => $value) {
                $this->cookie($name, $value);
            }
            return $this;
        }
        return $this->_cookies;
    }

    public function url()
    {
        $default =
            ($this->scheme() == self::SCHEME_HTTP  && $this->port() == self::PORT_HTTP) ||
            ($this->scheme() == self::SCHEME_HTTPS && $this->port() == self::PORT_HTTPS);
        return new \Coast\Url([
            'scheme'      => $this->scheme(),
            'host'        => $this->host(),
            'port'        => !$default ? $this->port() : null,
            'path'        => $this->base() . $this->path(),
            'queryParams' => $this->queryParams(),
        ]);
    }

    /**
     * Set a parameter.
     * @param string $name
     * @param mixed $value
     * @return self
     */
    public function __set($name, $value)
    {
        return $this->param($name, $value);
    }

    /**
     * Get a parameter.
     * @param  string $name
     * @return mixed
     */
    public function __get($name)
    {
        return $this->param($name);
    }

    /**
     * Check if a parameter exists.
     * @param  string  $name
     * @return boolean
     */
    public function __isset($name)
    {
        return $this->param($name) !== null;
    }

    /**
     * Unset a parameter.
     * @param  string  $name
     * @return boolean
     */
    public function __unset($name)
    {
        return $this->param($name, null);
    }
}
Coast API Documentation API documentation generated by ApiGen