ProfilesList extends Request
Retrieve a list of a Group's profiles according to visibility permissions and request filters.
Table of Contents
- $authorizations : bool|null
- if true, return the list of actions and resources the user has access
- $fields : string|null
- Defines the other available fields to be returned in the response.
- $groupId : string|null
- The group's identifier
- $inherit : bool|null
- also returns profiles inherited from parent's group
- $limit : int|null
- The maximum number of items to return
- $offset : int|null
- The number of items to skip
- from() : static
- Initializing a model from an array
- jsonSerialize() : array<string|int, mixed>
- setAuthorizations() : static
- Setter for authorizations
- setFields() : static
- Setter for fields
- setGroupId() : static
- Setter for groupId
- setInherit() : static
- Setter for inherit
- setLimit() : static
- Setter for limit
- setOffset() : static
- Setter for offset
Properties
$authorizations
if true, return the list of actions and resources the user has access
protected
bool|null
$authorizations
= null
$fields
Defines the other available fields to be returned in the response.
protected
string|null
$fields
= null
$groupId
The group's identifier
protected
string|null
$groupId
= null
$inherit
also returns profiles inherited from parent's group
protected
bool|null
$inherit
= null
$limit
The maximum number of items to return
protected
int|null
$limit
= null
$offset
The number of items to skip
protected
int|null
$offset
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setAuthorizations()
Setter for authorizations
public
setAuthorizations(bool $authorizations) : static
Parameters
- $authorizations : bool
-
if true, return the list of actions and resources the user has access
Return values
static —To use in method chains
setFields()
Setter for fields
public
setFields(string $fields) : static
Parameters
- $fields : string
-
Defines the other available fields to be returned in the response.
Return values
static —To use in method chains
setGroupId()
Setter for groupId
public
setGroupId(string $groupId) : static
Parameters
- $groupId : string
-
The group's identifier
Return values
static —To use in method chains
setInherit()
Setter for inherit
public
setInherit(bool $inherit) : static
Parameters
- $inherit : bool
-
also returns profiles inherited from parent's group
Return values
static —To use in method chains
setLimit()
Setter for limit
public
setLimit(int $limit) : static
Parameters
- $limit : int
-
The maximum number of items to return
Return values
static —To use in method chains
setOffset()
Setter for offset
public
setOffset(int $offset) : static
Parameters
- $offset : int
-
The number of items to skip
Return values
static —To use in method chains