Class: Base_UserCommon

Source Location: /modules/Base/User/UserCommon_0.php

Class Base_UserCommon

Class Overview

User class.

The functions of this class facilitate user management.

Located in /modules/Base/User/UserCommon_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_UserCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2008, Telaxus LLC
License:	MIT

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static bool	add_user()	Adds user to the database and adds to User group (normal, regular user).
static void	change_active_state()	Changes state of user (active or inactive).
static void	get_my_user_login()
static integer	get_user_id()	Returns user id.
static string	get_user_login()	Returns user username.

[ Top ]

Methods

static method add_user [line 33]

static bool add_user(
string
$username 
)

Adds user to the database and adds to User group (normal, regular user).

Parameters:

string

$username:

username

API Tags:

Return:	true on success, false otherwise
Access:	public

[ Top ]

static method change_active_state [line 23]

static void change_active_state(
integer
$uid, bool
$active 
)

Changes state of user (active or inactive).

Parameters:

integer	$uid:	user id
bool	$active:	is active?

API Tags:

Access:

public

[ Top ]

static method get_my_user_login [line 66]

static void get_my_user_login(
)

API Tags:

Access:

public

[ Top ]

static method get_user_id [line 52]

static integer get_user_id(
string
$username 
)

Returns user id.

Parameters:

string

$username:

username

API Tags:

Return:	user id
Access:	public

[ Top ]

static method get_user_login [line 62]

static string get_user_login(
integer
$id 
)

Returns user username.

Parameters:

integer

$id:

user id

API Tags:

Return:	username
Access:	public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:47:25 -0500 by phpDocumentor 1.4.2

	epesi-base user

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]