cvs: phpdoc /en/reference/spl/splfileinfo getowner.xml
| From: | Brett Bieber | Date: | Sat, 15 Nov 2008 13:12:38 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl/splfileinfo getowner.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2549@lists.php.net to get a copy of this message | ||
saltybeagle Sat Nov 15 13:12:38 2008 UTC
Modified files:
/phpdoc/en/reference/spl/splfileinfo getowner.xml
Log:
Document SplFileInfo::getOwner
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/splfileinfo/getowner.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/spl/splfileinfo/getowner.xml
diff -u phpdoc/en/reference/spl/splfileinfo/getowner.xml:1.1
phpdoc/en/reference/spl/splfileinfo/getowner.xml:1.2
--- phpdoc/en/reference/spl/splfileinfo/getowner.xml:1.1 Fri Nov 14 18:38:21 2008
+++ phpdoc/en/reference/spl/splfileinfo/getowner.xml Sat Nov 15 13:12:38 2008
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getowner" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getOwner</refname>
- <refpurpose>The getOwner purpose</refpurpose>
+ <refpurpose>Get the owner of the file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>SplFileInfo::getOwner</methodname>
+ <modifier>public</modifier>
<type>int</type><methodname>SplFileInfo::getOwner</methodname>
<void />
</methodsynopsis>
<para>
- The method description goes here.
+ Gets the file owner. The owner ID is returned in numerical format.
</para>
</refsect1>
@@ -26,7 +26,14 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Description...
+ The owner id in numerical format.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws RuntimeException on error.
</para>
</refsect1>
@@ -38,16 +45,11 @@
<programlisting role="php">
<![CDATA[
<?php
-/* ... */
+$info = new SplFileInfo('file.txt');
+print_r(posix_getpwuid($info->getOwner()));
?>
]]>
</programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
</example>
</para>
</refsect1>
@@ -56,7 +58,8 @@
&reftitle.seealso;
<para>
<simplelist>
- <member><methodname>Classname::Method</methodname></member>
+ <member><function>posix_getpwuid</function></member>
+ <member><methodname>SplFileInfo::getGroup</methodname></member>
</simplelist>
</para>
</refsect1>