UserManager Class Reference

Provides the interface to the user model for the application. More...

Public Member Functions
	UserManager ()
	Creates a new UserManager object. More...
	getUsernameField ()
	Returns the field name of the username in the user model. More...
	getEmailField ()
	Returns the field name of the email field in the user model. More...
	getUserClass ()
	Returns the datamodel class name of the user model. More...
	getUser ($user_id)
	Retrieves the user with the specified id. More...
	getActiveClause ()
	Return a clause that constrains records on those that are active. More...
	isActive ($user)
	Determine if the specified user account is active. More...
	getUserByName ($username)
	getUserByEmail ($email)
	getUserFullName ($user)
	Return the user's full name. More...
	validatePassword ($username, $password)
	Validates the user's username and password, returning the matching user. More...
	loadDefaultSession ($user)
	Load any supporting information into the user's session after a valid login. More...
	loginRedirect ($user)
	Redirect the user after a valid login. More...
	getLoginRedirect ($user)
	Redirect the user after a valid login. More...
	getPasswordResetPage ()
	Returns the identifier of the password reset page. More...
	getPasswordHelpText ()
	getPasswordHelpUserNameLabel ()

Static Public Member Functions
static	deleteRole ($del_role)
static	onInitialize ()
static	upgradeComponent ($version)

Detailed Description

Provides the interface to the user model for the application.

This implementation uses the default user model as shipped with Fakoli/CMS. If you need to use a different user model you can simply implement your own 'user' component and include it in your application web root to override this one. In that case you must supply a UserManager class that conforms to the interface below.

Author

andy

Definition at line 49 of file user_manager.inc.

Member Function Documentation

deleteRole()

static UserManager::deleteRole (   $del_role )

static

Definition at line 223 of file user_manager.inc.

     {
          $constraint = "WHERE role like '%$del_role%'";
          
          $mgr = new UserManager();
          $class = $mgr->getUserClass();
          $users = Query::create($class, $constraint)->execute();
          
          RoleManager::deleteRoleFromString($users, $del_role);
          
          return $del_role;
     }         

getActiveClause()

UserManager::getActiveClause

(

)

Return a clause that constrains records on those that are active.

Returns

string

Definition at line 101 of file user_manager.inc.

     {
          return "active=true";
     }

getEmailField()

UserManager::getEmailField

(

)

Returns the field name of the email field in the user model.

Returns

string

Definition at line 71 of file user_manager.inc.

     {
          return "email";
     }

getLoginRedirect()

UserManager::getLoginRedirect

(

$user

)

Redirect the user after a valid login.

Parameters

$user

the user object

Definition at line 188 of file user_manager.inc.

     {
          global $isAdmin;
          global $_SESSION;
     
          $page = $_SESSION["login_redirect"];
          unset($_SESSION["login_redirect"]);
     
          if (!$page || startsWith($page, "components/login"))
          {
               $page = ($isAdmin) ? "/admin/index" : SiteRole::getHomePage($user);
          }
     
          return $page;
     }

getPasswordHelpText()

UserManager::getPasswordHelpText

(

)

Definition at line 213 of file user_manager.inc.

     {
          return "If you have an account on this system, please enter your user name or your user email address and we will email a temporary password to you.";
     }

getPasswordHelpUserNameLabel()

UserManager::getPasswordHelpUserNameLabel

(

)

Definition at line 218 of file user_manager.inc.

     {
          return "User name or email";  
     }

getPasswordResetPage()

UserManager::getPasswordResetPage

(

)

Returns the identifier of the password reset page.

Returns

string the identifier of the password reset page.

Definition at line 208 of file user_manager.inc.

     {
          return "/password_reset";
     }

getUser()

UserManager::getUser

(

$user_id

)

Retrieves the user with the specified id.

Parameters

$user_id

the primary key identifying the user

Returns

object

Definition at line 90 of file user_manager.inc.

     {
          return new SiteUser($user_id);
     }

getUserByEmail()

UserManager::getUserByEmail

(

$email

)

Definition at line 127 of file user_manager.inc.

     {
          $emailField = $this->getEmailField();
          
          $matches = Query::create(SiteUser, "WHERE $emailField=:email")
                    ->bind(":email", $email)
                    ->execute();
          
          return (count($matches) > 0) ? $matches[0] : null;
     }

getUserByName()

UserManager::getUserByName

(

$username

)

Definition at line 115 of file user_manager.inc.

     {
          $usernameField = $this->getUsernameField();
          
          $matches = Query::create(SiteUser, "WHERE $usernameField=:username")
                    ->bind(":username", $username)
                    ->execute();
          
          return (count($matches) > 0) ? $matches[0] : null;
     }

getUserClass()

UserManager::getUserClass

(

)

Returns the datamodel class name of the user model.

Returns

string

Definition at line 80 of file user_manager.inc.

     {
          return SiteUser;
     }

getUserFullName()

UserManager::getUserFullName

(

$user

)

Return the user's full name.

Parameters

string

$user

the user object to be queried

Definition at line 142 of file user_manager.inc.

     {
          return $user->getFullName();
     }

getUsernameField()

UserManager::getUsernameField

(

)

Returns the field name of the username in the user model.

Returns

string

Definition at line 62 of file user_manager.inc.

     {
          return "username";
     }

isActive()

UserManager::isActive

(

$user

)

Determine if the specified user account is active.

Parameters

SiteUser

$user

Definition at line 110 of file user_manager.inc.

     {
          return $user->active;
     }

loadDefaultSession()

UserManager::loadDefaultSession

(

$user

)

Load any supporting information into the user's session after a valid login.

Parameters

$user

the user object

Definition at line 171 of file user_manager.inc.

     {
     }

loginRedirect()

UserManager::loginRedirect

(

$user

)

Redirect the user after a valid login.

Parameters

$user

the user object

Definition at line 179 of file user_manager.inc.

     {
          $page = $this->getLoginRedirect($user);
          redirect($page);
     }

onInitialize()

static UserManager::onInitialize ( )

static

Definition at line 236 of file user_manager.inc.

     {
          global $user;
          if ($user)
          {
               MenuManager::setDisplayFlag('logged_in', true);
          }
          else
          {
               MenuManager::setDisplayFlag('logged_in', false);
          }
     }

upgradeComponent()

static UserManager::upgradeComponent (   $version )

static

Definition at line 249 of file user_manager.inc.

     {
          $mgr = new UserUpgradeManager();
          $mgr->upgrade($version);
     }    

UserManager()

UserManager::UserManager

(

)

Creates a new UserManager object.

Definition at line 54 of file user_manager.inc.

     {
     }

validatePassword()

UserManager::validatePassword	(		$username,
			$password
	)

Validates the user's username and password, returning the matching user.

Parameters

$username	the user's username
$password	the supplied password

Returns

object the matching user if password is valid, null otherwise

Definition at line 153 of file user_manager.inc.

     {
          $user = querySingle(SiteUser, "WHERE username='{$username}' and active=1");
               
          if ($user && crypt($_POST["password"], $user->password) === $user->password)
          {
               return $user;
          }
          else
          {
               return null;
          }
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/user/user_manager.inc