realpath.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: nikic Status: ready -->
<refentry xml:id="function.realpath" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>realpath</refname>
  <refpurpose>Löst einen Pfad in einen absoluten und eindeutigen auf</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>realpath</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>realpath</function> löst alle symbolischen Verweise,
   <literal>/./</literal>, <literal>/../</literal> und mehrere aufeinanderfolgende <literal>/</literal> Zeichen,
   die in <parameter>path</parameter> enthalten sind, auf und gibt
   den so entstehenden absoluten Pfad zurück.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       Der Pfad, der aufgelöst werden soll.
       <note>
        <para>
         Der Pfad muss angegeben werden, kann allerdings auch ein leerer String
         sein, in diesem Fall wird dann das aktuelle Verzeichnis
         benutzt.
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt bei Erfolg den eindeutigen und absoluten Pfadnamen zurück. Dieser wird
   keine symbolischen Links, <literal>/./</literal> oder <literal>/../</literal> mehr enthalten.
   Abschließende Trennzeichen wie <literal>\</literal> und <literal>/</literal> werden ebenfalls entfernt.
  </para>
  <para>
   <function>realpath</function> gibt &false; zurück, wenn ein Fehler auftritt, 
   beispielsweise wenn die Datei nicht existiert.
  </para>
  <note>
   <para>
    Das ausführende Script muss alle Verzeichnisse im Pfad öffnen können
    (auf unixoiden Systemen wäre das das "execute" Recht). Ist dies nicht
    der Fall, gibt <function>realpath</function> &false; zurück.
   </para>
  </note>
  <note>
   <para>
    Bei Dateisystemen, bei denen Groß-/Kleinschreibung keine Rolle spielt,
    kann <function>realpath</function> die Schreibweise kanonisieren, oder auch
    nicht.
   </para>
  </note>
  <note>
   <para>
    Die Funktion <function>realpath</function> funktioniert nicht für Dateien in
    einem Phar, da solche Pfade virtuelle Pfade sind, aber keine realen Pfade.
   </para>
  </note>
  <note>
   <para>
    Unter Windows werden Junctions und symbolische Links zu Verzeichnissen nur
    um eine Ebene erweitert.
   </para>
  </note>
  &fs.file.32bit;
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>realpath</function></title>
    <programlisting role="php">
<![CDATA[
<?php
chdir('/var/www/');
echo realpath('./../../etc/passwd') . PHP_EOL;


echo realpath('/tmp/') . PHP_EOL;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
/etc/passwd
/tmp
]]>
    </screen>
   </example>
   <example>
    <title><function>realpath</function> auf Windows</title>
    <para>
     Unter Windows wandelt <function>realpath</function> Unix-artige
     Pfade in gültige Windows-Pfade um:
    </para>
    <programlisting role="php">
<![CDATA[
<?php
echo realpath('/windows/system32'), PHP_EOL;

echo realpath('C:\Program Files\\'), PHP_EOL;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
C:\WINDOWS\System32
C:\Program Files
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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