Ibexa >
Contracts >
Segmentation >
SegmentationServiceDecorator

SegmentationServiceDecorator

SegmentationServiceDecorator.php : 19 Copy path

Abstract

Implements SegmentationServiceInterface

Properties¶

$innerService ¶

SegmentationServiceDecorator.php : 21 Copy path

protected SegmentationServiceInterface $innerService

Methods¶

__construct() ¶

SegmentationServiceDecorator.php : 23 Copy path

public __construct(SegmentationServiceInterface $innerService)

Parameters

Name	Type	Default value	Description
$innerService	SegmentationServiceInterface	-	-

assignUserToSegment() ¶

SegmentationServiceDecorator.php : 103 Copy path

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

Parameters

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

createSegment() ¶

SegmentationServiceDecorator.php : 38 Copy path

public createSegment(SegmentCreateStruct $createStruct) : Segment

Parameters

Name	Type	Default value	Description
$createStruct	SegmentCreateStruct	-	-

Return values

Segment

createSegmentGroup() ¶

SegmentationServiceDecorator.php : 68 Copy path

    
                        public createSegmentGroup(SegmentGroupCreateStruct $createStruct) : SegmentGroup

Parameters

Name	Type	Default value	Description
$createStruct	SegmentGroupCreateStruct	-	-

Return values

SegmentGroup

isUserAssignedToSegment() ¶

SegmentationServiceDecorator.php : 98 Copy path

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

Parameters

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

Return values

bool

loadSegment() ¶

SegmentationServiceDecorator.php : 28 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() ¶

SegmentationServiceDecorator.php : 33 Copy path

public loadSegmentByIdentifier(string $identifier) : Segment

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

Segment

loadSegmentGroup() ¶

SegmentationServiceDecorator.php : 58 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() ¶

SegmentationServiceDecorator.php : 63 Copy path

public loadSegmentGroupByIdentifier(string $identifier) : SegmentGroup

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

SegmentGroup

loadSegmentGroups() ¶

SegmentationServiceDecorator.php : 83 Copy path

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

Return values

array<string|int, SegmentGroup>

loadSegmentsAssignedToCurrentUser() ¶

SegmentationServiceDecorator.php : 93 Copy path

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

Return values

array<string|int, Segment>

loadSegmentsAssignedToGroup() ¶

SegmentationServiceDecorator.php : 53 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() ¶

SegmentationServiceDecorator.php : 88 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() ¶

SegmentationServiceDecorator.php : 48 Copy path

public removeSegment(Segment $segment) : void

Parameters

Name	Type	Default value	Description
$segment	Segment	-	-

removeSegmentGroup() ¶

SegmentationServiceDecorator.php : 78 Copy path

public removeSegmentGroup(SegmentGroup $segmentGroup) : void

Parameters

Name	Type	Default value	Description
$segmentGroup	SegmentGroup	-	-

unassignUserFromSegment() ¶

SegmentationServiceDecorator.php : 108 Copy path

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

Parameters

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

updateSegment() ¶

SegmentationServiceDecorator.php : 43 Copy path

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

Parameters

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

Return values

Segment

updateSegmentGroup() ¶

SegmentationServiceDecorator.php : 73 Copy path

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

Parameters

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

Return values

SegmentGroup