PHP Class PEAR_REST

Author: Greg Beaver ([email protected])

Public Properties

Property	Type	Description
$_options
$config

Method	Description
PEAR_REST ( &$config, $options = [] )
downloadHttp ( string $url, false \| string \| array $lastmodified = null, false \| array $accept = false, $channel = false ) : string \| array	Efficiently Download a file through HTTP. Returns downloaded file as a string in-memory This is best used for small files
getCache ( $url )
getCacheId ( $url )
retrieveCacheFirst ( $url, $accept = false, $forcestring = false, $channel = false ) : string \| array	Retrieve REST data, but always retrieve the local cache if it is available.
retrieveData ( $url, $accept = false, $forcestring = false, $channel = false ) : string \| array	Retrieve a remote REST resource
saveCache ( $url, $contents, $lastmodified, $nochange = false, $cacheid = null )
saveCacheFile ( $file, $contents )
useLocalCache ( $url, $cacheid = null )

public PEAR_REST ( &$config, $options = [] )

If an HTTP proxy has been configured (http_proxy PEAR_Config setting), the proxy will be used.

public downloadHttp ( string $url, false \| string \| array $lastmodified = null, false \| array $accept = false, $channel = false ) : string \| array
$url	string	the URL to download
$lastmodified	false \| string \| array	header values to check against for caching use false to return the header values from this download
$accept	false \| array	Accept headers to send
return	string \| array	Returns the contents of the downloaded file or a PEAR error on failure. If the error is caused by socket-related errors, the error object will have the fsockopen error code available through getCode(). If caching is requested, then return the header values.

public getCache ( $url )

public getCacheId ( $url )

This is useful for elements that should never change, such as information on a particular release

public retrieveCacheFirst ( $url, $accept = false, $forcestring = false, $channel = false ) : string \| array
return	string \| array

Retrieve a remote REST resource

public retrieveData ( $url, $accept = false, $forcestring = false, $channel = false ) : string \| array
return	string \| array

public saveCache ( $url, $contents, $lastmodified, $nochange = false, $cacheid = null )

public saveCacheFile ( $file, $contents )

public useLocalCache ( $url, $cacheid = null )

public $_options

public $config