DigestAuthComponent Class Info:
- Class Declaration:
class DigestAuthComponent extends Object
- File name:
- app/controllers/components/digest_auth.php
- Description:
- Class Inheritance
Properties:
-
_authData
-
_authHdr
-
components
-
controller
-
preferedSchema
Prefered schema */
-
realm
-
validSchemas
Supported schemas. Implemented schemas are basic and digest */
Method Summary:
- __addBasicRequestHeader( )
- __addDigestRequestHeader( )
- authenticate( $required = true )
- cakeError( $method, $messages = array ( ) )
- __checkBasicHeader( )
- __checkBasicUser( )
- __checkDigestHeader( )
- __checkDigestUser( )
- __checkSession( )
- __checkUri( )
- __construct( )
- decline( )
- dispatchMethod( $method, $params = array ( ) )
- __fixWindowsUsername( )
- __getAuthHeader( )
- __getAuthSchema( )
- log( $msg, $type = 2 )
- Object( )
- __openPersistent( $name, $type = NULL )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- requestAuthentication( )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- startup( $controller )
- _stop( $status = 0 )
- toString( )
- __writeUserData( $user )
__addBasicRequestHeader
top__addDigestRequestHeader
topAdd authentication header to the response. The session keeps a login counter. If more than 3 logins where done, it denies the access by omitting the authentication header */
- Method defined in:
- app/controllers/components/digest_auth.php on line 73
authenticate
topAuthenticate a user by HTTP Authentication as described in RFC 2617 @param required If true an authentication is required. If the
- Parameters:
-
-
$required optional true
-
- Method defined in:
- app/controllers/components/digest_auth.php on line 319
- Return
True if the authentication was successful. true, the authentication is force and will redirect the request with authentication information. In this case, the function will not return on unsuccessful authentication. */
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__checkDigestHeader
topParse the http authorization header and checks for all required fields.
- Method defined in:
- app/controllers/components/digest_auth.php on line 206
__checkSession
topChecks the session to be active and validates the request counter. If the session is not alive or the request counter was already used, an unauthorized response is thrown
- Method defined in:
- app/controllers/components/digest_auth.php on line 254
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
decline
topDecline the client connection */
- Method defined in:
- app/controllers/components/digest_auth.php on line 105
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
__getAuthHeader
topReturns the authorization header. It tryies to fetch the HTTP authorization header from the apache header, from _SERVER[HTTP_AUTHORIZATION] variable or from _SERVER[PHP_AUTH_DIGEST]. If no header information is available, it returns false @return HTTP authorization header. False if no header was found */
- Method defined in:
- app/controllers/components/digest_auth.php on line 114
- Return
HTTP authorization header. False if no header was found */
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
__openPersistent
topOpen the persistent class file for reading Used by Object::_persist()
- Parameters:
-
-
string $name required
Name of persisted class
-
string $type optional NULL
Type of persistance (e.g: registry)
-
- Method defined in:
- cake/libs/object.php on line 268
- Return
void
- Access
private
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
requestAuthentication
topRequest the client for authentication. The given authentication schema depends on the preferedSchema property */
- Method defined in:
- app/controllers/components/digest_auth.php on line 95
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
startup
top- Parameters:
-
-
$controller required
-
- Method defined in:
- app/controllers/components/digest_auth.php on line 36
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
