Micro\Web\Request

Complexity

Total Complexity

35

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	7
Bugs	2	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	isCli()	0	4	1
A	isAjax()	0	4	1
A	getMethod()	0	4	1
A	getUserIP()	0	4	2
A	getBrowser()	0	4	2
C	getOption()	0	29	16
A	getFiles()	0	4	2
A	query()	0	4	1
A	post()	0	4	1
A	cookie()	0	4	1
A	session()	0	4	1
A	unsetSession()	0	6	2
A	server()	0	4	1
A	requestPayload()	0	4	1
A	setSession()	0	4	1

<?php /** MicroRequest */

namespace Micro\Web;

/**
 * Request class file.
 *
 * @author Oleg Lunegov <testuser@mail.linpax.org>
 * @link https://github.com/linpax/microphp-framework
 * @copyright Copyright &copy; 2013 Oleg Lunegov
 * @license /LICENSE
 * @package Micro
 * @subpackage Web
 * @version 1.0
 * @since 1.0
 */
class Request implements IRequest
{
    /** @var bool $cli Is running as CLI */
    protected $cli;
    /** @var array $files $_FILES from request */
    protected $files;


    /**
     * Constructor Request
     *
     * @access public
     *
     * @param array $files
     *
     * @result void
     */
    public function __construct(array $files = [])
    {
        $this->cli = PHP_SAPI === 'cli';

        $this->files = $files;
    }

    /**
     * Get flag of running as CLI
     *
     * @access public
     *
     * @return bool
     */
    public function isCli()
    {
        return $this->cli;
    }

    /**
     * Check request is AJAX ?
     *
     * @access public
     *
     * @return bool
     */
    public function isAjax()
    {
        return strtolower(filter_input(INPUT_SERVER, 'HTTP_X_REQUESTED_WITH')) === 'xmlhttprequest';
    }

    /**
     * Get request method
     *
     * @access public
     *
     * @return string
     */
    public function getMethod()
    {
        return filter_input(INPUT_SERVER, 'REQUEST_METHOD');
    }

    /**
     * Get user IP-address
     *
     * @access public
     *
     * @return string
     */
    public function getUserIP()
    {
        return ($ip = filter_input(INPUT_SERVER, 'REMOTE_ADDR')) ? $ip : '127.0.0.1';
    }

    /**
     * Get browser data from user user agent string
     *
     * @access public
     *
     * @param null|string $agent User agent string
     *
     * @return mixed
     */
    public function getBrowser($agent = null)
    {
        return get_browser($agent ?: filter_input(INPUT_SERVER, 'HTTP_USER_AGENT'), true);
    }

    /**
     * Get arguments from command line
     *
     * @access public
     *
     * @param string $char -a .. -z option char
     * @param string $name --optionName_string
     * @param bool|null $required Required value?
     *
     * @return mixed
     */
    public function getOption($char = '', $name = '', $required = null)
    {
        if (!$char && !$name) {
            return false;
        }

        if ($char && (1 < strlen($char) || 1 !== preg_match('/^\w$/', $char))) {
            return false;
        }

        if ($name && (1 !== preg_match('/^\w+$/', $name))) {
            return false;
        }

        switch ($required) {
            case true:
                $char = $char ? $char.':' : $char;
                $name = $name ? $name.':' : $name;
                break;
            case false:
                $char = $char ? $char.'::' : $char;
                $name = $name ? $name.'::' : $name;
                break;
        }

        $argv = ($opts = getopt($char, [$name])) ? array_shift($opts) : [];

        return is_array($argv) ? array_shift($argv) : $argv;
    }

    /**
     * Get files mapper
     *
     * @access public
     *
     * @param string $className Class name of mapper
     *
     * @return mixed
     */
    public function getFiles($className = '\Micro\Web\Uploader')
    {
        return $this->files ? new $className($this->files) : false;
    }

    /**
     * Get value by key from query storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function query($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_GET, $name, $filter, $options);
    }

    /**
     * Get value by key from post storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return mixed
     */
    public function post($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_POST, $name, $filter, $options);
    }

    /**
     * Get value by key from cookie storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function cookie($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_COOKIE, $name, $filter, $options);
    }

    /**
     * Get value by key from session storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function session($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_SESSION, $name, $filter, $options);
    }

    /**
     * Unset value by key from session storage
     *
     * @access public
     *
     * @param string $name Key name
     *
     * @return void
     */
    public function unsetSession($name)

unsetSession uses the super-global variable $_SESSION which is generally not recommended.

    {
        if (array_key_exists($name, $_SESSION)) {
            unset($_SESSION[$name]);
        }
    }


    /**
     * Get value by key from server storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param integer $filter
     * @param mixed $options
     *
     * @return bool
     */
    public function server($name, $filter = FILTER_DEFAULT, $options = null)
    {
        return filter_input(INPUT_SERVER, $name, $filter, $options);
    }

    /**
     * Get RequestPayload (RAW DATA)
     *
     * @return string|bool
     */
    public function requestPayload()
    {
        return file_get_contents('php://input');
    }

    /**
     * Set value into session storage
     *
     * @access public
     *
     * @param string $name Key name
     * @param string $value Key value
     *
     * @return void
     */
    public function setSession($name, $value)

setSession uses the super-global variable $_SESSION which is generally not recommended.

    {
        $_SESSION[$name] = $value;
    }
}