Class: PEAR_PackageUpdate

[line 172]
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 226]

The channel the package is hosted on.

$errors =

[line 272]

A collection of errors that have occurred.

$info = array()

[line 244]

Information about the latest version of the package.

$instInfo =

[line 263]

Informations about the current installed version of the package.

$instVersion =

[line 253]

The current installed version of the package.

$latestVersion =

[line 235]

The latest version available for the given package.

$packageName =

[line 217]

The name of the package.

$preferences = array()

[line 181]

The user's update preferences.

$pref_file =

[line 190]

The file to read PPU user-defined options from

$system_file =

[line 208]

The file to read PEAR system-wide defaults from

$user_file =

[line 199]

The file to read PEAR user-defined options from

__construct (Constructor)   [line 304]

---

PEAR_PackageUpdate (Constructor)   [line 286]

---

checkUpdate   [line 532]

---

determinePrefFile   [line 506]

---

factory   [line 371]

---

forceRestart   [line 1120]

---

getInstalledRelease   [line 829]

---

getLatestRelease   [line 864]

---

getPackageInfo   [line 564]

---

getPackagePreferences   [line 663]

---

hasErrors   [line 1260]

---

isIncludable   [line 418]

---

loadPreferences   [line 449]

---

popError   [line 1245]

---

preferencesAllowUpdate   [line 741]

---

presentUpdate   [line 1134]

---

pushError   [line 1169]

---

releaseType   [line 804]

---

repackagePEAR_Error   [line 1201]

---

savePreferences   [line 683]

---

setDontAskAgain   [line 883]

---

setDontAskUntilNextRelease   [line 902]

---

setMinimumReleaseType   [line 929]

---

setMinimumState   [line 955]

---

setPreference   [line 987]

---

setPreferences   [line 1027]

---

update   [line 1071]

---