cvs: peardoc /peardoc2/en/package/filesystem/file-htaccess addrequire.xml delrequire.xml file-htaccess.xml load.xml setauthuserfile.xml setrequire.xml

From: Date: Mon, 13 Jan 2003 13:14:08 +0000
Subject: cvs: peardoc /peardoc2/en/package/filesystem/file-htaccess addrequire.xml delrequire.xml file-htaccess.xml load.xml setauthuserfile.xml setrequire.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-253@lists.php.net to get a copy of this message
tuupola Mon Jan 13 08:14:08 2003 EDT Modified files: /peardoc/peardoc2/en/package/filesystem/file-htaccess addrequire.xml delrequire.xml file-htaccess.xml load.xml setauthuserfile.xml setrequire.xml Log: * fix typos

Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/addrequire.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/addrequire.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/addrequire.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/addrequire.xml:1.1 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/addrequire.xml Mon Jan 13 08:14:07 2003 @@ -72,7 +72,7 @@ <member> <link linkend="package.filesystem.file-htaccess.getrequire"> <function>File_HtAccess::getRequire</function> - </link>< + </link> </member> </simplelist> </para> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/delrequire.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/delrequire.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/delrequire.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/delrequire.xml:1.1 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/delrequire.xml Mon Jan 13 08:14:07 2003 @@ -1,7 +1,7 @@ <refentry id="package.filesystem.file-htaccess.delrequire"> <refnamediv> - <refname>File_HtAccess::delrequire()</refname> + <refname>File_HtAccess::delRequire()</refname> <refpurpose>remove a value from require property</refpurpose> </refnamediv> @@ -72,7 +72,7 @@ <member> <link linkend="package.filesystem.file-htaccess.getrequire"> <function>File_HtAccess::getRequire</function> - </link>< + </link> </member> </simplelist> </para> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.4 peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.5 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.4 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml Mon Jan 13 08:14:07 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="package.filesystem.file-htaccess.file-htaccess"> <refnamediv> @@ -98,18 +98,18 @@ </para> </refsect1> - <refsect1 id="package.filesystem.file.file-htaccess.setproperties.note"> + <refsect1 id="package.filesystem.file.file-htaccess.file-htaccess.note"> &title.note; &note.notstatic; </refsect1> - <refsect1 id="package.filesystem.file.file-htaccess.setproperties.see"> + <refsect1 id="package.filesystem.file.file-htaccess.file-htaccess.see"> &title.see; <para> </para> </refsect1> --> - <refsect1 id="package.filesystem.file-htaccess.setproperties.example"> + <refsect1 id="package.filesystem.file-htaccess.file-htaccess.example"> &title.example; <example> <title>How to create new instance of <classname>File_HtAccess</classname></title> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.5 peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.6 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.5 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml Mon Jan 13 08:14:08 2003 @@ -1,8 +1,8 @@ -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="package.filesystem.file-htaccess.load"> <refnamediv> - <refname>File_HtAccess::load()</refname> + <refname><function>File_HtAccess::load</function></refname> <refpurpose>load the contents of existing .htaccess file</refpurpose> </refnamediv> @@ -60,7 +60,7 @@ $fh = new File_HtAccess('.htaccess'); $status = $fh->load(); -if (PEAR::isError($fh)) { +if (PEAR::isError($status)) { // handle errors } else { // continue processing Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml:1.1 Fri Jan 10 12:51:37 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml Mon Jan 13 08:14:08 2003 @@ -1,19 +1,21 @@ <refentry id="package.filesystem.file-htaccess.setauthuserfile"> <refnamediv> - <refname>File_HtAccess::setAuthUserfile()</refname> - <refpurpose>set the name of AuthUserFile</refpurpose> + <refname>File_HtAccess::setAuthUserFile()</refname> + <refpurpose>set the value of authuserfile property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> +<!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> +--> <funcprototype> - <funcdef>void <function>File_HtAccess::setAuthUserfile</function></funcdef> + <funcdef>void <function>File_HtAccess::setAuthUserFile</function></funcdef> <paramdef> - string <parameter><optional>$file</optional></parameter> + <parameter>string <optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -23,12 +25,9 @@ &title.desc; <para> Sets the value of authuserfile property. AuthUserFile is the password - file which contains username:password pairs for user authenticatoin. + file which contains username:password pairs for Basic authentication. You must give full path to the password file in order for it to work. </para> - <para> - - </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthuserfile.parameter"> @@ -40,48 +39,66 @@ <parameter>string $file</parameter> - absolute pathname to the password file. </para> - </listitem> + </listitem> </itemizedlist> </para> </refsect1> -<!-- + <refsect1 id="package.filesystem.file-htaccess.setauthuserfile.return"> &title.returns; <para> void </para> </refsect1> + +<!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthuserfile.throws"> &title.throws; <para> </para> </refsect1> +--> + <refsect1 id="package.filesystem.file.file-htaccess.setauthuserfile.note"> &title.note; &note.notstatic; </refsect1> ---> + + <refsect1 id="package.filesystem.file.file-htaccess.setauthuserfile.see"> &title.see; <para> <simplelist> <member> - <link linkend="package.filesystem.file-passwd"> - <classname>File_Passwd</classname> - </link>< + <link linkend="package.filesystem.file-htaccess.setautdigestfile"> + <function>File_HtAccess::getAuthDigestFile</function> + </link> </member> </simplelist> </para> </refsect1> + <refsect1 id="package.filesystem.file-htaccess.setauthuserfile.example"> &title.example; <example> - <title>Using <function>File_HtAccess::setauthuserfile</function></title> + <title>Using <function>File_HtAccess::setAuthUserFile</function></title> <programlisting role="php"> <![CDATA[ <?php -require_once 'File_HtAccess.php'; +require_once('File_HtAccess.php'); + +/* set the password file to /etc/htpasswd */ +$fh = new File_HtAccess('.htaccess'); +$fh->load(); +$fh->setAuthUserFile('/etc/htpasswd'); +$fh->save(); +/* set the password file to .htpasswd in current working directory */ +$file = getcwd() . '/.htpasswd'; +$fh = new File_HtAccess('.htaccess'); +$fh->load(); +$fh->setAuthUserFile($file); +$fh->save(); ?> ]]> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml:1.3 peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml:1.4 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml:1.3 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml Mon Jan 13 08:14:08 2003 @@ -69,17 +69,17 @@ <member> <link linkend="package.filesystem.file-htaccess.addrequire"> <function>File_HtAccess::addRequire</function> - </link>< + </link> </member> <member> <link linkend="package.filesystem.file-htaccess.delrequire"> <function>File_HtAccess::delRequire</function> - </link>< + </link> </member> <member> <link linkend="package.filesystem.file-htaccess.getrequire"> <function>File_HtAccess::getRequire</function> - </link>< + </link> </member> </simplelist> </para>
« previous php.pear.doc (#253) next »