PHP Class eZ\Publish\Core\REST\Client\UserService

See also: eZ\Publish\API\Repository\UserService

Inheritance: implements eZ\Publish\API\Repository\UserService, implements eZ\Publish\Core\REST\Client\Sessionable

Show file Open project: ezsystems/ezpublish-kernel

Public Methods

Method	Description
__construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
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, 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.
setSession ( $id )	Set session ID.
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.

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
$client	eZ\Publish\Core\REST\Client\HttpClient
$inputDispatcher	eZ\Publish\Core\REST\Common\Input\Dispatcher
$outputVisitor	eZ\Publish\Core\REST\Common\Output\Visitor
$requestParser	eZ\Publish\Core\REST\Common\RequestParser

assignUserToUserGroup() public method

Assigns a new user group to the user.

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

createUser() public method

Create a new user. The created user is published by this method.

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

createUserGroup() public method

In 4.x in the content type parameter in the profile is ignored - the content type is determined via configuration and can be set to null. The returned version is published.

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

deleteUser() public method

This method deletes a user.

public deleteUser ( eZ\Publish\API\Repository\Values\User\User $user )
$user	eZ\Publish\API\Repository\Values\User\User

deleteUserGroup() public method

the users which are not assigned to other groups will be deleted.

public deleteUserGroup ( eZ\Publish\API\Repository\Values\User\UserGroup $userGroup )
$userGroup	eZ\Publish\API\Repository\Values\User\UserGroup

loadAnonymousUser() public method

Loads anonymous user.

Deprecation: since 5.3, use loadUser( $anonymousUserId ) instead

public loadAnonymousUser ( ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

loadSubUserGroups() public method

Loads the sub groups of a user group.

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[]

loadUser() public method

Loads a user.

public loadUser ( mixed $userId ) : eZ\Publish\API\Repository\Values\User\User
$userId	mixed
return	eZ\Publish\API\Repository\Values\User\User

loadUserByCredentials() public method

Loads a user for the given login and password.

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

loadUserByLogin() public method

Loads a user for the given login.

public loadUserByLogin ( string $login ) : eZ\Publish\API\Repository\Values\User\User
$login	string
return	eZ\Publish\API\Repository\Values\User\User

loadUserGroup() public method

Loads a user group for the given id.

public loadUserGroup ( mixed $id ) : eZ\Publish\API\Repository\Values\User\UserGroup
$id	mixed
return	eZ\Publish\API\Repository\Values\User\UserGroup

loadUserGroupsOfUser() public method

Loads the user groups the user belongs to.

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[]

loadUsersByEmail() public method

Returns an array of Users since eZ Publish has under certain circumstances allowed several users having same email in the past (by means of a configuration option).

public loadUsersByEmail ( string $email ) : eZ\Publish\API\Repository\Values\User\User[]
$email	string
return	eZ\Publish\API\Repository\Values\User\User[]

loadUsersOfUserGroup() public method

Loads the users of a user group.

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[]

moveUserGroup() public method

Moves the user group to another parent.

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

newUserCreateStruct() public method

Instantiate a user create class.

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
$email	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

newUserGroupCreateStruct() public method

Instantiate a user group create class.

public newUserGroupCreateStruct ( string $mainLanguageCode, 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	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

newUserGroupUpdateStruct() public method

Instantiate a new user group update struct.

public newUserGroupUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct
return	eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct

newUserUpdateStruct() public method

Instantiate a new user update struct.

public newUserUpdateStruct ( ) : eZ\Publish\API\Repository\Values\User\UserUpdateStruct
return	eZ\Publish\API\Repository\Values\User\UserUpdateStruct

setSession() public method

Only for testing

public setSession ( $id )

unAssignUserFromUserGroup() public method

Removes a user group from the user.

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

updateUser() public method

4.x: If the versionUpdateStruct is set in the user update structure, this method internally creates a content draft, updates ts with the provided data and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.

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

updateUserGroup() public method

4.x: If the versionUpdateStruct is set in $userGroupUpdateStruct, this method internally creates a content draft, updates ts with the provided data and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.

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