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

From: Date: Fri, 10 Jan 2003 17:51:37 +0000
Subject: cvs: peardoc /peardoc2/en/package/filesystem/file-htaccess file-htaccess.xml intro.xml load.xml save.xml setauthuserfile.xml setrequire.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-242@lists.php.net to get a copy of this message
tuupola Fri Jan 10 12:51:37 2003 EDT Added files: /peardoc/peardoc2/en/package/filesystem/file-htaccess setauthuserfile.xml setrequire.xml Modified files: /peardoc/peardoc2/en/package/filesystem/file-htaccess file-htaccess.xml intro.xml load.xml save.xml Log: * updating File_HtAccess docs...

Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml:1.1 Thu Jan 9 15:46:02 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/file-htaccess.xml Fri Jan 10 12:51:37 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-htaccess.file-htaccess"> <refnamediv> @@ -9,12 +9,12 @@ <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> - require_once 'File/HtAccesss.php'; + require_once 'File/HtAccess.php'; </funcsynopsisinfo> <funcprototype> <funcdef>object <function>new File_HtAccess</function></funcdef> <paramdef> - string <parameter><optional>$file </optional></parameter> + string <parameter><optional>$file='.htaccess' </optional></parameter> </paramdef> <paramdef> array <parameter><optional>$params</optional></parameter> @@ -72,6 +72,40 @@ <parameter>object</parameter> - instance of File_HtAccess </para> </refsect1> + +<!-- + <refsect1 id="package.filesystem.file.file-htaccess.setproperties.throws"> + &title.throws; + <para> + </para> + </refsect1> + + <refsect1 id="package.filesystem.file.file-htaccess.setproperties.note"> + &title.note; + &note.notstatic; + </refsect1> + <refsect1 id="package.filesystem.file.file-htaccess.setproperties.see"> + &title.see; + <para> + </para> + </refsect1> +--> + + <refsect1 id="package.filesystem.file-htaccess.setproperties.example"> + &title.example; + <example> + <title>Using <function>File_HtAccess::setProperties</function></title> + <programlisting role="php"> + <![CDATA[ +<?php +require_once 'File_HtAccess.php'; + + +?> +]]> + </programlisting> + </example> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/intro.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/intro.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/intro.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/intro.xml:1.1 Thu Jan 9 15:46:02 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/intro.xml Fri Jan 10 12:51:37 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-htaccess.intro"> <refnamediv> <refname>Introduction</refname> @@ -14,7 +14,8 @@ to protect webserver directories. Since <classname>File_HtAccess</classname> does not provide any means to manipulate or create password files you should use it together - with <classname>File_Passwd</classname>. + with <classname><link linkend="package.filesystem.file-passwd"> + File_Passwd</link></classname>. </para> </refsect1> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.2 peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.3 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml:1.2 Thu Jan 9 15:46:02 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/load.xml Fri Jan 10 12:51:37 2003 @@ -1,38 +1,67 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.filesystem.file-htaccess.load"> - <refnamediv> - <refname>File_HtAccess::load()</refname> - <refpurpose>load the .htaccess file</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/HtAccess.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>mixed <function>File_HtAccess::load</function></funcdef> - <paramdef> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.filesystem.file-htaccess.load.desc"> - &title.desc; - <para> - Load the contents of .htaccess file. - </para> - </refsect1> - <refsect1 id="package.filesystem.file-htaccess.load.return"> - &title.returns; - <para> - <parameter>mixed</parameter> - &return.success-pearerror; - </para> - </refsect1> - <refsect1 id="package.filesystem.file-htaccess.load.note"> - &title.note; - &note.notstatic; - </refsect1> - </refentry> + + <refnamediv> + <refname>File_HtAccess::load()</refname> + <refpurpose>load the .htaccess file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'File/HtAccess.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef>mixed <function>File_HtAccess::load</function></funcdef> + <paramdef> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.filesystem.file-htaccess.load.desc"> + &title.desc; + <para> + Load the contents of .htaccess file. + </para> + </refsect1> + + <refsect1 id="package.filesystem.file-htaccess.load.return"> + &title.returns; + <para> + <parameter>mixed</parameter> - &return.success-pearerror; + </para> + </refsect1> + +<!-- + <refsect1 id="package.filesystem.file.file-htaccess.load.throws"> + &title.throws; + <para> + </para> + </refsect1> +--> + + <refsect1 id="package.filesystem.file-htaccess.load.note"> + &title.note; + &note.notstatic; + </refsect1> +</refentry> + + <refsect1 id="package.filesystem.file-htaccess.load.example"> + &title.example; + <example> + <title>Using <function>File_HtAccess::load</function></title> + <programlisting role="php"> + <![CDATA[ +<?php +require_once 'File_HtAccess.php'; + +?> +]]> + </programlisting> + </example> + </refsect1> + <!-- Keep this comment at the end of the file Local variables: mode: sgml Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/save.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess/save.xml:1.1 peardoc/peardoc2/en/package/filesystem/file-htaccess/save.xml:1.2 --- peardoc/peardoc2/en/package/filesystem/file-htaccess/save.xml:1.1 Thu Jan 9 15:46:02 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/save.xml Fri Jan 10 12:51:37 2003 @@ -1,39 +1,69 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-htaccess.save"> - <refnamediv> - <refname>File_HtAccess::save()</refname> - <refpurpose>saves the .htaccess file</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/HtAccess.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>mixed <function>File_HtAccesss:save</function></funcdef> - <paramdef> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.filesystem.file-htaccess.save.desc"> - &title.desc; - <para> - Saves the contents of File_HtAccess object as a corresponding - .htaccess file on the disc. - </para> - </refsect1> - <refsect1 id="package.filesystem.file-htaccess.save.return"> - &title.returns; - <para> - <parameter>mixed</parameter> - &return.success-pearerror; - </para> - </refsect1> - <refsect1 id="package.filesystem.file-htaccess.save.note"> - &title.note; - &note.notstatic; - </refsect1> - </refentry> + + <refnamediv> + <refname>File_HtAccess::save()</refname> + <refpurpose>saves the .htaccess file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'File/HtAccess.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef>mixed <function>File_HtAccesss:save</function></funcdef> + <paramdef> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.filesystem.file-htaccess.save.desc"> + &title.desc; + <para> + Saves the contents of File_HtAccess object as a corresponding + .htaccess file on the disc. + </para> + </refsect1> + + <refsect1 id="package.filesystem.file-htaccess.save.return"> + &title.returns; + <para> + <parameter>mixed</parameter> - &return.success-pearerror; + </para> + </refsect1> + +<!-- + <refsect1 id="package.filesystem.file.file-htaccess.save.throws"> + &title.throws; + <para> + </para> + </refsect1> +--> + + <refsect1 id="package.filesystem.file-htaccess.save.note"> + &title.note; + &note.notstatic; + </refsect1> + + <refsect1 id="package.filesystem.file-htaccess.save.example"> + &title.example; + <example> + <title>Using <function>File_HtAccess::save</function></title> + <programlisting role="php"> + <![CDATA[ +<?php +require_once 'File_HtAccess.php'; + + +?> +]]> + </programlisting> + </example> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthuserfile.xml <refentry id="package.filesystem.file-htaccess.setauthuserfile"> <refnamediv> <refname>File_HtAccess::setAuthUserfile()</refname> <refpurpose>set the name of AuthUserFile</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthUserfile</function></funcdef> <paramdef> string <parameter><optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthuserfile.desc"> &title.desc; <para> Sets the value of authuserfile property. AuthUserFile is the password file which contains username:password pairs for user authenticatoin. 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"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $file</parameter> - absolute pathname to the password file. </para> </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>< </member> </simplelist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthuserfile.example"> &title.example; <example> <title>Using <function>File_HtAccess::setauthuserfile</function></title> <programlisting role="php"> <![CDATA[ <?php require_once 'File_HtAccess.php'; ?> ]]> </programlisting> </example> </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 --> Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setrequire.xml <refentry id="package.filesystem.file-htaccess.setrequire"> <refnamediv> <refname>File_HtAccess::setRequire()</refname> <refpurpose>set the value of require property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>File_HtAccess::setRequire</function></funcdef> <paramdef> mixed <optional><parameter>$require/parameter></optional> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setrequire.desc"> &title.desc; <para> Sets the value of require property.This overwrites the previous value. If you need to add a value (user) to require use <function>File_HtAccess::addRequire</function> instead. Using this method you can control which users will be able to access the protected folders. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setrequire.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>mixed $require</parameter> - value the requre property to be set to. Can be given as a string or an array. If given as a string separate multiple values with a space. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setrequire.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setrequire.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setrequire.note"> &title.note; &note.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.setrequire.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.addrequire"> <function>File_HtAccess::addRequire</function> </link>< </member> <member> <link linkend="package.filesystem.file-htaccess.delrequire"> <function>File_HtAccess::delRequire</function> </link>< </member> <member> <link linkend="package.filesystem.file-htaccess.getrequire"> <function>File_HtAccess::getRequire</function> </link>< </member> </simplelist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setrequire.example"> &title.example; <example> <title>Using <function>File_HtAccess::setRequire</function></title> <programlisting role="php"> <![CDATA[ <?php require_once 'File_HtAccess.php'; ?> ]]> </programlisting> </example> </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 -->
« previous php.pear.doc (#242) next »