Files
doc-fr/reference/phar/Phar/loadPhar.xml
George Peter Banyard ede1b06016 Sync Phar docs with EN
2021-09-07 17:20:29 +01:00

123 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 28046efaba656e158bdf45a2585c23a339943869 Maintainer: gui Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.loadphar" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::loadPhar</refname>
<refpurpose>Charge n'importe quelle archive phar avec un 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>
Cette méthode peut être utilisée pour lire le contenu d'une archive Phar externe. C'est
principalement utile pour assigner un alias à un phar de telle façon que les références ultérieures
au phar puissent être faites à l'aide d'un alias plus court ou pour charger des archives Phar
qui contiennent seulement des données et qui ne sont pas destinées à être exécutées/incluses dans des
scripts PHP.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
le chemin relatif ou absolu vers l'archive phar à ouvrir
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>alias</parameter></term>
<listitem>
<para>
L'alias qui pourra être utilisé pour se référer à l'archive phar. Notez que
de nombreuses archives phar spécifient un alias explicite au sein de l'archive phar,
et une exception <classname>PharException</classname> sera levée si un nouvel alias est
spécifié dans ce cas.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Une exception<classname>PharException</classname> est levée
si un alias est passé alors que l'archive phar a déjà un alias explicite
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>Phar::loadPhar</function></title>
<para>
Phar::loadPhar peut être utilisée n'importe où pour charger
une archive phar externe alors que Phar::mapPhar devrait être
utilisée dans un conteneur de chargement pour un Phar.
</para>
<programlisting role="php">
<![CDATA[
<?php
try {
Phar::loadPhar('/chemin/vers/phar.phar', 'mon.phar');
echo file_get_contents('phar://mon.phar/fichier.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
-->