eZPublishCommunityProject  2012.12
eZ\Publish\Core\Persistence\Legacy\User\Gateway Class Reference

Base class for user gateways. More...

+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\User\Gateway:

Public Member Functions

 assignRole ($contentId, $roleId, array $limitation)
 Assigns role to user with given limitation. More...
 
 createUser (User $user)
 Create user. More...
 
 deleteUser ($userId)
 Delete user with the given ID. More...
 
 load ($userId)
 Loads user with user ID. More...
 
 loadByLoginOrMail ($login, $email=null)
 Loads user with user ID. More...
 
 removeRole ($contentId, $roleId)
 Remove role from user. More...
 
 updateUser (User $user)
 Update the user information specified by the user struct. More...
 

Detailed Description

Base class for user gateways.

Member Function Documentation

eZ\Publish\Core\Persistence\Legacy\User\Gateway::assignRole (   $contentId,
  $roleId,
array  $limitation 
)
abstract

Assigns role to user with given limitation.

Parameters
mixed$contentId
mixed$roleId
array$limitation
eZ\Publish\Core\Persistence\Legacy\User\Gateway::createUser ( User  $user)
abstract

Create user.

Parameters
user$user
Returns
mixed
eZ\Publish\Core\Persistence\Legacy\User\Gateway::deleteUser (   $userId)
abstract

Delete user with the given ID.

Parameters
mixed$userId
eZ\Publish\Core\Persistence\Legacy\User\Gateway::load (   $userId)
abstract

Loads user with user ID.

Parameters
mixed$userId
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Gateway::loadByLoginOrMail (   $login,
  $email = null 
)
abstract

Loads user with user ID.

Parameters
string$login
string | null$email
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Gateway::removeRole (   $contentId,
  $roleId 
)
abstract

Remove role from user.

Parameters
mixed$contentId
mixed$roleId
eZ\Publish\Core\Persistence\Legacy\User\Gateway::updateUser ( User  $user)
abstract

Update the user information specified by the user struct.

Parameters
User$user

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