Reference Manuals

UserMixIn

UserMixIn — An abstract MixIn for a User object

UserMixIn is part of the User package.

Synopsis

class UserMixIn {
        public         User                $user

        public         void                destroy                   ( void );
        public         void                init                      ( User &$user );
        public         void                start                     ( void );
}

Object Hierarchy

UserMixIn
 +----AuthMixIn
 +----PreferencesMixIn

Description

An abstract MixIn for a User object

If you want to extend the User object should subclass this. All public functions and attributes will be directly accessible from the User object. You can also override the start() or destroy() methods to hook into the User object.

Attribute Details

$user

public         User           $user

A reference to the User object.

Method Details

destroy()

public         void           destroy                   ( void );

Executed after a User::destroy() has been called

---

init()

public         void           init                      ( User &$user );

Executed when the User object is created

When you override this function, you should call this manually from within your init() function.

&$user

A reference to the User object for this extension.

---

start()

public         void           start                     ( void );

Executed after a user has been succesfully authenticated and a session has been created.

This is after a User::start() call or after a succesfull User::login() call.