Class: PEAR_PackageUpdate

[line 259]
The package allows a developer to add a few lines of code to

their existing packages and have the ability to update their package automatically. This auto-update ability allows users to stay up to date much more easily than requiring them to update manually.

This package keeps track of user preferences such as "don't remind me again".

This package is designed to be a backend to different front ends written for this package. For example, this package can be used to drive a PHP-GTK 2, CLI or web front end. The API for this package should be flexible enough to allow any type of front end to be used and also to allow the package to be used directly in another package without a front end driver.

The interface for this package must allow for the following functionality:

• allow user to confirm or cancel upgrade
• download and install the package

• don't ask again
• don't ask until next release
• only ask for state XXXX or higher

• update channel automatically

• PHP-GTK/CLI apps must exit to allow classes to reload
• web front end could send headers to reload certain page

This class is simply a wrapper for PEAR classes that actually do the work.

EXAMPLE:

 <?php

  class Goo {
      function __construct()
      {
          // Check for updates...
          require_once 'PEAR/PackageUpdate.php';
          $ppu =& PEAR_PackageUpdate::factory('Gtk2', 'Goo', 'pear');
          if ($ppu !== false) {
              if ($ppu->checkUpdate()) {
                  // Use a dialog window to ask permission to update.
                  if ($ppu->presentUpdate()) {
                      if ($ppu->update()) {
                          // If the update succeeded, the application should
                          // be restarted.
                          $ppu->forceRestart();
                      }
                  }
              }
          }
          // ...
      }
      // ...
  }
 ?>

$channel =

[line 313]

The channel the package is hosted on.

$errors =

[line 359]

A collection of errors that have occurred.

$info = array()

[line 331]

Information about the latest version of the package.

$instInfo =

[line 350]

Informations about the current installed version of the package.

$instVersion =

[line 340]

The current installed version of the package.

$latestVersion =

[line 322]

The latest version available for the given package.

$packageName =

[line 304]

The name of the package.

$preferences = array()

[line 268]

The user's update preferences.

$pref_file =

[line 277]

The file to read PPU user-defined options from

$system_file =

[line 295]

The file to read PEAR system-wide defaults from

$user_file =

[line 286]

The file to read PEAR user-defined options from

__construct (Constructor)   [line 401]

---

PEAR_PackageUpdate (Constructor)   [line 377]

---

checkUpdate   [line 645]

---

determinePrefFile   [line 608]

---

factory   [line 470]

---

forceRestart   [line 1244]

---

getInstalledRelease   [line 947]

---

getLatestRelease   [line 986]

---

getPackageInfo   [line 677]

---

getPackagePreferences   [line 781]

---

hasErrors   [line 1385]

---

isIncludable   [line 520]

---

loadPreferences   [line 552]

---

popError   [line 1368]

---

preferencesAllowUpdate   [line 857]

---

presentUpdate   [line 1258]

---

pushError   [line 1294]

---

releaseType   [line 922]

---

repackagePEARError   [line 1325]

---

savePreferences   [line 802]

---

setDontAskAgain   [line 1006]

---

setDontAskUntilNextRelease   [line 1026]

---

setMinimumReleaseType   [line 1054]

---

setMinimumState   [line 1080]

---

setPreference   [line 1112]

---

setPreferences   [line 1152]

---

update   [line 1196]

---