Docs For Class PEAR_REST

__construct (Constructor) [line 39]

PEAR_REST_10 __construct(

$config, [
$options = array()])

Parameters:

	`$config`	—
	`$options`	—

[ Top ]

betterStates [line 836]

false|array betterStates(
string
$state, [boolean
$include = false])

Return an array containing all of the states that are more stable than or equal to the passed in state

Return: False if $state is not a valid release state

Parameters:

string	`$state`	—	Release state
boolean	`$include`	—	Determines whether to include $state in the list

[ Top ]

getDepDownloadURL [line 123]

void getDepDownloadURL(

$base, 
$xsdversion, 
$dependency, 
$deppackage, [
$prefstate = 'stable'], [
$installed = false], [
$channel = false])

Overridden in child classes as:

PEAR_REST_13::getDepDownloadURL()

Parameters:

	`$base`	—
	`$xsdversion`	—
	`$dependency`	—
	`$deppackage`	—
	`$prefstate`	—
	`$installed`	—
	`$channel`	—

[ Top ]

getDownloadURL [line 61]

array|false|PEAR_Error getDownloadURL(
string
$base, array
$packageinfo, string
$prefstate, bool
$installed, [
$channel = false])

Retrieve information about a remote package to be downloaded from a REST server

Return: see _returnDownloadURL()

Overridden in child classes as:

PEAR_REST_13::getDownloadURL(): Retrieve information about a remote package to be downloaded from a REST server

Parameters:

string	`$base`	—	The uri to prepend to all REST calls
array	`$packageinfo`	—	an array of format: array( 'package' => 'packagename', 'channel' => 'channelname', ['state' => 'alpha' (or valid state),] -or- ['version' => '1.whatever']
string	`$prefstate`	—	Current preferred_state config variable value
bool	`$installed`	—	the installed version of this package to compare against
	`$channel`	—

[ Top ]

listAll [line 482]

void listAll(

$base, 
$dostable, [
$basic = true], [
$searchpackage = false], [
$searchsummary = false], [
$channel = false])

Parameters:

	`$base`	—
	`$dostable`	—
	`$basic`	—
	`$searchpackage`	—
	`$searchsummary`	—
	`$channel`	—

[ Top ]

listCategories [line 390]

array listCategories(
string
$base, [
$channel = false])

List all categories of a REST server

Return: of categorynames

Parameters:

string	`$base`	—	base URL of the server
	`$channel`	—

[ Top ]

listCategory [line 435]

array listCategory(
string
$base, string
$category, [boolean
$info = false], [
$channel = false])

List a category of a REST server

Return: of packagenames

Parameters:

string	`$base`	—	base URL of the server
string	`$category`	—	name of the category
boolean	`$info`	—	also download full package info
	`$channel`	—

[ Top ]

listLatestUpgrades [line 650]

void listLatestUpgrades(

$base, 
$pref_state, 
$installed, 
$channel, 
&$reg)

Overridden in child classes as:

PEAR_REST_13::listLatestUpgrades(): List package upgrades but take the PHP version into account.

Parameters:

	`$base`	—
	`$pref_state`	—
	`$installed`	—
	`$channel`	—
	`&$reg`	—

[ Top ]

listPackages [line 366]

void listPackages(

$base, [
$channel = false])

Parameters:

	`$base`	—
	`$channel`	—

[ Top ]

packageInfo [line 740]

void packageInfo(

$base, 
$package, [
$channel = false])

Parameters:

	`$base`	—
	`$package`	—
	`$channel`	—

[ Top ]

Class: PEAR_REST_10

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 39]

Parameters:

betterStates [line 836]

Parameters:

getDepDownloadURL [line 123]

Parameters:

getDownloadURL [line 61]

Parameters:

listAll [line 482]

Parameters:

listCategories [line 390]

Parameters:

listCategory [line 435]

Parameters:

listLatestUpgrades [line 650]

Parameters:

listPackages [line 366]

Parameters:

packageInfo [line 740]

Parameters: