PartnersUpdate extends CommonGroupUpdate
Defines the Partners group's update properties
Table of Contents
- TYPE_CHANNEL = 9
- Channel
- TYPE_DIST = 8
- DIST
- TYPE_NIP = 7
- NIP
- TYPE_OTHER = 2
- Other
- TYPE_PARTNER = 11
- Partner
- TYPE_PARTNERS = 6
- Partners
- TYPE_SO = 0
- SO
- TYPE_STARTER = 10
- Starter
- TYPE_SVNO = 5
- SVNO
- $description : string|null
- The group's description
- $name : string|null
- The group's name
- $timezone : string|null
- The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").
- $type : int|null
- - Group's type
- from() : static
- Initializing a model from an array
- getDescription() : string
- Getter for description
- getName() : string
- Getter for name
- getTimezone() : string
- Getter for timezone
- getType() : int
- Getter for type
- jsonSerialize() : array<string|int, mixed>
- setDescription() : static
- Setter for description
- setName() : static
- Setter for name
- setTimezone() : static
- Setter for timezone
- setType() : static
- Setter for type
Constants
TYPE_CHANNEL
Channel
public
mixed
TYPE_CHANNEL
= 9
TYPE_DIST
DIST
public
mixed
TYPE_DIST
= 8
TYPE_NIP
NIP
public
mixed
TYPE_NIP
= 7
TYPE_OTHER
Other
public
mixed
TYPE_OTHER
= 2
TYPE_PARTNER
Partner
public
mixed
TYPE_PARTNER
= 11
TYPE_PARTNERS
Partners
public
mixed
TYPE_PARTNERS
= 6
TYPE_SO
SO
public
mixed
TYPE_SO
= 0
TYPE_STARTER
Starter
public
mixed
TYPE_STARTER
= 10
TYPE_SVNO
SVNO
public
mixed
TYPE_SVNO
= 5
Properties
$description
The group's description
protected
string|null
$description
= null
$name
The group's name
protected
string|null
$name
= null
$timezone
The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").
protected
string|null
$timezone
= null
$type
- Group's type
protected
int|null
$type
= 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 —getDescription()
Getter for description
public
getDescription() : string
Return values
string —The group's description
getName()
Getter for name
public
getName() : string
Return values
string —The group's name
getTimezone()
Getter for timezone
public
getTimezone() : string
Return values
string —The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").
getType()
Getter for type
public
getType() : int
Return values
int —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setDescription()
Setter for description
public
setDescription(string $description) : static
Parameters
- $description : string
-
The group's description
Return values
static —To use in method chains
setName()
Setter for name
public
setName(string $name) : static
Parameters
- $name : string
-
The group's name
Return values
static —To use in method chains
setTimezone()
Setter for timezone
public
setTimezone(string $timezone) : static
Parameters
- $timezone : string
-
The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").
Return values
static —To use in method chains
setType()
Setter for type
public
setType(int $type) : static
Parameters
- $type : int
-
Return values
static —To use in method chains