Class ZAuth

(line 38)

Description

Object
   |
   --Persistent
      |
      --Component
         |
         --ZAuth

Located in File: /Zend/zauth.inc.php

ZAuth provides a component able to authenticate using dispatchers, so changing the dispatcher, allows you to authenticate using different mechanisms.


Properties

Summary:
AuthAdapter Specifies the adapter to be used when authenticating
ErrorMessage The error message to show if the authentication failed
Title
UserName Specifies the user name to be used for authentication purposes
UserPassword Specifies the password to be used for authentication purposes
UserRealm Realm to be used when authenticating

Defined in class Component

Name Specifies the name for the component. The name is used as an identifier and should be unique.
Tag A versatile property of every Component that can be used in any way you want
ComponentCount Indicates the number of components owned by the component.
Components Lists all the components owned by this component.
ControlState A flag to know the state of the control, csLoading, csDesigning
DataFieldValue This property returns the value of the datafield if any.
NamePath Specifies the path to uniquely identify a component, qualified by the owner when required.
Owner Indicates the component that is responsible for streaming and freeing this component.

Defined in class Persistent

NamePath Used to serialize/unserialize. It returns the full path to identify this component.
Owner Owner of the component.

property AuthAdapter (line 96)

ZAuthAdapter AuthAdapter

Specifies the adapter to be used when authenticating

property ErrorMessage (line 73)

string ErrorMessage

The error message to show if the authentication failed

property Title (line 87)

void Title


property UserName (line 64)

string UserName

Specifies the user name to be used for authentication purposes

property UserPassword (line 55)

string UserPassword

Specifies the password to be used for authentication purposes

property UserRealm (line 82)

string UserRealm

Realm to be used when authenticating

property Name

Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name

property Tag

A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag

property ComponentCount

Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount

property Components

Lists all the components owned by this component.
This property is implemented in Component::Components

property ControlState

A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState

property DataFieldValue

This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue

property NamePath

Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath

property Owner

Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner

property NamePath

Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePath

property Owner

Owner of the component.
This property is implemented in Persistent::Owner

Methods

Summary:
Execute Call this method to perform authentication
loaded Initializes the component after the form file has been read into memory. [Overrides Component::loaded()]

Defined in class Component

dumpChildrenJavascript Dumps the javascript code for all the children
dumpFormItems Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
dumpHeaderCode Dumps header code required
dumpJavascript Dumps the javascript code needed by this component
hasValidDataField Returns true if a valid data field is attached to the component
init Initializes a component
loaded Initializes the component after the form file has been read into memory.
loadedChildren Calls childrens loaded
preinit Method called before init()
serializeChildren Serializes all children
unserializeChildren Unserializes all children by calling unserialize for all the components

Defined in class Persistent

serialize Stores this object into the session.
unserialize This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Defined in class Object

__construct Constructs an object and initializes its data before the object is first used.
className Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
classParent Returns the type of the immediate ancestor of a class.

Method Execute (line 110)

void Execute( )

Call this method to perform authentication

Method loaded (line 101)

void loaded( )

Overrides : Component::loaded() Initializes the component after the form file has been read into memory.


Events

Summary:
OnLogin Fired when the user cannot be authenticated, a nice opportunity to show a login dialog.

property OnLogin (line 151)

mixed OnLogin

Fired when the user cannot be authenticated, a nice opportunity to show a login dialog.

Javascript Events

Summary:

[none]

Documentation generated on Fri, 26 Dec 2008 11:46:52 +0100 by phpDocumentor 1.4.0a2