Ibexa >
Contracts >
Segmentation >
SegmentationServiceInterface

SegmentationServiceInterface

SegmentationServiceInterface.php : 19 Copy path

Interface

Methods¶

assignUserToSegment() ¶

SegmentationServiceInterface.php : 69 Copy path

public assignUserToSegment(User $user, Segment $segment) : void

Parameters

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

createSegment() ¶

SegmentationServiceInterface.php : 28 Copy path

public createSegment(SegmentCreateStruct $createStruct) : Segment

Parameters

Name	Type	Default value	Description
$createStruct	SegmentCreateStruct	-	-

Return values

Segment

createSegmentGroup() ¶

SegmentationServiceInterface.php : 46 Copy path

    
                        public createSegmentGroup(SegmentGroupCreateStruct $createStruct) : SegmentGroup

Parameters

Name	Type	Default value	Description
$createStruct	SegmentGroupCreateStruct	-	-

Return values

SegmentGroup

isUserAssignedToSegment() ¶

SegmentationServiceInterface.php : 67 Copy path

public isUserAssignedToSegment(User $user, Segment $segment) : bool

Parameters

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

Return values

bool

loadSegment() ¶

SegmentationServiceInterface.php : 24 Copy path

For remote API or external usage rely on {@see loadSegmentByIdentifier()} method instead.

public loadSegment(int $segmentId) : Segment

Parameters

Name	Type	Default value	Description
$segmentId	int	-	-

Return values

Segment

loadSegmentByIdentifier() ¶

SegmentationServiceInterface.php : 26 Copy path

public loadSegmentByIdentifier(string $identifier) : Segment

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

Segment

loadSegmentGroup() ¶

SegmentationServiceInterface.php : 42 Copy path

For remote API or external usage rely on {@see loadSegmentGroupByIdentifier()} method instead.

public loadSegmentGroup(int $segmentGroupId) : SegmentGroup

Parameters

Name	Type	Default value	Description
$segmentGroupId	int	-	-

Return values

SegmentGroup

loadSegmentGroupByIdentifier() ¶

SegmentationServiceInterface.php : 44 Copy path

public loadSegmentGroupByIdentifier(string $identifier) : SegmentGroup

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

SegmentGroup

loadSegmentGroups() ¶

SegmentationServiceInterface.php : 55 Copy path

public loadSegmentGroups() : array<string|int, SegmentGroup>

Return values

array<string|int, SegmentGroup>

loadSegmentsAssignedToCurrentUser() ¶

SegmentationServiceInterface.php : 65 Copy path

public loadSegmentsAssignedToCurrentUser() : array<string|int, Segment>

Return values

array<string|int, Segment>

loadSegmentsAssignedToGroup() ¶

SegmentationServiceInterface.php : 37 Copy path

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

Parameters

Name	Type	Default value	Description
$segmentGroup	SegmentGroup	-	-

Return values

array<string|int, Segment>

loadSegmentsAssignedToUser() ¶

SegmentationServiceInterface.php : 60 Copy path

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

Parameters

Name	Type	Default value	Description
$user	User	-	-

Return values

array<string|int, Segment>

removeSegment() ¶

SegmentationServiceInterface.php : 32 Copy path

public removeSegment(Segment $segment) : void

Parameters

Name	Type	Default value	Description
$segment	Segment	-	-

removeSegmentGroup() ¶

SegmentationServiceInterface.php : 50 Copy path

public removeSegmentGroup(SegmentGroup $segmentGroup) : void

Parameters

Name	Type	Default value	Description
$segmentGroup	SegmentGroup	-	-

unassignUserFromSegment() ¶

SegmentationServiceInterface.php : 71 Copy path

public unassignUserFromSegment(User $user, Segment $segment) : void

Parameters

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

updateSegment() ¶

SegmentationServiceInterface.php : 30 Copy path

    
                        public updateSegment(Segment $segment, SegmentUpdateStruct $updateStruct) : Segment

Parameters

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

Return values

Segment

updateSegmentGroup() ¶

SegmentationServiceInterface.php : 48 Copy path

    
                        public updateSegmentGroup(SegmentGroup $segmentGroup, SegmentGroupUpdateStruct $updateStruct) : SegmentGroup

Parameters

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

Return values

SegmentGroup