mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
ref.rar: switch to new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237356 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
f13c4b5a01
commit
031eda7db0
14 changed files with 454 additions and 190 deletions
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.rar-close">
|
||||
<refnamediv>
|
||||
<refname>rar_close</refname>
|
||||
<refpurpose>Close Rar archive and free all resources</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>rar_close</methodname>
|
||||
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
|
||||
|
|
@ -14,10 +15,31 @@
|
|||
<para>
|
||||
Close Rar archive and free all allocated resources.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<function>rar_close</function> returns &false; on error.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>rar_file</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A Rar file resource, opened with <function>rar_open</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.rar-entry-get">
|
||||
<refnamediv>
|
||||
<refname>rar_entry_get</refname>
|
||||
<refpurpose>Get entry object from the Rar archive</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>RarEntry</type><methodname>rar_entry_get</methodname>
|
||||
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
|
||||
|
|
@ -15,9 +16,45 @@
|
|||
<para>
|
||||
Get entry object from the Rar archive.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>rar_file</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A Rar file resource, opened with <function>rar_open</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>entry_name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the entry within the Rar archive.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>rar_get_entry</function> returns entry object or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>rar_entry_get</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -29,12 +66,11 @@ print_r($entry);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>rar_get_entry</function> returns entry object or &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,28 +1,67 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>extract</methodname>
|
||||
<methodparam><type>string</type><parameter>dir</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>filepath</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<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">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>dir</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the directory where files should be extracted.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>filepath</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::extract</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -35,11 +74,11 @@ $entry->extract(false, '/dir/to/new_name.txt'); // create /dir/to/new_name.txt
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>How to extract all files in archive: </title>
|
||||
<programlisting role="php">
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>How to extract all files in archive: </title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -58,12 +97,11 @@ rar_close($rar_file);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
&return.success;
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,23 +1,39 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getAttr</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
<function>Rar::getAttr</function> returns attributes of the archive
|
||||
entry.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::getAttr</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the attributes or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getAttr</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -72,15 +88,21 @@ rar_close($rar_file);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getAttr</function> returns &false; on error.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>Rar::getHostOs</function>.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.Rar-getHostOs" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,33 +1,32 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getCrc</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<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
|
||||
</refsect1>
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>Rar::getCrc</function> returns &false; on error.
|
||||
Returns the CRC of the archive entry or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,34 +1,33 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>getFileTime</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<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.
|
||||
Gets entry last modification time.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns entry last modification time as string in format
|
||||
<literal>YYYY-MM-DD HH:II:SS</literal>, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,23 +1,39 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getHostOs</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<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">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the code of the host OS, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getHostOs</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -48,12 +64,11 @@ switch ($entry->getHostOs()) {
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getHostOs</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,23 +1,39 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getMethod</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<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">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the method number or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getMethod</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -29,12 +45,11 @@ echo "Method number: " . $entry->getMethod();
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getMethod</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,22 +1,38 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>getName</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
<function>Rar::getName</function> returns full name of the archive entry.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::getName</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the entry name as a string, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getName</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -28,12 +44,11 @@ echo "Entry name: " . $entry->getName();
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getName</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,22 +1,38 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getPackedSize</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Get packed size of the archive entry.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the packed size, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getPackedSize</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -28,12 +44,11 @@ echo "Packed size of " . $entry->getName() . " = " . $entry->getPackedSize() . "
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getPackedSize</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,22 +1,38 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getUnpackedSize</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Get unpacked size of the archive entry.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::getUnpackedSize</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the unpacked size, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getUnpackedSize</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -28,12 +44,11 @@ echo "Unpacked size of " . $entry->getName() . " = " . $entry->getPackedSize() .
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getUnpackedSize</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,22 +1,38 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Rar</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>getVersion</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Get version of the archiver used to add the archive entry.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::getVersion</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the version or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Rar::getVersion</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -28,12 +44,11 @@ echo "Rar (WinRAR) version used: " . $entry->getVersion();
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>Rar::getVersion</function> returns &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.rar-list">
|
||||
<refnamediv>
|
||||
<refname>rar_list</refname>
|
||||
<refpurpose>Get entries list from the Rar archive</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>rar_list</methodname>
|
||||
<methodparam><type>resource</type><parameter>rar_file</parameter></methodparam>
|
||||
|
|
@ -14,9 +15,37 @@
|
|||
<para>
|
||||
Get entries list from the Rar archive.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>Rar::</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>rar_file</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A Rar file resource, opened with <function>rar_open</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>rar_list</function> returns array of entries or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>rar_list</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -28,12 +57,11 @@ print_r($entries_list);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
<function>rar_list</function> returns array of entries or &false; on error.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.rar-open">
|
||||
<refnamediv>
|
||||
<refname>rar_open</refname>
|
||||
<refpurpose>Open Rar archive</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>rar_open</methodname>
|
||||
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
||||
|
|
@ -15,10 +16,39 @@
|
|||
<para>
|
||||
Open specified Rar archive and return Rar file resource.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the Rar archive.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>password</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A plain password, if needed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>rar_open</function> returns Rar file resource or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
Loading…
Reference in a new issue