Request::isXhr() - Code Metrics - alphazframework/framework - Measure and Improve Code Quality continuously with Scrutinizer

Request::isXhr() A
last analyzed 2023-12-15 04:26 UTC

↳ Parent: Request
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
<?php

/**
 * This file is part of the alphaz Framework.
 *
 * @author Muhammad Umer Farooq (Malik) <[email protected]>
 *
 * @link https://github.com/alphazframework/framework
 *
 * For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 * @since 1.0.0
 *
 * @license MIT
 */

namespace alphaz\http;

class Request extends Uri
{
    /**
     * Constructor.
     *
     * Instantiate the request object
     *
     * @since 1.0.0
     */
    public function __construct()
    {
        parent::__construct();
        $this->get = $_GET ?? [];
        $this->post = $_POST ?? [];
        $this->files = $_FILES ?? [];
        $this->session = $_SESSION ?? [];
        $this->cookie = $_COOKIE ?? [];
        $this->server = $_SERVER ?? [];
        $this->env = $_ENV ?? [];

        if ($this->getRequestMethod()) {
            $this->parseData();
        }
    }

    /**
     * Does this request use a given method?
     *
     * @param (string) $method HTTP method
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isMethod($method)
    {
        return $this->getRequestMethod() === $method;
    }

    /**
     * Determine whether or not the request has FILES.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function hasFiles()
    {
        return count($this->files) > 0;
    }

    /**
     * Is this an GET request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isGet()
    {
        return $this->isMethod('GET');
    }

    /**
     * Is this an HEAD request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isHead()
    {
        return $this->isMethod('HEAD');
    }

    /**
     * Is this an POST request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isPost()
    {
        return $this->isMethod('POST');
    }

    /**
     * Is this an PUT request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isPut()
    {
        return $this->isMethod('PUT');
    }

    /**
     * Is this an DELETE request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isDelete()
    {
        return $this->isMethod('DELETE');
    }

    /**
     * Is this an TRACE request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isTrace()
    {
        return $this->isMethod('TRACE');
    }

    /**
     * Is this an OPTIONS request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isOptions()
    {
        return $this->isMethod('OPTIONS');
    }

    /**
     * Is this an CONNEXT request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isConnect()
    {
        return $this->isMethod('CONNECT');
    }

    /**
     * Is this an PATH request.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isPatch()
    {
        return $this->isMethod('PATCH');
    }

    /**
     * Return whether or not the request is secure.
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isSecure()
    {
        return $this->gethttps() || $this->getServerPort() && $this->getServerPort() === '443';
    }

    /**
     * Is this an XHR request?
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function isXhr()
    {
        return strtolower($this->getHeader('x-requested-with')) === 'xmlhttprequest';
    }

    /**
     * Get a value from $_GET, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getQuery($key = null)
    {
        if ($key === null) {
            return $this->get;
        } else {
            return (isset($this->get[$key])) ? $this->get[$key] : null;
        }
    }

    /**
     * Get a value from $_POST, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getPost($key = null)
    {
        if ($key === null) {
            return $this->post;
        } else {
            return (isset($this->post[$key])) ? $this->post[$key] : null;
        }
    }

    /**
     * Get a value from $_FILES, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getFiles($key = null)
    {
        if ($key === null) {
            return $this->files;
        } else {
            return (isset($this->files[$key])) ? $this->files[$key] : null;
        }
    }

    /**
     * Get a value from PUT query data, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getPut($key = null)
    {
        if ($key === null) {
            return $this->put;
        } else {
            return (isset($this->put[$key])) ? $this->put[$key] : null;
        }
    }

    /**
     * Get a value from PATCH query data, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getPatch($key = null)
    {
        if ($key === null) {
            return $this->patch;
        } else {
            return (isset($this->patch[$key])) ? $this->patch[$key] : null;
        }
    }

    /**
     * Get a value from DELETE query data, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getDelete($key = null)
    {
        if ($key === null) {
            return $this->delete;
        } else {
            return (isset($this->delete[$key])) ? $this->delete[$key] : null;
        }
    }

    /**
     * Get a value from $_SESSION, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getSession($key = null)
    {
        if ($key === null) {
            return $this->session;
        } else {
            return (isset($this->session[$key])) ? $this->session[$key] : null;
        }
    }

    /**
     * Get a value from $_COOKIE, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getCookie($key = null)
    {
        if ($key === null) {
            return $this->cookie;
        } else {
            return (isset($this->cookie[$key])) ? $this->cookie[$key] : null;
        }
    }

    /**
     * Get a value from $_SERVER, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getServer($key = null)
    {
        if ($key === null) {
            return $this->server;
        } else {
            return (isset($this->server[$key])) ? $this->server[$key] : null;
        }
    }

    /**
     * Get a value from $_ENV, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getEnv($key = null)
    {
        if ($key === null) {
            return $this->env;
        } else {
            return (isset($this->env[$key])) ? $this->env[$key] : null;
        }
    }

    /**
     * Get a value from parsed data, or the whole array.
     *
     * @param (string) $key
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getParsedData($key = null)
    {
        $result = null;

        if ($this->parsedData !== null && is_array($this->parsedData)) {
            if (null === $key) {
                $result = $this->parsedData;
            } else {
                $result = (isset($this->parsedData[$key])) ? $this->parsedData[$key] : null;
            }
        }

        return $result;
    }

    /**
     * Get the raw data.
     *
     * @since 1.0.0
     *
     * @return string
     */
    public function getRawData()
    {
        return $this->rawData;
    }

    /**
     * Parse any data that came with the request.
     *
     * @since 1.0.0
     *
     * @return void
     */
    protected function parseData()
    {
        if (strtoupper($this->getRequestMethod()) == 'GET') {
        if (strtoupper(/** @scrutinizer ignore-type */ $this->getRequestMethod()) == 'GET') {
            $this->rawData = ($this->getQueryString()) ? rawurldecode($this->getQueryString()) : null;
            $this->rawData = ($this->getQueryString()) ? rawurldecode(/** @scrutinizer ignore-type */ $this->getQueryString()) : null;
        } else {
            $input = fopen('php://input', 'r');
            while ($data = fread($input, 1024)) {
                $this->rawData .= $data;
            }
        }

        // If the content-type is JSON
        if ($this->getQueryString() && stripos($this->getQueryString(), 'json') !== false) {
        if ($this->getQueryString() && stripos(/** @scrutinizer ignore-type */ $this->getQueryString(), 'json') !== false) {
            $this->parsedData = json_decode($this->rawData, true);
            // Else, if the content-type is XML
        } elseif ($this->getContentType() && stripos($this->getContentType(), 'xml') !== false) {
            $matches = [];
            preg_match_all('/<!\[cdata\[(.*?)\]\]>/is', $this->rawData, $matches);

            foreach ($matches[0] as $match) {
                $strip = str_replace(
                    ['<![CDATA[', ']]>', '<', '>'],
                    ['', '', '&lt;', '&gt;'],
                    $match
                );
                $this->rawData = str_replace($match, $strip, $this->rawData);
            }

            $this->parsedData = json_decode(json_encode((array) simplexml_load_string($this->rawData)), true);
            // Else, default to a regular URL-encoded string
        } else {
            switch (strtoupper($this->getRequestMethod())) {
                case 'GET':
                    $this->parsedData = $this->get;
                    break;

                case 'POST':
                    $this->parsedData = $this->post;
                    break;
                default:
                    if ($this->getContentType() && strtolower($this->getContentType()) == 'application/x-www-form-urlencoded') {
                    if ($this->getContentType() && strtolower(/** @scrutinizer ignore-type */ $this->getContentType()) == 'application/x-www-form-urlencoded') {
                        parse_str($this->rawData, $this->parsedData);
                    }
            }
        }
        switch (strtoupper($this->getRequestMethod())) {
            case 'PUT':
                $this->put = $this->parsedData;
                break;

            case 'PATCH':
                $this->patch = $this->parsedData;
                break;

            case 'DELETE':
                $this->delete = $this->parsedData;
                break;
        }
    }
}

alphazframework / framework

Request::isXhr() A last analyzed 2023-12-15 04:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Request::isXhr() A
last analyzed 2023-12-15 04:26 UTC
