eZPublishCommunityProject  2013.6
eZ\Publish\Core\REST\Server\Controller\User Class Reference

User controller. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Server\Controller\User:
+ Collaboration diagram for eZ\Publish\Core\REST\Server\Controller\User:

Public Member Functions

 __construct (UserService $userService, RoleService $roleService, ContentService $contentService, ContentTypeService $contentTypeService, LocationService $locationService, SectionService $sectionService, Repository $repository)
 Construct controller. More...
 
 assignUserToUserGroup ()
 Assigns the user to a user group. More...
 
 createUser ()
 Create a new user group in the given group. More...
 
 createUserGroup ()
 Create a new user group under the given parent To create a top level group use /user/groups/subgroups. More...
 
 deleteUser ()
 Given user is deleted. More...
 
 deleteUserGroup ()
 Given user group is deleted. More...
 
 loadRootUserGroup ()
 Redirects to the root user group. More...
 
 loadSubUserGroups ()
 Returns a list of the sub groups. More...
 
 loadUser ()
 Loads a user for the given ID. More...
 
 loadUserByRemoteId ()
 Loads a user by its remote ID. More...
 
 loadUserDrafts ()
 Loads drafts assigned to user. More...
 
 loadUserGroup ()
 Loads a user group for the given path. More...
 
 loadUserGroupByRemoteId ()
 Loads a user group by its remote ID. More...
 
 loadUserGroups ()
 Loads user groups. More...
 
 loadUserGroupsAssignedToRole ()
 Loads a list of user groups assigned to role. More...
 
 loadUserGroupsOfUser ()
 Returns a list of user groups the user belongs to. More...
 
 loadUsers ()
 Loads users. More...
 
 loadUsersAssignedToRole ()
 Loads a list of users assigned to role. More...
 
 loadUsersFromGroup ()
 Loads the users of the group with the given path. More...
 
 moveUserGroup ()
 Moves the user group to another parent. More...
 
 unassignUserFromUserGroup ()
 Unassigns the user from a user group. More...
 
 updateUser ()
 Updates a user. More...
 
 updateUserGroup ()
 Updates a user group. More...
 
- Public Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 setContainer (Container $container)
 
 setInputDispatcher (InputDispatcher $inputDispatcher)
 
 setRepository (Repository $repository)
 
 setRequest (HttpRequest $request)
 
 setUrlHandler (UrlHandler $urlHandler)
 

Protected Member Functions

 getMediaType ()
 Extracts the requested media type from $request. More...
 

Protected Attributes

 $contentService
 
 $contentTypeService
 
 $locationService
 
 $repository
 
 $roleService
 
 $sectionService
 
 $userService
 
- Protected Attributes inherited from eZ\Publish\Core\REST\Server\Controller
 $container
 
 $inputDispatcher
 
 $repository
 
 $request
 
 $urlHandler
 

Private Member Functions

 extractLocationIdFromPath ($path)
 Extracts and returns an item id from a path, e.g. More...
 

Detailed Description

User controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\User::__construct ( UserService  $userService,
RoleService  $roleService,
ContentService  $contentService,
ContentTypeService  $contentTypeService,
LocationService  $locationService,
SectionService  $sectionService,
Repository  $repository 
)

Construct controller.

Parameters
\eZ\Publish\API\Repository\UserService$userService
\eZ\Publish\API\Repository\RoleService$roleService
\eZ\Publish\API\Repository\ContentService$contentService
\eZ\Publish\API\Repository\LocationService$locationService
\eZ\Publish\API\Repository\SectionService$sectionService
\eZ\Publish\API\Repository\Repository$repository

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\User::assignUserToUserGroup ( )

Assigns the user to a user group.

Returns
eZ\Publish\Core\REST\Server\Controller\User::createUser ( )

Create a new user group in the given group.

Returns
eZ\Publish\Core\REST\Server\Controller\User::createUserGroup ( )

Create a new user group under the given parent To create a top level group use /user/groups/subgroups.

Returns
eZ\Publish\Core\REST\Server\Controller\User::deleteUser ( )

Given user is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\User::deleteUserGroup ( )

Given user group is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\User::getMediaType ( )
protected
eZ\Publish\Core\REST\Server\Controller\User::loadRootUserGroup ( )

Redirects to the root user group.

Returns
eZ\Publish\Core\REST\Server\Controller\User::loadSubUserGroups ( )

Returns a list of the sub groups.

Returns
|
eZ\Publish\Core\REST\Server\Controller\User::loadUser ( )

Loads a user for the given ID.

Returns
eZ\Publish\Core\REST\Server\Controller\User::loadUserByRemoteId ( )

Loads a user by its remote ID.

Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\User\loadUsers().

eZ\Publish\Core\REST\Server\Controller\User::loadUserDrafts ( )

Loads drafts assigned to user.

Returns
eZ\Publish\Core\REST\Server\Controller\User::loadUserGroup ( )

Loads a user group for the given path.

Returns
eZ\Publish\Core\REST\Server\Controller\User::loadUserGroupByRemoteId ( )

Loads a user group by its remote ID.

Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\User\loadUserGroups().

eZ\Publish\Core\REST\Server\Controller\User::loadUserGroups ( )

Loads user groups.

Returns
|
eZ\Publish\Core\REST\Server\Controller\User::loadUserGroupsAssignedToRole ( )

Loads a list of user groups assigned to role.

Returns
[]

Referenced by eZ\Publish\Core\REST\Server\Controller\User\loadUserGroups().

eZ\Publish\Core\REST\Server\Controller\User::loadUserGroupsOfUser ( )

Returns a list of user groups the user belongs to.

The returned list includes the resources for unassigning a user group if the user is in multiple groups.

Returns
eZ\Publish\Core\REST\Server\Controller\User::loadUsers ( )

Loads users.

Returns
|
eZ\Publish\Core\REST\Server\Controller\User::loadUsersAssignedToRole ( )

Loads a list of users assigned to role.

Returns
[]

Referenced by eZ\Publish\Core\REST\Server\Controller\User\loadUsers().

eZ\Publish\Core\REST\Server\Controller\User::loadUsersFromGroup ( )

Loads the users of the group with the given path.

Returns
|
eZ\Publish\Core\REST\Server\Controller\User::moveUserGroup ( )

Moves the user group to another parent.

Returns
eZ\Publish\Core\REST\Server\Controller\User::unassignUserFromUserGroup ( )

Unassigns the user from a user group.

Returns
eZ\Publish\Core\REST\Server\Controller\User::updateUser ( )

Updates a user.

Returns
eZ\Publish\Core\REST\Server\Controller\User::updateUserGroup ( )

Updates a user group.

Returns

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\User::$contentService
protected
eZ\Publish\Core\REST\Server\Controller\User::$contentTypeService
protected
eZ\Publish\Core\REST\Server\Controller\User::$locationService
protected
eZ\Publish\Core\REST\Server\Controller\User::$repository
protected
eZ\Publish\Core\REST\Server\Controller\User::$roleService
protected
eZ\Publish\Core\REST\Server\Controller\User::$sectionService
protected
eZ\Publish\Core\REST\Server\Controller\User::$userService
protected

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