Class: PEAR_PackageUpdate

[line 272]
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();
                      }
                  }
              }
          }
          // ...
      }
      // ...
  }
 ?>

$adapters = array()

[line 381]

List of adapters used to communicate with package channels

$channel =

[line 326]

The channel the package is hosted on.

$errors =

[line 372]

A collection of errors that have occurred.

$info = array()

[line 344]

Information about the latest version of the package.

$instInfo =

[line 363]

Informations about the current installed version of the package.

$instVersion =

[line 353]

The current installed version of the package.

$latestVersion =

[line 335]

The latest version available for the given package.

$packageName =

[line 317]

The name of the package.

$preferences = array()

[line 281]

The user's update preferences.

$pref_file =

[line 290]

The file to read PPU user-defined options from

$system_file =

[line 308]

The file to read PEAR system-wide defaults from

$user_file =

[line 299]

The file to read PEAR user-defined options from

__construct (Constructor)   [line 423]

---

PEAR_PackageUpdate (Constructor)   [line 399]

---

addAdapter   [line 1445]

---

checkUpdate   [line 667]

---

determinePrefFile   [line 630]

---

factory   [line 492]

---

forceRestart   [line 1279]

---

getInstalledRelease   [line 955]

---

getLatestRelease   [line 1020]

---

getPackageInfo   [line 700]

---

getPackagePreferences   [line 789]

---

hasErrors   [line 1423]

---

isIncludable   [line 542]

---

loadPreferences   [line 574]

---

popError   [line 1406]

---

preferencesAllowUpdate   [line 865]

---

presentUpdate   [line 1295]

---

pushError   [line 1332]

---

releaseType   [line 930]

---

repackagePEARError   [line 1363]

---

savePreferences   [line 810]

---

setDontAskAgain   [line 1040]

---

setDontAskUntilNextRelease   [line 1060]

---

setMinimumReleaseType   [line 1088]

---

setMinimumState   [line 1114]

---

setPreference   [line 1146]

---

setPreferences   [line 1186]

---

update   [line 1230]

---