<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.realpath" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>realpath</refname>

<refpurpose>Retorna la ruta de acceso canónica absoluta</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> resuelve todos los enlaces simbólicos, y

reemplaza todas las referencias <literal>/./</literal>, <literal>/../</literal>

y <literal>/</literal> de <parameter>path</parameter> luego retorna

la ruta de acceso canónica absoluta así encontrada.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>path</parameter></term>

<listitem>

<para>

La ruta de acceso a verificar.

<note>

<para>

Debe ser proporcionada una ruta de acceso, el valor puede ser una cadena de caracteres vacía.

En estos casos, el valor es interpretado como el directorio actual.

</para>

</note>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retorna la ruta de acceso canónica absoluta

así encontrada. El resultado no contiene ningún enlace simbólico,

<literal>/./</literal> o <literal>/../</literal>. Los delimitadores

de fin como <literal>\</literal> y <literal>/</literal> son igualmente eliminados.

</para>

<para>

<function>realpath</function> retorna &false; si ocurre un error, por ejemplo

si el fichero no existe.

</para>

<note>

<para>

El script que se ejecuta debe tener los permisos de ejecución

sobre todos los directorios de la estructura, de lo contrario, la función

<function>realpath</function> retornará &false;.

</para>

</note>

<note>

<para>

Para los sistemas de archivos insensibles a mayúsculas/minúsculas,

<function>realpath</function> puede o no normalizar la casilla de los

caracteres.

</para>

</note>

<note>

<para>

La función <function>realpath</function> no funcionará para un

fichero que se encuentra dentro de un phar ya que esta ruta sería una

ruta de acceso virtual, no una real.

</para>

</note>

<note>

<para>

En Windows, las uniones y los enlaces simbólicos a los directorios son

únicamente extendidos a un nivel.

</para>

</note>

&fs.file.32bit;

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <function>realpath</function></title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

<example>

<title>Ejemplo con <function>realpath</function> en Windows</title>

<para>

En Windows, <function>realpath</function> cambiará las rutas de estilo Unix

a rutas de estilo Windows.

</para>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</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>