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

96 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 28046efaba656e158bdf45a2585c23a339943869 Maintainer: gui Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.running" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::running</refname>
<refpurpose>Retourne le chemin complet sur le disque ou l'URL phar complète de l'archive phar couramment exécutée</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Phar::running</methodname>
<methodparam choice="opt"><type>bool</type><parameter>returnPhar</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Retourne le chemin complet de l'archive phar exécutée. C'est bien entendu utilisé un peu comme
la constante magique <literal>__FILE__</literal> et a des effets uniquement au sein d'une archive phar
en train d'être exécutée.
</para>
<para>
Dans le conteneur de chargement d'une archive, <function>Phar::running</function> retourne
<literal>&quot;&quot;</literal>. Utilisez simplement <constant>__FILE__</constant>
pour accéder au phar courant au sein d'un conteneur de chargement.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>returnPhar</parameter></term>
<listitem>
<para>
Si &false;, le chemin complet sur le disque vers le phar est retourné.
Si &true;, une URL phar complète est retournée.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le chemin de fichier si valide, sinon une chaîne vide.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>Phar::running</function></title>
<para>
Pour l'exemple suivant, on suppose que le fichier phar est
<literal>/chemin/vers/mon.phar</literal>.
</para>
<programlisting role="php">
<![CDATA[
<?php
$a = Phar::running(); // $a vaut "phar:///chemin/vers/mon.phar"
$b = Phar::running(false); // $b vaut "/chemin/vers/mon.phar"
?>
]]>
</programlisting>
</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
-->