php-doc-en/reference/filesystem/functions/realpath.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.23 -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.realpath">
 <refnamediv>
  <refname>realpath</refname>
  <refpurpose>Returns canonicalized absolute pathname</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>realpath</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>realpath</function> expands all symbolic links and
   resolves references to '/./', '/../' and extra '/' characters in
   the input <parameter>path</parameter> and return the canonicalized
   absolute pathname.  The resulting path will have no symbolic link,
   '/./' or '/../' components.
  </para>
  <para>
   <function>realpath</function> returns &false; on failure, e.g. if
   the file does not exist. On BSD systems <function>realpath</function>
   doesn't fail if only the last <parameter>path</parameter> component
   doesn't exist, while other systems will return &false;.
  </para>
  <para>
   <example>
    <title><function>realpath</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
chdir('/var/www/');
echo realpath('./../../etc/passwd');
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
/etc/passwd
]]>
    </screen>
   </example>
  </para>
  <para>
   See also <function>basename</function>,
   <function>dirname</function>, and
   <function>pathinfo</function>.
  </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:"../../../../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
-->