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

<!-- $Revision$ -->

<!-- EN-Revision: d0cc084a925f112c156d0dbac12718b2bd8d4889 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

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

<refnamediv>

<refname>pathinfo</refname>

<refpurpose>Devuelve información sobre una ruta del sistema</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> devuelve información sobre la ruta

<parameter>path</parameter>, en forma de string o array asociativo, dependiendo del argumento <parameter>flags</parameter>.

</para>

<note>

<para>

Para más información sobre la lectura de la ruta actual,

consulte la sección sobre las

<link linkend="language.variables.predefined">variables predefinidas</link>.

</para>

</note>

<note>

<para>

<function>pathinfo</function> opera de manera ingenua sobre la cadena de entrada,

y no es consciente de los sistemas de archivos actuales, o de los componentes

de rutas como "<literal>..</literal>".

</para>

</note>

<note>

<para>

Solo en sistemas Windows, el carácter <literal>\</literal> será

interpretado como separador de directorio. En otros sistemas, será

tratado como cualquier otro carácter.

</para>

</note>

<caution>

<para>

La función <function>pathinfo</function> es sensible a la configuración local,

por lo tanto, si se desea que analice correctamente una ruta que contenga

caracteres de varios bytes, la configuración local correspondiente debe ser definida

utilizando la función <function>setlocale</function>.

</para>

</caution>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

La ruta a analizar.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

Especifica qué elemento será devuelto. Puede pasar una de las constantes

<constant>PATHINFO_DIRNAME</constant>,

<constant>PATHINFO_BASENAME</constant>,

<constant>PATHINFO_EXTENSION</constant> y

<constant>PATHINFO_FILENAME</constant>.

</para>

<para>

Si <parameter>flags</parameter> no es especificado,

todos los elementos son devueltos.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Si <parameter>flags</parameter> no es utilizado, esta función devolverá

un array asociativo que contiene los siguientes elementos :

<literal>dirname</literal>, <literal>basename</literal>,

<literal>extension</literal> (si existe), y <literal>filename</literal>.

</para>

<note>

<para>

Si <parameter>path</parameter> contiene más de una extensión,

<constant>PATHINFO_EXTENSION</constant> devuelve únicamente la

última y <constant>PATHINFO_FILENAME</constant> eliminará

únicamente la última también (ver el primer ejemplo a continuación).

</para>

</note>

<note>

<para>

Si <parameter>path</parameter> no tiene extensión, el elemento

<literal>extension</literal> no será devuelto

(ver el segundo ejemplo a continuación).

</para>

</note>

<note>

<para>

Si <literal>basename</literal> del argumento <parameter>path</parameter>

comienza con un punto, los caracteres siguientes son interpretados como la

<literal>extension</literal>, y el <literal>filename</literal> estará vacío

(ver el tercer ejemplo a continuación).

</para>

</note>

<para>

Si <parameter>flags</parameter> es utilizado, esta función devolverá

una &string; que contiene los elementos.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <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>Ejemplo <function>pathinfo</function> sin extensión</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>Ejemplo con <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>Ejemplo de <function>pathinfo</function> con desestructuración de array</title>

<para>

El argumento <parameter>flags</parameter> no es una máscara de bits. Solo un valor

puede ser proporcionado. Para seleccionar únicamente un conjunto limitado de valores analizados, utilice

la desestructuración de array como se muestra a continuación:

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

-->