PHP Class PEAR_REST

Author: Greg Beaver ([email protected])
Datei anzeigen Open project: sourcefabric/newscoop Class Usage Examples

Public Properties

Property Type Description
$_options
$config

Public Methods

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 )

Method Details

PEAR_REST() public method

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

downloadHttp() public method

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.

getCache() public method

public getCache ( $url )

getCacheId() public method

public getCacheId ( $url )

retrieveCacheFirst() public method

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

retrieveData() public method

Retrieve a remote REST resource
public retrieveData ( $url, $accept = false, $forcestring = false, $channel = false ) : string | array
return string | array

saveCache() public method

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

saveCacheFile() public method

public saveCacheFile ( $file, $contents )

useLocalCache() public method

public useLocalCache ( $url, $cacheid = null )

Property Details

$_options public_oe property

public $_options

$config public_oe property

public $config