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

<!-- EN-Revision: 21cd3a942724400765125b657d24f8c8c4d623e9 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no -->

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

<refnamediv>

<refname>dirname</refname>

<refpurpose>Devuelve la ruta de la carpeta padre</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>

Devuelve la ruta padre de un camino que representa un fichero

o una carpeta, que corresponde a <parameter>levels</parameter> nivel(es) más

arriba que la carpeta actual.

</para>

<note>

<para>

<function>dirname</function> actúa de forma ingenua sobre la cadena de entrada y

no está al tanto del sistema de archivos actual o de componentes eventuales como

"<literal>..</literal>".

</para>

</note>

<caution>

<para>

En Windows, <function>dirname</function> asume que la página de código actualmente

definida, por lo que para que pueda ver el nombre de carpeta correcto con caracteres

multioctetos en el camino, la página de código correspondiente debe

estar definida.

Si <parameter>path</parameter> contiene caracteres que son inválidos

para la página de código actual, el comportamiento de <function>dirname</function>

es indefinido.

</para>

<para>

En otros sistemas, <function>dirname</function> asume que <parameter>path</parameter>

está codificado en un codificación compatible con ASCII. De lo contrario, el comportamiento de la

función es indefinido.

</para>

</caution>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Un camino.

</para>

<para>

En Windows, las barras (/<literal>/</literal>) y backslash

(<literal>\</literal>) se utilizan como separadores

de carpeta. En otros entornos, solo la barra

(<literal>/</literal>) se utiliza.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>levels</parameter></term>

<listitem>

<para>

El número de carpetas padres más arriba.

</para>

<para>

Debe ser un integer superior a 0.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve la carpeta padre del camino. Si no hay ninguna barra en el camino

<parameter>path</parameter>, un punto ('<literal>.</literal>') será

devuelto, indicando la carpeta actual. De lo contrario, la cadena devuelta

será el camino <parameter>path</parameter> del cual se habrán eliminado todos

los <literal>/component</literal>.

</para>

<caution>

<para>

Se debe tener cuidado al utilizar esta función en un ciclo que pueda alcanzar la

carpeta raíz, ya que esto puede producir un ciclo infinito.

<informalexample>

<programlisting role="php">

<![CDATA[

<?php

dirname('.'); // Devolverá '.'.

dirname('/'); // Devolverá `\` en Windows y '/' en sistemas *nix.

dirname('\\'); // Devolverá `\` en Windows y '.' en sistemas *nix.

dirname('C:\\'); // Devolverá 'C:\' en Windows y '.' en sistemas *nix.

?>

]]>

</programlisting>

</informalexample>

</para>

</caution>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <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

/ (o \ en 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

-->