ChannelGroupInfo implements IChannelGroupInfo
Table of Contents
Interfaces
Methods
- __construct() : mixed
- compareBySort() : int
- Compare
- getCaption() : string
- Get channel group caption.
- getID() : string
- Get channel group ID.
- getParentID() : null|string
- Returns parent group ID.
- getSort() : int
- Get channel group gort.
- getUrl() : string
- Get channel group URL.
- isDisplayable() : bool
- Check if channel group is displayable Items of not displayable group will be displayed at top-level as non-grouped.
- setParentID() : void
- Sets parent group ID.
- sort() : mixed
Methods
__construct()
public
__construct(mixed $tracker, mixed $ID[, mixed $caption = '' ][, mixed $sort = 1000 ][, mixed $isDisplayable = true ][, mixed $url = '' ]) : mixed
Parameters
- $tracker : mixed
- $ID : mixed
- $caption : mixed = ''
- $sort : mixed = 1000
- $isDisplayable : mixed = true
- $url : mixed = ''
compareBySort()
Compare
public
static compareBySort(IChannelGroupInfo $a, IChannelGroupInfo $b) : int
Parameters
- $a : IChannelGroupInfo
- $b : IChannelGroupInfo
Return values
intgetCaption()
Get channel group caption.
public
getCaption() : string
Return values
stringgetID()
Get channel group ID.
public
getID() : string
Return values
stringgetParentID()
Returns parent group ID.
public
getParentID() : null|string
Return values
null|stringgetSort()
Get channel group gort.
public
getSort() : int
Return values
intgetUrl()
Get channel group URL.
public
getUrl() : string
Return values
stringisDisplayable()
Check if channel group is displayable Items of not displayable group will be displayed at top-level as non-grouped.
public
isDisplayable() : bool
Return values
boolsetParentID()
Sets parent group ID.
public
setParentID(string $parent) : void
Parameters
- $parent : string
sort()
public
static sort(array<string|int, mixed> $items) : mixed
Parameters
- $items : array<string|int, mixed>