Docs For Class Mage_Admin_Model

Description

Admin user model

author: Magento Core Team <[email protected]>

Located in /Admin/Model/User.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Admin_Model_User

Class Constant Summary

MIN_PASSWORD_LENGTH = 7

XML_PATH_FORGOT_EMAIL_IDENTITY = 'admin/emails/forgot_email_identity'

XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template'

XML_PATH_STARTUP_PAGE = 'admin/startup/page'

Variable Summary

mixed $_eventPrefix

mixed $_hasAvailableResources

Mage_Admin_Model_Roles $_role

Method Summary

void add ()

boolean authenticate (string $username, string $password)

void deleteFromRole ()

string findFirstAvailableMenu ([Mage_Core_Model_Config_Element $parent = null], [string $path = ''], [integer $level = 0])

string getAclRole ()

void getCollection ()

void getId ()

void getName ([ $separator = ' '])

Mage_Admin_Model_Roles getRole ()

void getRoles ()

string getStartupPageUrl ()

string getStatrupPageUrl ()

void hasAssigned2Role ( $user)

bool hasAvailableResources ()

void loadByUsername ( $username)

Mage_Admin_Model_User login ( $username, string $password, string $login)

void reload ()

void roleUserExists ()

Mage_Admin_Model_User saveExtra (array $data)

Mage_Admin_Model_User saveRelations ()

Mage_Admin_Model_User sendNewPasswordEmail ()

void userExists ()

mixed validate ()

Mage_Admin_Model_User _beforeSave ()

void _construct ()

void _getEncodedPassword ( $pwd)

Variables

mixed $_eventPrefix = 'admin_user' (line 41)

access: protected

Redefinition of:

Mage_Core_Model_Abstract::$_eventPrefix: Prefix of model events names

mixed $_hasAvailableResources = true (line 48)

access: protected

Mage_Admin_Model_Roles $_role (line 46)

access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

add (line 156)

access: public

void add ()

authenticate (line 225)

Authenticate user name and password and save loaded record

throws: Mage_Core_Exception
access: public

boolean authenticate (string $username, string $password)

string $username
string $password

deleteFromRole (line 144)

access: public

void deleteFromRole ()

findFirstAvailableMenu (line 309)

Find first menu item that user is able to access

access: public

string findFirstAvailableMenu ([Mage_Core_Model_Config_Element $parent = null], [string $path = ''], [integer $level = 0])

Mage_Core_Model_Config_Element $parent
string $path
integer $level

getAclRole (line 212)

Get user ACL role

access: public

string getAclRole ()

getCollection (line 168)

access: public

void getCollection ()

Redefinition of:

Mage_Core_Model_Abstract::getCollection()

getId (line 202)

access: public

void getId ()

Redefinition of:

Mage_Core_Model_Abstract::getId(): Retrieve model object identifier

getName (line 197)

access: public

void getName ([ $separator = ' '])

$separator

getRole (line 132)

Get admin role model

access: public

Mage_Admin_Model_Roles getRole ()

getRoles (line 122)

access: public

void getRoles ()

getStartupPageUrl (line 356)

Find admin start page url

access: public

string getStartupPageUrl ()

getStatrupPageUrl (line 346)

Find admin start page url

see: Mage_Admin_Model_User::getStartupPageUrl()
deprecated: Please use getStartupPageUrl() method instead
access: public

string getStatrupPageUrl ()

hasAssigned2Role (line 291)

access: public

void hasAssigned2Role ( $user)

$user

hasAvailableResources (line 334)

Check if user has available resources

access: public

bool hasAvailableResources ()

loadByUsername (line 285)

access: public

void loadByUsername ( $username)

$username

login (line 269)

Login user

access: public

Mage_Admin_Model_User login ( $username, string $password, string $login)

string $login
string $password
$username

reload (line 277)

access: public

void reload ()

roleUserExists (line 150)

access: public

void roleUserExists ()

saveExtra (line 102)

Save admin user extra data (like configuration sections state)

access: public

Mage_Admin_Model_User saveExtra (array $data)

array $data

saveRelations (line 116)

Save user roles

access: public

Mage_Admin_Model_User saveRelations ()

sendNewPasswordEmail (line 177)

Send email with new user password

access: public

Mage_Admin_Model_User sendNewPasswordEmail ()

userExists (line 162)

access: public

void userExists ()

validate (line 376)

Validate user attribute values.

Returns TRUE or array of errors.

access: public

mixed validate ()

_beforeSave (line 63)

Processing data before model save

access: protected

Mage_Admin_Model_User _beforeSave ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeSave(): Processing object before save data

_construct (line 53)

Varien constructor

access: protected

void _construct ()

_getEncodedPassword (line 296)

access: protected

void _getEncodedPassword ( $pwd)

$pwd

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Constants

MIN_PASSWORD_LENGTH = 7 (line 39)

XML_PATH_FORGOT_EMAIL_IDENTITY = 'admin/emails/forgot_email_identity' (line 37)

XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template' (line 36)

XML_PATH_STARTUP_PAGE = 'admin/startup/page' (line 38)

Class Mage_Admin_Model_User

Inherited Variables

Inherited Methods