*************
Request Class
*************

The request class is an object-oriented representation of an HTTP request. This is meant to
work for both incoming, such as a request to the application from a browser, and outgoing requests,
like would be used to send a request from the application to a third-party application. This class
provides the common functionality they both need, but both cases have custom classes that extend
from the Request class to add specific functionality.

See the documentation for the :doc:`IncomingRequest Class </libraries/incomingrequest>` and
:doc:`CURLRequest Class </libraries/curlrequest>` for more usage details.

===============
Class Reference
===============

.. php:class:: CodeIgniter\\HTTP\\IncomingRequest

	.. php:method:: ipAddress()

		:returns: The user's IP Address, if it can be detected, or null. If the IP address
					is not a valid IP addresss, then will return 0.0.0.0
		:rtype: string

		Returns the IP address for the current user. If the IP address is not valid, the method
		will return '0.0.0.0'::

			echo $request->ipAddress();

		.. important:: This method takes into account the ``App->proxy_ips`` setting and will
			return the reported HTTP_X_FORWARDED_FOR, HTTP_CLIENT_IP, HTTP_X_CLIENT_IP, or
			HTTP_X_CLUSTER_CLIENT_IP address for the allowed IP address.

	.. php:method:: validIP($ip[, $which = ''])

		:param	string	$ip: IP address
		:param	string	$which: IP protocol ('ipv4' or 'ipv6')
		:returns:	true if the address is valid, false if not
		:rtype:	bool

		Takes an IP address as input and returns true or false (boolean) depending
		on whether it is valid or not.

		.. note:: The $request->ipAddress() method above automatically validates the IP address.

                ::

			if ( ! $request->validIP($ip))
			{
                            echo 'Not Valid';
			}
			else
			{
                            echo 'Valid';
			}

		Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
		an IP format. The default checks for both formats.


	.. php:method:: method([$upper = FALSE])

		:param	bool	$upper: Whether to return the request method name in upper or lower case
		:returns:	HTTP request method
		:rtype:	string

		Returns the ``$_SERVER['REQUEST_METHOD']``, with the option to set it
		in uppercase or lowercase.
		::

			echo $request->method(TRUE); // Outputs: POST
			echo $request->method(FALSE); // Outputs: post
			echo $request->method(); // Outputs: post

	.. php:method:: getServer($index[, $filter = NULL])

		:param	mixed	$index: Value name
		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
		:returns:	$_SERVER item value if found, NULL if not
		:rtype:	mixed

		This method is identical to the ``post()``, ``get()`` and ``cookie()`` methods from the
		:doc:`IncomingRequest Class </libraries/incomingrequest>`, only it fetches getServer data (``$_SERVER``)::

			$request->getServer('some_data');

		To return an array of multiple ``$_SERVER`` values, pass all the required keys
		as an array.
		::

			$require->getServer(array('SERVER_PROTOCOL', 'REQUEST_URI'));

