Copied!

SegmentationServiceInterface

SegmentationServiceInterface.php : 22
Interface

Methods

publicassignUserToSegment()

SegmentationServiceInterface.php : 92 
public assignUserToSegment(User $user, Segment $segment) : void

Parameters

Name Type Default value Description
$user User - -
$segment Segment - -
Tags
Throws
UnauthorizedException
Throws
ForbiddenException
Throws
ValidationFailedException

publiccreateSegment()

SegmentationServiceInterface.php : 31 
public createSegment(SegmentCreateStruct $createStruct) : Segment

Parameters

Name Type Default value Description
$createStruct SegmentCreateStruct - -

Return values

Segment

publiccreateSegmentGroup()

SegmentationServiceInterface.php : 55 
public createSegmentGroup(SegmentGroupCreateStruct $createStruct) : SegmentGroup

Parameters

Name Type Default value Description
$createStruct SegmentGroupCreateStruct - -

Return values

SegmentGroup

publicisUserAssignedToSegment()

SegmentationServiceInterface.php : 82 
public isUserAssignedToSegment(User $user, Segment $segment) : bool

Parameters

Name Type Default value Description
$user User - -
$segment Segment - -

Return values

bool

publicloadSegment()

SegmentationServiceInterface.php : 27 
public loadSegment(int $segmentId) : Segment

Parameters

Name Type Default value Description
$segmentId int - -

Return values

Segment

Tags
Deprecated

Deprecated since Ibexa DXP 3.3 and will be dropped in 5.0. Use SegmentationServiceInterface::loadSegmentByIdentifier() method instead.

publicloadSegmentByIdentifier()

SegmentationServiceInterface.php : 29 
public loadSegmentByIdentifier(string $identifier) : Segment

Parameters

Name Type Default value Description
$identifier string - -

Return values

Segment

publicloadSegmentGroup()

SegmentationServiceInterface.php : 51 
public loadSegmentGroup(int $segmentGroupId) : SegmentGroup

Parameters

Name Type Default value Description
$segmentGroupId int - -

Return values

SegmentGroup

Tags
Deprecated

Deprecated since Ibexa DXP 3.3 and will be dropped in 5.0. Use SegmentationServiceInterface::loadSegmentGroupByIdentifier() method instead.

publicloadSegmentGroupByIdentifier()

SegmentationServiceInterface.php : 53 
public loadSegmentGroupByIdentifier(string $identifier) : SegmentGroup

Parameters

Name Type Default value Description
$identifier string - -

Return values

SegmentGroup

publicloadSegmentGroups()

SegmentationServiceInterface.php : 70 
public loadSegmentGroups() : array<string|int, SegmentGroup>

Return values

array<string|int, SegmentGroup>

publicloadSegmentsAssignedToCurrentUser()

SegmentationServiceInterface.php : 80 
public loadSegmentsAssignedToCurrentUser() : array<string|int, Segment>

Return values

array<string|int, Segment>

publicloadSegmentsAssignedToGroup()

SegmentationServiceInterface.php : 46 
public loadSegmentsAssignedToGroup(SegmentGroup $segmentGroup) : array<string|int, Segment>

Parameters

Name Type Default value Description
$segmentGroup SegmentGroup - -

Return values

array<string|int, Segment>

publicloadSegmentsAssignedToUser()

SegmentationServiceInterface.php : 75 
public loadSegmentsAssignedToUser(User $user) : array<string|int, Segment>

Parameters

Name Type Default value Description
$user User - -

Return values

array<string|int, Segment>

publicremoveSegment()

SegmentationServiceInterface.php : 41 
public removeSegment(Segment $segment) : void

Parameters

Name Type Default value Description
$segment Segment - -

publicremoveSegmentGroup()

SegmentationServiceInterface.php : 65 
public removeSegmentGroup(SegmentGroup $segmentGroup) : void

Parameters

Name Type Default value Description
$segmentGroup SegmentGroup - -

publicunassignUserFromSegment()

SegmentationServiceInterface.php : 97 
public unassignUserFromSegment(User $user, Segment $segment) : void

Parameters

Name Type Default value Description
$user User - -
$segment Segment - -

publicupdateSegment()

SegmentationServiceInterface.php : 36 
public updateSegment(Segment $segment, SegmentUpdateStruct $updateStruct) : Segment

Parameters

Name Type Default value Description
$segment Segment - -
$updateStruct SegmentUpdateStruct - -

Return values

Segment

publicupdateSegmentGroup()

SegmentationServiceInterface.php : 60 
public updateSegmentGroup(SegmentGroup $segmentGroup, SegmentGroupUpdateStruct $updateStruct) : SegmentGroup

Parameters

Name Type Default value Description
$segmentGroup SegmentGroup - -
$updateStruct SegmentGroupUpdateStruct - -

Return values

SegmentGroup