cvs: peardoc /en/package/filesystem/file-passwd/file-passwd file-passwd.xml file_passwd.xml /en/package/filesystem/file-passwd/file-passwd-authbasic
file-passwd-authbasic.xml file_passwd_authbasic.xml /en/package/filesystem/file-passwd/file-passwd-authdigest file-passwd-authdigest.xml
file_passwd_authdigest.xml /en/package/filesystem/file-passwd/file-passwd-common --clone.xml --construct.xml -auth.xml -close.xml -open.xml -save.xml
__clone.xml __construct.xml _auth.xml _close.xml _open.xml _save.xml /en/package/filesystem/file-passwd/file-passwd-custom file-passwd-custom.xml
file_passwd_custom.xml /en/package/filesystem/file-passwd/file-passwd-cvs file-passwd-cvs.xml file_passwd_cvs.xml
/en/package/filesystem/file-passwd/file-passwd-smb file-passwd-smb.xml file_passwd_smb.xml /en/package/filesystem/file-passwd/file-passwd-unix
file-passwd-unix.xml file_passwd_unix.xml
| From: | Mehdi Achour | Date: | Tue, 16 Mar 2004 16:09:23 +0000 |
| Subject: | cvs: peardoc /en/package/filesystem/file-passwd/file-passwd file-passwd.xml file_passwd.xml /en/package/filesystem/file-passwd/file-passwd-authbasic file-passwd-authbasic.xml file_passwd_authbasic.xml /en/package/filesystem/file-passwd/file-passwd-authdigest file-passwd-authdigest.xml file_passwd_authdigest.xml /en/package/filesystem/file-passwd/file-passwd-common --clone.xml --construct.xml -auth.xml -close.xml -open.xml -save.xml __clone.xml __construct.xml _auth.xml _close.xml _open.xml _save.xml /en/package/filesystem/file-passwd/file-passwd-custom file-passwd-custom.xml file_passwd_custom.xml /en/package/filesystem/file-passwd/file-passwd-cvs file-passwd-cvs.xml file_passwd_cvs.xml /en/package/filesystem/file-passwd/file-passwd-smb file-passwd-smb.xml file_passwd_smb.xml /en/package/filesystem/file-passwd/file-passwd-unix file-passwd-unix.xml file_passwd_unix.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2997@lists.php.net to get a copy of this message | ||
didou Tue Mar 16 11:09:23 2004 EDT
Added files:
/peardoc/en/package/filesystem/file-passwd/file-passwd
file-passwd.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic
file-passwd-authbasic.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest
file-passwd-authdigest.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-common
--clone.xml
--construct.xml
-auth.xml
-close.xml
-open.xml
-save.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-custom
file-passwd-custom.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-cvs
file-passwd-cvs.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-smb
file-passwd-smb.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-unix
file-passwd-unix.xml
Removed files:
/peardoc/en/package/filesystem/file-passwd/file-passwd
file_passwd.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic
file_passwd_authbasic.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest
file_passwd_authdigest.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-common
__clone.xml
__construct.xml
_auth.xml
_close.xml
_open.xml
_save.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-custom
file_passwd_custom.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-cvs
file_passwd_cvs.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-smb
file_passwd_smb.xml
/peardoc/en/package/filesystem/file-passwd/file-passwd-unix
file_passwd_unix.xml
Log:
fixing filenames
http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd.file-passwd"> <refnamediv> <refname>constructor <function>File_Passwd::constructor File_Passwd</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Passwd.php'; </funcsynopsisinfo> <funcprototype> <funcdef><void /> <function>constructor File_Passwd::constructor File_Passwd</function></funcdef> <paramdef>$file <parameter>$file</parameter></paramdef> <paramdef>$lock <parameter> <optional>$lock</parameter></paramdef> <paramdef><varname>$lockfile</varname> <parameter> <optional>$lockfile = ""</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.desc"> &title.desc; <para>Requires the name of the passwd file. This functions opens the file and read it. Changes to this file will written first in the lock file, so it is still possible to access the passwd file by another programs. The lock parameter controls the locking oft the lockfile, not of the passwd file! (Swapping $lock and $lockfile would break BC). Don't forget to call close() to save changes!</para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.; <parameter>$file</parameter> </term> </varlistentry> <listitem> <para> name of the passwd file </para> </listitem> </variablelist> <variablelist> <varlistentry> <term> &type.; <parameter>$lock</parameter> </term> </varlistentry> <listitem> <para> if 'true' $lockfile will be locked </para> </listitem> </variablelist> <variablelist> <varlistentry> <term> &type.; <parameter>$lockfile</parameter> </term> </varlistentry> <listitem> <para> name of the temp file, where changes are saved </para> </listitem> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.filesystem.file-passwd.file-passwd.close"><function>File_Passwd::close()</function></link> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic"> <refnamediv> <refname><function>File_Passwd_Authbasic::File_Passwd_Authbasic</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Authbasic.php';</funcsynopsisinfo> <funcprototype> <funcdef> object &new <function>File_Passwd_Authbasic</function> </funcdef> <paramdef>string <parameter> <optional>$file = '.htpasswd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.desc"> &title.desc; <para> Initialise a new File_Passwd_Authbasic object with the given path to the passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to AuthUserFile </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Authbasic</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest"> <refnamediv> <refname><function>File_Passwd_Authdigest::File_Passwd_Authdigest</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Authdigest.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Authdigest</function></funcdef> <paramdef>string <parameter><optional>$file = '.htdigest'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.desc"> &title.desc; <para> Initialize a new object of File_Passwd_Authdigest with the specified path to the AuthDigestFile. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to AuthDigestFile </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Authdigest</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.--clone"> <refnamediv> <refname><function>File_Passwd_Common::__clone</function></refname> <refpurpose>Get Copy of this object</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>object <function>File_Passwd_Common::__clone</function></funcdef> <paramdef /> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.desc"> &title.desc; <para> Implemented for Zend Engine 2 compatiability. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.return"> &title.returns; <para> Returns &type.object; File_Passwd_* - a copy of the File_Passwd object. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.--construct"> <refnamediv> <refname><function>File_Passwd_Common::__construct</function></refname> <refpurpose>Constructor (ZE2)</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>object <function>File_Passwd_Common::__construct</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.desc"> &title.desc; <para> Implemented for Zend Engine 2 compatibility. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.return"> &title.returns; <para> Returns &type.object; File_Passwd_* - new instance of an File_Passwd_* object. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-auth"> <refnamediv> <refname><function>File_Passwd_Common::_auth</function></refname> <refpurpose>Base method for File_Passwd::staticAuth()</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_auth</function></funcdef> <paramdef>string <parameter>$file</parameter></paramdef> <paramdef>string <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.desc"> &title.desc; <para> Base method for <function>File_Passwd_*::staticAuth</function> </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> <varlistentry> <term> &type.string; <parameter>$id</parameter> </term> <listitem> <para> user_id to search for </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.return"> &title.returns; <para> Returns &type.string; line of passwd file containing $id, &false; if $id wasn't found, or <classname>PEAR_Error</classname> on failure. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_EXISTS_NOT</entry> <entry>passwd file doesn't exist</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in read mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked shared</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked (only if auth fails)</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed (only if auth fails)</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-close"> <refnamediv> <refname><function>File_Passwd_Common::_close</function></refname> <refpurpose>Closes a prior opened and locked file handle</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_close</function></funcdef> <paramdef>resource <parameter>&$file_handle</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.desc"> &title.desc; <para> Closes a prior with <function>File_Passwd_Common::_open</function> opened and locked file handle. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.res; <parameter>&$file_handle</parameter> </term> <listitem> <para> the file handle to operate on </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.return"> &title.returns; <para> &return.success-pearerror; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-open"> <refnamediv> <refname><function>File_Passwd_Common::_open</function></refname> <refpurpose>Open a file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed &<function>File_Passwd_Common::_open</function></funcdef> <paramdef>string <parameter>$mode</parameter></paramdef> <paramdef>mixed <parameter><optional>$file = null</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.desc"> &title.desc; <para> Opens a file, locks it exclusively and returns the filehandle. </para> <para>&pdevrel;</para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$mode</parameter> </term> <listitem> <para> the mode to open the file with </para> </listitem> </varlistentry> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.return"> &title.returns; <para> Returns &type.res; file handle or <classname>PEAR_Error</classname> on failure. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_DIR_NOT_CREATED</entry> <entry>the directory in which the passwd file should reside couldn't be created</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in the desired mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-save"> <refnamediv> <refname><function>File_Passwd_Common::_save</function></refname> <refpurpose>Save the modified content to the passwd file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_save</function></funcdef> <paramdef>string <parameter>$content</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.desc"> &title.desc; <para> Save content to file. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$content</parameter> </term> <listitem> <para> file content </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.return"> &title.returns; <para> &return.success-pearerror; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_DIR_NOT_CREATED</entry> <entry>the directory in which the passwd file should reside couldn't be created</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in write mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked exclusively</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom"> <refnamediv> <refname><function>File_Passwd_Custom::File_Passwd_Custom</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Custom.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_custom</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.desc"> &title.desc; <para> Initialize a new File_Passwd_Custom object with the specified path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Custom</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs"> <refnamediv> <refname><function>File_Passwd_Cvs::File_Passwd_Cvs</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Cvs.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Cvs</function></funcdef> <paramdef>mixed <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.desc"> &title.desc; <para> Initialize a new <classname>File_Passwd_Cvs</classname> object with the given path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Cvs</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb"> <refnamediv> <refname><function>File_Passwd_Smb::File_Passwd_Smb</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Smb.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Smb</function></funcdef> <paramdef>string <parameter> <optional>$file = 'smbpasswd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.desc"> &title.desc; <para> Initialize a new <classname>File_Passwd_Smb</classname> object with the given path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to SMB passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Smb</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix"> <refnamediv> <refname><function>File_Passwd_Unix::File_Passwd_Unix</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Unix.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Unix</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.desc"> &title.desc; <para> Initialize a new File_Passwd_Unix object with the specified path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Unix</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.note"> &title.note; ¬e.notstatic; </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 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 -->
http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd/file-passwd.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd.file-passwd"> <refnamediv> <refname>constructor <function>File_Passwd::constructor File_Passwd</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Passwd.php'; </funcsynopsisinfo> <funcprototype> <funcdef><void /> <function>constructor File_Passwd::constructor File_Passwd</function></funcdef> <paramdef>$file <parameter>$file</parameter></paramdef> <paramdef>$lock <parameter> <optional>$lock</parameter></paramdef> <paramdef><varname>$lockfile</varname> <parameter> <optional>$lockfile = ""</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.desc"> &title.desc; <para>Requires the name of the passwd file. This functions opens the file and read it. Changes to this file will written first in the lock file, so it is still possible to access the passwd file by another programs. The lock parameter controls the locking oft the lockfile, not of the passwd file! (Swapping $lock and $lockfile would break BC). Don't forget to call close() to save changes!</para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.; <parameter>$file</parameter> </term> </varlistentry> <listitem> <para> name of the passwd file </para> </listitem> </variablelist> <variablelist> <varlistentry> <term> &type.; <parameter>$lock</parameter> </term> </varlistentry> <listitem> <para> if 'true' $lockfile will be locked </para> </listitem> </variablelist> <variablelist> <varlistentry> <term> &type.; <parameter>$lockfile</parameter> </term> </varlistentry> <listitem> <para> name of the temp file, where changes are saved </para> </listitem> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.filesystem.file-passwd.file-passwd.close"><function>File_Passwd::close()</function></link> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd.file-passwd.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file-passwd-authbasic.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic"> <refnamediv> <refname><function>File_Passwd_Authbasic::File_Passwd_Authbasic</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Authbasic.php';</funcsynopsisinfo> <funcprototype> <funcdef> object &new <function>File_Passwd_Authbasic</function> </funcdef> <paramdef>string <parameter> <optional>$file = '.htpasswd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.desc"> &title.desc; <para> Initialise a new File_Passwd_Authbasic object with the given path to the passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to AuthUserFile </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Authbasic</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file-passwd-authdigest.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest"> <refnamediv> <refname><function>File_Passwd_Authdigest::File_Passwd_Authdigest</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Authdigest.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Authdigest</function></funcdef> <paramdef>string <parameter><optional>$file = '.htdigest'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.desc"> &title.desc; <para> Initialize a new object of File_Passwd_Authdigest with the specified path to the AuthDigestFile. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to AuthDigestFile </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Authdigest</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/--clone.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.--clone"> <refnamediv> <refname><function>File_Passwd_Common::__clone</function></refname> <refpurpose>Get Copy of this object</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>object <function>File_Passwd_Common::__clone</function></funcdef> <paramdef /> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.desc"> &title.desc; <para> Implemented for Zend Engine 2 compatiability. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.return"> &title.returns; <para> Returns &type.object; File_Passwd_* - a copy of the File_Passwd object. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--clone.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/--construct.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.--construct"> <refnamediv> <refname><function>File_Passwd_Common::__construct</function></refname> <refpurpose>Constructor (ZE2)</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>object <function>File_Passwd_Common::__construct</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.desc"> &title.desc; <para> Implemented for Zend Engine 2 compatibility. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.return"> &title.returns; <para> Returns &type.object; File_Passwd_* - new instance of an File_Passwd_* object. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.--construct.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-auth.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-auth"> <refnamediv> <refname><function>File_Passwd_Common::_auth</function></refname> <refpurpose>Base method for File_Passwd::staticAuth()</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_auth</function></funcdef> <paramdef>string <parameter>$file</parameter></paramdef> <paramdef>string <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.desc"> &title.desc; <para> Base method for <function>File_Passwd_*::staticAuth</function> </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> <varlistentry> <term> &type.string; <parameter>$id</parameter> </term> <listitem> <para> user_id to search for </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.return"> &title.returns; <para> Returns &type.string; line of passwd file containing $id, &false; if $id wasn't found, or <classname>PEAR_Error</classname> on failure. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_EXISTS_NOT</entry> <entry>passwd file doesn't exist</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in read mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked shared</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked (only if auth fails)</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed (only if auth fails)</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-auth.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-close.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-close"> <refnamediv> <refname><function>File_Passwd_Common::_close</function></refname> <refpurpose>Closes a prior opened and locked file handle</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_close</function></funcdef> <paramdef>resource <parameter>&$file_handle</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.desc"> &title.desc; <para> Closes a prior with <function>File_Passwd_Common::_open</function> opened and locked file handle. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.res; <parameter>&$file_handle</parameter> </term> <listitem> <para> the file handle to operate on </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.return"> &title.returns; <para> &return.success-pearerror; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-close.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-open.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-open"> <refnamediv> <refname><function>File_Passwd_Common::_open</function></refname> <refpurpose>Open a file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed &<function>File_Passwd_Common::_open</function></funcdef> <paramdef>string <parameter>$mode</parameter></paramdef> <paramdef>mixed <parameter><optional>$file = null</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.desc"> &title.desc; <para> Opens a file, locks it exclusively and returns the filehandle. </para> <para>&pdevrel;</para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$mode</parameter> </term> <listitem> <para> the mode to open the file with </para> </listitem> </varlistentry> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.return"> &title.returns; <para> Returns &type.res; file handle or <classname>PEAR_Error</classname> on failure. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_DIR_NOT_CREATED</entry> <entry>the directory in which the passwd file should reside couldn't be created</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in the desired mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-open.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-common/-save.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-common.-save"> <refnamediv> <refname><function>File_Passwd_Common::_save</function></refname> <refpurpose>Save the modified content to the passwd file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>mixed <function>File_Passwd_Common::_save</function></funcdef> <paramdef>string <parameter>$content</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.desc"> &title.desc; <para> Save content to file. </para> <para> &pdevrel; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$content</parameter> </term> <listitem> <para> file content </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.return"> &title.returns; <para> &return.success-pearerror; </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="2"> <thead> <row> <entry>Error Code</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry>FILE_PASSWD_E_DIR_NOT_CREATED</entry> <entry>the directory in which the passwd file should reside couldn't be created</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_OPENED</entry> <entry>passwd file couldn't be opened in write mode</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_LOCKED</entry> <entry>passwd file couldn't be locked exclusively</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_UNLOCKED</entry> <entry>passwd file couldn't be unlocked</entry> </row> <row> <entry>FILE_PASSWD_E_FILE_NOT_CLOSED</entry> <entry>passwd file couldn't be closed</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-common.-save.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-custom/file-passwd-custom.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom"> <refnamediv> <refname><function>File_Passwd_Custom::File_Passwd_Custom</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Custom.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_custom</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.desc"> &title.desc; <para> Initialize a new File_Passwd_Custom object with the specified path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Custom</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-custom.file-passwd-custom.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file-passwd-cvs.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs"> <refnamediv> <refname><function>File_Passwd_Cvs::File_Passwd_Cvs</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Cvs.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Cvs</function></funcdef> <paramdef>mixed <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.desc"> &title.desc; <para> Initialize a new <classname>File_Passwd_Cvs</classname> object with the given path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Cvs</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file-passwd-smb.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb"> <refnamediv> <refname><function>File_Passwd_Smb::File_Passwd_Smb</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Smb.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Smb</function></funcdef> <paramdef>string <parameter> <optional>$file = 'smbpasswd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.desc"> &title.desc; <para> Initialize a new <classname>File_Passwd_Smb</classname> object with the given path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to SMB passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Smb</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml?r=1.1&p=1 Index: peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml +++ peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file-passwd-unix.xml <!-- $Revision: 1.1 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix"> <refnamediv> <refname><function>File_Passwd_Unix::File_Passwd_Unix</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once 'File/Passwd/Unix.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &new <function>File_Passwd_Unix</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.desc"> &title.desc; <para> Initialize a new File_Passwd_Unix object with the specified path to passwd file. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$file</parameter> </term> <listitem> <para> path to passwd file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.return"> &title.returns; <para> Returns &type.object; <classname>File_Passwd_Unix</classname>. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.throws"> &title.throws; <para> Throws no exception. </para> </refsect1> <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.note"> &title.note; ¬e.notstatic; </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 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 -->