previousFile_HtAccess::setProperties() (Previous) (Next) File_HtAccess::setAuthGroupFile()next

View this page in Last updated: Sun, 18 Oct 2009
English | Brazilian Portuguese | Chinese | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Turkish

File_HtAccess::setAuthUserFile()

File_HtAccess::setAuthUserFile() – set the value of authuserfile property

Synopsis

void File_HtAccess::setAuthUserFile ( string $file )

Description

Sets the value of authuserfile property. AuthUserFile is the password file which contains username:password pairs for Basic authentication. You must give full path to the password file in order for it to work.

Parameter

  • string $file - absolute pathname to the password file.

Return value

void

Note

This function can not be called statically.

Example

Using File_HtAccess::setAuthUserFile()

<?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();

?>
previousFile_HtAccess::setProperties() (Previous) (Next) File_HtAccess::setAuthGroupFile()next

Download Documentation Last updated: Sun, 18 Oct 2009
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.