mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
81534059fc
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@253392 c90b9560-bf6c-de11-be94-00142212c4b1
128 lines
3 KiB
XML
128 lines
3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.realpath">
|
|
<refnamediv>
|
|
<refname>realpath</refname>
|
|
<refpurpose>Returns canonicalized absolute pathname</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>path</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The path being checked.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the canonicalized absolute pathname on success. 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
<example>
|
|
<title><function>realpath</function> on Windows</title>
|
|
<para>
|
|
On windows <function>realpath</function> will change unix style paths to
|
|
windows style.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo realpath('/windows/system32');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
C:\WINDOWS\System32
|
|
]]>
|
|
</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:"../../../../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
|
|
-->
|