mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
c5aae9ac79
$c->__construct() usually returns NULL but isn't call explicitly often git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321903 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.3 KiB
XML
119 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="phardata.construct">
|
|
<refnamediv>
|
|
<refname>PharData::__construct</refname>
|
|
<refpurpose>Construct a non-executable tar or zip archive object</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<methodname>PharData::__construct</methodname>
|
|
<methodparam><type>string</type><parameter>fname</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>alias</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>format</parameter><initializer><constant>Phar::TAR</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>fname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Path to an existing tar/zip archive or to-be-created archive
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Flags to pass to <classname>Phar</classname> parent class
|
|
<classname>RecursiveDirectoryIterator</classname>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>alias</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Alias with which this Phar archive should be referred to in calls to stream
|
|
functionality.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>format</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the
|
|
<link linkend="phar.constants.fileformat">file format constants</link>
|
|
available within the <classname>Phar</classname> class.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>BadMethodCallException</classname> if called twice;
|
|
<classname>UnexpectedValueException</classname> if the Phar archive can't
|
|
be opened.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>PharData::__construct</function> example</title>
|
|
<para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
try {
|
|
$p = new PharData('/path/to/my.tar', CURRENT_AS_FILEINFO | KEY_AS_FILENAME);
|
|
} catch (UnexpectedValueException $e) {
|
|
die('Could not open my.tar');
|
|
} catch (BadMethodCallException $e) {
|
|
echo 'technically, this cannot happen';
|
|
}
|
|
echo file_get_contents('phar:///path/to/my.tar/example.txt');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</para>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/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
|
|
-->
|