Copied!

SegmentationServiceInterface

SegmentationServiceInterface.php : 21
Interface

Methods

publicassignUserToSegment()

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

Parameters

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

publiccountSegmentsPerGroup()

SegmentationServiceInterface.php : 94 
public countSegmentsPerGroup([array<string|int, string> $sources = [] ][, string|null $searchPhrase = null ]) : array<int, int>

Parameters

Name Type Default value Description
$sources array<string|int, string> [] -
$searchPhrase string|null null -

Return values

array<int, int>

segment counts keyed by segment group id, ordered by group name

publiccountSegmentsPerSource()

SegmentationServiceInterface.php : 101 
public countSegmentsPerSource([array<string|int, int> $segmentGroupIds = [] ][, string|null $searchPhrase = null ]) : array<string, int>

Parameters

Name Type Default value Description
$segmentGroupIds array<string|int, int> [] -
$searchPhrase string|null null -

Return values

array<string, int>

publiccreateSegment()

SegmentationServiceInterface.php : 37 
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

publicfindSegments()

SegmentationServiceInterface.php : 87 
public findSegments([SegmentQuery|null $query = null ]) : SegmentSearchResult

Parameters

Name Type Default value Description
$query SegmentQuery|null null -

Return values

SegmentSearchResult

publicisUserAssignedToSegment()

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

Parameters

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

Return values

bool

publicloadSegment()

SegmentationServiceInterface.php : 26

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

publicloadSegmentByIdentifier()

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

Parameters

Name Type Default value Description
$identifier string - -

Return values

Segment

publicloadSegmentGroup()

SegmentationServiceInterface.php : 51

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

publicloadSegmentGroupByIdentifier()

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

Parameters

Name Type Default value Description
$identifier string - -

Return values

SegmentGroup

publicloadSegmentGroups()

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

Return values

array<string|int, SegmentGroup>

publicloadSegments()

SegmentationServiceInterface.php : 33 
public loadSegments(array<int, int> $segmentIds) : array<int, Segment>

Parameters

Name Type Default value Description
$segmentIds array<int, int> - -

Return values

array<int, Segment>

publicloadSegmentsAssignedToCurrentUser()

SegmentationServiceInterface.php : 74 
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 : 69 
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 : 59 
public removeSegmentGroup(SegmentGroup $segmentGroup) : void

Parameters

Name Type Default value Description
$segmentGroup SegmentGroup - -

publicunassignUserFromSegment()

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

Parameters

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

publicupdateSegment()

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

Parameters

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

Return values

Segment

publicupdateSegmentGroup()

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

Parameters

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

Return values

SegmentGroup