class_HttpRequest.php

Go to the documentation of this file.

<?php
class HttpRequest extends BaseFrameworkSystem implements Requestable {
        private $requestData = array();

        private $requestIsValid = true;

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        public final static function createHttpRequest () {
                // Create an instance
                $httpInstance = new HttpRequest();

                // Prepare the HTTP request data for usage
                $httpInstance->prepareRequestData();

                // Return the prepared instance
                return $httpInstance;
        }

        public function prepareRequestData () {
                // Copy GET then POST data
                $this->requestData = array_merge($_GET, $_POST);
        }

        public function isRequestElementSet ($element) {
                // Is this element found?
                $isSet = isset($this->requestData[$element]);

                // Return result
                return $isSet;
        }

        public function getRequestElement ($element) {
                // Initialize value
                $value = null;

                // Is the element set?
                if ($this->isRequestElementSet($element)) {
                        // Get the bare value
                        $value = $this->requestData[$element];

                        // Secure it against attacks
                        $value = htmlentities(strip_tags($value), ENT_QUOTES);
                } // END - if

                // Return the element's value
                return $value;
        }

        public function setRequestElement ($element, $value) {
                $this->requestData[$element] = $value;
        }

        public function getParameterNames () {
                return array_keys($this->requestData);
        }

        public function getHeader ($headerName) {
                // Default return value on error
                $headerValue = null;

                // Construct the name
                $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));

                // Does this header exist?
                if (isset($_SERVER[$name])) {
                        $headerValue = $_SERVER[$name];
                } // END - if

                // Return the value
                return $headerValue;
        }

        public final function getRequestMethod () {
                return $_SERVER['REQUEST_METHOD'];
        }

        public final function requestIsValid ($isValid = true) {
                $this->requestIsValid = (bool) $isValid;
        }

        public final function isRequestValid () {
                return $this->requestIsValid;
        }

        public final function readCookie ($cookieName) {
                // Default is no cookie with that name found
                $cookieValue = null;

                // Is the cookie set?
                if (isset($_COOKIE[$cookieName])) {
                        // Then get it
                        $cookieValue = $_COOKIE[$cookieName];
                } // END - if

                // Return the value
                return $cookieValue;
        }
}

// [EOF]
?>