Clientbase
/
wellrested
mirror of https://github.com/basemaster/wellrested.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix comments.

This commit is contained in:
PJ Dietz 2012-11-29 14:56:04 -05:00
parent 34ed07f4a0
commit 7c76ddb010
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Request.inc.php
View File

@ -8,12 +8,14 @@ require_once(dirname(__FILE__) . '/exceptions/CurlException.inc.php');
// !TODO: Include port in the URI // !TODO: Include port in the URI
/** /**
* A Request instance contains information relating to the current HTTP request * A Request instance represents an HTTP request. This class has two main uses:
* a client sent to the server.
* *
* Since the main use for this class is to provide info about the one specific * First, you can access a singleton instance via the getRequest() method that
* request, the class exposes the static getRequest() method for obtaining a * represents the request sent to the server. The instance will contain the URI,
* singleton Request instance. * headers, body, etc.
*
* Second, you can create a custom Request and use it to obtain a Response
* from a server through cURL.
* *
* @property string body Entity body of the request * @property string body Entity body of the request
* @property array headers Associative array of HTTP headers * @property array headers Associative array of HTTP headers
@ -22,7 +24,7 @@ require_once(dirname(__FILE__) . '/exceptions/CurlException.inc.php');
* @property string path Path component of the URI for the request * @property string path Path component of the URI for the request
* @property string pathParts Fragments of the path, delimited by slashes * @property string pathParts Fragments of the path, delimited by slashes
* @property array query Associative array of query parameters * @property array query Associative array of query parameters
* @property array uri Full URI, including protocol, hostname, path, and query * @property array uri Full URI (protocol, hostname, path, etc.)
* *
* @package WellRESTed * @package WellRESTed
*/ */