sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document SplFileInfo::getLinkTarget

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269039 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Brett Bieber 2008-11-15 01:02:20 +00:00
parent ae6278eeb2
commit f57ff3646c
1 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
reference/spl/splfileinfo/getlinktarget.xml
View file

@ -1,21 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getlinktarget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getLinkTarget</refname>
<refpurpose>The getLinkTarget purpose</refpurpose>
<refpurpose>Get the target of a link</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getLinkTarget</methodname>
<modifier>public</modifier> <type>string</type><methodname>SplFileInfo::getLinkTarget</methodname>
<void />
</methodsynopsis>
<para>
The method description goes here.
Get the target of a filesystem link.
</para>
<note>
<para>
The target may not be the real path on the filesystem. Use <methodname>SplFileInfo::getRealPath</methodname>
to determine the true path on the filesystem.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
@ -26,7 +32,14 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
Returns the target of the filesystem link.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws RuntimeException on error.
</para>
</refsect1>
@ -38,14 +51,19 @@
<programlisting role="php">
<![CDATA[
<?php
/* ... */
$info = new SplFileInfo('/Users/bbieber/workspace');
if ($info->isLink()) {
var_dump($info->getLinkTarget());
var_dump($info->getRealPath());
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
string(19) "Documents/workspace"
string(34) "/Users/bbieber/Documents/workspace"
]]>
</screen>
</example>
@ -56,7 +74,8 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>SplFileInfo::isLink</methodname></member>
<member><methodname>SplFileInfo::getRealPath</methodname></member>
</simplelist>
</para>
</refsect1>