sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated RAR documentation.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@291570 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gustavo André dos Santos Lopes 2009-12-01 20:36:23 +00:00
parent 5b66697a00
commit 2ef641d354
27 changed files with 1172 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
reference/rar/book.xml
View file

@ -43,7 +43,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

12
reference/rar/constants.xml
View file

@ -12,7 +12,7 @@
</term>
<listitem>
<simpara>
Use <link linkend="rarentry.constants.host-msdos"><constant>RarEntry::HOST_MSDOS</constant></link> instead.
</simpara>
</listitem>
</varlistentry>
@ -23,7 +23,7 @@
</term>
<listitem>
<simpara>
Use <link linkend="rarentry.constants.host-os2"><constant>RarEntry::HOST_OS2</constant></link> instead.
</simpara>
</listitem>
</varlistentry>
@ -34,7 +34,7 @@
</term>
<listitem>
<simpara>
Use <link linkend="rarentry.constants.host-win32"><constant>RarEntry::HOST_WIN32</constant></link> instead.
</simpara>
</listitem>
</varlistentry>
@ -45,7 +45,7 @@
</term>
<listitem>
<simpara>
Use <link linkend="rarentry.constants.host-unix"><constant>RarEntry::HOST_UNIX</constant></link> instead.
</simpara>
</listitem>
</varlistentry>
@ -56,7 +56,7 @@
</term>
<listitem>
<simpara>
Use <link linkend="rarentry.constants.host-beos"><constant>RarEntry::HOST_BEOS</constant></link> instead.
</simpara>
</listitem>
</varlistentry>
@ -74,7 +74,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

2
reference/rar/examples.xml
View file

@ -46,7 +46,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

6
reference/rar/functions/rar-close.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.rar-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rar_close</refname>
<refpurpose>Close Rar archive and free all resources</refpurpose>
<refpurpose>Close RAR archive and free all resources.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
</methodsynopsis>
<para>
Close Rar archive and free all allocated resources.
Close RAR archive and free all allocated resources.
</para>
</refsect1>
@ -79,7 +79,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

6
reference/rar/functions/rar-comment-get.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.rar-comment-get" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rar_comment_get</refname>
<refpurpose>Get comment text from the Rar archive</refpurpose>
<refpurpose>Get comment text from the RAR archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
</methodsynopsis>
<para>
Get the comment stored in the Rar archive. It may be up to 64 KiB long.
Get the comment stored in the RAR archive. It may be up to 64 KiB long.
</para>
</refsect1>
@ -60,7 +60,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

6
reference/rar/functions/rar-entry-get.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.rar-entry-get" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rar_entry_get</refname>
<refpurpose>Get entry object from the Rar archive</refpurpose>
<refpurpose>Get entry object from the RAR archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -14,7 +14,7 @@
<methodparam><type>string</type><parameter>entry_name</parameter></methodparam>
</methodsynopsis>
<para>
Get entry object (file or directory) from the Rar archive.
Get entry object (file or directory) from the RAR archive.
</para>
</refsect1>
@ -92,7 +92,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

6
reference/rar/functions/rar-list.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.rar-list" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rar_list</refname>
<refpurpose>Get entries list from the Rar archive</refpurpose>
<refpurpose>Get entries list from the RAR archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
</methodsynopsis>
<para>
Get entries list (files and directories) from the Rar archive.
Get entries list (files and directories) from the RAR archive.
</para>
</refsect1>
@ -76,7 +76,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

4
reference/rar/functions/rar-open.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.rar-open" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rar_open</refname>
<refpurpose>Open Rar archive</refpurpose>
<refpurpose>Open RAR archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -66,7 +66,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

2
reference/rar/ini.xml
View file

@ -16,7 +16,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

758
reference/rar/rarentry.xml
View file

@ -1,20 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.rarentry" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<phpdoc:classref xml:id="class.rarentry" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>RarEntry</classname> class</title>
<titleabbrev>RarEntry</titleabbrev>
<partintro>
<!-- {{{ RarEntry intro -->
<section xml:id="rarentry.intro">
&reftitle.intro;
<para>
A Rar entry, representing a directory or a compressed file inside a Rar archive.
A RAR entry, representing a directory or a compressed file inside a RAR archive.
</para>
</section>
<!-- }}} -->
<section xml:id="rarentry.synopsis">
&reftitle.classsynopsis;
@ -29,24 +31,761 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-msdos">RarEntry::HOST_MSDOS</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-os2">RarEntry::HOST_OS2</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-win32">RarEntry::HOST_WIN32</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-unix">RarEntry::HOST_UNIX</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-macos">RarEntry::HOST_MACOS</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.host-beos">RarEntry::HOST_BEOS</varname>
<initializer>5</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-readonly">RarEntry::ATTRIBUTE_WIN_READONLY</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-hidden">RarEntry::ATTRIBUTE_WIN_HIDDEN</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-system">RarEntry::ATTRIBUTE_WIN_SYSTEM</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-directory">RarEntry::ATTRIBUTE_WIN_DIRECTORY</varname>
<initializer>16</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-archive">RarEntry::ATTRIBUTE_WIN_ARCHIVE</varname>
<initializer>32</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-device">RarEntry::ATTRIBUTE_WIN_DEVICE</varname>
<initializer>64</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-normal">RarEntry::ATTRIBUTE_WIN_NORMAL</varname>
<initializer>128</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-temporary">RarEntry::ATTRIBUTE_WIN_TEMPORARY</varname>
<initializer>256</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-sparse-file">RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</varname>
<initializer>512</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-reparse-point">RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</varname>
<initializer>1024</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-compressed">RarEntry::ATTRIBUTE_WIN_COMPRESSED</varname>
<initializer>2048</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-offline">RarEntry::ATTRIBUTE_WIN_OFFLINE</varname>
<initializer>4096</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-not-content-indexed">RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</varname>
<initializer>8192</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-encrypted">RarEntry::ATTRIBUTE_WIN_ENCRYPTED</varname>
<initializer>16384</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-win-virtual">RarEntry::ATTRIBUTE_WIN_VIRTUAL</varname>
<initializer>65536</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-world-execute">RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-world-write">RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-world-read">RarEntry::ATTRIBUTE_UNIX_WORLD_READ</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-group-execute">RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-group-write">RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</varname>
<initializer>16</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-group-read">RarEntry::ATTRIBUTE_UNIX_GROUP_READ</varname>
<initializer>32</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-owner-execute">RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</varname>
<initializer>64</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-owner-write">RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</varname>
<initializer>128</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-owner-read">RarEntry::ATTRIBUTE_UNIX_OWNER_READ</varname>
<initializer>256</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-sticky">RarEntry::ATTRIBUTE_UNIX_STICKY</varname>
<initializer>512</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-setgid">RarEntry::ATTRIBUTE_UNIX_SETGID</varname>
<initializer>1024</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-setuid">RarEntry::ATTRIBUTE_UNIX_SETUID</varname>
<initializer>2048</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-final-quartet">RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</varname>
<initializer>61440</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-fifo">RarEntry::ATTRIBUTE_UNIX_FIFO</varname>
<initializer>4096</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-char-dev">RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</varname>
<initializer>8192</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-directory">RarEntry::ATTRIBUTE_UNIX_DIRECTORY</varname>
<initializer>16384</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-block-dev">RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</varname>
<initializer>24576</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-regular-file">RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</varname>
<initializer>32768</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-sym-link">RarEntry::ATTRIBUTE_UNIX_SYM_LINK</varname>
<initializer>40960</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="rarentry.constants.attribute-unix-socket">RarEntry::ATTRIBUTE_UNIX_SOCKET</varname>
<initializer>49152</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.rarfile">rarfile</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.name">name</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.unpacked-size">unpacked_size</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.packed-size">packed_size</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.host-os">host_os</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.file-time">file_time</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.crc">crc</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.attr">attr</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.version">version</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.method">method</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.flags">flags</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
<!-- {{{ RarEntry properties -->
<section xml:id="rarentry.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="rarentry.props.rarfile">
<term><varname>rarfile</varname></term>
<listitem>
<para>Used internally to hold a reference to the RAR file resource. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Used internally to store the UTF-8 encoded entry name. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.unpacked-size">
<term><varname>unpacked_size</varname></term>
<listitem>
<para>Used internally to store the unpacked entry size. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.packed-size">
<term><varname>packed_size</varname></term>
<listitem>
<para>Used internally to store the packed entry size. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.host-os">
<term><varname>host_os</varname></term>
<listitem>
<para>Used internally to store the host OS. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.file-time">
<term><varname>file_time</varname></term>
<listitem>
<para>Used internally to store the last modification time of the entry. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.crc">
<term><varname>crc</varname></term>
<listitem>
<para>Used internally to store the entry's hexadecimal string representation of its CRC. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.attr">
<term><varname>attr</varname></term>
<listitem>
<para>Used internally to store the entry's attributes. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.version">
<term><varname>version</varname></term>
<listitem>
<para>Used internally to store the minimum RAR version needed to unpack the entry.
It is encoded as 10 * Major version + minor version. This property is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.method">
<term><varname>method</varname></term>
<listitem>
<para>Used internally to store the method used to pack the entry. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.flags">
<term><varname>flags</varname></term>
<listitem>
<para>Used internally to store several entry properties, such as dictionary size, whether it's a directory,
is encrypted, is continued in the previous or next volume, is solid or has a comment. Again, not part of the contract.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ RarEntry constants -->
<section xml:id="rarentry.constants">
&reftitle.constants;
<section xml:id="rarentry.constants.types">
<title>RarEntry Node Types</title>
<variablelist>
<varlistentry xml:id="rarentry.constants.host-msdos">
<term><constant>RarEntry::HOST_MSDOS</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, MS-DOS was used to
add this entry. Use instead of <constant>RAR_HOST_MSDOS</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-os2">
<term><constant>RarEntry::HOST_OS2</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, OS/2 was used to
add this entry. Intended to replace <constant>RAR_HOST_OS2</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-win32">
<term><constant>RarEntry::HOST_WIN32</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Microsoft Windows was used to
add this entry. Intended to replace <constant>RAR_HOST_WIN32</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-unix">
<term><constant>RarEntry::HOST_UNIX</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, an unspecified UNIX OS was used to
add this entry. Intended to replace <constant>RAR_HOST_UNIX</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-macos">
<term><constant>RarEntry::HOST_MACOS</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Mac OS was used to
add this entry.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-beos">
<term><constant>RarEntry::HOST_BEOS</constant></term>
<listitem>
<para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, BeOS was used to
add this entry. Intended to replace <constant>RAR_HOST_BEOS</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-readonly">
<term><constant>RarEntry::ATTRIBUTE_WIN_READONLY</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a read-only attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-hidden">
<term><constant>RarEntry::ATTRIBUTE_WIN_HIDDEN</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a hidden attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-system">
<term><constant>RarEntry::ATTRIBUTE_WIN_SYSTEM</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a system attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-directory">
<term><constant>RarEntry::ATTRIBUTE_WIN_DIRECTORY</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-archive">
<term><constant>RarEntry::ATTRIBUTE_WIN_ARCHIVE</constant></term>
<listitem>
<para>Bit that represents a Windows entry with an archive attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-device">
<term><constant>RarEntry::ATTRIBUTE_WIN_DEVICE</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a device attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-normal">
<term><constant>RarEntry::ATTRIBUTE_WIN_NORMAL</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-temporary">
<term><constant>RarEntry::ATTRIBUTE_WIN_TEMPORARY</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a temporary attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-sparse-file">
<term><constant>RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-reparse-point">
<term><constant>RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse point, e.g. a
directory junction or a mount file system). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-compressed">
<term><constant>RarEntry::ATTRIBUTE_WIN_COMPRESSED</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-offline">
<term><constant>RarEntry::ATTRIBUTE_WIN_OFFLINE</constant></term>
<listitem>
<para>Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-not-content-indexed">
<term><constant>RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-encrypted">
<term><constant>RarEntry::ATTRIBUTE_WIN_ENCRYPTED</constant></term>
<listitem>
<para>Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-virtual">
<term><constant>RarEntry::ATTRIBUTE_WIN_VIRTUAL</constant></term>
<listitem>
<para>Bit that represents a Windows entry with a virtual attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is world executable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is world writable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_READ</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is world readable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is group executable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is group writable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_READ</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is group readable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is owner executable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is owner writable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_READ</constant></term>
<listitem>
<para>Bit that represents a UNIX entry that is owner readable. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-sticky">
<term><constant>RarEntry::ATTRIBUTE_UNIX_STICKY</constant></term>
<listitem>
<para>Bit that represents the UNIX sticky bit. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-setgid">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SETGID</constant></term>
<listitem>
<para>Bit that represents the UNIX setgid attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-setuid">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SETUID</constant></term>
<listitem>
<para>Bit that represents the UNIX setuid attribute. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-final-quartet">
<term><constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></term>
<listitem>
<para>Mask to isolate the last four bits of UNIX attributes. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constants <link linkend="rarentry.constants.attribute-unix-fifo"><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></link>,
<link linkend="rarentry.constants.attribute-unix-char-dev"><constant>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</constant></link>,
<link linkend="rarentry.constants.attribute-unix-directory"><constant>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</constant></link>,
<link linkend="rarentry.constants.attribute-unix-block-dev"><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></link>,
<link linkend="rarentry.constants.attribute-unix-regular-file"><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></link>,
<link linkend="rarentry.constants.attribute-unix-sym-link"><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></link> and
<link linkend="rarentry.constants.attribute-unix-socket"><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-fifo">
<term><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></term>
<listitem>
<para>Unix FIFOs will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-char-dev">
<term><constant>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</constant></term>
<listitem>
<para>Unix character devices will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-directory">
<term><constant>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</constant></term>
<listitem>
<para>Unix directories will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that
were added in other operating systems.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-block-dev">
<term><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></term>
<listitem>
<para>Unix block devices will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-regular-file">
<term><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></term>
<listitem>
<para>Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that
were added in other operating systems.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-sym-link">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></term>
<listitem>
<para>Unix symbolic links will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-socket">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></term>
<listitem>
<para>Unix sockets will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.rar.entities.rarentry;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -58,7 +797,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
@ -67,4 +806,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

47
reference/rar/rarentry/extract.xml
View file

@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-extract" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.extract" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::extract</refname>
<refpurpose>Extract entry from the archive</refpurpose>
<refpurpose>Extract entry from the archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>extract</methodname>
<modifier>public</modifier> <type>bool</type><methodname>extract</methodname>
<methodparam><type>string</type><parameter>dir</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filepath</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>RarEntry::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.
<methodname>RarEntry::extract</methodname> extracts the entry's data.
It will create new file in the specified
<parameter>dir</parameter> with the name identical to the entry's name,
unless the second argument is specified. See below for more information.
</para>
</refsect1>
@ -38,6 +37,7 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filepath</parameter></term>
<listitem>
@ -48,6 +48,20 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
be omitted. If this parameter is omitted and the entry is encrypted, the password given to
<function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
or implicitly via <function>rar_open</function>, CRC checking will fail and this method will fail and return &false;.
If no password is given and one is required, this method will fail and return &false;.
You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<warning>
@ -67,7 +81,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::extract</function> example</title>
<title><methodname>RarEntry::extract</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -108,6 +122,15 @@ rar_close($rar_file);
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>RarEntry::getStream</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
@ -122,7 +145,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

32
reference/rar/rarentry/getattr.xml
View file

@ -1,25 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getattr" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getattr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getAttr</refname>
<refpurpose>Get attributes of the entry</refpurpose>
<refpurpose>Get attributes of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getAttr</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getAttr</methodname>
<void/>
</methodsynopsis>
<para>
<function>RarEntry::getAttr</function> returns attributes of the archive
entry.
Returns the OS-dependent attributes of the archive entry.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -32,7 +33,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getAttr</function> example</title>
<title><methodname>RarEntry::getAttr</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -98,7 +99,8 @@ rar_close($rar_file);
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.rarentry-gethostos" /></member>
<member><methodname>RarEntry::getHostOs</methodname></member>
<member>The constants in <classname>RarEntry</classname></member>
</simplelist>
</para>
</refsect1>
@ -116,7 +118,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

27
reference/rar/rarentry/getcrc.xml
View file

@ -1,24 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getcrc" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getcrc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getCrc</refname>
<refpurpose>Get CRC of the entry</refpurpose>
<refpurpose>Get CRC of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getCrc</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>getCrc</methodname>
<void/>
</methodsynopsis>
<para>
<function>RarEntry::getCrc</function> returns CRC of the archive entry.
Returns an hexadecimal string representation of the CRC of the archive entry.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -64,7 +67,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

25
reference/rar/rarentry/getfiletime.xml
View file

@ -1,24 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getfiletime" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getfiletime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getFileTime</refname>
<refpurpose>Get entry last modification time</refpurpose>
<refpurpose>Get entry last modification time.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getFileTime</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>getFileTime</methodname>
<void/>
</methodsynopsis>
<para>
Gets entry last modification time.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -41,7 +44,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

75
reference/rar/rarentry/gethostos.xml
View file

@ -1,25 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-gethostos" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.gethostos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getHostOs</refname>
<refpurpose>Get entry host OS</refpurpose>
<refpurpose>Get entry host OS.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getHostOs</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getHostOs</methodname>
<void/>
</methodsynopsis>
<para>
<function>RarEntry::getHostOs</function> return code of the host OS of the
archive entry.
Returns the code of the host OS of the archive entry.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -32,7 +34,43 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getHostOs</function> example</title>
<title><methodname>RarEntry::getHostOs</methodname> example (version &gt;= 2.0.0)</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 RarEntry::HOST_MSDOS:
echo "MS-DOS\n";
break;
case RarEntry::HOST_OS2:
echo "OS2\n";
break;
case RarEntry::HOST_WIN32:
echo "Win32\n";
break;
case RarEntry::HOST_MACOS:
echo "MacOS\n";
break;
case RarEntry::HOST_UNIX:
echo "Unix/Linux\n";
break;
case RarEntry::HOST_BEOS:
echo "BeOS\n";
break;
}
?>
]]>
</programlisting>
</example>
<example>
<title><methodname>RarEntry::getHostOs</methodname> example (version &lt;= 1.0.0)</title>
<programlisting role="php">
<![CDATA[
<?php
@ -68,6 +106,15 @@ switch ($entry->getHostOs()) {
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>RarEntry::extract</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
@ -82,7 +129,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

29
reference/rar/rarentry/getmethod.xml
View file

@ -1,25 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getmethod" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getmethod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getMethod</refname>
<refpurpose>Get pack method of the entry</refpurpose>
<refpurpose>Get pack method of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getMethod</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getMethod</methodname>
<void/>
</methodsynopsis>
<para>
<function>RarEntry::getMethod</function> returns number of the method used when adding
<methodname>RarEntry::getMethod</methodname> returns number of the method used when adding
current archive entry.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -32,7 +35,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getMethod</function> example</title>
<title><methodname>RarEntry::getMethod</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -63,7 +66,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

29
reference/rar/rarentry/getname.xml
View file

@ -1,24 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getname" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getName</refname>
<refpurpose>Get name of the entry</refpurpose>
<refpurpose>Get name of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getName</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>getName</methodname>
<void/>
</methodsynopsis>
<para>
<function>RarEntry::getName</function> returns the name (with path) of the archive entry.
Returns the name (with path) of the archive entry.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -55,7 +58,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getName</function> example</title>
<title><methodname>RarEntry::getName</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -97,7 +100,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

25
reference/rar/rarentry/getpackedsize.xml
View file

@ -1,20 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getpackedsize" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getpackedsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getPackedSize</refname>
<refpurpose>Get packed size of the entry</refpurpose>
<refpurpose>Get packed size of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getPackedSize</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getPackedSize</methodname>
<void/>
</methodsynopsis>
<para>
Get packed size of the archive entry.
</para>
@ -24,6 +22,11 @@
<constant>PHP_INT_MAX</constant>.</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -62,7 +65,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getPackedSize</function> example</title>
<title><methodname>RarEntry::getPackedSize</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -93,7 +96,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

55
reference/rar/rarentry/getstream.xml
View file

@ -1,6 +1,7 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getstream" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getStream</refname>
<refpurpose>Get file handler for entry.</refpurpose>
@ -8,15 +9,12 @@
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getStream</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>resource</type><methodname>RarEntry::getStream</methodname>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
<function>RarEntry::getStream</function> returns a file handler that
Returns a file handler that
supports read operations. This handler provides on-the-fly decompression
for this entry.
</para>
@ -24,6 +22,32 @@
The handler is not invalidated by calling
<function>rar_close</function>.
</para>
<warning>
<para>The resulting stream has no integrity verification. In particular, file corruption and
decryption with a wrong a key will not be detected. It is the programmer's responsability to use the entry's CRC
to check for integrity, if he so wishes.</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
be omitted. If this parameter is omitted and the entry is encrypted, the password given to
<function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
or implicitly via <function>rar_open</function>, this method's resulting stream will produce wrong
output. If no password is given and one is required, this method will fail and return &false;.
You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
@ -37,7 +61,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getStream</function> example</title>
<title><methodname>RarEntry::getStream</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -72,6 +96,15 @@ fclose($stream);
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>RarEntry::extract</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
@ -86,7 +119,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

25
reference/rar/rarentry/getunpackedsize.xml
View file

@ -1,20 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getunpackedsize" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getunpackedsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getUnpackedSize</refname>
<refpurpose>Get unpacked size of the entry</refpurpose>
<refpurpose>Get unpacked size of the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getUnpackedSize</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getUnpackedSize</methodname>
<void/>
</methodsynopsis>
<para>
Get unpacked size of the archive entry.
</para>
@ -24,6 +22,11 @@
<constant>PHP_INT_MAX</constant>.</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -62,7 +65,7 @@
&reftitle.returnvalues;
<para>
<example>
<title><function>RarEntry::getUnpackedSize</function> example</title>
<title><methodname>RarEntry::getUnpackedSize</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -93,7 +96,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

30
reference/rar/rarentry/getversion.xml
View file

@ -1,24 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-getversion" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.getversion" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getVersion</refname>
<refpurpose>Get version of the archiver used to add the entry</refpurpose>
<refpurpose>Get minimum version of RAR program required to unpack the entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>getVersion</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>getVersion</methodname>
<void/>
</methodsynopsis>
<para>
Get version of the archiver used to add the archive entry.
Returns minimum version of RAR program (e.g. WinRAR) required to unpack the entry.
It is encoded as 10 * major version + minor version.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@ -31,7 +35,7 @@
&reftitle.examples;
<para>
<example>
<title><function>RarEntry::getVersion</function> example</title>
<title><methodname>RarEntry::getVersion</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -40,7 +44,7 @@ $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();
echo "Rar version required for unpacking: " . $entry->getVersion();
?>
]]>
@ -62,7 +66,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

31
reference/rar/rarentry/isDirectory.xml → reference/rar/rarentry/isdirectory.xml
View file

@ -1,25 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.rarentry-isdirectory" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="rarentry.isdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::isDirectory</refname>
<refpurpose>Test whether an entry represents a directory</refpurpose>
<refpurpose>Test whether an entry represents a directory.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>RarEntry</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>isDirectory</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>isDirectory</methodname>
<void/>
</methodsynopsis>
<para>
Test whether the entry is a directory.
Tests whether the current entry is a directory.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -32,7 +35,7 @@
<para>
This function is only available starting with version 2.0.0, but one can
also test whether an entry is a directory by checking the entry attributes,
like this (only works for files compressed in Rar for Windows or Unix):
like this (only works for files compressed in RAR for Windows or Unix):
<programlisting role="php">
<![CDATA[
<?php
@ -60,7 +63,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

58
reference/rar/rarentry/isencrypted.xml Normal file
View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rarentry.isencrypted" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::isEncrypted</refname>
<refpurpose>Test whether an entry is encrypted.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarEntry::isEncrypted</methodname>
<void />
</methodsynopsis>
<para>
Tests whether the current entry contents are encrypted.
</para>
<note>
<para>The password used may differ between files inside the same RAR archive.</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the current entry is encrypted and &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
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
-->

58
reference/rar/rarentry/tostring.xml Normal file
View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rarentry.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::__toString</refname>
<refpurpose>Get text representation of entry.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarEntry::__toString</methodname>
<void />
</methodsynopsis>
<para>
<methodname>RarEntry::__toString</methodname> returns a textual representation for this entry. It includes whether
the entry is a file or a directory (symbolic links and other special objects will be treated as files),
the UTF-8 name of the entry and its CRC. The form and content of this representation may be changed in the future,
so they cannot be relied upon.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A textual representation for the entry.
</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
-->

2
reference/rar/reference.xml
View file

@ -18,7 +18,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

2
reference/rar/setup.xml
View file

@ -72,7 +72,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

4
reference/rar/versions.xml
View file

@ -17,6 +17,8 @@
<function name='RarEntry::getunpackedsize' from='PECL rar &gt;= 0.1'/>
<function name='RarEntry::getversion' from='PECL rar &gt;= 0.1'/>
<function name='RarEntry::isDirectory' from='PECL rar &gt;= 2.0.0'/>
<function name='RarEntry::isencrypted' from='PECL rar &gt;= 2.0.0'/>
<function name='RarEntry::__tostring' from='PECL rar &gt;= 2.0.0'/>
<function name='rar_close' from='PECL rar &gt;= 0.1'/>
<function name='rar_list' from='PECL rar &gt;= 0.1'/>
@ -36,7 +38,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil