1
0
mirror of https://github.com/php/doc-fr.git synced 2026-03-24 07:02:06 +01:00
Files
2026-03-10 19:04:42 +01:00

261 lines
7.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d0cc084a925f112c156d0dbac12718b2bd8d4889 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pathinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pathinfo</refname>
<refpurpose>Retourne des informations sur un chemin système</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>string</type></type><methodname>pathinfo</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PATHINFO_ALL</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pathinfo</function> retourne des informations sur le chemin
<parameter>path</parameter>, sous forme de chaîne ou de tableau associatif, ceci
dépend du paramètre <parameter>flags</parameter>.
</para>
<note>
<para>
Pour plus d'informations sur la lecture du chemin courant,
se référer à la section sur les
<link linkend="language.variables.predefined">variables prédéfinies</link>.
</para>
</note>
<note>
<para>
<function>pathinfo</function> opère naïvement sur la chaîne d'entrée,
et n'est pas consciente du système de fichiers actuel, ou des composants
de chemins tels que "<literal>..</literal>".
</para>
</note>
<note>
<para>
Sur les systèmes Windows uniquement, le caractère <literal>\</literal> sera
interprété comme un séparateur de répertoire. Sur les autres systèmes, il sera
traité comme n'importe quel autre caractère.
</para>
</note>
<caution>
<para>
La fonction <function>pathinfo</function> est sensible à la configuration locale,
aussi, pour qu'elle analyse correctement un chemin contenant les
caractères sur plusieurs octets, la locale correspondante doit être définie
en utilisant la fonction <function>setlocale</function>.
</para>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Le chemin à analyser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Spécifie quel élément sera retourné. Il est possible de passer l'une des constantes
<constant>PATHINFO_DIRNAME</constant>,
<constant>PATHINFO_BASENAME</constant>,
<constant>PATHINFO_EXTENSION</constant> et
<constant>PATHINFO_FILENAME</constant>.
</para>
<para>
Si <parameter>flags</parameter> n'est pas renseigné,
tous les éléments sont retournés.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Si <parameter>flags</parameter> n'est pas utilisé, cette fonction retourne
un tableau associatif contenant les éléments suivants :
<literal>dirname</literal>, <literal>basename</literal>,
<literal>extension</literal> (s'il y en a), et <literal>filename</literal>.
</para>
<note>
<para>
Si <parameter>path</parameter> contient plus d'une extension,
<constant>PATHINFO_EXTENSION</constant> retourne uniquement le
dernier et <constant>PATHINFO_FILENAME</constant> va supprimer
uniquement le dernier également (voir le premier exemple ci-dessous).
</para>
</note>
<note>
<para>
Si <parameter>path</parameter> n'a pas d'extension, l'élément
<literal>extension</literal> ne sera pas retourné
(voir le second exemple ci-après).
</para>
</note>
<note>
<para>
Si <literal>basename</literal> du paramètre <parameter>path</parameter>
commence par un point, les caractères suivants sont interprétés comme l'
<literal>extension</literal>, et le <literal>filename</literal> sera vide
(voir le troisième exemple ci-dessous).
</para>
</note>
<para>
Si <parameter>flags</parameter> est utilisé, cette fonction retourne
une &string; contenant les éléments.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>pathinfo</function></title>
<programlisting role="php">
<![CDATA[
<?php
$path_parts = pathinfo('/www/htdocs/inc/lib.inc.php');
echo $path_parts['dirname'], "\n";
echo $path_parts['basename'], "\n";
echo $path_parts['extension'], "\n";
echo $path_parts['filename'], "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
/www/htdocs/inc
lib.inc.php
php
lib.inc
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemple <function>pathinfo</function> sans extension</title>
<programlisting role="php">
<![CDATA[
<?php
$path_parts = pathinfo('/path/emptyextension.');
var_dump($path_parts['extension']);
$path_parts = pathinfo('/path/noextension');
var_dump($path_parts['extension']);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(0) ""
Notice: Undefined index: extension in test.php on line 6
NULL
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemple avec <function>pathinfo</function></title>
<programlisting role="php">
<![CDATA[
<?php
print_r(pathinfo('/some/path/.test'));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[dirname] => /some/path
[basename] => .test
[extension] => test
[filename] =>
)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemple de <function>pathinfo</function> avec déréférencement de tableau</title>
<para>
Le paramètre <parameter>flags</parameter> n'est pas un masque de bits. Seule une valeur
peut être fournie. Pour sélectionner uniquement un ensemble limité de valeurs analysées, il convient d'utiliser
la déstructuration de tableau comme ceci :
</para>
<programlisting role="php">
<![CDATA[
<?php
['basename' => $basename, 'dirname' => $dirname] = pathinfo('/www/htdocs/inc/lib.inc.php');
var_dump($basename, $dirname);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(11) "lib.inc.php"
string(15) "/www/htdocs/inc"
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>dirname</function></member>
<member><function>basename</function></member>
<member><function>parse_url</function></member>
<member><function>realpath</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
-->