Copied!

MemberService

MemberService.php : 22
Interface

Constants

publicDEFAULT_COMPANY_MEMBERS_LIST_LIMIT

MemberService.php : 24 
public mixed DEFAULT_COMPANY_MEMBERS_LIST_LIMIT = 25

Methods

publiccountCompanyMembers()

MemberService.php : 50 
public countCompanyMembers(Company $company[, CriterionInterface|null $filter = null ]) : int

Parameters

Name Type Default value Description
$company Company - -
$filter CriterionInterface|null null -

Return values

int

Tags
Throws
BadStateException
Throws
InvalidArgumentException

publiccreateMember()

MemberService.php : 75 
public createMember(Company $company, MemberCreateStruct $memberCreateStruct, Role $role) : Member

Parameters

Name Type Default value Description
$company Company - -
$memberCreateStruct MemberCreateStruct - -
$role Role - -

Return values

Member

Tags
Throws
ContentFieldValidationException
Throws
UnauthorizedException
Throws
ValidationFailedExceptionInterface

publicdeleteMember()

MemberService.php : 79 
public deleteMember(Member $member) : void

Parameters

Name Type Default value Description
$member Member - -

publicgetCompanyContact()

MemberService.php : 83 
public getCompanyContact(Company $company) : Member|null

Parameters

Name Type Default value Description
$company Company - -

Return values

Member|null

publicgetCompanyMembers()

MemberService.php : 38 
public getCompanyMembers(Company $company[, CriterionInterface|null $filter = null ][, array<string|int, SortClause> $sortClauses = [] ][, int|null $limit = self::DEFAULT_COMPANY_MEMBERS_LIST_LIMIT ][, int $offset = 0 ]) : array<string|int, Member>

Parameters

Name Type Default value Description
$company Company - -
$filter CriterionInterface|null null -
$sortClauses array<string|int, SortClause> [] -
$limit int|null MemberService::DEFAULT_COMPANY_MEMBERS_LIST_LIMIT -
$offset int 0 -

Return values

array<string|int, Member>

Tags
Throws
BadStateException
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
UnauthorizedException

publicgetMember()

MemberService.php : 26 
public getMember(int $memberId, Company $company) : Member

Parameters

Name Type Default value Description
$memberId int - -
$company Company - -

Return values

Member

publicgetMemberAssignment()

MemberService.php : 52 
public getMemberAssignment(Member $member, Company $company) : MemberAssignment

Parameters

Name Type Default value Description
$member Member - -
$company Company - -

Return values

MemberAssignment

publicgetMemberAssignmentByUser()

MemberService.php : 54 
public getMemberAssignmentByUser(User $user, Company $company) : MemberAssignment

Parameters

Name Type Default value Description
$user User - -
$company Company - -

Return values

MemberAssignment

publicgetMemberAssignments()

MemberService.php : 59 
public getMemberAssignments(Member $member) : iterable<string|int, MemberAssignment>

Parameters

Name Type Default value Description
$member Member - -

Return values

iterable<string|int, MemberAssignment>

publicgetMemberAssignmentsByMemberId()

MemberService.php : 64 
public getMemberAssignmentsByMemberId(int $memberId) : iterable<string|int, MemberAssignment>

Parameters

Name Type Default value Description
$memberId int - -

Return values

iterable<string|int, MemberAssignment>

publicgetRoleAssignment()

MemberService.php : 68 
public getRoleAssignment(Member $member) : RoleAssignment

Parameters

Name Type Default value Description
$member Member - -

Return values

RoleAssignment

publicgetRoleAssignmentByUser()

MemberService.php : 66 
public getRoleAssignmentByUser(User $user, Role $role, string $locationPath) : RoleAssignment

Parameters

Name Type Default value Description
$user User - -
$role Role - -
$locationPath string - -

Return values

RoleAssignment

publicnewMemberCreateStruct()

MemberService.php : 85 
public newMemberCreateStruct(string $login, string $email, string $password[, ContentType|null $contentType = null ]) : MemberCreateStruct

Parameters

Name Type Default value Description
$login string - -
$email string - -
$password string - -
$contentType ContentType|null null -

Return values

MemberCreateStruct

publicnewMemberUpdateStruct()

MemberService.php : 92 
public newMemberUpdateStruct() : MemberUpdateStruct

Return values

MemberUpdateStruct

publicsetMemberRole()

MemberService.php : 81 
public setMemberRole(Member $member, Role $role) : void

Parameters

Name Type Default value Description
$member Member - -
$role Role - -

publicupdateMember()

MemberService.php : 77 
public updateMember(Member $member, MemberUpdateStruct $memberUpdateStruct) : Member

Parameters

Name Type Default value Description
$member Member - -
$memberUpdateStruct MemberUpdateStruct - -

Return values

Member