Class: Auth_HTTP

Source Location: /Auth_HTTP-2.0/Auth_HTTP.php

Class Overview

Auth
   |
   --Auth_HTTP

PEAR::Auth_HTTP

Author(s):

Martin Jansen <mailto:mj at php.net>

Version:

$Revision: 1.9 $

Inherited Variables

Inherited Methods

Class Details

[line 42]
PEAR::Auth_HTTP

The PEAR::Auth_HTTP class provides methods for creating an HTTP authentication system using PHP.

Instead of generating an HTML driven form like PEAR::Auth does, this class sends header commands to the clients which cause them to present a login box like they are e.g. used in Apache's .htaccess mechanism.

This class requires the PEAR::Auth package.

Version: $Revision: 1.9 $
Extends: Auth
Author: Martin Jansen <mailto:mj@php.net>

[ Top ]

Class Variables

$CancelText = "Error 401 - Access denied"

[line 63]

Text to send if user hits cancel button

See: Auth_HTTP::drawLogin()
Access: public

Type:

string

[ Top ]

$realm = "protected area"

[line 54]

Name of the realm

See: Auth_HTTP::drawLogin()
Access: public

Type:

string

[ Top ]

Method Detail

assignData [line 75]

void assignData(
)

Assign values from $PHP_AUTH_USER and $PHP_AUTH_PW to internal variables and sets the session id based on them

[ Top ]

drawLogin [line 101]

void drawLogin(
[string
$username = ""])

Launch the login box

Parameters:

string $username — Username

[ Top ]

setCancelText [line 142]

void setCancelText(
string
$text)

Set the text to send if user hits the cancel button

Access: public

Parameters:

string $text — Text to send

[ Top ]

setRealm [line 127]

void setRealm(
string
$name)

Set name of the current realm

Access: public

Parameters:

string $name — Name of the realm

[ Top ]