Class Mage_Api_Model_User

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /Api/Model/User.php (line 27)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Api_Model_User
Method Summary
void add ()
boolean authenticate (string $username, string $apiKey)
void delete ()
void deleteFromRole ()
string getAclRole ()
void getCollection ()
void getId ()
void getName ([ $separator = ' '])
void getRoles ()
void hasAssigned2Role ( $user)
void loadBySessId ( $sessId)
void loadByUsername ( $username)
Mage_Api_Model_User login ( $username, string $apiKey, string $login)
void logoutBySessId ( $sessid)
void reload ()
void roleUserExists ()
void save ()
void saveRelations ()
void userExists ()
void _construct ()
void _getEncodedApiKey ( $apiKey)
Variables
Methods
add (line 101)
  • access: public
void add ()
authenticate (line 144)

Authenticate user name and api key and save loaded record

  • access: public
boolean authenticate (string $username, string $apiKey)
  • string $username
  • string $apiKey
delete (line 70)
  • access: public
void delete ()

Redefinition of:
Mage_Core_Model_Abstract::delete()
Delete object from database
deleteFromRole (line 89)
  • access: public
void deleteFromRole ()
getAclRole (line 132)

Get user ACL role

  • access: public
string getAclRole ()
getCollection (line 113)
  • access: public
void getCollection ()

Redefinition of:
Mage_Core_Model_Abstract::getCollection()
getId (line 122)
  • access: public
void getId ()

Redefinition of:
Mage_Core_Model_Abstract::getId()
Retrieve model object identifier
getName (line 117)
  • access: public
void getName ([ $separator = ' '])
  • $separator
getRoles (line 84)
  • access: public
void getRoles ()
hasAssigned2Role (line 207)
  • access: public
void hasAssigned2Role ( $user)
  • $user
loadBySessId (line 195)
  • access: public
void loadBySessId ( $sessId)
  • $sessId
loadByUsername (line 189)
  • access: public
void loadByUsername ( $username)
  • $username
login (line 166)

Login user

  • access: public
Mage_Api_Model_User login ( $username, string $apiKey, string $login)
  • string $login
  • string $apiKey
  • $username
logoutBySessId (line 201)
  • access: public
void logoutBySessId ( $sessid)
  • $sessid
reload (line 183)
  • access: public
void reload ()
roleUserExists (line 95)
  • access: public
void roleUserExists ()
save (line 34)
  • access: public
void save ()

Redefinition of:
Mage_Core_Model_Abstract::save()
Save object data
saveRelations (line 78)
  • access: public
void saveRelations ()
userExists (line 107)
  • access: public
void userExists ()
_construct (line 29)
  • access: protected
void _construct ()
_getEncodedApiKey (line 212)
  • access: protected
void _getEncodedApiKey ( $apiKey)
  • $apiKey

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()

Documentation generated on Fri, 11 Feb 2011 17:15:36 +0200 by phpDocumentor 1.4.3