cvs: phpdoc /en/reference/rar/functions Rar-extract.xml Rar-getAttr.xml Rar-getCrc.xml Rar-getFileTime.xml Rar-getHostOs.xml Rar-getMethod.xml
Rar-getName.xml Rar-getPackedSize.xml Rar-getUnpackedSize.xml Rar-getVersion.xml rar-extract.xml rar-getattr.xml rar-getcrc.xml rar-getfiletime.xml
rar-gethostos.xml rar-getmethod.xml rar-getname.xml rar-getpackedsize.xml rar-getunpackedsize.xml rar-getversion.xml

tony2001 Tue Sep 28 08:23:28 2004 EDT Added files: /phpdoc/en/reference/rar/functions rar-extract.xml rar-getattr.xml rar-getcrc.xml rar-getfiletime.xml rar-gethostos.xml rar-getmethod.xml rar-getname.xml rar-getpackedsize.xml rar-getunpackedsize.xml rar-getversion.xml Removed files: /phpdoc/en/reference/rar/functions Rar-extract.xml Rar-getAttr.xml Rar-getCrc.xml Rar-getFileTime.xml Rar-getHostOs.xml Rar-getMethod.xml Rar-getName.xml Rar-getPackedSize.xml Rar-getUnpackedSize.xml Rar-getVersion.xml Log: convert all filenames to lowercase

http://cvs.php.net/co.php/phpdoc/en/reference/rar/functions/rar-extract.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-extract.xml +++ phpdoc/en/reference/rar/functions/rar-extract.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-extract"> <refnamediv> <refname>Rar::extract</refname> <refpurpose>Extract entry from the archive</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>Rar::extract</methodname> <methodparam><type>string</type><parameter>dir</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>filepath</parameter></methodparam> </methodsynopsis> <para> <function>Rar::extract</function> extracts entry's data to the <parameter>dir</parameter>. It will create new file in the specified <parameter>dir</parameter> with the name identical to the entry's name. If parameter <parameter>filepath</parameter> is specified instead <parameter>dir</parameter>, <function>Rar::extract</function> will extract entry's data to the specified file. </para> <example> <title><function>Rar::extract</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); $entry->extract('/dir/to'); // create /dir/to/Dir/file.txt $entry->extract(false, '/dir/to/new_name.txt'); // create /dir/to/new_name.txt ?> ]]> </programlisting> </example> <para> &return.success; </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/rar/functions/rar-getattr.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getattr.xml +++ phpdoc/en/reference/rar/functions/rar-getattr.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getAttr"> <refnamediv> <refname>Rar::getAttr</refname> <refpurpose>Get attributes of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getAttr</methodname> <void/> </methodsynopsis> <para> <function>Rar::getAttr</function> returns attributes of the archive entry. </para> <example> <title><function>Rar::getAttr</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Can't open Rar archive"); $entry = rar_entry_get($rar_file, 'dir/in/the/archive') or die("Can't find such entry"); $host_os = $entry->getHostOs(); $attr = $entry->getAttr(); switch($host_os) { case RAR_HOST_MSDOS: case RAR_HOST_OS2: case RAR_HOST_WIN32: case RAR_HOST_MACOS: printf("%c%c%c%c%c%c\n", ($attr & 0x08) ? 'V' : '.', ($attr & 0x10) ? 'D' : '.', ($attr & 0x01) ? 'R' : '.', ($attr & 0x02) ? 'H' : '.', ($attr & 0x04) ? 'S' : '.', ($attr & 0x20) ? 'A' : '.'); break; case RAR_HOST_UNIX: case RAR_HOST_BEOS: switch ($attr & 0xF000) { case 0x4000: printf("d"); break; case 0xA000: printf("l"); break; default: printf("-"); break; } printf("%c%c%c%c%c%c%c%c%c\n", ($attr & 0x0100) ? 'r' : '-', ($attr & 0x0080) ? 'w' : '-', ($attr & 0x0040) ? (($attr & 0x0800) ? 's':'x'):(($attr & 0x0800) ? 'S':'-'), ($attr & 0x0020) ? 'r' : '-', ($attr & 0x0010) ? 'w' : '-', ($attr & 0x0008) ? (($attr & 0x0400) ? 's':'x'):(($attr & 0x0400) ? 'S':'-'), ($attr & 0x0004) ? 'r' : '-', ($attr & 0x0002) ? 'w' : '-', ($attr & 0x0001) ? 'x' : '-'); break; } rar_close($rar_file); ?> ]]> </programlisting> </example> <para> <function>Rar::getAttr</function> returns &false; on error. </para> <para> See also <function>Rar::getHostOs</function>. </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/rar/functions/rar-getcrc.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getcrc.xml +++ phpdoc/en/reference/rar/functions/rar-getcrc.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getCrc"> <refnamediv> <refname>Rar::getCrc</refname> <refpurpose>Get CRC of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getCrc</methodname> <void/> </methodsynopsis> <para> <function>Rar::getCrc</function> returns CRC of the archive entry. </para> <example> <title><function>Rar::getCrc</function> example</title> <programlisting role="php"> <![CDATA[ <?php ?> ]]> </programlisting> </example> <para> <function>Rar::getCrc</function> returns &false; on error. </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/rar/functions/rar-getfiletime.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getfiletime.xml +++ phpdoc/en/reference/rar/functions/rar-getfiletime.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getFileTime"> <refnamediv> <refname>Rar::getFileTime</refname> <refpurpose>Get entry last modification time</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>Rar::getFileTime</methodname> <void/> </methodsynopsis> <para> <function>Rar::getFileTime</function> returns entry last modification time as string in format YYYY-MM-DD HH:II:SS. </para> <example> <title><function>Rar::</function> example</title> <programlisting role="php"> <![CDATA[ <?php ?> ]]> </programlisting> </example> <para> <function>Rar::getFileTime</function> returns &false; on error. </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/rar/functions/rar-gethostos.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-gethostos.xml +++ phpdoc/en/reference/rar/functions/rar-gethostos.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getHostOs"> <refnamediv> <refname>Rar::getHostOs</refname> <refpurpose>Get entry host OS</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getHostOs</methodname> <void/> </methodsynopsis> <para> <function>Rar::getHostOs</function> return code of the host OS of the archive entry. </para> <example> <title><function>Rar::getHostOs</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); switch ($entry->getHostOs()) { case RAR_HOST_MSDOS: echo "MS-DOS\n"; break; case RAR_HOST_OS2: echo "OS2\n"; break; case RAR_HOST_WIN32: echo "Win32\n"; break; case RAR_HOST_MACOS: echo "MacOS\n"; break; case RAR_HOST_UNIX: echo "Unix/Linux\n"; break; case RAR_HOST_BEOS: echo "BeOS\n"; break; } ?> ]]> </programlisting> </example> <para> <function>Rar::getHostOs</function> returns &false; on error. </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/rar/functions/rar-getmethod.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getmethod.xml +++ phpdoc/en/reference/rar/functions/rar-getmethod.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getMethod"> <refnamediv> <refname>Rar::getMethod</refname> <refpurpose>Get pack method of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getMethod</methodname> <void/> </methodsynopsis> <para> <function>Rar::getMethod</function> returns number of the method used when adding current archive entry. </para> <example> <title><function>Rar::getMethod</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); echo "Method number: " . $entry->getMethod(); ?> ]]> </programlisting> </example> <para> <function>Rar::getMethod</function> returns &false; on error. </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/rar/functions/rar-getname.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getname.xml +++ phpdoc/en/reference/rar/functions/rar-getname.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getName"> <refnamediv> <refname>Rar::getName</refname> <refpurpose>Get name of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>Rar::getName</methodname> <void/> </methodsynopsis> <para> <function>Rar::getName</function> returns full name of the archive entry. </para> <example> <title><function>Rar::getName</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); echo "Entry name: " . $entry->getName(); ?> ]]> </programlisting> </example> <para> <function>Rar::getName</function> returns &false; on error. </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/rar/functions/rar-getpackedsize.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getpackedsize.xml +++ phpdoc/en/reference/rar/functions/rar-getpackedsize.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getPackedSize"> <refnamediv> <refname>Rar::getPackedSize</refname> <refpurpose>Get packed size of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getPackedSize</methodname> <void/> </methodsynopsis> <para> Get packed size of the archive entry. </para> <example> <title><function>Rar::</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); echo "Packed size of " . $entry->getName() . " = " . $entry->getPackedSize() . " bytes"; ?> ]]> </programlisting> </example> <para> <function>Rar::getPackedSize</function> returns &false; on error. </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/rar/functions/rar-getunpackedsize.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml +++ phpdoc/en/reference/rar/functions/rar-getunpackedsize.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getUnpackedSize"> <refnamediv> <refname>Rar::getUnpackedSize</refname> <refpurpose>Get unpacked size of the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getUnpackedSize</methodname> <void/> </methodsynopsis> <para> Get unpacked size of the archive entry. </para> <example> <title><function>Rar::getUnpackedSize</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); echo "Unpacked size of " . $entry->getName() . " = " . $entry->getPackedSize() . " bytes"; ?> ]]> </programlisting> </example> <para> <function>Rar::getUnpackedSize</function> returns &false; on error. </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/rar/functions/rar-getversion.xml?r=1.1&p=1 Index: phpdoc/en/reference/rar/functions/rar-getversion.xml +++ phpdoc/en/reference/rar/functions/rar-getversion.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Rar-getVersion"> <refnamediv> <refname>Rar::getVersion</refname> <refpurpose>Get version of the archiver used to add the entry</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>Rar::getVersion</methodname> <void/> </methodsynopsis> <para> Get version of the archiver used to add the archive entry. </para> <example> <title><function>Rar::getVersion</function> example</title> <programlisting role="php"> <![CDATA[ <?php $rar_file = rar_open('example.rar') or die("Failed to open Rar archive"); $entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry"); echo "Rar (WinRAR) version used: " . $entry->getVersion(); ?> ]]> </programlisting> </example> <para> <function>Rar::getVersion</function> returns &false; on error. </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 -->