Class Mage_Admin_Model_User

Admin user model

Varien_Object

Mage_Admin_Model_User

Package: Mage\Admin
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Admin/Model/User.php

Methods summary
`protected`	# `_construct( )` Initialize user model Initialize user model
`protected Mage_Admin_Model_User`	# `_beforeSave( )` Processing data before model save Processing data before model save Returns `Mage_Admin_Model_User` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public Mage_Admin_Model_User`	# `saveExtra( array $data )` Save admin user extra data (like configuration sections state) Save admin user extra data (like configuration sections state) Parameters `$data` `array` $data Returns `Mage_Admin_Model_User`
`public Mage_Admin_Model_User`	# `saveRelations( )` Save user roles Save user roles Returns `Mage_Admin_Model_User`
`public array`	# `getRoles( )` Retrieve user roles Retrieve user roles Returns `array`
`public Mage_Admin_Model_Roles`	# `getRole( )` Get admin role model Get admin role model Returns `Mage_Admin_Model_Roles`
`public Mage_Admin_Model_User`	# `deleteFromRole( )` Unassign user from his current role Unassign user from his current role Returns `Mage_Admin_Model_User`
`public boolean`	# `roleUserExists( )` Check if such combination role/user exists Check if such combination role/user exists Returns `boolean`
`public Mage_Admin_Model_User`	# `add( )` Assign user to role Assign user to role Returns `Mage_Admin_Model_User`
`public boolean`	# `userExists( )` Check if user exists based on its id, username and email Check if user exists based on its id, username and email Returns `boolean`
`public Mage_Admin_Model_Resource_User_Collection`	# `getCollection( )` Retrieve admin user collection Retrieve admin user collection Returns `Mage_Admin_Model_Resource_User_Collection` Overrides `Mage_Core_Model_Abstract::getCollection()`
`public Mage_Admin_Model_User`	# `sendPasswordResetConfirmationEmail( )` Send email with reset password confirmation link Send email with reset password confirmation link Returns `Mage_Admin_Model_User`
`public string`	# `getName( string $separator = ' ' )` Retrieve user name Retrieve user name Parameters `$separator` `string` $separator Returns `string`
`public mixed`	# `getId( )` Retrieve user identifier Retrieve user identifier Returns `mixed` Overrides `Mage_Core_Model_Abstract::getId()`
`public string`	# `getAclRole( )` Get user ACL role Get user ACL role Returns `string`
`public boolean`	# `authenticate( string $username, string $password )` Authenticate user name and password and save loaded record Authenticate user name and password and save loaded record Parameters `$username` `string` $username `$password` `string` $password Returns `boolean` Throws `Mage_Core_Exception`
`public Mage_Admin_Model_User`	# `login( string $username, string $password )` Login user Login user Parameters `$username` `string` $login `$password` `string` $password Returns `Mage_Admin_Model_User`
`public Mage_Admin_Model_User`	# `reload( )` Reload current user Reload current user Returns `Mage_Admin_Model_User`
`public Mage_Admin_Model_User`	# `loadByUsername( string $username )` Load user by its username Load user by its username Parameters `$username` `string` $username Returns `Mage_Admin_Model_User`
`public null\|boolean\|array`	# `hasAssigned2Role( integer\|Mage_Core_Admin_Model_User $user )` Check if user is assigned to any role Check if user is assigned to any role Parameters `$user` `integer\|Mage_Core_Admin_Model_User` $user Returns `null\|boolean\|array`
`protected string`	# `_getEncodedPassword( string $password )` Retrieve encoded password Retrieve encoded password Parameters `$password` `string` $password Returns `string`
`public string`	# `findFirstAvailableMenu( Mage_Core_Model_Config_Element $parent = null, string $path = '', integer $level = 0 )` Find first menu item that user is able to access Find first menu item that user is able to access Parameters `$parent` `Mage_Core_Model_Config_Element` $parent `$path` `string` $path `$level` `integer` $level Returns `string`
`public boolean`	# `hasAvailableResources( )` Check if user has available resources Check if user has available resources Returns `boolean`
`public string`	# `getStartupPageUrl( )` Find admin start page url Find admin start page url Returns `string`
`public mixed`	# `validate( )` Validate user attribute values. Returns TRUE or array of errors. Validate user attribute values. Returns TRUE or array of errors. Returns `mixed`
`public Mage_Admin_Model_User`	# `changeResetPasswordLinkToken( string $newResetPasswordLinkToken )` Change reset password link token Change reset password link token Stores new reset password link token and its creation time Parameters `$newResetPasswordLinkToken` `string` $newResetPasswordLinkToken Returns `Mage_Admin_Model_User` Throws `Mage_Core_Exception`
`public boolean`	# `isResetPasswordLinkTokenExpired( )` Check if current reset password link token is expired Check if current reset password link token is expired Returns `boolean`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getEntityId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`string`	`XML_PATH_FORGOT_EMAIL_TEMPLATE`	`'admin/emails/forgot_email_template'`	# Configuration paths for email templates and identities Configuration paths for email templates and identities
`string`	`XML_PATH_FORGOT_EMAIL_IDENTITY`	`'admin/emails/forgot_email_identity'`	#
`string`	`XML_PATH_STARTUP_PAGE`	`'admin/startup/page'`	#
`integer`	`MIN_PASSWORD_LENGTH`	`7`	# Minimum length of admin password Minimum length of admin password

Properties summary
`protected string`	`$_eventPrefix`	`'admin_user'`	# Model event prefix Model event prefix
`protected Mage_Admin_Model_Roles`	`$_role`		# Admin role Admin role
`protected boolean`	`$_hasAvailableResources`	`true`	# Available resources flag Available resources flag

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Class Mage_Admin_Model_User

Returns

Overrides

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Overrides

Returns

Parameters

Returns

Returns

Overrides

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Returns