1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.realpath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>realpath</refname>
<refpurpose>Returns canonicalized absolute pathname</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> expands all symbolic links and
resolves references to <literal>/./</literal>, <literal>/../</literal> and extra <literal>/</literal> characters in
the input <parameter>path</parameter> and returns 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.
<note>
<para>
Whilst a path must be supplied, the value can be an empty string.
In this case, the value is interpreted as the current directory.
</para>
</note>
</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, <literal>/./</literal> or <literal>/../</literal> components. Trailing delimiters,
such as <literal>\</literal> and <literal>/</literal>, are also removed.
</para>
<para>
<function>realpath</function> returns &false; on failure, e.g. if
the file does not exist.
</para>
<note>
<para>
The running script must have executable permissions on all directories in
the hierarchy, otherwise <function>realpath</function> will return
&false;.
</para>
</note>
<note>
<para>
For case-insensitive filesystems <function>realpath</function> may or may
not normalize the character case.
</para>
</note>
<note>
<para>
The function <function>realpath</function> will not work for a file which
is inside a Phar as such path would be a virtual path, not a real one.
</para>
</note>
<note>
<para>
On Windows, junctions and symbolic links to directories are only expanded by
one level.
</para>
</note>
&fs.file.32bit;
</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') . PHP_EOL;
echo realpath('/tmp/') . PHP_EOL;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
/etc/passwd
/tmp
]]>
</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'), PHP_EOL;
echo realpath('C:\Program Files\\'), PHP_EOL;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
C:\WINDOWS\System32
C:\Program Files
]]>
</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:"~/.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
-->
|
