request.php

<?php

/**
 * Request class allow us to make HTTP requests to remote URLs.
 *
 * @author Faizan Ayubi
 */

namespace Framework {

    use Framework\Base as Base;
    use Framework\Events as Events;
    use Framework\StringMethods as StringMethods;
    use Framework\RequestMethods as RequestMethods;
    use Framework\Request\Exception as Exception;

    class Request extends Base {

        protected $_request;

        /**
         * @readwrite
         */
        public $_willFollow = true;

        /**
         * @readwrite
         */
        protected $_willShareSession = true;

        /**
         * @readwrite
         */
        protected $_headers = array();

        /**
         * @readwrite
         */
        protected $_options = array();

        /**
         * @readwrite
         */
        protected $_referer;

        /**
         * @readwrite
         */
        protected $_agent;

        protected function _getExceptionForImplementation($method) {
            return new Exception\Implementation("{$method} not implemented");
        }

        public function __construct($options = array()) {
            parent::__construct($options);
            $this->agent = RequestMethods::server("HTTP_USER_AGENT", "Curl/PHP " . PHP_VERSION);
        }

        public function delete($url, $parameters = array()) {
            return $this->request("DELETE", $url, $parameters);
        }

        function get($url, $parameters = array()) {
            if (!empty($parameters)) {
                $url .= StringMethods::indexOf($url, "?") ? "&" : "?";
                $url .= is_string($parameters) ? $parameters : http_build_query($parameters, "", "&");
            }
            return $this->request("GET", $url);
        }

        function head($url, $parameters = array()) {
            return $this->request("HEAD", $url, $parameters);
        }

        function post($url, $parameters = array()) {
            return $this->request("POST", $url, $parameters);
        }

        function put($url, $parameters = array()) {
            return $this->request("PUT", $url, $parameters);
        }

        /**
         * Use Curl to make the HTTP requests. Resposible for doing the real work.
         * @param type $method
         * @param type $url
         * @param type $parameters
         * @return \Framework\Request\Response
         * @throws Exception\Response
         */
        function request($method, $url, $parameters = array()) {
            Events::fire("framework.request.request.before", array($method, $url, $parameters));

            $request = $this->_request = curl_init();

            if (is_array($parameters)) {
                $parameters = http_build_query($parameters, "", "&");
            }

            $this
                ->_setRequestMethod($method)
                ->_setRequestOptions($url, $parameters)
                ->_setRequestHeaders();

            $response = curl_exec($request);

            if ($response) {
                $response = new Request\Response(array(
                    "response" => $response
                ));
            } else {
                throw new Exception\Response(ucfirst(curl_error($request)));
            }

            Events::fire("framework.request.request.after", array($method, $url, $parameters, $response));

            curl_close($request);
            return $response;
        }

        /**
         * Convenience method for tasks perform within the three important Request setter methods.
         * @param type $key
         * @param type $value
         * @return \Framework\Request
         */
        protected function _setOption($key, $value) {
            curl_setopt($this->_request, $key, $value);
            return $this;
        }

        /**
         * Convenience method for tasks perform within the three important Request setter methods.
         * @param type $key
         * @return type
         */
        protected function _normalize($key) {
            return "CURLOPT_" . str_replace("CURLOPT_", "", strtoupper($key));
        }

        /**
         * Sets Curl parameters relating to each of the different request methods.
         * @param type $method
         * @return \Framework\Request
         */
        protected function _setRequestMethod($method) {
            switch (strtoupper($method)) {
                case "HEAD":
                    $this->_setOption(CURLOPT_NOBODY, true);
                    break;
                case "GET":
                    $this->_setOption(CURLOPT_HTTPGET, true);
                    break;
                case "POST":
                    $this->_setOption(CURLOPT_POST, true);
                    break;
                default:
                    $this->_setOption(CURLOPT_CUSTOMREQUEST, $method);
                    break;
            }

            return $this;
        }

        /**
         * Iterates through all the request-specific parameters that need to be set. 
         * @param type $url
         * @param type $parameters
         * @return \Framework\Request
         */
        protected function _setRequestOptions($url, $parameters) {
            $this
                    ->_setOption(CURLOPT_URL, $url)
                    ->_setOption(CURLOPT_HEADER, true)
                    ->_setOption(CURLOPT_RETURNTRANSFER, true)
                    ->_setOption(CURLOPT_USERAGENT, $this->agent);

            if (!empty($parameters)) {
                $this->_setOption(CURLOPT_POSTFIELDS, $parameters);
            }

            if ($this->willFollow) {
                $this->_setOption(CURLOPT_FOLLOWLOCATION, true);
            }

            if ($this->willShareSession) {
                $this->_setOption(CURLOPT_COOKIE, session_name() . "=" . session_id());
            }

            if ($this->referer) {
                $this->_setOption(CURLOPT_REFERER, $this->referer);
            }

            foreach ($this->_options as $key => $value) {
                $this->_setOption(constant($this->_normalize($key)), $value);
            }

            return $this;
        }

        /**
         * Iterates through the headers specified by the setHeaders() setter method to add any custom headers to the request.
         * @return \Framework\Request
         */
        protected function _setRequestHeaders() {
            $headers = array();

            foreach ($this->headers as $key => $value) {
                $headers[] = $key . ': ' . $value;
            }

            $this->_setOption(CURLOPT_HTTPHEADER, $headers);
            return $this;
        }

    }

}