VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: User

Source Location: /auth.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --User

Basic User class


Class Details

[line 36]
Basic User class

A common base class for user authentication, inherit from it to create new types of authentication




[ Top ]

Properties

Events

    [none]

JS Events

    [none]

Methods

Constants

    [none]

Child classes:

DatabaseUser
DatabaseUser can be used to authenticate an user against a database table

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 Logged : boolean [line 51]

Specifies whether the user is logged or not

[ Top ]


Events



Javascript Events



Methods


constructor __construct [line 40]

User __construct( [ $aowner = null])



Overrides Component::__construct (Constructor)

Parameters:

   $aowner  

[ Top ]

void Authenticate [line 59]

void Authenticate( string $username, string $password)

Authenticate the user inside the system



Overridden in child classes as:

DatabaseUser::Authenticate()
Authenticate an user

Parameters:

string   $username   Name of the user to authenticate
string   $password   Password of the user to authenticate

[ Top ]



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