Property | Type | Description | |
---|---|---|---|
$service | eZ\Publish\API\Repository\UserService | Aggregated service. | |
$signalDispatcher | SignalDispatcher. |
Method | Description | |
---|---|---|
__construct ( eZ\Publish\API\Repository\UserService $service, |
Constructor. | |
assignUserToUserGroup ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | Assigns a new user group to the user. | |
createUser ( eZ\Publish\API\Repository\Values\User\UserCreateStruct $userCreateStruct, array $parentGroups ) : eZ\Publish\API\Repository\Values\User\User | Create a new user. The created user is published by this method. | |
createUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct $userGroupCreateStruct, eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup ) : eZ\Publish\API\Repository\Values\User\UserGroup | Creates a new user group using the data provided in the ContentCreateStruct parameter. | |
deleteUser ( eZ\Publish\API\Repository\Values\User\User $user ) | This method deletes a user. | |
deleteUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | Removes a user group. | |
loadAnonymousUser ( ) : eZ\Publish\API\Repository\Values\User\User | Loads anonymous user. | |
loadSubUserGroups ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\UserGroup[] | Loads the sub groups of a user group. | |
loadUser ( mixed $userId ) : eZ\Publish\API\Repository\Values\User\User | Loads a user. | |
loadUserByCredentials ( string $login, string $password ) : eZ\Publish\API\Repository\Values\User\User | Loads a user for the given login and password. | |
loadUserByLogin ( string $login ) : eZ\Publish\API\Repository\Values\User\User | Loads a user for the given login. | |
loadUserGroup ( mixed $id ) : eZ\Publish\API\Repository\Values\User\UserGroup | Loads a user group for the given id. | |
loadUserGroupsOfUser ( eZ\Publish\API\Repository\Values\User\User $user, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\UserGroup[] | Loads the user groups the user belongs to. | |
loadUsersByEmail ( string $email ) : eZ\Publish\API\Repository\Values\User\User[] | Loads a user for the given email. | |
loadUsersOfUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\User[] | Loads the users of a user group. | |
moveUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, eZ\Publish\API\Repository\Values\User\UserGroup $newParent ) | Moves the user group to another parent. | |
newUserCreateStruct ( string $login, string $email, string $password, string $mainLanguageCode, eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType = null ) : eZ\Publish\API\Repository\Values\User\UserCreateStruct | Instantiate a user create class. | |
newUserGroupCreateStruct ( string $mainLanguageCode, null | eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType = null ) : eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct | Instantiate a user group create class. | |
newUserGroupUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct | Instantiate a new user group update struct. | |
newUserUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserUpdateStruct | Instantiate a new user update struct. | |
unAssignUserFromUserGroup ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | Removes a user group from the user. | |
updateUser ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserUpdateStruct $userUpdateStruct ) : eZ\Publish\API\Repository\Values\User\User | Updates a user. | |
updateUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct $userGroupUpdateStruct ) : eZ\Publish\API\Repository\Values\User\UserGroup | Updates the group profile with fields and meta data. |
public __construct ( eZ\Publish\API\Repository\UserService $service, |
||
$service | eZ\Publish\API\Repository\UserService | |
$signalDispatcher |
public assignUserToUserGroup ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | ||
$user | eZ\Publish\API\Repository\Values\User\User | |
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup |
public createUser ( eZ\Publish\API\Repository\Values\User\UserCreateStruct $userCreateStruct, array $parentGroups ) : eZ\Publish\API\Repository\Values\User\User | ||
$userCreateStruct | eZ\Publish\API\Repository\Values\User\UserCreateStruct | the data used for creating the user |
$parentGroups | array | the groups of type {@link \eZ\Publish\API\Repository\Values\User\UserGroup} which are assigned to the user after creation |
return | eZ\Publish\API\Repository\Values\User\User |
public createUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct $userGroupCreateStruct, eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup ) : eZ\Publish\API\Repository\Values\User\UserGroup | ||
$userGroupCreateStruct | eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct | a structure for setting all necessary data to create this user group |
$parentGroup | eZ\Publish\API\Repository\Values\User\UserGroup | |
return | eZ\Publish\API\Repository\Values\User\UserGroup |
public deleteUser ( eZ\Publish\API\Repository\Values\User\User $user ) | ||
$user | eZ\Publish\API\Repository\Values\User\User |
public deleteUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | ||
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup |
public loadAnonymousUser ( ) : eZ\Publish\API\Repository\Values\User\User | ||
return | eZ\Publish\API\Repository\Values\User\User |
public loadSubUserGroups ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\UserGroup[] | ||
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup | |
$offset | integer | the start offset for paging |
$limit | integer | the number of user groups returned |
return | eZ\Publish\API\Repository\Values\User\UserGroup[] |
public loadUserByCredentials ( string $login, string $password ) : eZ\Publish\API\Repository\Values\User\User | ||
$login | string | |
$password | string | the plain password |
return | eZ\Publish\API\Repository\Values\User\User |
public loadUserByLogin ( string $login ) : eZ\Publish\API\Repository\Values\User\User | ||
$login | string | |
return | eZ\Publish\API\Repository\Values\User\User |
public loadUserGroup ( mixed $id ) : eZ\Publish\API\Repository\Values\User\UserGroup | ||
$id | mixed | |
return | eZ\Publish\API\Repository\Values\User\UserGroup |
public loadUserGroupsOfUser ( eZ\Publish\API\Repository\Values\User\User $user, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\UserGroup[] | ||
$user | eZ\Publish\API\Repository\Values\User\User | |
$offset | integer | the start offset for paging |
$limit | integer | the number of user groups returned |
return | eZ\Publish\API\Repository\Values\User\UserGroup[] |
public loadUsersByEmail ( string $email ) : eZ\Publish\API\Repository\Values\User\User[] | ||
string | ||
return | eZ\Publish\API\Repository\Values\User\User[] |
public loadUsersOfUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\User\User[] | ||
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup | |
$offset | integer | the start offset for paging |
$limit | integer | the number of users returned |
return | eZ\Publish\API\Repository\Values\User\User[] |
public moveUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, eZ\Publish\API\Repository\Values\User\UserGroup $newParent ) | ||
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup | |
$newParent | eZ\Publish\API\Repository\Values\User\UserGroup |
public newUserCreateStruct ( string $login, string $email, string $password, string $mainLanguageCode, eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType = null ) : eZ\Publish\API\Repository\Values\User\UserCreateStruct | ||
$login | string | the login of the new user |
string | the email of the new user | |
$password | string | the plain password of the new user |
$mainLanguageCode | string | the main language for the underlying content object |
$contentType | eZ\Publish\API\Repository\Values\ContentType\ContentType | 5.x the content type for the underlying content object. In 4.x it is ignored and taken from the configuration |
return | eZ\Publish\API\Repository\Values\User\UserCreateStruct |
public newUserGroupCreateStruct ( string $mainLanguageCode, null | eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType = null ) : eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct | ||
$mainLanguageCode | string | The main language for the underlying content object |
$contentType | null | eZ\Publish\API\Repository\Values\ContentType\ContentType | 5.x the content type for the underlying content object. In 4.x it is ignored and taken from the configuration |
return | eZ\Publish\API\Repository\Values\User\UserGroupCreateStruct |
public newUserGroupUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct | ||
return | eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct |
public newUserUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserUpdateStruct | ||
return | eZ\Publish\API\Repository\Values\User\UserUpdateStruct |
public unAssignUserFromUserGroup ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserGroup $userGroup ) | ||
$user | eZ\Publish\API\Repository\Values\User\User | |
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup |
public updateUser ( eZ\Publish\API\Repository\Values\User\User $user, eZ\Publish\API\Repository\Values\User\UserUpdateStruct $userUpdateStruct ) : eZ\Publish\API\Repository\Values\User\User | ||
$user | eZ\Publish\API\Repository\Values\User\User | |
$userUpdateStruct | eZ\Publish\API\Repository\Values\User\UserUpdateStruct | |
return | eZ\Publish\API\Repository\Values\User\User |
public updateUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup, eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct $userGroupUpdateStruct ) : eZ\Publish\API\Repository\Values\User\UserGroup | ||
$userGroup | eZ\Publish\API\Repository\Values\User\UserGroup | |
$userGroupUpdateStruct | eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct | |
return | eZ\Publish\API\Repository\Values\User\UserGroup |
protected UserService,eZ\Publish\API\Repository $service | ||
return | eZ\Publish\API\Repository\UserService |