PHP Class eZ\Bundle\EzPublishCoreBundle\Features\Context\UserContext

Inheritance: implements Behat\Behat\Context\Context, use trait EzSystems\PlatformBehatBundle\Context\RepositoryContext

Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property	Type	Description
$searchService	eZ\Publish\API\Repository\SearchService
$userService	eZ\Publish\API\Repository\UserService

Public Methods

Method	Description
__construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\API\Repository\UserService $userService, eZ\Publish\API\Repository\SearchService $searchService )
assertUserWithNameDoesntExist ( $username )
assertUserWithNameDoesntExistInGroup ( $username, $parentGroup )
assertUserWithNameDoesntExistInGroups ( $username, Behat\Gherkin\Node\TableNode $table )
assertUserWithNameExists ( $username )
assertUserWithNameExistsInGroup ( $username, $parentGroup )
assertUserWithNameExistsWithFields ( $username, Behat\Gherkin\Node\TableNode $table )
checkUserExistenceByEmail ( string $email, string $parentGroupName = null ) : boolean	Checks if the User with email $email exists.
checkUserExistenceByUsername ( string $username, string $parentGroupName = null ) : boolean	Checks if the User with username $username exists.
createPasswordHash ( $login, $password, $type )
createUserGroup ( string $name, eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup = null ) : eZ\Publish\API\Repository\Values\User\UserGroup	Create new User Group inside existing parent User Group.
ensureUserDoesntExist ( string $username, string $parentGroupName = null )	Make sure a User with name $username does not exist (in parent group).
ensureUserExists ( string $username, string $email, string $password, string $parentGroupName = null ) : eZ\Publish\API\Repository\Values\User\User	Make sure a User with name $username, $email and $password exists in parent group.
iDontHaveUser ( $username )
iDontHaveUserInGroup ( $username, $parentGroup )
iHaveTheFollowingUsers ( Behat\Gherkin\Node\TableNode $table )
iHaveUser ( $username ) : eZ\Publish\API\Repository\Values\User\User
iHaveUserInGroup ( $username, $parentGroupName ) : eZ\Publish\API\Repository\Values\User\User
iHaveUserWithUsernameEmailAndPassword ( $username, $email, $password ) : eZ\Publish\API\Repository\Values\User\User
iHaveUserWithUsernameEmailAndPasswordInGroup ( $username, $email, $password, $parentGroupName ) : eZ\Publish\API\Repository\Values\User\User
searchUserByLogin ( string $username, $parentGroupId = null ) : User	Search User with given username, optionally at given location.
searchUserGroups ( string $name, string $parentLocationId = null ) : search	Search User Groups with given name.

Protected Methods

Method	Description
createUser ( $username, $email, $password, $parentGroup = null, $fields = [] ) : eZ\Publish\API\Repository\Values\User\User	Create user inside given User Group; DELETES existing User if login already exists!

Private Methods

Method	Description
findNonExistingUserEmail ( $username = 'User' ) : string	Find a non existing User email.
findNonExistingUserName ( ) : string	Find a non existing User name.

Method Details

__construct() public method

public __construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\API\Repository\UserService $userService, eZ\Publish\API\Repository\SearchService $searchService )
$repository	eZ\Publish\API\Repository\Repository
$userService	eZ\Publish\API\Repository\UserService
$searchService	eZ\Publish\API\Repository\SearchService

assertUserWithNameDoesntExist() public method

public assertUserWithNameDoesntExist ( $username )

assertUserWithNameDoesntExistInGroup() public method

public assertUserWithNameDoesntExistInGroup ( $username, $parentGroup )

assertUserWithNameDoesntExistInGroups() public method

public assertUserWithNameDoesntExistInGroups ( $username, Behat\Gherkin\Node\TableNode $table )
$table	Behat\Gherkin\Node\TableNode

assertUserWithNameExists() public method

public assertUserWithNameExists ( $username )

assertUserWithNameExistsInGroup() public method

public assertUserWithNameExistsInGroup ( $username, $parentGroup )

assertUserWithNameExistsWithFields() public method

public assertUserWithNameExistsWithFields ( $username, Behat\Gherkin\Node\TableNode $table )
$table	Behat\Gherkin\Node\TableNode

checkUserExistenceByEmail() public method

Checks if the User with email $email exists.

public checkUserExistenceByEmail ( string $email, string $parentGroupName = null ) : boolean
$email	string	User email
$parentGroupName	string	User group name to search inside
return	boolean	true if it exists, false if not

checkUserExistenceByUsername() public method

Checks if the User with username $username exists.

public checkUserExistenceByUsername ( string $username, string $parentGroupName = null ) : boolean
$username	string	User name
$parentGroupName	string	User group name to search inside
return	boolean	true if it exists, false if user or group don't exist

createPasswordHash() public method

public createPasswordHash ( $login, $password, $type )

createUser() protected method

Create user inside given User Group; DELETES existing User if login already exists!

protected createUser ( $username, $email, $password, $parentGroup = null, $fields = [] ) : eZ\Publish\API\Repository\Values\User\User
$username		username of the user to create
$email		email address of user to create
$password		account password for user to create
$parentGroup		pathstring wherein to create user
return	eZ\Publish\API\Repository\Values\User\User

createUserGroup() public method

Create new User Group inside existing parent User Group.

public createUserGroup ( string $name, eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup = null ) : eZ\Publish\API\Repository\Values\User\UserGroup
$name	string	User Group name
$parentGroup	eZ\Publish\API\Repository\Values\User\UserGroup	(optional) parent user group, defaults to UserGroup "/Users"
return	eZ\Publish\API\Repository\Values\User\UserGroup

ensureUserDoesntExist() public method

Make sure a User with name $username does not exist (in parent group).

public ensureUserDoesntExist ( string $username, string $parentGroupName = null )
$username	string	User name
$parentGroupName	string	(optional) name of the parent group to check

ensureUserExists() public method

Make sure a User with name $username, $email and $password exists in parent group.

public ensureUserExists ( string $username, string $email, string $password, string $parentGroupName = null ) : eZ\Publish\API\Repository\Values\User\User
$username	string	User name
$email	string	User's email
$password	string	User's password
$parentGroupName	string	(optional) name of the parent group to check
return	eZ\Publish\API\Repository\Values\User\User

iDontHaveUser() public method

public iDontHaveUser ( $username )

iDontHaveUserInGroup() public method

public iDontHaveUserInGroup ( $username, $parentGroup )

iHaveTheFollowingUsers() public method

public iHaveTheFollowingUsers ( Behat\Gherkin\Node\TableNode $table )
$table	Behat\Gherkin\Node\TableNode

iHaveUser() public method

public iHaveUser ( $username ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

iHaveUserInGroup() public method

public iHaveUserInGroup ( $username, $parentGroupName ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

iHaveUserWithUsernameEmailAndPassword() public method

public iHaveUserWithUsernameEmailAndPassword ( $username, $email, $password ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

iHaveUserWithUsernameEmailAndPasswordInGroup() public method

public iHaveUserWithUsernameEmailAndPasswordInGroup ( $username, $email, $password, $parentGroupName ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

searchUserByLogin() public method

Search User with given username, optionally at given location.

public searchUserByLogin ( string $username, $parentGroupId = null ) : User
$username	string	name of User to search for
return	User	found

searchUserGroups() public method

Search User Groups with given name.

public searchUserGroups ( string $name, string $parentLocationId = null ) : search
$name	string	name of User Group to search for
$parentLocationId	string	(optional) parent location id to search in
return	search	results

Property Details

$searchService protected property

protected SearchService,eZ\Publish\API\Repository $searchService
return	eZ\Publish\API\Repository\SearchService

$userService protected property

protected UserService,eZ\Publish\API\Repository $userService
return	eZ\Publish\API\Repository\UserService