Mage_Api_Model_User Class Reference

Inheritance diagram for Mage_Api_Model_User:

List of all members.

Public Member Functions
	save ()
	delete ()
	saveRelations ()
	getRoles ()
	deleteFromRole ()
	roleUserExists ()
	add ()
	userExists ()
	getCollection ()
	getName ($separator=' ')
	getId ()
	getAclRole ()
	authenticate ($username, $apiKey)
	login ($username, $apiKey)
	reload ()
	loadByUsername ($username)
	loadBySessId ($sessId)
	logoutBySessId ($sessid)
	hasAssigned2Role ($user)
Protected Member Functions
	_construct ()
	_getEncodedApiKey ($apiKey)

---

Detailed Description

Definition at line 27 of file User.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 29 of file User.php.

    {
        $this->_init('api/user');
    }

_getEncodedApiKey

(

$

apiKey

)

[protected]

Definition at line 210 of file User.php.

    {
        return Mage::helper('core')->getHash($apiKey, 2);
    }

add

(

)

Definition at line 99 of file User.php.

    {
        $this->_getResource()->add($this);
        return $this;
    }

authenticate	(	$	username,
		$	apiKey
	)

Authenticate user name and api key and save loaded record

Parameters:

	string	$username
	string	$apiKey

Returns:

boolean

Definition at line 142 of file User.php.

    {
        $this->loadByUsername($username);
        if (!$this->getId()) {
            return false;
        }
        $auth = Mage::helper('core')->validateHash($apiKey, $this->getApiKey());
        if ($auth) {
            return true;
        } else {
            $this->unsetData();
            return false;
        }
    }

delete

(

)

Delete object from database

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 70 of file User.php.

    {
        $this->_getResource()->delete($this);
        return $this;
    }

deleteFromRole

(

)

Definition at line 87 of file User.php.

    {
        $this->_getResource()->deleteFromRole($this);
        return $this;
    }

getAclRole

(

)

Get user ACL role

Returns:

string

Definition at line 130 of file User.php.

    {
        return 'U'.$this->getUserId();
    }

getCollection

(

)

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 111 of file User.php.

                                    {
        return Mage::getResourceModel('admin/user_collection');
    }

getId

(

)

Retrieve model object identifier

Returns:

mixed

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 120 of file User.php.

    {
        return $this->getUserId();
    }

getName

(

$

separator = ' '

)

Definition at line 115 of file User.php.

    {
        return $this->getFirstname().$separator.$this->getLastname();
    }

getRoles

(

)

Definition at line 82 of file User.php.

    {
        return $this->_getResource()->_getRoles($this);
    }

hasAssigned2Role

(

$

user

)

Definition at line 205 of file User.php.

    {
        return $this->getResource()->hasAssigned2Role($user);
    }

loadBySessId

(

$

sessId

)

Definition at line 193 of file User.php.

    {
        $this->setData($this->getResource()->loadBySessId($sessId));
        return $this;
    }

loadByUsername

(

$

username

)

Definition at line 187 of file User.php.

    {
        $this->setData($this->getResource()->loadByUsername($username));
        return $this;
    }

login	(	$	username,
		$	apiKey
	)

Login user

Parameters:

	string	$login
	string	$apiKey

Returns:

Mage_Api_Model_User

Definition at line 164 of file User.php.

    {
        $sessId = $this->getSessid();
        if ($this->authenticate($username, $apiKey)) {
            $this->setSessid($sessId);
            $this->getResource()->cleanOldSessions($this)
                ->recordLogin($this)
                ->recordSession($this);
            Mage::dispatchEvent('api_user_authenticated', array(
               'model'    => $this,
               'api_key'  => $apiKey,
            ));
        }

        return $this;
    }

logoutBySessId

(

$

sessid

)

Definition at line 199 of file User.php.

    {
        $this->getResource()->clearBySessId($sessid);
        return $this;
    }

reload

(

)

Definition at line 181 of file User.php.

    {
        $this->load($this->getId());
        return $this;
    }

roleUserExists

(

)

Definition at line 93 of file User.php.

    {
        $result = $this->_getResource()->roleUserExists($this);
        return ( is_array($result) && count($result) > 0 ) ? true : false;
    }

save

(

)

Save object data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 34 of file User.php.

    {
        $this->_beforeSave();
        $data = array(
                'firstname' => $this->getFirstname(),
                'lastname'  => $this->getLastname(),
                'email'     => $this->getEmail(),
                'modified'  => Mage::getSingleton('core/date')->gmtDate()
            );

        if($this->getId() > 0) {
            $data['user_id']   = $this->getId();
        }

        if( $this->getUsername() ) {
            $data['username']   = $this->getUsername();
        }

        if ($this->getApiKey()) {
            $data['api_key']   = $this->_getEncodedApiKey($this->getApiKey());
        }

        if ($this->getNewApiKey()) {
            $data['api_key']   = $this->_getEncodedApiKey($this->getNewApiKey());
        }

        if ( !is_null($this->getIsActive()) ) {
            $data['is_active']  = intval($this->getIsActive());
        }

        $this->setData($data);
        $this->_getResource()->save($this);
        $this->_afterSave();
        return $this;
    }

saveRelations

(

)

Definition at line 76 of file User.php.

    {
        $this->_getResource()->_saveRelations($this);
        return $this;
    }

userExists

(

)

Definition at line 105 of file User.php.

    {
        $result = $this->_getResource()->userExists($this);
        return ( is_array($result) && count($result) > 0 ) ? true : false;
    }

---

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

• app/code/core/Mage/Api/Model/User.php