Mage_Admin_Model_Mysql4_User Class Reference

Inheritance diagram for Mage_Admin_Model_Mysql4_User:

Detailed Description

Definition at line 34 of file User.php.

Member Function Documentation

_afterLoad ( Mage_Core_Model_Abstract $ object ) [protected]

Perform actions after object load

Parameters:

Varien_Object

$object

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 128 of file User.php.

00129     {
00130         if (is_string($user->getExtra())) {
00131             $user->setExtra(unserialize($user->getExtra()));
00132         }
00133         return parent::_afterLoad($user);
00134     }

_afterSave ( Mage_Core_Model_Abstract $ object ) [protected]

Perform actions after object save

Parameters:

Varien_Object

$object

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 122 of file User.php.

00123     {
00124         $user->setExtra(unserialize($user->getExtra()));
00125         return $this;
00126     }

_beforeSave ( Mage_Core_Model_Abstract $ object ) [protected]

Perform actions before object save

Parameters:

Varien_Object

$object

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 113 of file User.php.

00114     {
00115         if (!$user->getId()) {
00116             $user->setCreated(now());
00117         }
00118         $user->setModified(now());
00119         return $this;
00120     }

_construct ( ) [protected]

Resource initialization

Reimplemented from Mage_Core_Model_Resource_Abstract.

Definition at line 37 of file User.php.

00038     {
00039         $this->_init('admin/user', 'user_id');
00040     }

_initUniqueFields ( ) [protected]

Initialize unique fields

Returns:: Mage_Core_Model_Mysql4_Abstract

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 47 of file User.php.

00048     {
00049         $this->_uniqueFields = array(
00050             array(
00051                 'field' => 'email',
00052                 'title' => Mage::helper('adminhtml')->__('Email')
00053             ),
00054             array(
00055                 'field' => 'username',
00056                 'title' => Mage::helper('adminhtml')->__('User Name')
00057             ),
00058         );
00059         return $this;
00060     }

_saveRelations ( Mage_Core_Model_Abstract $ user )

TODO: unify _saveRelations() and add() methods, they make same things

Definition at line 166 of file User.php.

00167     {
00168         $rolesIds = $user->getRoleIds();
00169 
00170         if( !is_array($rolesIds) || count($rolesIds) == 0 ) {
00171             return $user;
00172         }
00173 
00174         $this->_getWriteAdapter()->beginTransaction();
00175 
00176         try {
00177             $this->_getWriteAdapter()->delete($this->getTable('admin/role'), "user_id = {$user->getId()}");
00178             foreach ($rolesIds as $rid) {
00179                 $rid = intval($rid);
00180                 if ($rid > 0) {
00181                     $row = Mage::getModel('admin/role')->load($rid)->getData();
00182                 } else {
00183                     $row = array('tree_level' => 0);
00184                 }
00185 
00186                 $data = array(
00187                     'parent_id'     => $rid,
00188                     'tree_level'    => $row['tree_level'] + 1,
00189                     'sort_order'    => 0,
00190                     'role_type'     => 'U',
00191                     'user_id'       => $user->getId(),
00192                     'role_name'     => $user->getFirstname()
00193                 );
00194                 $this->_getWriteAdapter()->insert($this->getTable('admin/role'), $data);
00195             }
00196             $this->_getWriteAdapter()->commit();
00197         } catch (Mage_Core_Exception $e) {
00198             throw $e;
00199         } catch (Exception $e){
00200             $this->_getWriteAdapter()->rollBack();
00201         }
00202     }

add ( Mage_Core_Model_Abstract $ user )

Definition at line 218 of file User.php.

00219     {
00220         $dbh = $this->_getWriteAdapter();
00221 
00222         $aRoles = $this->hasAssigned2Role($user);
00223         if ( sizeof($aRoles) > 0 ) {
00224             foreach($aRoles as $idx => $data){
00225                 $dbh->delete($this->getTable('admin/role'), "role_id = {$data['role_id']}");
00226             }
00227         }
00228 
00229         if ($user->getId() > 0) {
00230             $role = Mage::getModel('admin/role')->load($user->getRoleId());
00231         } else {
00232             $role = new Varien_Object();
00233             $role->setTreeLevel(0);
00234         }
00235         $dbh->insert($this->getTable('admin/role'), array(
00236             'parent_id' => $user->getRoleId(),
00237             'tree_level'=> ($role->getTreeLevel() + 1),
00238             'sort_order'=> 0,
00239             'role_type' => 'U',
00240             'user_id'   => $user->getUserId(),
00241             'role_name' => $user->getFirstname()
00242         ));
00243 
00244         return $this;
00245     }

delete ( Mage_Core_Model_Abstract $ object )

Delete the object

Parameters:

Varien_Object

$object

Returns:: Mage_Core_Model_Mysql4_Abstract

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 144 of file User.php.

00145     {
00146         $dbh = $this->_getWriteAdapter();
00147         $uid = $user->getId();
00148         $dbh->beginTransaction();
00149         try {
00150             $dbh->delete($this->getTable('admin/user'), "user_id=$uid");
00151             $dbh->delete($this->getTable('admin/role'), "user_id=$uid");
00152         } catch (Mage_Core_Exception $e) {
00153             throw $e;
00154             return false;
00155         } catch (Exception $e){
00156             $dbh->rollBack();
00157             return false;
00158         }
00159         $dbh->commit();
00160         return true;
00161     }

deleteFromRole ( Mage_Core_Model_Abstract $ user )

Definition at line 247 of file User.php.

00248     {
00249         if ( $user->getUserId() <= 0 ) {
00250             return $this;
00251         }
00252         if ( $user->getRoleId() <= 0 ) {
00253             return $this;
00254         }
00255         $dbh = $this->_getWriteAdapter();
00256         $condition = "`{$this->getTable('admin/role')}`.user_id = ".$dbh->quote($user->getUserId())." AND `{$this->getTable('admin/role')}`.parent_id = ".$dbh->quote($user->getRoleId());
00257         $dbh->delete($this->getTable('admin/role'), $condition);
00258         return $this;
00259     }

getRoles ( Mage_Core_Model_Abstract $ user )

Definition at line 204 of file User.php.

00205     {
00206         if ( !$user->getId() ) {
00207             return array();
00208         }
00209         $table  = $this->getTable('admin/role');
00210         $read   = $this->_getReadAdapter();
00211         $select = $read->select()->from($table, array())
00212                     ->joinLeft(array('ar' => $table), "(ar.role_id = `{$table}`.parent_id and ar.role_type = 'G')", array('role_id'))
00213                     ->where("`{$table}`.user_id = {$user->getId()}");
00214 
00215         return (($roles = $read->fetchCol($select)) ? $roles : array());
00216     }

hasAssigned2Role ( $ user )

Definition at line 87 of file User.php.

00088     {
00089         if (is_numeric($user)) {
00090             $userId = $user;
00091         } else if ($user instanceof Mage_Core_Model_Abstract) {
00092             $userId = $user->getUserId();
00093         } else {
00094             return null;
00095         }
00096 
00097         if ( $userId > 0 ) {
00098             $dbh = $this->_getReadAdapter();
00099             $select = $dbh->select();
00100             $select->from($this->getTable('admin/role'))
00101                 ->where("parent_id > 0 AND user_id = {$userId}");
00102             return $dbh->fetchAll($select);
00103         } else {
00104             return null;
00105         }
00106     }

load	(	Mage_Core_Model_Abstract $	object,
		$	value,
		$	field = `null`
	)

Load an object

Parameters:

	Mage_Core_Model_Abstract	$object
	mixed	$value
	string	$field field to load by (defaults to model id)

Returns:: Mage_Core_Model_Mysql4_Abstract

Reimplemented from Mage_Core_Model_Mysql4_Abstract.

Definition at line 136 of file User.php.

00137     {
00138 //        if (!intval($value) && is_string($value)) {
00139 //            $field = 'user_id';
00140 //        }
00141         return parent::load($user, $value, $field);
00142     }

loadByUsername ( $ username )

Definition at line 80 of file User.php.

00081     {
00082         $select = $this->_getReadAdapter()->select()->from($this->getTable('admin/user'))
00083             ->where('username=:username');
00084         return $this->_getReadAdapter()->fetchRow($select, array('username'=>$username));
00085     }

recordLogin ( Mage_Admin_Model_User $ user )

Authenticate user by $username and $password

Parameters:

	string	$username
	string	$password

Returns:: boolean|Object

Definition at line 69 of file User.php.

00070     {
00071         $data = array(
00072             'logdate' => now(),
00073             'lognum'  => $user->getLognum()+1
00074         );
00075         $condition = $this->_getWriteAdapter()->quoteInto('user_id=?', $user->getUserId());
00076         $this->_getWriteAdapter()->update($this->getTable('admin/user'), $data, $condition);
00077         return $this;
00078     }

roleUserExists ( Mage_Core_Model_Abstract $ user )

Definition at line 261 of file User.php.

00262     {
00263         if ( $user->getUserId() > 0 ) {
00264             $roleTable = $this->getTable('admin/role');
00265             $dbh    = $this->_getReadAdapter();
00266             $select = $dbh->select()->from($roleTable)
00267                 ->where("parent_id = {$user->getRoleId()} AND user_id = {$user->getUserId()}");
00268             return $dbh->fetchCol($select);
00269         } else {
00270             return array();
00271         }
00272     }

saveExtra	(	$	object,
		$	data
	)

Definition at line 283 of file User.php.

00284     {
00285         if ($object->getId()) {
00286             $this->_getWriteAdapter()->update($this->getMainTable(), array('extra'=>$data));
00287         }
00288         return $this;
00289     }

userExists ( Mage_Core_Model_Abstract $ user )

Definition at line 274 of file User.php.

00275     {
00276         $usersTable = $this->getTable('admin/user');
00277         $select = $this->_getReadAdapter()->select();
00278         $select->from($usersTable);
00279         $select->where("({$usersTable}.username = '{$user->getUsername()}' OR {$usersTable}.email = '{$user->getEmail()}') AND {$usersTable}.user_id != '{$user->getId()}'");
00280         return $this->_getReadAdapter()->fetchRow($select);
00281     }

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

app/code/core/Mage/Admin/Model/Mysql4/User.php


Public Member Functions
	recordLogin (Mage_Admin_Model_User $user)
	loadByUsername ($username)
	hasAssigned2Role ($user)
	load (Mage_Core_Model_Abstract $user, $value, $field=null)
	delete (Mage_Core_Model_Abstract $user)
	_saveRelations (Mage_Core_Model_Abstract $user)
	getRoles (Mage_Core_Model_Abstract $user)
	add (Mage_Core_Model_Abstract $user)
	deleteFromRole (Mage_Core_Model_Abstract $user)
	roleUserExists (Mage_Core_Model_Abstract $user)
	userExists (Mage_Core_Model_Abstract $user)
	saveExtra ($object, $data)
Protected Member Functions
	_construct ()
	_initUniqueFields ()
	_beforeSave (Mage_Core_Model_Abstract $user)
	_afterSave (Mage_Core_Model_Abstract $user)
	_afterLoad (Mage_Core_Model_Abstract $user)

Mage_Admin_Model_Mysql4_User Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation