Class: BasicAuthentication

Source Location: /auth.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --BasicAuthentication

Performs authentication using basic HTTP

Class Details

[line 203]
Performs authentication using basic HTTP

This component is useful to easily protect web pages just by dropping a component. For basic usage, just set UserName and Password to the valid value to log in and call the Execute() method in the OnBeforeShow event of your page.

For more advance usage, @see OnAuthenticate it allows you to authenticate using your own rules.

[ Top ]

Properties ErrorMessage [published] Password [published] Title [published] Username [published]	Events OnAuthenticate [published]	JS Events [none]
Methods Execute	Constants [none]

Inherited Properties Class: Component Component::ComponentCount Indicates how many components this component is owner Component::Components Component list containing all the components owned by this component Component::ControlState A flag to know the state of the control, csLoading, csDesigning Component::DataFieldValue This function returns the value of the datafield, if any Component::Name Name for the component, to be used as an identifier, should be unique Component::NamePath The path to uniquely identify a component, qualified by the owner when required Component::Owner The owner of this component, usually the page component, but the owner of pages is the application object Component::Tag A versatily property of every Component that can be used in any way you want Class: Persistent Persistent::NamePath Used to serialize/unserialize Persistent::Owner Owner of the component, in Persistent always return null	Inherited Events	Inherited JS Events
Inherited Methods Class: Component Component::__construct Constructor Component::ajaxCall Returns the js event attribute to call the server using ajax Component::callEvent Calls a server event Component::dumpChildrenHeaderCode Dump the header code for all the children Component::dumpChildrenJavascript Dump the javascript code for all the children Component::dumpHeaderCode To dump header code required Component::dumpHiddenKeyFields This function dumps out the key fields for the current row, useful to Component::dumpJavascript To dump the javascript code needed by this component Component::fixupProperty This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference Component::generateAjaxEvent Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff. Component::hasValidDataField This function returns true if the datafield is valid Component::init To initialize a component, the right place to process events Component::insertComponent Insert a component into the components collection Component::loaded A virtual method to get notified when the object has been fully loaded from a stream Component::loadedChildren Calls childrens loaded recursively Component::loadResource Load this component from a string Component::preinit To initialize a component, called before init() Component::readAccessibility Overwrite this method to provide accessibility info for the RPC engine Component::readFromResource Read a component from a resource file Component::removeComponent Remove a component from the components collection Component::serializeChildren Serialize all children Component::unserializeChildren Unserialize all children Component::updateDataField Checks if there is any datafield attached to the component Class: Persistent Persistent::assign Assing the source properties to this object Persistent::assignError Raises an assignation error Persistent::assignTo Assign this object to another object Persistent::serialize Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored. Persistent::unserialize Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized. Class: Object Object::__construct Constructor Object::className Returns the name of the object class Object::classNameIs Check if the object is from a specific class Object::classParent Returns the parent class of the object Object::inheritsFrom Check if the object inherits from a specific class Object::methodExists Check if a method exists Object::readProperty Reads a property from the streams Object::__get To virtualize properties Object::__set To virtualize properties

Properties

property ErrorMessage : string [line 233]

Error message to show when the user is not authenticated

[ Top ]

property Password : string [line 216]

Password to request

[ Top ]

property Title : string [line 241]

Title of the authentication dialog to show the user

[ Top ]

property Username : string [line 225]

Username to request

[ Top ]

Events

property OnAuthenticate [line 258]

It's fired when the component needs to authenticate the user by code.

In $params['username'] you will get the username entered by the user In $params['password'] you will get the password entered by the user

Return true if the user should get authenticated, false otherwise

[ Top ]

Javascript Events

Methods

void Execute [line 269]

void Execute(
)

Executes the authentication and checks if the user has been authenticated or not

If the user is not authenticated, requests again the username/password If the event OnAuthenticate is assigned, valid username/password will be provided by code if not, properties Username/Password will be used to authenticate

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:33:14 +0200 by phpDocumentor 1.3.1

Class: BasicAuthentication

Class Overview

Class Details

Properties

Events

JS Events

Methods

Constants

Inherited Properties

Class: Component

Class: Persistent

Inherited Events

Inherited JS Events

Inherited Methods

Class: Component

Class: Persistent

Class: Object

Properties

property ErrorMessage : string [line 233]

property Password : string [line 216]

property Title : string [line 241]

property Username : string [line 225]

Events

property OnAuthenticate [line 258]

Javascript Events

Methods

void Execute [line 269]