EmbientSMF Class Reference

Inheritance diagram for EmbientSMF:

Inheritance graph
[legend]
Collaboration diagram for EmbientSMF:

Collaboration graph
[legend]
List of all members.

Detailed Description

Implementation of Embient plugin class for SMF.

Definition at line 99 of file smf.plugin.php.

Public Member Functions

 EmbientSMF ()
 Class constructor - See embient.plugin.php.
 Init ($cfg)
 SMF implementation of Init() - See embient.plugin.php.
 Login ($username)
 SMF implementation of Login() - See embient.plugin.php.
 Logout ($username)
 SMF implementation of Logout() - See embient.plugin.php.
 Add ($user)
 SMF implementation of Add() - See embient.plugin.php.
 Update ($username, $user)
 SMF implementation of Update() - See embient.plugin.php.
 Delete ($username)
 SMF implementation of Delete() - See embient.plugin.php.

Public Attributes

 $conf
 configurations from Settings.php
 $settings
 Configurations from SMF database.
 $user
 System specific user info that can be directly loaded from or saved to database.
 $name
 Name of this system.

Protected Member Functions

 _Load ($username)
 SMF implementation of _Load() - See embient.plugin.php.
 _ConvertUserInfo ($user, $default=true)
 SMF implementation of _ConvertUserInfo() - See embient.plugin.php.

Protected Attributes

 $_common_fields
 list of Embient user info fields.

Private Member Functions

 _LogAction ($action=NULL)
 Log the current user with online status on SMF.

Constructor & Destructor Documentation

EmbientSMF::EmbientSMF (   ) 
 

Class constructor - See embient.plugin.php.

Definition at line 112 of file smf.plugin.php.

Here is the call graph for this function:

Member Function Documentation

EmbientSMF::_ConvertUserInfo (  $  user,
$  default = true
)  [protected]
 

SMF implementation of _ConvertUserInfo() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 664 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::_Load (  $  username  )  [protected]
 

SMF implementation of _Load() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 624 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::_LogAction (  $  action = NULL  )  [private]
 

Log the current user with online status on SMF.

Parameters:
$action string - action to be displayed on SMF for this user, null for unknown

Definition at line 579 of file smf.plugin.php.

EmbientSMF::Add (  $  user  ) 
 

SMF implementation of Add() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 301 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::Delete (  $  username  ) 
 

SMF implementation of Delete() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 373 of file smf.plugin.php.

EmbientSMF::Init (  $  cfg  ) 
 

SMF implementation of Init() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 130 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::Login (  $  username  ) 
 

SMF implementation of Login() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 205 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::Logout (  $  username  ) 
 

SMF implementation of Logout() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 276 of file smf.plugin.php.

Here is the call graph for this function:

EmbientSMF::Update (  $  username,
$  user
) 
 

SMF implementation of Update() - See embient.plugin.php.

Reimplemented from EmbientPlugin.

Definition at line 327 of file smf.plugin.php.

Here is the call graph for this function:

Member Data Documentation

EmbientPlugin::$_common_fields [protected, inherited]
 

Initial value:

 array
      (
        'name',
        'passwd',
        'mail',
        'firstname',
        'lastname',
        'signature',
        'timezone',
      )
list of Embient user info fields.

This is the list of fileds those are common between system. It represent the information in Embient style and need to map to system specific name using plugin's _ConvertUserInfo methods.

The fields are:

  • name -> user login name
  • passwd -> user loing password
  • mail -> user email
  • firstname -> user's first name
  • lastname -> user's last name
  • signature -> user's signature
  • timezone -> number of seconds from GMT, e.g., 25200 for GMT+7 and -25200 for GMT -7

Definition at line 88 of file embient.plugin.php.

EmbientSMF::$conf
 

configurations from Settings.php

Definition at line 102 of file smf.plugin.php.

EmbientPlugin::$name [inherited]
 

Name of this system.

Definition at line 49 of file embient.plugin.php.

EmbientSMF::$settings
 

Configurations from SMF database.

Definition at line 105 of file smf.plugin.php.

EmbientPlugin::$user [inherited]
 

System specific user info that can be directly loaded from or saved to database.

Definition at line 46 of file embient.plugin.php.

The documentation for this class was generated from the following file:
Generated on Fri Feb 10 15:05:56 2006 for Embient by  doxygen 1.4.6-NO