PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Class: PEAR_REST_10

Source Location: /PEAR-1.9.4/PEAR/REST/10.php

Class Overview


Implement REST 1.0


Author(s):

Version:

  • Release: 1.9.4

Copyright:

  • 1997-2009 The Authors

Methods


Child classes:

PEAR_REST_13
Implement REST 1.3

Inherited Variables

Inherited Methods


Class Details

[line 34]
Implement REST 1.0


[ Top ]


Method Detail

PEAR_REST_10 (Constructor)   [line 40]

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


Parameters:

   $config     
   $options     

[ Top ]

betterStates   [line 837]

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 124]

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 62]

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 483]

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


Parameters:

   $base     
   $dostable     
   $basic     
   $searchpackage     
   $searchsummary     
   $channel     

[ Top ]

listCategories   [line 391]

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 436]

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 651]

void listLatestUpgrades( $base, $pref_state, $installed, $channel, &$reg)


Parameters:

   $base     
   $pref_state     
   $installed     
   $channel     
   &$reg     

[ Top ]

listPackages   [line 367]

void listPackages( $base, [ $channel = false])


Parameters:

   $base     
   $channel     

[ Top ]

packageInfo   [line 741]

void packageInfo( $base, $package, [ $channel = false])


Parameters:

   $base     
   $package     
   $channel     

[ Top ]


Documentation generated on Wed, 06 Jul 2011 23:30:23 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.