[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en/package/pear pear-packageupdate.xml /en/package/pear/pear-packageupdate
From: "Mark Wiesemann" <wiesemann () php ! net>
Date: 2007-06-26 10:09:31
Message-ID: cvswiesemann1182852571 () cvsserver
[Download RAW message or body]
wiesemann Tue Jun 26 10:09:31 2007 UTC
Added files:
/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate
setpreference.xml
setminimumstate.xml
getlatestrelease.xml
getinstalledrelease.xml
haserrors.xml
update.xml
poperror.xml
setminimumreleasetype.xml
setpreferences.xml
/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource
sqlquery.xml
Modified files:
/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate
setdontaskagain.xml
preferencesallowupdate.xml
determinepreffile.xml
releasetype.xml
checkupdate.xml
factory.xml
isincludable.xml
savepreferences.xml
getpackageinfo.xml
setdontaskuntilnextrelease.xml
getpackagepreferences.xml
loadpreferences.xml
/peardoc/en/package/pear pear-packageupdate.xml
Log:
- Laurent Laville's doc updates/additions for PEAR_PackageUpdate docs with some XML and typo fixes
["wiesemann-20070626100931.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml:1.2 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml:1.3
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml:1.2 Tue \
Nov 14 12:42:41 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskagain.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskagain">
<refnamediv>
@@ -10,25 +10,31 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::setDontAskAgain</methodname>
- <methodparam>&type.bool; <parameter>dontAsk</parameter></methodparam>
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setDontAskAgain</function></funcdef> + \
<paramdef>&type.bool; <parameter>$dontAsk</parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskagain.desc">
&title.desc;
<para>
Sets the user's "Don't Ask Again" preference to
- <parameter>dontAsk</parameter>. If <parameter>dontAsk</parameter> is &true;
+ <parameter>$dontAsk</parameter>. If <parameter>$dontAsk</parameter> is &true;
the user will not be asked to update the package again.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskagain.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -38,7 +44,7 @@
&type.bool; - &true; if the preference was set properly, &false; otherwise.
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
@@ -60,3 +66,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml:1.1 Wed \
Nov 8 13:49:42 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/preferencesallowupdate.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.preferencesallowupdate">
<refnamediv>
@@ -11,12 +11,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::preferencesAllowUpdate</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::preferencesAllowUpdate</function></funcdef> + \
<paramdef/> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.preferencesallowupdate.desc">
@@ -33,6 +36,9 @@
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.preferencesallowupdate.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -40,10 +46,10 @@
&title.returns;
<para>
&type.bool; - &true; if the user's preferences allow an update for the
- latest version of the package.
+ latest version of the package, &false; otherwise.
</para>
</refsect1>
-
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.preferencesallowupdate.see">
&title.see;
<para>
@@ -74,3 +80,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml:1.3 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml:1.4
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml:1.3 Mon \
Aug 7 11:44:38 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/determinepreffile.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.determinepreffile">
<refnamediv>
@@ -10,12 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.string;
- <methodname>PEAR_PackageUpdate::determinePrefFile</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.string; \
<function>PEAR_PackageUpdate::determinePrefFile</function></funcdef> + <paramdef/>
+ </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.determinepreffile.desc">
@@ -36,6 +39,9 @@
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.determinepreffile.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.canstatic;
</refsect1>
@@ -66,3 +72,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml:1.1 Tue \
Nov 14 03:38:05 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/releasetype.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.releasetype">
<refnamediv>
@@ -11,12 +11,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.string;
- <methodname>PEAR_PackageUpdate::releaseType</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.string; \
<function>PEAR_PackageUpdate::releaseType</function></funcdef> + <paramdef/>
+ </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.releasetype.desc">
@@ -36,16 +39,19 @@
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.releasetype.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.releasetype.return">
&title.returns;
<para>
- &type.string; - The release type.
+ &type.string; - The release type (bug|minor|major).
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
@@ -67,3 +73,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml:1.1 Tue \
May 2 17:43:17 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/checkupdate.xml Tue \
Jun 26 10:09:30 2007 @@ -1,48 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.checkupdate">
<refnamediv>
<refname>PEAR_PackageUpdate::checkUpdate</refname>
<refpurpose>
- Checks to see if an update is available and the user has not asked not to
+ Checks to see if an update is available and the user has asked not to
be notified about the update.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::checkUpdate</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::checkUpdate</function></funcdef> + <paramdef/>
+ </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.checkupdate.desc">
&title.desc;
<para>
- Checks to see if an update is available and the user has not asked not to
+ Checks to see if an update is available and the user has asked not to
be notified about the update.
</para>
<para>
This method takes the user's preferences in consideration when determining
if an update is available. If a new bug fix release is available but the
user has asked not to be notified until the next major release of the
- package, this method will return &false;.
+ package, this method will return &false;.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.checkupdate.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.checkupdate.return">
&title.returns;
<para>
- &type.bool; - &true; if an update is available and the user has not asked
- not to be notified about the update, &false; otherwise.
+ &type.bool; - &true; if an update is available and the user has asked
+ to be notified about the update, &false; otherwise.
</para>
</refsect1>
@@ -67,3 +73,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml?r1=1.4&r2=1.5&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml:1.4 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml:1.5
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml:1.4 Sat \
Apr 29 16:27:08 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/factory.xml Tue Jun \
26 10:09:30 2007 @@ -1,36 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.factory">
<refnamediv>
<refname>PEAR_PackageUpdate::factory</refname>
<refpurpose>
- Factory method for createing PEAR_PackageUpdate frontend instances.
+ Factory method for creating PEAR_PackageUpdate frontend instances.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.mixed;
- <methodname>PEAR_PackageUpdate::factory</methodname>
-
- <methodparam>
- &type.string;
- <parameter>$driver</parameter>
- </methodparam>
-
- <methodparam>
- &type.string;
- <parameter>$packageName</parameter>
- </methodparam>
-
- <methodparam>
- &type.string;
- <parameter>$channel</parameter>
- </methodparam>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.mixed; <function>PEAR_PackageUpdate::factory</function></funcdef>
+ <paramdef>&type.string; <parameter>$driver</parameter></paramdef>
+ <paramdef>&type.string; <parameter>$packageName</parameter></paramdef>
+ <paramdef>&type.string; <parameter>$channel</parameter></paramdef>
+ <paramdef>&type.string; <parameter><optional>$user_file = \
''</optional></parameter></paramdef> + <paramdef>&type.string; \
<parameter><optional>$system_file = ''</optional></parameter></paramdef> + \
<paramdef>&type.string; <parameter><optional>$pref_file = \
''</optional></parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.factory.desc">
@@ -44,7 +37,6 @@
&title.param;
<para>
<variablelist>
-
<varlistentry>
<term>
&type.string; <parameter>$driver</parameter>
@@ -52,12 +44,11 @@
<listitem>
<para>
The name of a frontend driver class. Must be one of
- <literal>Gtk2</literal>, <literal>CLI</literal>, or
+ <literal>Gtk2</literal>, <literal>Cli</literal>, or
<literal>Web</literal>.
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term>
&type.string; <parameter>$packageName</parameter>
@@ -69,10 +60,9 @@
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term>
- &type.string; <parameter>$driver</parameter>
+ &type.string; <parameter>$channel</parameter>
</term>
<listitem>
<para>
@@ -83,20 +73,60 @@
</para>
</listitem>
</varlistentry>
-
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$user_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ The path to the file to read PEAR user-defined options from.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$system_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ The path to the file to read PEAR system-wide defaults from.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$pref_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ The path to the file to read user's preferences from.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.factory.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_NONEXISTENTDRIVER</literal>, + when invalid \
driver name is used (i.e. Gtk2, Cli, Web). + </para>
+ </refsect1>
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.factory.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.shouldstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.factory.return">
&title.returns;
<para>
- &type.mixed; - reference to a new object or &false; when
+ &type.mixed; - reference to a new object or &false;
if the object could not be created (i.e. invalid driver name).
</para>
</refsect1>
@@ -121,4 +151,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml:1.3 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml:1.4
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml:1.3 Mon \
Aug 7 11:44:38 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/isincludable.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.isincludable">
<refnamediv>
@@ -10,16 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::isIncludable</methodname>
-
- <methodparam>
- &type.string;
- <parameter>$path</parameter>
- </methodparam>
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::isIncludable</function></funcdef> + \
<paramdef>&type.string; <parameter>$path</parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.isincludable.desc">
@@ -29,12 +28,11 @@
ensure that the driver class file can be found and included.
</para>
</refsect1>
-
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.isincludable.parameter">
&title.param;
<para>
<variablelist>
-
<varlistentry>
<term>
&type.string; <parameter>$path</parameter>
@@ -42,24 +40,26 @@
<listitem>
<para>
The path to the file to check. The path should be a subdirectory of
- one of the directories in the include path.
+ one of the directories in the include path.
</para>
</listitem>
</varlistentry>
-
</variablelist>
</para>
</refsect1>
-
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.isincludable.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.2
+ </para>
¬e.canstatic;
</refsect1>
-
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.isincludable.return">
&title.returns;
<para>
- &type.bool; - &true; if the file is includable.
+ &type.bool; - &true; if the file is includable, &false; otherwise.
</para>
</refsect1>
@@ -82,4 +82,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml:1.1 Wed \
Nov 8 13:49:42 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/savepreferences.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences">
<refnamediv>
@@ -10,12 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::savePreferences</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::savePreferences</function></funcdef> + \
<paramdef>&type.string; <parameter><optional>$pref_file = \
''</optional></parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.desc">
@@ -25,18 +28,52 @@
</para>
</refsect1>
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.parameter">
+ &title.param;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$pref_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ The path to the file to save user's preferences to.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_PREFFILE_WRITEACCESS</literal>, + when user's \
preference file has no WRITE access right. + </para>
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_PREFFILE_WRITEERROR</literal>, + when an I/O \
error occured while writing user's preference file contents. + </para>
+ </refsect1>
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.return">
&title.returns;
<para>
- &type.bool; - &true; if the user's preferences were saved successfully.
+ &type.bool; - &true; if the user's preferences were saved successfully, &false;
+ othewise.
</para>
</refsect1>
-
+
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.savepreferences.see">
&title.see;
<para>
@@ -67,3 +104,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml:1.1 Tue \
May 2 17:43:17 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackageinfo.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.getpackageinfo">
<refnamediv>
@@ -10,12 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>protected</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::getPackageInfo</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::getPackageInfo</function></funcdef> + <paramdef/>
+ </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getpackageinfo.desc">
@@ -29,10 +32,36 @@
encountered (channel server does not host the package, bad package name,
etc.) they will be pushed onto the error stack.
</para>
+ <note>
+ <para>
+ Since version 0.5.2, protocol REST 1.0 is also supported. So we try to contact
+ the packages channel server using a <classname>PEAR_REST</classname> instance,
+ if this channel support the protocol, rather than default protocol XMLRPC.
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getpackageinfo.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_NOPACKAGE</literal>, + if package name was set to \
empty. + </para>
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_NOCHANNEL</literal>, + if channel was set to \
empty. + </para>
+ <para>
+ <emphasis>throws</emphasis> <literal>PEAR_PACKAGEUPDATE_ERROR_NOINFO</literal>,
+ when there are no information available about the package name hosted on the \
channel server. + </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getpackageinfo.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -65,3 +94,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml:1.2 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml:1.3
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml:1.2 Tue \
Nov 14 12:42:41 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setdontaskuntilnextrelease.xml Tue \
Jun 26 10:09:30 2007 @@ -1,36 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskuntilnextrelease">
<refnamediv>
<refname>PEAR_PackageUpdate::setDontAskUntilNextRelease</refname>
<refpurpose>
- Sets the user's "Don't Ask Again Until Next Release" preference
+ Sets the user's "Don't Ask Again Until Next Release" preference
for the package.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.bool;
- <methodname>PEAR_PackageUpdate::setDontAskUntilNextRelease</methodname>
- <methodparam>&type.bool; <parameter>dontAsk</parameter></methodparam>
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setDontAskUntilNextRelease</function></funcdef> + \
<paramdef>&type.bool; <parameter>$dontAsk</parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskuntilnextrelease.desc">
&title.desc;
<para>
- Sets the user's "Don't Ask Again Until Next Releaase" preference
- to <parameter>dontAsk</parameter>. If <parameter>dontAsk</parameter> is
+ Sets the user's "Don't Ask Again Until Next Release" preference
+ to <parameter>$dontAsk</parameter>. If <parameter>$dontAsk</parameter> is
&true; the user will not be asked to update the package again until a new
- version is released..
+ version is released.
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskuntilnextrelease.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> <literal>PEAR_PACKAGEUPDATE_ERROR_NOINFO</literal>,
+ when there are no information available about the package name hosted on the \
channel server. </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setdontaskuntilnextrelease.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -40,7 +54,7 @@
&type.bool; - &true; if the preference was set properly, &false; otherwise.
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
@@ -62,3 +76,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml:1.1 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml:1.2
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml:1.1 Tue \
May 23 19:57:00 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getpackagepreferences.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.getpackagepreferences">
<refnamediv>
@@ -10,12 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.array;
- <methodname>PEAR_PackageUpdate::getPackagePreferences</methodname>
-
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.array; \
<function>PEAR_PackageUpdate::getPackagePreferences</function></funcdef> + \
<paramdef/> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getpackagepreferences.desc">
@@ -27,43 +30,64 @@
</para>
<para>
The array returned may have up to four elements:
- <itemizedlist>
- <listitem>
- <para>
- PEAR_PACKAGEUPDATE_PREF_NOUPDATES - if &true; the user does not want to
- know about any new updates.
- </para>
- </listitem>
- <listitem>
- <para>
- PEAR_PACKAGEUPDATE_PREF_NEXTRELEASE - if set, the user does not want to
- be asked until a version greater than the value of this element has been
- released.
- </para>
- </listitem>
- <listitem>
- <para>
- PEAR_PACKAGEUPDATE_PREF_TYPE - if set, the user does not want to be
- notified unless the release is at least the given type (one of
- PEAR_PACKAGEUPDATE_TYPE_BUG, PEAR_PACKAGEUPDATE_TYPE_MINOR,
- PEAR_PACKAGEUPDATE_MAJOR).
- </para>
- </listitem>
- <listitem>
- <para>
- PEAR_PACKAGEUPDATE_PREF_STATE - if set, the user does not want to be
- notified unless the release has at least the given state (one of
- PEAR_PACKAGEUPDATE_PREF_STATE_DEVEL, PEAR_PACKAGEUPDATE_PREF_STATE_ALPHA,
- PEAR_PACKAGEUPDATE_PREF_STATE_BETA,
- PEAR_PACKAGEUPDATE_PREF_STATE_STABLE).
- </para>
- </listitem>
- </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <literal>PEAR_PACKAGEUPDATE_PREF_NOUPDATES</literal>
+ </term>
+ <listitem>
+ <para>
+ if &true; the user does not want to know about any new updates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>PEAR_PACKAGEUPDATE_PREF_NEXTRELEASE</literal>
+ </term>
+ <listitem>
+ <para>
+ if set, the user does not want to be asked until
+ a version greater than the value of this element has been released.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>PEAR_PACKAGEUPDATE_PREF_TYPE</literal>
+ </term>
+ <listitem>
+ <para>
+ if set, the user does not want to be
+ notified unless the release is at least the given type (one of
+ PEAR_PACKAGEUPDATE_TYPE_BUG, PEAR_PACKAGEUPDATE_TYPE_MINOR,
+ PEAR_PACKAGEUPDATE_TYPE_MAJOR).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>PEAR_PACKAGEUPDATE_PREF_STATE</literal>
+ </term>
+ <listitem>
+ <para>
+ if set, the user does not want to be
+ notified unless the release has at least the given state (one of
+ PEAR_PACKAGEUPDATE_PREF_STATE_DEVEL, PEAR_PACKAGEUPDATE_PREF_STATE_ALPHA,
+ PEAR_PACKAGEUPDATE_PREF_STATE_BETA,
+ PEAR_PACKAGEUPDATE_PREF_STATE_STABLE).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getpackagepreferences.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -95,3 +119,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml
diff -u peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml:1.2 \
peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml:1.3
--- peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml:1.2 Tue \
May 2 17:43:17 2006
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/loadpreferences.xml Tue \
Jun 26 10:09:30 2007 @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.loadpreferences">
<refnamediv>
@@ -10,13 +10,15 @@
</refnamediv>
<refsynopsisdiv>
- <methodsynopsis>
- <modifier>public</modifier>
- &type.mixed;
- <methodname>
- PEAR_PackageUpdate::loadPreferences
- </methodname>
- </methodsynopsis>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/PackageUpdate.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.bool; \
<function>PEAR_PackageUpdate::loadPreferences</function></funcdef> + \
<paramdef>&type.string; <parameter><optional>$pref_file = \
''</optional></parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.loadpreferences.desc">
@@ -25,14 +27,61 @@
Loads the user's preferences from the preference file.
</para>
<para>
- The preferences are stored in the user's home directory as the file
+ If the user is on a Windows machine, the file will be in the
+ <literal>PEAR_CONFIG_SYSCONFIG</literal> directory and named
+ <literal>ppurc.ini</literal>. If the user is on any other operating system, the
+ preferences file will be stored in the user's home directory as the file
<literal>.ppurc</literal>. The file contains a serialized array of
preferences for each package that has been checked for updates so far.
</para>
+ <note>
+ <para>
+ Since version 0.7.0, you could also choose another directory and name for your
+ preference file. Use then the optional parameter \
<parameter>$pref_file</parameter>. + </para>
+ </note>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.loadpreferences.parameter">
+ &title.param;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$pref_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ The path to the file to read user's preferences from.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.loadpreferences.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_PREFFILE_READACCESS</literal>, + when user's \
preference file has no READ access right. + </para>
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_PREFFILE_CORRUPTED</literal>, + when user's \
preference file has invalid contents. + </para>
+ <para>
+ <emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_INVALIDINIFILE</literal>, + when user's \
preference file given by parameter <parameter>$pref_file</parameter> + does not \
exist. + </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.loadpreferences.note">
&title.note;
+ <para>
+ <emphasis>since</emphasis> 0.4.0a1
+ </para>
¬e.notstatic;
</refsect1>
@@ -64,3 +113,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate.xml?r1=1.6&r2=1.7&diff_format=u
Index: peardoc/en/package/pear/pear-packageupdate.xml
diff -u peardoc/en/package/pear/pear-packageupdate.xml:1.6 \
peardoc/en/package/pear/pear-packageupdate.xml:1.7
--- peardoc/en/package/pear/pear-packageupdate.xml:1.6 Tue Nov 14 04:29:13 2006
+++ peardoc/en/package/pear/pear-packageupdate.xml Tue Jun 26 10:09:30 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<sect1 id="package.pear.pear-packageupdate">
<title>PEAR_PackageUpdate</title>
<refentry id="package.pear.pear-packageupdate.pear-packageupdate-summary">
@@ -19,7 +19,7 @@
for the latest release and self-updating with the user's permission.
Auto-update features help developers by reducing the number of different
versions of a package which are currently used. This reduces the likely hood
- of bugs related to outdated versions being reported.
+ of bugs related to outdated versions being reported.
</para>
<para>
This package automates the update process but still allows the user to
@@ -27,13 +27,13 @@
preferences and allows the user to decide not only if the package should be
updated but also when to be alerted to new updates. The user can decide to
only be notified when a new release has a certain state or release type (bug
- fix, feature enhancment, or major version). The user can even turn off the
+ fix, feature enhancement, or major version). The user can even turn off the
updating features. All of these settings are on a package-by-package basis.
</para>
<para>
PEAR::PackageUpdate is designed to be a backend for other packages which
provide different interface types. For example, this package can be used to
- drive a PHP-GTK 2, CLI or HTML frontend.
+ drive a PHP-GTK 2, CLI or HTML frontend.
</para>
</refsect1>
<refsect1>
@@ -50,7 +50,70 @@
require_once 'PEAR/PackageUpdate.php';
// Load the PHP-GTK 2 driver to check for updates for pear://Foo
$ppu = PEAR_PackageUpdate::factory('Gtk2', 'Foo', 'pear');
-
+
+ // Check for trouble loading the driver.
+ if ($ppu !== false) {
+
+ // See if a new version is available (respects user prefs).
+ if ($ppu->checkUpdate()) {
+
+ // Ask for permission to update.
+ if ($ppu->presentUpdate()) {
+
+ if ($ppu->update()) {
+
+ // The update was a success. The app must be
+ // restarted.
+ $ppu->forceRestart();
+ }
+ }
+ }
+ }
+ // ...
+ }
+ // ...
+}
+?>]]>
+ </programlisting>
+ </para>
+</refsect1>
+<refsect1>
+ <title>
+ How to check warnings and/or errors
+ </title>
+ <para>
+ Rather than stop on first error/warning encountered, as it's done by other PHP4 \
PEAR packages, + PEAR::PackageUpdate used the
+ <link linkend="core.pear.pear-errorstack.intro">
+ <classname>PEAR_ErrorStack</classname>
+ </link>
+ for advanced error handling.
+ </para>
+ <para>
+ PEAR_ErrorStack implements error raising and handling using a stack pattern.
+ So, to determine whether there are any errors on the stack, you should use the
+ <link linkend="package.pear.pear-packageupdate.pear-packageupdate.haserrors"><function>PEAR_PackageUpdate::hasErrors</function></link>.
+ And to retrieve each error/warning, one by one, from the stack, you have to use \
the + <link linkend="package.pear.pear-packageupdate.pear-packageupdate.poperror"><function>PEAR_PackageUpdate::popError</function></link>.
+ </para>
+ <para>
+ See example below:
+ <warning>
+ <para>
+ Usage of error levels with <function>PEAR_PackageUpdate::hasErrors</function> is \
only + available since version 0.7.0
+ </para>
+ </warning>
+ <programlisting role="php-highlighted">
+<![CDATA[<?php
+class Foo {
+ function __construct()
+ {
+ // Try to update the package if needed.
+ require_once 'PEAR/PackageUpdate.php';
+ // Load the Cli driver to check for updates for pear://Foo
+ $ppu = PEAR_PackageUpdate::factory('Cli', 'Foo', 'pear');
+
// Check for trouble loading the driver.
if ($ppu !== false) {
@@ -65,6 +128,30 @@
// The update was a success. The app must be
// restarted.
$ppu->forceRestart();
+ } else {
+ // Error handling
+ if ($ppu->hasErrors('warning')) {
+ // Warning: specifying error levels is only allowed \
since version 0.7.0 + // Retrieve only first warning, not \
all + $error = $ppu->popError();
+ echo "Warning occured when trying to update: pear/Foo \
package\n"; + echo "Message: " . $error['message'] ."\n";
+ }
+ if ($ppu->hasErrors()) {
+ // Retrieve only first error, not all
+ $error = $ppu->popError();
+ echo "Error occured when trying to update: pear/Foo \
package\n"; + echo "Message: " . $error['message'] ."\n";
+ if (isset($error['context']) {
+ // context is available
+ echo "*** Context: ***\n";
+ echo "File: " . $error['context']['file'] ."\n";
+ echo "Line: " . $error['context']['line'] ."\n";
+ echo "Function: " . $error['context']['function'] \
."\n"; + echo "Class: " . $error['context']['class'] \
."\n"; + }
+ exit();
+ }
}
}
}
@@ -88,23 +175,22 @@
&package.pear.pear-packageupdate.pear-packageupdate.savepreferences;
&package.pear.pear-packageupdate.pear-packageupdate.preferencesallowupdate;
&package.pear.pear-packageupdate.pear-packageupdate.releasetype;
+&package.pear.pear-packageupdate.pear-packageupdate.getinstalledrelease;
+&package.pear.pear-packageupdate.pear-packageupdate.getlatestrelease;
&package.pear.pear-packageupdate.pear-packageupdate.setdontaskagain;
&package.pear.pear-packageupdate.pear-packageupdate.setdontaskuntilnextrelease;
-<!--
&package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype;
&package.pear.pear-packageupdate.pear-packageupdate.setminimumstate;
&package.pear.pear-packageupdate.pear-packageupdate.setpreference;
&package.pear.pear-packageupdate.pear-packageupdate.setpreferences;
&package.pear.pear-packageupdate.pear-packageupdate.update;
-&package.pear.pear-packageupdate.pear-packageupdate.forcerestart;
-&package.pear.pear-packageupdate.pear-packageupdate.presentupdate;
-&package.pear.pear-packageupdate.pear-packageupdate.pusherror;
-&package.pear.pear-packageupdate.pear-packageupdate.repackagepear-error;
&package.pear.pear-packageupdate.pear-packageupdate.poperror;
&package.pear.pear-packageupdate.pear-packageupdate.haserrors;
+<!--
+&package.pear.pear-packageupdate.pear-packageupdate.forcerestart;
+&package.pear.pear-packageupdate.pear-packageupdate.presentupdate;
-->
</sect1>
-<!-- Generated by phpDocumentor v 1.3.0 http://www.phpdoc.org -->
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -124,3 +210,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreference.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreference.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreference.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setpreference">
<refnamediv>
<refname>PEAR_PackageUpdate::setPreference</refname>
<refpurpose>
Sets the given preference to the given value.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setPreference</function></funcdef> \
<paramdef>&type.string; <parameter>$pref</parameter></paramdef> \
<paramdef>&type.string; <parameter>$value</parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreference.desc">
&title.desc;
<para>
Sets one of the given preference to the given value. Both preference and value,
should have valid values.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreference.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_INVALIDPREF</literal>, when invalid preference is \
used (PEAR_PACKAGEUPDATE_PREF_NOUPDATES, PEAR_PACKAGEUPDATE_PREF_NEXTRELEASE, \
PEAR_PACKAGEUPDATE_PREF_TYPE, PEAR_PACKAGEUPDATE_PREF_STATE). </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreference.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreference.return">
&title.returns;
<para>
&type.bool; - &true; if the preference was set properly, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumstate.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumstate.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumstate.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setminimumstate">
<refnamediv>
<refname>PEAR_PackageUpdate::setMinimumState</refname>
<refpurpose>
Sets the user's preference for asking about release states.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setMinimumState</function></funcdef> \
<paramdef>&type.string; <parameter>$minState</parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumstate.desc">
&title.desc;
<para>
Sets the user's preference for asking about minimum release state.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumstate.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_INVALIDSTATE</literal>, when invalid state of \
release is used (snapshot|devel|alpha|beta|stable). </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumstate.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumstate.return">
&title.returns;
<para>
&type.bool; - &true; if the preference was set properly, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getlatestrelease.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getlatestrelease.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getlatestrelease.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.getlatestrelease">
<refnamediv>
<refname>PEAR_PackageUpdate::getLatestRelease</refname>
<refpurpose>
Loads the latest package information from the channel server.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.mixed; \
<function>PEAR_PackageUpdate::getLatestRelease</function></funcdef> <paramdef/>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getlatestrelease.desc">
&title.desc;
<para>
Loads the informations from the channel server.
</para>
<para>
<variablelist>
<varlistentry>
<term>
&type.string; <literal>license</literal>
</term>
<listitem>
<para>
The license the latest package version is released under.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>summary</literal>
</term>
<listitem>
<para>
A short description about the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>description</literal>
</term>
<listitem>
<para>
A long description about the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>releasedate</literal>
</term>
<listitem>
<para>
The date of the latest release available from the channel server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>releasenotes</literal>
</term>
<listitem>
<para>
Description about changes on the package from previous release.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>state</literal>
</term>
<listitem>
<para>
The state of the package release installed (snapshot|devel|alpha|beta|stable).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.array; <literal>deps</literal>
</term>
<listitem>
<para>
The list of dependencies for this release of the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>version</literal>
</term>
<listitem>
<para>
The version of the latest release available from the channel server.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getlatestrelease.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.6.0
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getlatestrelease.return">
&title.returns;
<para>
&type.bool; - &false; if the information was not available.
</para>
<para>
&type.array; - informations about the current installed version of the package
(license, summary, description, releasedate, releasenotes, state, deps, version).
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getinstalledrelease.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getinstalledrelease.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/getinstalledrelease.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.getinstalledrelease">
<refnamediv>
<refname>PEAR_PackageUpdate::getInstalledRelease</refname>
<refpurpose>
Loads the latest package information from the current installation.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.mixed; \
<function>PEAR_PackageUpdate::getInstalledRelease</function></funcdef> <paramdef/>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getinstalledrelease.desc">
&title.desc;
<para>
Loads the informations about current installed version of the package.
</para>
<para>
<variablelist>
<varlistentry>
<term>
&type.string; <literal>version</literal>
</term>
<listitem>
<para>
The version of installed package name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>license</literal>
</term>
<listitem>
<para>
The license this package is released under.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>summary</literal>
</term>
<listitem>
<para>
A short description about the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>description</literal>
</term>
<listitem>
<para>
A long description about the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>releasedate</literal>
</term>
<listitem>
<para>
The date of the release of the version installed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>releasenotes</literal>
</term>
<listitem>
<para>
Description about changes on the package from previous release.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>state</literal>
</term>
<listitem>
<para>
The state of the package release installed (snapshot|devel|alpha|beta|stable).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.array; <literal>deps</literal>
</term>
<listitem>
<para>
The list of dependencies for this release of the package.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>xsdversion</literal>
</term>
<listitem>
<para>
The version of the XML package used to install this release (1.0 or 2.0).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string; <literal>packagerversion</literal>
</term>
<listitem>
<para>
The version of the PEAR packager that was used to build this release.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getinstalledrelease.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.6.0
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.getinstalledrelease.return">
&title.returns;
<para>
&type.bool; - &false; if the information was not available.
</para>
<para>
&type.array; - informations about the current installed version of the package
(version, license, summary, description, releasedate, releasenotes, state, deps,
xsdversion, packagerversion).
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/haserrors.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/haserrors.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/haserrors.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.haserrors">
<refnamediv>
<refname>PEAR_PackageUpdate::hasErrors</refname>
<refpurpose>
Returns whether or not errors have occurred (and been captured).
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; <function>PEAR_PackageUpdate::hasErrors</function></funcdef>
<paramdef>&type.mixed; <parameter><optional>$level = \
&false;</optional></parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.haserrors.desc">
&title.desc;
<para>
Returns whether or not errors , and or, warnings (version 0.7.0 or better)
have occurred.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.haserrors.parameter">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.mixed; <parameter>$level</parameter>
</term>
<listitem>
<para>
The level of errors to pop off of the stack (warning|error). Use &false;
if you want all errors and warnings at once.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.haserrors.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.haserrors.return">
&title.returns;
<para>
&type.bool; - &true; if errors(/warnings) have been captured, &false; othewise.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.haserrors.see">
&title.see;
<para>
<link linkend="package.pear.pear-packageupdate.pear-packageupdate.poperror">
<function>PEAR_PackageUpdate::popError</function>
</link>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/update.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/update.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/update.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.update">
<refnamediv>
<refname>PEAR_PackageUpdate::update</refname>
<refpurpose>
Updates the source for the package.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; <function>PEAR_PackageUpdate::update</function></funcdef>
<paramdef/>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.update.desc">
&title.desc;
<para>
Updates your current installation with the new source for the package.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.update.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_NOTINSTALLED</literal>, if the package is not \
already installed. </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.update.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.update.return">
&title.returns;
<para>
&type.bool; - &true; if the update was successful, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/poperror.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/poperror.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/poperror.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.poperror">
<refnamediv>
<refname>PEAR_PackageUpdate::popError</refname>
<refpurpose>
Pops an error off the error stack.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.array; <function>PEAR_PackageUpdate::popError</function></funcdef>
<paramdef/>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.poperror.desc">
&title.desc;
<para>
Pops an error off the error stack.
</para>
<para>
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.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.poperror.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.poperror.return">
&title.returns;
<para>
&type.array; - details of an error or warning (with debug context if available).
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.poperror.see">
&title.see;
<para>
<link linkend="package.pear.pear-packageupdate.pear-packageupdate.haserrors">
<function>PEAR_PackageUpdate::hasErrors</function>
</link>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumreleasetype.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumreleasetype.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setminimumreleasetype.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype">
<refnamediv>
<refname>PEAR_PackageUpdate::setMinimumReleaseType</refname>
<refpurpose>
Sets the user's preference for asking about release types.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setMinimumReleaseType</function></funcdef> \
<paramdef>&type.string; <parameter>$minType</parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype.desc">
&title.desc;
<para>
Sets the user's preference for asking about minimum release types.
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> \
<literal>PEAR_PACKAGEUPDATE_ERROR_INVALIDTYPE</literal>, when invalid type of \
release is used (bug|minor|major). </para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setminimumreleasetype.return">
&title.returns;
<para>
&type.bool; - &true; if the preference was set properly, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreferences.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreferences.xml
+++ peardoc/en/package/pear/pear-packageupdate/pear-packageupdate/setpreferences.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-packageupdate.pear-packageupdate.setpreferences">
<refnamediv>
<refname>PEAR_PackageUpdate::setPreferences</refname>
<refpurpose>
Sets all preferences at once.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/PackageUpdate.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; \
<function>PEAR_PackageUpdate::setPreferences</function></funcdef> \
<paramdef>&type.array; <parameter>$preferences</parameter></paramdef> \
</funcprototype> </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreferences.desc">
&title.desc;
<para>
Sets a group of preference with associated values, all at once. Invalid preference
is ignored (no error raised).
</para>
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreferences.note">
&title.note;
<para>
<emphasis>since</emphasis> 0.4.0a1
</para>
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-packageupdate.pear-packageupdate.setpreferences.return">
&title.returns;
<para>
&type.bool; - &true; if all the preferences were set properly, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/sqlquery.xml?view=markup&rev=1.1
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/sqlquery.xml
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/sqlquery.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.sqlquery">
<refnamediv>
<refname>Structures_DataGrid_DataSource_SQLQuery</refname>
<refpurpose>SQL Query Data Source Driver</refpurpose>
</refnamediv>
<refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.sqlquery.desc">
<title>Description</title>
<para>
This class is a Data Source driver for SQL queries
</para>
</refsect1>
<refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.sqlquery.modes">
<title>Supported operations modes</title>
<para>
This driver supports the following operation modes:
</para>
<table>
<title>Supported operations modes of this driver</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Supported?</entry>
</row>
</thead>
<tbody>
<row>
<entry>Multiple field sorting</entry>
<entry>yes</entry>
</row>
<row>
<entry>Insert, update and delete records</entry>
<entry>no</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.sqlquery.options">
<title>Options</title>
<para>
This driver accepts the following options:
</para>
<table>
<title>Options for this driver</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Type</entry>
<entry>Description</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>backend</entry>
<entry>string</entry>
<entry>The backend that should be used. Allowed values: 'DB', 'MDB2',
'PDO'. This option is only used when the 'dsn' option is given.</entry>
<entry>null</entry>
</row>
<row>
<entry>count_query</entry>
<entry>string</entry>
<entry>Query that calculates the number of rows. See below for more
information about when such a count query is needed.</entry>
<entry>''</entry>
</row>
<row>
<entry>db_options</entry>
<entry>array</entry>
<entry>Options for the created database object. This option is only used
when the 'dsn' option is given.</entry>
<entry>array()</entry>
</row>
<row>
<entry>dbc</entry>
<entry>object</entry>
<entry>A database object that should be used by this driver. Either this
or the 'dsn' option is required.</entry>
<entry>null</entry>
</row>
<row>
<entry>dsn</entry>
<entry>string</entry>
<entry>A DSN string (compatible with DB/MDB2 or PDO). The DB/MDB2 or PDO
connection will be established by this driver. For usage with PDO you
might need to specify also the 'username' and 'password' options. Either
this or the 'dbc' option is required.</entry>
<entry>null</entry>
</row>
<row>
<entry>fields</entry>
<entry>array</entry>
<entry>Which data fields to fetch from the datasource. An empty array
means: all fields. Form: array(field1, field2, ...)</entry>
<entry>array()</entry>
</row>
<row>
<entry>generate_columns</entry>
<entry>bool</entry>
<entry>Generate Structures_DataGrid_Column objects with labels. See the
'labels' option. DEPRECATED: use Structures_DataGrid::generateColumns()
instead</entry>
<entry>false</entry>
</row>
<row>
<entry>labels</entry>
<entry>array</entry>
<entry>Data field to column label mapping. Only used when
'generate_columns' is true. Form: array(field => label, ...)
DEPRECATED: use Structures_DataGrid::generateColumns() instead</entry>
<entry>array()</entry>
</row>
<row>
<entry>password</entry>
<entry>string</entry>
<entry>Password for the crated PDO connection. Only needed in conjunction
with 'dsn' option.</entry>
<entry>null</entry>
</row>
<row>
<entry>primary_key</entry>
<entry>array</entry>
<entry>Name(s), or numerical index(es) of the field(s) which contain a
unique record identifier (only use several fields in case of a
multiple-fields primary key)</entry>
<entry>null</entry>
</row>
<row>
<entry>username</entry>
<entry>string</entry>
<entry>Username for the created PDO connection. Only needed in
conjunction with 'dsn' option.</entry>
<entry>null</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.sqlquery.notes">
<title>General notes</title>
<para>
You need to specify either a database object, or a DB/MDB2 or PDO compatible
DSN string as an option to use this driver.
</para>
<para>
If you use complex queries (e.g. with complex joins or with aliases),
$datagrid->getRecordCount() might return a wrong result. For the case of
GROUP BY, UNION, or DISTINCT in your queries, and for the case of subqueries,
this driver already has special handling. However, if you observe wrong
record counts, you need to specify a special query that returns only the
number of records (e.g. 'SELECT COUNT(*) FROM ...') as an additional option
'count_query' to the bind() call.
</para>
<para>
You can specify an ORDER BY statement in your query. Please be aware that this
sorting statement is then used in *every* query before the sorting options
that come from a renderer (e.g. by clicking on the column header when using
the HTML_Table renderer which is sent in the HTTP request).
If you want to give a default sorting statement that is only used if there is
no sorting query in the HTTP request, then use $datagrid->setDefaultSort().
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic