php-doc-en/reference/phar/Phar/loadPhar.xml
Máté Kocsis 28046efaba
Generate ext/phar methodsynopsis based on stubs
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-626.
2021-09-03 14:35:53 +02:00

119 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phar.loadphar" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::loadPhar</refname>
<refpurpose>Loads any phar archive with an alias</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>Phar::loadPhar</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>alias</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
This can be used to read the contents of an external Phar archive. This
is most useful for assigning an alias to a phar so that subsequent references
to the phar can use the shorter alias, or for loading Phar archives that
only contain data and are not intended for execution/inclusion in PHP scripts.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
the full or relative path to the phar archive to open
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>alias</parameter></term>
<listitem>
<para>
The alias that may be used to refer to the phar archive. Note
that many phar archives specify an explicit alias inside the
phar archive, and a <classname>PharException</classname> will be thrown if
a new alias is specified in this case.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<classname>PharException</classname> is thrown if an alias is passed in and the phar archive
already has an explicit alias
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Phar::loadPhar</function> example</title>
<para>
Phar::loadPhar can be used anywhere to load an external Phar archive, whereas
Phar::mapPhar should be used in a loader stub for a Phar.
</para>
<programlisting role="php">
<![CDATA[
<?php
try {
Phar::loadPhar('/path/to/phar.phar', 'my.phar');
echo file_get_contents('phar://my.phar/file.txt');
} catch (PharException $e) {
echo $e;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::mapPhar</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.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
-->