Docs For Class PEAR_PackageUpdate

void __construct(
string
$packageName, string
$channel)

PHP 5 style constructor. Loads the user preferences.

Since: 0.4.0a1
Access: public

Parameters:

string	`$packageName`	—	The package to update.
string	`$channel`	—	The channel the package resides on.

[ Top ]

void PEAR_PackageUpdate(
string
$packageName, string
$channel)

PHP 4 style constructor. Calls the PHP 5 style constructor.

Since: 0.4.0a1
Access: public

Parameters:

string	`$packageName`	—	The package to update.
string	`$channel`	—	The channel the package resides on.

[ Top ]

boolean checkUpdate(
)

Checks to see if an update is available.

Respects the user preferences when determining if an update is avaiable. Returns true if an update is available and the user may want to update the package.

Return: true if an update is available.
Since: 0.4.0a1
Access: public

[ Top ]

string determinePrefFile(
)

Returns the path to the preferences file.

Since: 0.4.0a1
Access: protected

[ Top ]

object An &factory(
string
$driver, string
$packageName, string
$channel)

Creates an instance of the given update class.

Return: instance of type PEAR_PackageUpdate_$driver
Throws: PEAR_PACKAGEUPDATE_ERROR_NONEXISTENTDRIVER
Since: 0.4.0a1
Access: public

Parameters:

string	`$driver`	—	The type of PPU to create.
string	`$packageName`	—	The package to update.
string	`$channel`	—	The channel the package resides on.

[ Top ]

void forceRestart(
)

Redirects or exits to force the user to restart the application.

Abstract:
Since: 0.4.0a1
Access: public

Overridden in child classes as:

PEAR_PackageUpdate_Cli::forceRestart()

[ Top ]

array|bool getInstalledRelease(
)

Returns informations about current installed version of the package

Return: false on error, data array otherwise
Author: Laurent Laville
Since: 0.6.0
Access: public

[ Top ]

array|bool getLatestRelease(
)

Returns information on latest version available

Return: false on error, data array otherwise
Author: Laurent Laville
Since: 0.6.0
Access: public

[ Top ]

boolean getPackageInfo(
)

Returns the latest information about the given package.

Return: true on success, false on error
Throws: PEAR_PACKAGEUPDATE_ERROR_NOPACKAGE, PEAR_PACKAGEUPDATE_ERROR_NOCHANNEL, PEAR_PACKAGEUPDATE_ERROR_NOINFO
Since: 0.4.0a1
Access: protected

[ Top ]

array getPackagePreferences(
)

Returns the preferences associated with the given package.

The preferences returned are an array with the folling values:

don't ask again
don't ask until next version
only ask for state x
bug/minor/major updates only

Since: 0.4.0a1
Access: public

[ Top ]

boolean hasErrors(
)

Returns whether or not errors have occurred (and been captured).

Since: 0.4.0a1
Access: public

[ Top ]

boolean isIncludable(
string
$path)

Returns whether or not a path is in the include path.

Return: true if the path is in the include path.
Since: 0.4.2
Access: public

Parameters:

string $path —

[ Top ]

boolean loadPreferences(
)

Loads the user's preferences from a file.

The preferences are stored in the user's home directory as the file .ppurc. The file contains a serialized array of preferences for each package that has been checked for updates so far.

Return: true on success, false on error
Throws: PEAR_PACKAGEUPDATE_ERROR_PREFFILE_READACCESS, PEAR_PACKAGEUPDATE_ERROR_PREFFILE_CORRUPTED
Since: 0.4.0a1
Access: protected

[ Top ]

object A popError(
)

Pops an error off the error stack.

This method is just for collecting errors that occur while checking for updates and updating a package. The child class is responsible for displaying all errors and handling them properly. This is because the way errors are handled varies greatly depending on the driver used.

Return: PEAR_Error instance or false if no errors exist.
Since: 0.4.0a1
Access: public

[ Top ]

boolean preferencesAllowUpdate(
)

Returns whether or not the user's preferences will allow an update to take place.

The user's preferences may define restrictions such as:

don't update
don't ask until next version (remembers last version asked)
only ask for state XXXX or higher
minor or higher (no bug fix)
major only

Return: true if the preferences will allow an update for the latest version.
Since: 0.4.0a1
Access: public

[ Top ]

boolean presentUpdate(
)

Presents the user with the option to update.

Return: true if the user wants to update
Abstract:
Since: 0.4.0a1
Access: public

Overridden in child classes as:

PEAR_PackageUpdate_Cli::presentUpdate()

[ Top ]

PEAR_Error|array|Exception pushError(
int
$code, [string
$level = 'error'], [array
$params = array()], [string
$msg = false], [array
$repackage = false], [array
$backtrace = false])

Pushes an error onto an error stack.

This method is just for collecting errors that occur while checking for updates and updating a package. The child class is responsible for displaying all errors and handling them properly. This is because the way errors are handled varies greatly depending on the driver used.

Return: if compatibility mode is on, a PEAR_Error is also thrown. If the class Exception exists, then one is returned.
Since: 0.4.0a1
Access: public

Parameters:

int	`$code`	—	Package-specific error code
string	`$level`	—	Error level. This is NOT spell-checked
array	`$params`	—	associative array of error parameters
string	`$msg`	—	Error message, or a portion of it if the message is to be generated
array	`$repackage`	—	If this error re-packages an error pushed by another package, place the array returned from pop() in this parameter
array	`$backtrace`	—	Protected parameter: use this to pass in the http://www.php.net/debug_backtrace that should be used to find error context

[ Top ]

string releaseType(
)

Returns the type of release. (bug|minor|major);

Since: 0.4.0a1
Access: protected

[ Top ]

mixed repackagePEAR_Error(

&$error, object
$error)

Repackages PEAR_Errors for use with ErrorStack.

Return: The return from PEAR::ErrorStack::push()
Author: Ian Eure
Since: 0.4.0a1
Access: public

Parameters:

object	`$error`	—	A PEAR_Error
	`&$error`	—

[ Top ]

boolean savePreferences(
)

Saves the current prefernces to the RC file.

Return: true on success, false on error
Throws: PEAR_PACKAGEUPDATE_ERROR_PREFFILE_WRITEACCESS, PEAR_PACKAGEUPDATE_ERROR_PREFFILE_WRITEERROR
Since: 0.4.0a1
Access: public

[ Top ]

boolean setDontAskAgain(
boolean
$dontAsk)

Sets the user's preference for asking about all updates for this package.

Return: true on success, false on failure
Since: 0.4.0a1
Access: public

Parameters:

boolean $dontAsk —

[ Top ]

boolean setDontAskUntilNextRelease(
boolean
$nextrelease)

Sets the user's preference for asking about updates again until the next release.

Return: true on success, false on failure
Throws: PEAR_PACKAGEUPDATE_ERROR_NOINFO
Since: 0.4.0a1
Access: public

Parameters:

boolean $nextrelease —

[ Top ]

boolean setMinimumReleaseType(
string
$minType)

Sets the user's preference for asking about release types.

Return: true on success, false on failure
Throws: PEAR_PACKAGEUPDATE_ERROR_INVALIDTYPE
Since: 0.4.0a1
Access: public

Parameters:

string $minType — The minimum release type to allow.

[ Top ]

boolean setMinimumState(
string
$minState)

Sets the user's preference for asking about release states.

Return: true on success, false on failure
Throws: PEAR_PACKAGEUPDATE_ERROR_INVALIDSTATE
Since: 0.4.0a1
Access: public

Parameters:

string $minState — The minimum release state to allow.

[ Top ]

boolean setPreference(
integer
$pref, mixed
$value)

Sets the given preference to the given value.

Don't take any chances. Anytime a preference is set, the preferences are saved. We can't rely on the developer to call savePreferences.

Return: true if the preference was set and saved properly.
Throws: PEAR_PACKAGEUPDATE_ERROR_INVALIDPREF
Since: 0.4.0a1
Access: protected

Parameters:

integer	`$pref`	—	One of the preference constants.
mixed	`$value`	—	The value of the preference.

[ Top ]

boolean setPreferences(
array
$preferences)

Sets all preferences at once.

Return: true if the preferences were set and saved.
Since: 0.4.0a1
Access: public

Parameters:

array $preferences —

[ Top ]

boolean update(
)

Updates the source for the package.

We have to update required dependencies automatically to make sure that everything still works properly.

It is the developers responsibility to make sure the user is given the option to update any optional dependencies if needed. This can be done by creating a new instance of PEAR_PackageUpdate for the optional dependency.

Return: true if the update was successful.
Throws: PEAR_PACKAGEUPDATE_ERROR_NOTINSTALLED
Since: 0.4.0a1
Access: public

[ Top ]

Class: PEAR_PackageUpdate

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$channel =

$errors =

$info = array()

$instInfo =

$instVersion =

$latestVersion =

$packageName =

$preferences = array()

Method Detail

__construct (Constructor) [line 262]

Parameters:

PEAR_PackageUpdate (Constructor) [line 248]

Parameters:

checkUpdate [line 453]

determinePrefFile [line 427]

factory [line 306]

Parameters:

forceRestart [line 1022]

getInstalledRelease [line 732]

getLatestRelease [line 767]

getPackageInfo [line 485]

getPackagePreferences [line 575]

hasErrors [line 1158]

isIncludable [line 353]

Parameters:

loadPreferences [line 382]

popError [line 1146]

preferencesAllowUpdate [line 645]

presentUpdate [line 1036]

pushError [line 1071]

Parameters:

releaseType [line 707]

repackagePEAR_Error [line 1103]

Parameters:

savePreferences [line 593]

setDontAskAgain [line 786]

Parameters:

setDontAskUntilNextRelease [line 805]

Parameters:

setMinimumReleaseType [line 832]

Parameters:

setMinimumState [line 858]

Parameters:

setPreference [line 889]

Parameters:

setPreferences [line 929]

Parameters:

update [line 973]