Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

executable file 358 lines (311 sloc) 9.707 kb
<?php
/**
* @author Dick Munroe (munroe@csworks.com)
* @copyright copyright @ 2004, Dick Munroe, released under the GPL.
*
* The cURL class is a thin wrapper around the procedural interface
* to cURL provided by PHP. I use it mostly as a base class for
* web services whose low level interface is, literally, web pages.
*
* There are a few differences (value added, I guess) between the interface
* provided by this class and the procedural cURL interface. Most
* noticable are:
*
* 1. The curl::exec function (when returning data to the caller rather
* than simply outputing it) always parses the HTTP header and returns
* only the body portion of the reqeust. The header is available via
* the curl::getHeader method.
* 2. The status of the last curl::exec is always maintained. It is
* available via the curl::getStatus method. In addition to the information
* returned by curl_getinfo, that of curl_error and curl_errno is folded
* in as well.
*
* @example ./example.class.curl.php
*/
//
// Edit History:
//
// Dick Munroe munroe@csworks.com 30-Nov-2004
// Initial Version Created.
//
// Dick Munroe munroe@csworks.com 01-Dec-2004
// Forgot to check for cURL actually being in this instance of PHP.
//
class curl
{
/**
* The mapping to caseless header names.
*
* @access private
* @var array
*/
var $m_caseless ;
/**
* The handle for the current curl session.
*
* @access private
* @var resource
*/
var $m_handle ;
/**
* The parsed contents of the HTTP header if one happened in the
* message. All repeated elements appear as arrays.
*
* The headers are stored as an associative array, the key of which
* is the name of the header, e.g., Set-Cookie, and the values of which
* are the bodies of the header in the order in which they occurred.
*
* Some headers can be repeated in a single header, e.g., Set-Cookie and
* pragma, so each type of header has an array containing one or more
* headers of the same type.
*
* The names of the headers can, potentially, vary in spelling from
* server to server and client to client. No attempt to regulate this
* is made, i.e., the curl class does not force all headers to lower
* or upper class, but it DOES collect all headers of the same type
* under the spelling of the type of header used by the FIRST header
* of that type.
*
* For example, two headers:
*
* 1. Set-Cookie: ...
* 2. set-cookie: ...
*
* Would appear as $this->m_header['Set-Cookie'][0] and ...[1]
*
* @access private
* @var mixed
*/
var $m_header ;
/**
* Current setting of the curl options.
*
* @access private
* @var mixed
*/
var $m_options ;
/**
* Status information for the last executed http request. Includes the errno and error
* in addition to the information returned by curl_getinfo.
*
* The keys defined are those returned by curl_getinfo with two additional
* ones specified, 'error' which is the value of curl_error and 'errno' which
* is the value of curl_errno.
*
* @link http://www.php.net/curl_getinfo
* @link http://www.php.net/curl_errno
* @link http://www.php.net/curl_error
* @access private
* @var mixed
*/
var $m_status ;
/**
* curl class constructor
*
* Initializes the curl class for it's default behavior:
* o no HTTP headers.
* o return the transfer as a string.
* o URL to access.
* By default, the curl class will simply read the URL provided
* in the constructor.
*
* @link http://www.php.net/curl_init
* @param string $theURL [optional] the URL to be accessed by this instance of the class.
*/
function curl($theURL=null)
{
if (!function_exists('curl_init'))
{
trigger_error('PHP was not built with --with-curl, rebuild PHP to use the curl class.', E_USER_ERROR) ;
}
$this->m_handle = curl_init() ;
$this->m_caseless = null ;
$this->m_header = null ;
$this->m_options = null ;
$this->m_status = null ;
if (!empty($theURL))
{
$this->setopt(CURLOPT_URL, $theURL) ;
}
$this->setopt(CURLOPT_HEADER, false) ;
$this->setopt(CURLOPT_RETURNTRANSFER, true) ;
}
/**
* Free the resources associated with the curl session.
*
* @link http://www.php.net/curl_close
*/
function close()
{
curl_close($this->m_handle) ;
$this->m_handle = null ;
}
/**
* Execute the curl request and return the result.
*
* @link http://www.php.net/curl_exec
* @link http://www.php.net/curl_getinfo
* @link http://www.php.net/curl_errno
* @link http://www.php.net/curl_error
* @return string The contents of the page (or other interaction as defined by the
* settings of the various curl options).
*/
function exec()
{
$theReturnValue = curl_exec($this->m_handle) ;
$this->m_status = curl_getinfo($this->m_handle) ;
$this->m_status['errno'] = curl_errno($this->m_handle) ;
$this->m_status['error'] = curl_error($this->m_handle) ;
//
// Parse out the http header (if any).
//
$this->m_header = null ;
if ($this->getOption(CURLOPT_HEADER))
{
$theArray = preg_split("/(\r\n){2,2}/", $theReturnValue, 2) ;
$this->parseHeader($theArray[0]) ;
return $theArray[1] ;
}
return $theReturnValue ;
}
/**
* Returns the parsed http header.
*
* @param string $theHeader [optional] the name of the header to be returned.
* The name of the header is case insensitive. If
* the header name is omitted the parsed header is
* returned. If the requested header doesn't exist
* false is returned.
* @returns mixed
*/
function getHeader($theHeader=null)
{
if (empty($theHeader))
{
return $this->m_header ;
}
else
{
$theHeader = strtoupper($theHeader) ;
if (isset($this->m_caseless[$theHeader]))
{
return $this->m_header[$this->m_caseless[$theHeader]] ;
}
else
{
return false ;
}
}
}
/**
* Returns the current setting of the request option. If no
* option has been set, it return null.
*
* @param integer the requested CURLOPT.
* @returns mixed
*/
function getOption($theOption)
{
if (isset($this->m_options[$theOption]))
{
return $this->m_options[$theOption] ;
}
return null ;
}
/**
* Did the last curl exec operation have an error?
*
* @return mixed The error message associated with the error if an error
* occurred, false otherwise.
*/
function hasError()
{
if (isset($this->m_status['error']))
{
return (empty($this->m_status['error']) ? false : $this->m_status['error']) ;
}
else
{
return false ;
}
}
/**
* Parse an HTTP header.
*
* As a side effect it stores the parsed header in the
* m_header instance variable. The header is stored as
* an associative array and the case of the headers
* as provided by the server is preserved and all
* repeated headers (pragma, set-cookie, etc) are grouped
* with the first spelling for that header
* that is seen.
*
* All headers are stored as if they COULD be repeated, so
* the headers are really stored as an array of arrays.
*
* @param string $theHeader The HTTP data header.
*/
function parseHeader($theHeader)
{
$this->m_caseless = array() ;
$theArray = preg_split("/(\r\n)+/", $theHeader) ;
//
// Ditch the HTTP status line.
//
if (preg_match('/^HTTP/', $theArray[0]))
{
$theArray = array_slice($theArray, 1) ;
}
foreach ($theArray as $theHeaderString)
{
$theHeaderStringArray = preg_split("/\s*:\s*/", $theHeaderString, 2) ;
$theCaselessTag = strtoupper($theHeaderStringArray[0]) ;
if (!isset($this->m_caseless[$theCaselessTag]))
{
$this->m_caseless[$theCaselessTag] = $theHeaderStringArray[0] ;
}
$this->m_header[$this->m_caseless[$theCaselessTag]][] = $theHeaderStringArray[1] ;
}
}
/**
* Return the status information of the last curl request.
*
* @param string $theField [optional] the particular portion
* of the status information desired.
* If omitted the array of status
* information is returned. If a non-existant
* status field is requested, false is returned.
* @returns mixed
*/
function getStatus($theField=null)
{
if (empty($theField))
{
return $this->m_status ;
}
else
{
if (isset($this->m_status[$theField]))
{
return $this->m_status[$theField] ;
}
else
{
return false ;
}
}
}
/**
* Set a curl option.
*
* @link http://www.php.net/curl_setopt
* @param mixed $theOption One of the valid CURLOPT defines.
* @param mixed $theValue the value of the curl option.
*/
function setopt($theOption, $theValue)
{
curl_setopt($this->m_handle, $theOption, $theValue) ;
$this->m_options[$theOption] = $theValue ;
}
}
?>
Jump to Line
Something went wrong with that request. Please try again.