dirname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 21cd3a942724400765125b657d24f8c8c4d623e9 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.dirname">
 <refnamediv>
  <refname>dirname</refname>
  <refpurpose>Renvoie le chemin du dossier parent</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>dirname</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>levels</parameter><initializer>1</initializer></methodparam>
  </methodsynopsis>
  <para>
   Renvoie le chemin parent d'un chemin représentant un fichier
   ou un dossier, qui correspond à <parameter>levels</parameter> niveau(x) plus
   haut que le dossier courant.
  </para>
  <note>
   <para>
    <function>dirname</function> agit naïvement sur la chaine en entrée et
    n'est pas au courant du système de fichiers courant ou d'éventuels
    composants comme "<literal>..</literal>".
   </para>
  </note>
  <caution>
   <para>
    Sur Windows, <function>dirname</function> assume que la codepage actuellement
    définie, donc pour qu'il puisse voir le nom de dossier correct avec des
    caractères multioctets dans le chemin, la codepage correspondante doit
    être définie.
    Si <parameter>path</parameter> contient des caractères qui sont invalides
    pour la codepage courante, le comportement de <function>dirname</function>
    est indéfini.
   </para>
   <para>
    Sur d'autres systèmes, <function>dirname</function> assume que <parameter>path</parameter>
    est encodé dans un encodage compatible ASCII. Sinon, le comportement de la
    fonction est indéfinie.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       Un chemin.
      </para>
      <para>
       Sous Windows, les slash (<literal>/</literal>) et antislash
       (<literal>\</literal>) sont utilisés comme séparateurs
       de dossier. Dans les autres environnements, seul le slash
       (<literal>/</literal>) est utilisé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>levels</parameter></term>
     <listitem>
      <para>
       Le nombre de dossiers parents plus haut.
      </para>
      <para>
       Doit être un entier supérieur à 0.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le dossier parent du chemin. S'il n'y a pas de slash dans le chemin
   <parameter>path</parameter>, un point ('<literal>.</literal>') sera
   retourné, indiquant le dossier courant. Sinon, la chaîne retournée
   sera le chemin <parameter>path</parameter> dont on aura supprimé tous
   les <literal>/component</literal>.
  </para>

  <caution>
   <para>
    Il faut faire attention lors de l'utilisation de cette fonction dans une
    boucle qui peut atteindre le dossier racine, car ceci peut produire une
    boucle infinie.
    <informalexample>
     <programlisting role="php">
<![CDATA[
<?php
dirname('.');    // Will return '.'.
dirname('/');    // Will return `\` on Windows and '/' on *nix systems.
dirname('\\');   // Will return `\` on Windows and '.' on *nix systems.
dirname('C:\\'); // Will return 'C:\' on Windows and '.' on *nix systems.
?>
]]>
     </programlisting>
    </informalexample>
   </para>
  </caution>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>dirname</function></title>
    <programlisting role="php">
<![CDATA[
<?php
echo dirname("/etc/passwd") . PHP_EOL;
echo dirname("/etc/") . PHP_EOL;
echo dirname(".") . PHP_EOL;
echo dirname("C:\\") . PHP_EOL;
echo dirname("/usr/local/lib", 2);
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
/etc
/ (ou \ sous Windows)
.
C:\
/usr
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>basename</function></member>
    <member><function>pathinfo</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
-->