Files
doc-fr/reference/phar/Phar/offsetGet.xml
Sergey Panteleev 88c89e4481 More stub syncs with EN (#146)
Co-authored-by: George Peter Banyard <girgias@php.net>
2021-12-27 12:52:01 +00:00

128 lines
3.5 KiB
XML

<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision$ -->
<!-- EN-Revision: ed66a8608b9b7e9e6b880226e7265a0ef69f816d Maintainer: gui Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="phar.offsetget" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::offsetGet</refname>
<refpurpose>Obtient un objet <classname>PharFileInfo</classname> à partir d'un fichier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SplFileInfo</type><methodname>Phar::offsetGet</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>
<para>
C'est une implémentation de l'interface
<interfacename>ArrayAccess</interfacename> qui permet
la manipulation directe du contenu d'une archive Phar
en utilisant les crochets d'accès au tableau.
<function>Phar::offsetGet</function> est utilisé pour
extraire des fichiers d'une archive Phar.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Le nom de fichier (en chemin relatif) à chercher dans le Phar.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Un objet <classname>PharFileInfo</classname> est retourné et
peut être utilisé pour intégrer le contenu d'un fichier ou pour
récupérer des informations sur le fichier courant.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Cette méthode émet une exception <classname>BadMethodCallException</classname>
si le fichier n'existe pas dans l'archive Phar.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>Phar::offsetGet</function></title>
<para>
Comme avec toutes les classes qui implémentent l'interface
<classname>ArrayAccess</classname>, <function>Phar::offsetGet</function>
est automatiquement appelée quand les crochets d'accès à un tableau
sont utilisés (<literal>[]</literal>).
</para>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar(dirname(__FILE__) . '/monphar.phar', 0, 'monphar.phar');
$p['existe.txt'] = "le fichier existe\n";
try {
// appelle automatiquement offsetGet()
echo $p['existe.txt'];
echo $p['nexistepas.txt'];
} catch (BadMethodCallException $e) {
echo $e;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
le fichier existe
Entry nexistepas.txt does not exist
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::offsetExists</function></member>
<member><function>Phar::offsetSet</function></member>
<member><function>Phar::offsetUnset</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
-->