cvs: peardoc /peardoc2/en/package/filesystem file-htaccess.xml /peardoc2/en/package/filesystem/file-htaccess getrequire.xml setauthdigestfile.xml
setauthgroupfile.xml setauthtype.xml setproperties.xml
| From: | Mika Tuupola | Date: | Mon, 13 Jan 2003 13:31:49 +0000 |
| Subject: | cvs: peardoc /peardoc2/en/package/filesystem file-htaccess.xml /peardoc2/en/package/filesystem/file-htaccess getrequire.xml setauthdigestfile.xml setauthgroupfile.xml setauthtype.xml setproperties.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-254@lists.php.net to get a copy of this message | ||
tuupola Mon Jan 13 08:31:49 2003 EDT
Added files:
/peardoc/peardoc2/en/package/filesystem/file-htaccess
getrequire.xml
setauthdigestfile.xml
setauthgroupfile.xml
setauthtype.xml
setproperties.xml
Modified files:
/peardoc/peardoc2/en/package/filesystem file-htaccess.xml
Log:
* continue documentation on File_HtAccess
Index: peardoc/peardoc2/en/package/filesystem/file-htaccess.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.4 peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.5 --- peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.4 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess.xml Mon Jan 13 08:31:48 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <sect1 id="package.filesystem.file-htaccess"> <title>File_HtAccess</title> @@ -10,19 +10,18 @@ &package.filesystem.file-htaccess.file-htaccess; &package.filesystem.file-htaccess.load; &package.filesystem.file-htaccess.save; - <!-- + &package.filesystem.file-htaccess.setrequire; + &package.filesystem.file-htaccess.addrequire; + &package.filesystem.file-htaccess.delrequire; + &package.filesystem.file-htaccess.getrequire; &package.filesystem.file-htaccess.setproperties; - &package.filesystem.file-htaccess.setauthname; - &package.filesystem.file-htaccess.setauthtype; &package.filesystem.file-htaccess.setauthuserfile; &package.filesystem.file-htaccess.setauthgroupfile; - --> + &package.filesystem.file-htaccess.setauthtype; + &package.filesystem.file-htaccess.setauthdigestfile; - &package.filesystem.file-htaccess.setrequire; - &package.filesystem.file-htaccess.addrequire; - &package.filesystem.file-htaccess.delrequire; <!-- - &package.filesystem.file-htaccess.getrequire; + &package.filesystem.file-htaccess.setauthname; &package.filesystem.file-htaccess.setadditional; &package.filesystem.file-htaccess.addadditional; &package.filesystem.file-htaccess.getadditional; Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/getrequire.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/getrequire.xml <refentry id="package.filesystem.file-htaccess.getrequire"> <refnamediv> <refname>File_HtAccess::getRequire()</refname> <refpurpose>get the value(s) of require property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>array <function>File_HtAccess::getRequire</function></funcdef> <paramdef> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.getrequire.desc"> &title.desc; <para> Get the value(s) of require property as an array. Require property contains the usernames or groups users who are allowed to access protected resources. Value valid-user means all users listed in password file are allowed to access. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.getrequire.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $type</parameter> - if 'string' return value will be a string with usernames separated by a space character. Otherwise return value will be an array(). Defaults to an array. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.getrequire.return"> &title.returns; <para> mixed string or array depending on $type parameter. </para> </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.getrequire.note"> &title.note; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.getrequire.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.setrequire"> <function>File_HtAccess::setRequire</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.getrequire.example"> &title.example; <example> <title>Using <function>File_HtAccess::getrequire</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* add user tuupola and viemero to list of users to be granted access */ $fh = new File_HtAccess('.htaccess'); $fh->addRequire('tuupola'); $fh->addRequire('viemero'); $require1 = $fh->getRequire(); $require2 = $fh->getRequire('string'); print_r($require1); /* Array */ /* ( */ /* [0] => tuupola */ /* [1] => viemero */ /* ) */ print_r($require2); /* tuupola viemero */ ?> ]]> </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/setauthdigestfile.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthdigestfile.xml <refentry id="package.filesystem.file-htaccess.setauthdigestfile"> <refnamediv> <refname>File_HtAccess::setAuthDigestFile</refname> <refpurpose>set the value of authdigestfile property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthDigestFile</function></funcdef> <paramdef> <parameter>string <optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.desc"> &title.desc; <para> Sets the value of authdigestfile property. AuthDigestFile is the password file which contains username:realm:password pairs for Digest authentication. You must give full path to the password file in order for it to work. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.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.setauthdigestfile.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.note"> &title.note; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.setauthuserfile"> <function>File_HtAccess::setAuthUserFile</function> </link> </member> </simplelist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.example"> &title.example; <example> <title>Using <function>File_HtAccess::setauthdigestfile</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* set the password file to /etc/htdigest */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setauthdigestfile('/etc/htdigest'); $fh->save(); ?> ]]> </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/setauthgroupfile.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthgroupfile.xml <refentry id="package.filesystem.file-htaccess.setauthgroupfile"> <refnamediv> <refname>File_HtAccess::setAuthGroupFile()</refname> <refpurpose>set the value of authgroupfile property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthGroupFile</function></funcdef> <paramdef> <parameter>string <optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.desc"> &title.desc; <para> Sets the value of authgroupfile property. AuthGroupFile a file containing names of the groups and usernames belonging to the group. You must give full path to the group file in order for it to work. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $file</parameter> - absolute pathname to the group file. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.note"> &title.note; ¬e.notstatic; </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.see"> &title.see; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.example"> &title.example; <example> <title>Using <function>File_HtAccess::setauthgroupfile</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* set the group file to /etc/htgroup */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setAuthGroupFile('/etc/htgroup'); $fh->save(); ?> ]]> </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/setauthtype.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthtype.xml <refentry id="package.filesystem.file-htaccess.setauthtype"> <refnamediv> <refname>File_HtAccess::setAuthType</refname> <refpurpose>set the value of authtype property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthType</function></funcdef> <paramdef> <parameter>string <optional>$type='Basic'</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthtype.desc"> &title.desc; <para> Sets the value of authtype property. Almost allways you will be using Basic authentication. Since most browsers don't yet support Digest authentication you should only use Digest if you can control what browsers will be accessing the resources. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthtype.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $type</parameter> - authentication type to use. Should be Basic os Digest. Defaults to Basic. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthtype.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.note"> &title.note; ¬e.notstatic; </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.see"> &title.see; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file-htaccess.setauthtype.example"> &title.example; <example> <title>Using <function>File_HtAccess::setAuthType</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* use Digest authentication */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setAuthType('Digest'); $fh->save(); ?> ]]> </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/setproperties.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setproperties.xml <refentry id="package.filesystem.file-htaccess.setproperties"> <refnamediv> <refname>File_HtAccess::setProperties()</refname> <refpurpose>set the values of objects properties</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setProperties</function></funcdef> <paramdef> <parameter>array $params</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setproperties.desc"> &title.desc; <para> Set the values of objects properties as defined by hash given as a parameter. You can use this method as an alternative to passing property values in <link linkend="package.filesystem.file-htaccess.file-htaccess">constructor </link>. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setproperties.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>$params['authname']</parameter> - authname </para> </listitem> <listitem> <para> <parameter>$params['authtype']</parameter> - authtype </para> </listitem> <listitem> <para> <parameter>$params['authuserfile']</parameter> - authuserfile </para> </listitem> <listitem> <para> <parameter>$params['authgroupfile']</parameter> - authgroupfile </para> </listitem> <listitem> <para> <parameter>$params['require']</parameter> - require </para> </listitem> <listitem> <para> <parameter>$params['additional']</parameter> - additional </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setproperties.return"> &title.returns; <para> void </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; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.setproperties.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.file-htaccess"> <function>File_HtAccess::file-htaccess</function> </link> </member> </simplelist> </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'); /* let any valid user access the resource */ $fh = new File_HtAccess('.htaccess'); $params['authname'] = 'Private'; $params['authtype'] = 'Basic'; $params['authuserfile'] = '/path/to/.htpasswd'; $params['authgroupfile'] = '/path/to/.htgroup'; $params['require'] = array('group', 'admins'); $fh->setProperties($params); ?> ]]> </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.xml diff -u peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.4 peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.5 --- peardoc/peardoc2/en/package/filesystem/file-htaccess.xml:1.4 Sat Jan 11 15:42:09 2003 +++ peardoc/peardoc2/en/package/filesystem/file-htaccess.xml Mon Jan 13 08:31:48 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <sect1 id="package.filesystem.file-htaccess"> <title>File_HtAccess</title> @@ -10,19 +10,18 @@ &package.filesystem.file-htaccess.file-htaccess; &package.filesystem.file-htaccess.load; &package.filesystem.file-htaccess.save; - <!-- + &package.filesystem.file-htaccess.setrequire; + &package.filesystem.file-htaccess.addrequire; + &package.filesystem.file-htaccess.delrequire; + &package.filesystem.file-htaccess.getrequire; &package.filesystem.file-htaccess.setproperties; - &package.filesystem.file-htaccess.setauthname; - &package.filesystem.file-htaccess.setauthtype; &package.filesystem.file-htaccess.setauthuserfile; &package.filesystem.file-htaccess.setauthgroupfile; - --> + &package.filesystem.file-htaccess.setauthtype; + &package.filesystem.file-htaccess.setauthdigestfile; - &package.filesystem.file-htaccess.setrequire; - &package.filesystem.file-htaccess.addrequire; - &package.filesystem.file-htaccess.delrequire; <!-- - &package.filesystem.file-htaccess.getrequire; + &package.filesystem.file-htaccess.setauthname; &package.filesystem.file-htaccess.setadditional; &package.filesystem.file-htaccess.addadditional; &package.filesystem.file-htaccess.getadditional; Index: peardoc/peardoc2/en/package/filesystem/file-htaccess/getrequire.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/getrequire.xml <refentry id="package.filesystem.file-htaccess.getrequire"> <refnamediv> <refname>File_HtAccess::getRequire()</refname> <refpurpose>get the value(s) of require property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>array <function>File_HtAccess::getRequire</function></funcdef> <paramdef> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.getrequire.desc"> &title.desc; <para> Get the value(s) of require property as an array. Require property contains the usernames or groups users who are allowed to access protected resources. Value valid-user means all users listed in password file are allowed to access. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.getrequire.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $type</parameter> - if 'string' return value will be a string with usernames separated by a space character. Otherwise return value will be an array(). Defaults to an array. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.getrequire.return"> &title.returns; <para> mixed string or array depending on $type parameter. </para> </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.getrequire.note"> &title.note; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.getrequire.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.setrequire"> <function>File_HtAccess::setRequire</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.getrequire.example"> &title.example; <example> <title>Using <function>File_HtAccess::getrequire</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* add user tuupola and viemero to list of users to be granted access */ $fh = new File_HtAccess('.htaccess'); $fh->addRequire('tuupola'); $fh->addRequire('viemero'); $require1 = $fh->getRequire(); $require2 = $fh->getRequire('string'); print_r($require1); /* Array */ /* ( */ /* [0] => tuupola */ /* [1] => viemero */ /* ) */ print_r($require2); /* tuupola viemero */ ?> ]]> </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/setauthdigestfile.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthdigestfile.xml <refentry id="package.filesystem.file-htaccess.setauthdigestfile"> <refnamediv> <refname>File_HtAccess::setAuthDigestFile</refname> <refpurpose>set the value of authdigestfile property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthDigestFile</function></funcdef> <paramdef> <parameter>string <optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.desc"> &title.desc; <para> Sets the value of authdigestfile property. AuthDigestFile is the password file which contains username:realm:password pairs for Digest authentication. You must give full path to the password file in order for it to work. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.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.setauthdigestfile.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.note"> &title.note; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.setauthdigestfile.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.setauthuserfile"> <function>File_HtAccess::setAuthUserFile</function> </link> </member> </simplelist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthdigestfile.example"> &title.example; <example> <title>Using <function>File_HtAccess::setauthdigestfile</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* set the password file to /etc/htdigest */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setauthdigestfile('/etc/htdigest'); $fh->save(); ?> ]]> </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/setauthgroupfile.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthgroupfile.xml <refentry id="package.filesystem.file-htaccess.setauthgroupfile"> <refnamediv> <refname>File_HtAccess::setAuthGroupFile()</refname> <refpurpose>set the value of authgroupfile property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthGroupFile</function></funcdef> <paramdef> <parameter>string <optional>$file</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.desc"> &title.desc; <para> Sets the value of authgroupfile property. AuthGroupFile a file containing names of the groups and usernames belonging to the group. You must give full path to the group file in order for it to work. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $file</parameter> - absolute pathname to the group file. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.note"> &title.note; ¬e.notstatic; </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthgroupfile.see"> &title.see; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file-htaccess.setauthgroupfile.example"> &title.example; <example> <title>Using <function>File_HtAccess::setauthgroupfile</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* set the group file to /etc/htgroup */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setAuthGroupFile('/etc/htgroup'); $fh->save(); ?> ]]> </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/setauthtype.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setauthtype.xml <refentry id="package.filesystem.file-htaccess.setauthtype"> <refnamediv> <refname>File_HtAccess::setAuthType</refname> <refpurpose>set the value of authtype property</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setAuthType</function></funcdef> <paramdef> <parameter>string <optional>$type='Basic'</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setauthtype.desc"> &title.desc; <para> Sets the value of authtype property. Almost allways you will be using Basic authentication. Since most browsers don't yet support Digest authentication you should only use Digest if you can control what browsers will be accessing the resources. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthtype.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $type</parameter> - authentication type to use. Should be Basic os Digest. Defaults to Basic. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setauthtype.return"> &title.returns; <para> void </para> </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.throws"> &title.throws; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.note"> &title.note; ¬e.notstatic; </refsect1> <!-- <refsect1 id="package.filesystem.file.file-htaccess.setauthtype.see"> &title.see; <para> </para> </refsect1> --> <refsect1 id="package.filesystem.file-htaccess.setauthtype.example"> &title.example; <example> <title>Using <function>File_HtAccess::setAuthType</function></title> <programlisting role="php"> <![CDATA[ <?php require_once('File_HtAccess.php'); /* use Digest authentication */ $fh = new File_HtAccess('.htaccess'); $fh->load(); $fh->setAuthType('Digest'); $fh->save(); ?> ]]> </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/setproperties.xml +++ peardoc/peardoc2/en/package/filesystem/file-htaccess/setproperties.xml <refentry id="package.filesystem.file-htaccess.setproperties"> <refnamediv> <refname>File_HtAccess::setProperties()</refname> <refpurpose>set the values of objects properties</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <!-- <funcsynopsisinfo> require_once 'File_HtAccess.php'; </funcsynopsisinfo> --> <funcprototype> <funcdef>void <function>File_HtAccess::setProperties</function></funcdef> <paramdef> <parameter>array $params</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.filesystem.file-htaccess.setproperties.desc"> &title.desc; <para> Set the values of objects properties as defined by hash given as a parameter. You can use this method as an alternative to passing property values in <link linkend="package.filesystem.file-htaccess.file-htaccess">constructor </link>. </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setproperties.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>$params['authname']</parameter> - authname </para> </listitem> <listitem> <para> <parameter>$params['authtype']</parameter> - authtype </para> </listitem> <listitem> <para> <parameter>$params['authuserfile']</parameter> - authuserfile </para> </listitem> <listitem> <para> <parameter>$params['authgroupfile']</parameter> - authgroupfile </para> </listitem> <listitem> <para> <parameter>$params['require']</parameter> - require </para> </listitem> <listitem> <para> <parameter>$params['additional']</parameter> - additional </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.filesystem.file-htaccess.setproperties.return"> &title.returns; <para> void </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; ¬e.notstatic; </refsect1> <refsect1 id="package.filesystem.file.file-htaccess.setproperties.see"> &title.see; <para> <simplelist> <member> <link linkend="package.filesystem.file-htaccess.file-htaccess"> <function>File_HtAccess::file-htaccess</function> </link> </member> </simplelist> </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'); /* let any valid user access the resource */ $fh = new File_HtAccess('.htaccess'); $params['authname'] = 'Private'; $params['authtype'] = 'Basic'; $params['authuserfile'] = '/path/to/.htpasswd'; $params['authgroupfile'] = '/path/to/.htgroup'; $params['require'] = array('group', 'admins'); $fh->setProperties($params); ?> ]]> </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 -->