cvs: phpdoc /en/reference/rpmreader/functions rpm-close.xml rpm-get-tag.xml rpm-is-valid.xml rpm-open.xml rpm_close.xml rpm_get_tag.xml
rpm_is_valid.xml rpm_open.xml

jsgoupil Sat Oct 15 10:17:22 2005 EDT Added files: /phpdoc/en/reference/rpmreader/functions rpm-close.xml rpm-get-tag.xml rpm-is-valid.xml rpm-open.xml Removed files: /phpdoc/en/reference/rpmreader/functions rpm_close.xml rpm_get_tag.xml rpm_is_valid.xml rpm_open.xml Log: using dash instead of underscore for functions filename - no change in file

http://cvs.php.net/co.php/phpdoc/en/reference/rpmreader/functions/rpm-close.xml?r=1.1&p=1 Index: phpdoc/en/reference/rpmreader/functions/rpm-close.xml +++ phpdoc/en/reference/rpmreader/functions/rpm-close.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.rpm-close"> <refnamediv> <refname>rpm_close</refname> <refpurpose>Closes an RPM file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>boolean</type><methodname>rpm_close</methodname> <methodparam><type>resource</type><parameter>rpmr</parameter></methodparam> </methodsynopsis> <para> <function>rpm_close</function> will close an RPM file pointer. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>rpmr</parameter></term> <listitem> <para> A file pointer resource successfully opened by <function>rpm_open</function>. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>rpm_close</function> example</title> <programlisting role="php"> <![CDATA[ <?php $file = "/path/to/file.rpm"; $rpmr = rpm_open($file); rpm_close($rpmr); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>rpm_open</function></member> </simplelist> </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 indent-tabs-mode:nil 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/co.php/phpdoc/en/reference/rpmreader/functions/rpm-get-tag.xml?r=1.1&p=1 Index: phpdoc/en/reference/rpmreader/functions/rpm-get-tag.xml +++ phpdoc/en/reference/rpmreader/functions/rpm-get-tag.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.rpm-get-tag"> <refnamediv> <refname>rpm_get_tag</refname> <refpurpose>Retrieves a header tag from an RPM file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>rpm_get_tag</methodname> <methodparam><type>resource</type><parameter>rpmr</parameter></methodparam> <methodparam><type>int</type><parameter>tagnum</parameter></methodparam> </methodsynopsis> <para> <function>rpm_get_tag</function> will retrieve a given tag from the RPM file's header and return it. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>rpmr</parameter></term> <listitem> <para> A file pointer resource successfully opened by <function>rpm_open</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>tagnum</parameter></term> <listitem> <para> The tag number to retrieve from the RPM header. This value can be specified using the list of constants defined by this module. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The return value can be of various types depending on the <parameter>tagnum</parameter> supplied to the function. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>rpm_get_tag</function> example</title> <programlisting role="php"> <![CDATA[ <?php $file = "/path/to/file.rpm"; $rpmr = rpm_open($file); $name = rpm_get_tag($rpmr, RPMREADER_NAME); echo "$name<br>\n"; rpm_close($rpmr); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>rpm_open</function></member> <member><function>rpm_close</function></member> </simplelist> </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 indent-tabs-mode:nil 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/co.php/phpdoc/en/reference/rpmreader/functions/rpm-is-valid.xml?r=1.1&p=1 Index: phpdoc/en/reference/rpmreader/functions/rpm-is-valid.xml +++ phpdoc/en/reference/rpmreader/functions/rpm-is-valid.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.rpm-is-valid"> <refnamediv> <refname>rpm_is_valid</refname> <refpurpose>Tests a filename for validity as an RPM file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>boolean</type><methodname>rpm_is_valid</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> <function>rpm_is_valid</function> will test an RPM file for validity as an RPM file. This is not the same as <function>rpm_open</function> as it only checks the file for validity but does not return a file pointer to be used by further functions. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>filename</parameter></term> <listitem> <para> The filename of the RPM file you wish to check for validity. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>rpm_is_valid</function> example</title> <programlisting role="php"> <![CDATA[ <?php $file = "/path/to/file.rpm"; if (rpm_is_valid($file)) { echo "File is recognized as an RPM file.<br>\n"; } else { echo "File is not recognized as an RPM file.<br>\n"; } ?> ]]> </programlisting> </example> </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 indent-tabs-mode:nil 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/co.php/phpdoc/en/reference/rpmreader/functions/rpm-open.xml?r=1.1&p=1 Index: phpdoc/en/reference/rpmreader/functions/rpm-open.xml +++ phpdoc/en/reference/rpmreader/functions/rpm-open.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.rpm-open"> <refnamediv> <refname>rpm_open</refname> <refpurpose>Opens an RPM file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>rpm_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> <function>rpm_open</function> will open an RPM file and will determine if the file is a valid RPM file. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>filename</parameter></term> <listitem> <para> The filename of the RPM file you wish to open. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> If the open succeeds, then <function>rpm_open</function> will return a file pointer resource to the newly opened file. On error, the function will return &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>rpm_open</function> example</title> <programlisting role="php"> <![CDATA[ <?php $file = "/path/to/file.rpm"; $rpmr = rpm_open($file); rpm_close($rpmr); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>rpm_close</function></member> </simplelist> </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 indent-tabs-mode:nil 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 -->