RulesetDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
RulesetDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ACTION_ALLOW = 'ALLOW'
- ACTION_BLOCK = 'BLOCK'
- ACTION_BOUNCE_HARD = 'BOUNCE_HARD'
- ACTION_BOUNCE_SOFT = 'BOUNCE_SOFT'
- ACTION_FILTER_REMOVE = 'FILTER_REMOVE'
- DISCRIMINATOR = null
- HANDLER_EXCEPTION = 'EXCEPTION'
- SCOPE_RECEIVING_EMAILS = 'RECEIVING_EMAILS'
- SCOPE_RECEIVING_SMS = 'RECEIVING_SMS'
- SCOPE_SENDING_EMAILS = 'SENDING_EMAILS'
- SCOPE_SENDING_SMS = 'SENDING_SMS'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAction() : string
- Gets action
- getActionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getActive() : bool
- Gets active
- getCreatedAt() : DateTime
- Gets created_at
- getHandler() : string
- Gets handler
- getHandlerAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getId() : string
- Gets id
- getInboxId() : string|null
- Gets inbox_id
- getModelName() : string
- The original name of the model.
- getPhoneId() : string|null
- Gets phone_id
- getScope() : string
- Gets scope
- getScopeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTarget() : string
- Gets target
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAction() : self
- Sets action
- setActive() : self
- Sets active
- setCreatedAt() : self
- Sets created_at
- setHandler() : self
- Sets handler
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setPhoneId() : self
- Sets phone_id
- setScope() : self
- Sets scope
- setTarget() : self
- Sets target
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
ACTION_ALLOW
public
mixed
ACTION_ALLOW
= 'ALLOW'
ACTION_BLOCK
public
mixed
ACTION_BLOCK
= 'BLOCK'
ACTION_BOUNCE_HARD
public
mixed
ACTION_BOUNCE_HARD
= 'BOUNCE_HARD'
ACTION_BOUNCE_SOFT
public
mixed
ACTION_BOUNCE_SOFT
= 'BOUNCE_SOFT'
ACTION_FILTER_REMOVE
public
mixed
ACTION_FILTER_REMOVE
= 'FILTER_REMOVE'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
HANDLER_EXCEPTION
public
mixed
HANDLER_EXCEPTION
= 'EXCEPTION'
SCOPE_RECEIVING_EMAILS
public
mixed
SCOPE_RECEIVING_EMAILS
= 'RECEIVING_EMAILS'
SCOPE_RECEIVING_SMS
public
mixed
SCOPE_RECEIVING_SMS
= 'RECEIVING_SMS'
SCOPE_SENDING_EMAILS
public
mixed
SCOPE_SENDING_EMAILS
= 'SENDING_EMAILS'
SCOPE_SENDING_SMS
public
mixed
SCOPE_SENDING_SMS
= 'SENDING_SMS'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['id' => 'id', 'inbox_id' => 'inboxId', 'phone_id' => 'phoneId', 'scope' => 'scope', 'action' => 'action', 'target' => 'target', 'handler' => 'handler', 'active' => 'active', 'created_at' => 'createdAt']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['id' => 'getId', 'inbox_id' => 'getInboxId', 'phone_id' => 'getPhoneId', 'scope' => 'getScope', 'action' => 'getAction', 'target' => 'getTarget', 'handler' => 'getHandler', 'active' => 'getActive', 'created_at' => 'getCreatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'inbox_id' => 'uuid', 'phone_id' => 'uuid', 'scope' => null, 'action' => null, 'target' => null, 'handler' => null, 'active' => null, 'created_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'RulesetDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'inbox_id' => true, 'phone_id' => true, 'scope' => false, 'action' => false, 'target' => false, 'handler' => false, 'active' => false, 'created_at' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['id' => 'string', 'inbox_id' => 'string', 'phone_id' => 'string', 'scope' => 'string', 'action' => 'string', 'target' => 'string', 'handler' => 'string', 'active' => 'bool', 'created_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'inbox_id' => 'setInboxId', 'phone_id' => 'setPhoneId', 'scope' => 'setScope', 'action' => 'setAction', 'target' => 'setTarget', 'handler' => 'setHandler', 'active' => 'setActive', 'created_at' => 'setCreatedAt']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAction()
Gets action
public
getAction() : string
Return values
string —getActionAllowableValues()
Gets allowable values of the enum
public
getActionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getActive()
Gets active
public
getActive() : bool
Return values
bool —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getHandler()
Gets handler
public
getHandler() : string
Return values
string —getHandlerAllowableValues()
Gets allowable values of the enum
public
getHandlerAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getId()
Gets id
public
getId() : string
Return values
string —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneId()
Gets phone_id
public
getPhoneId() : string|null
Return values
string|null —getScope()
Gets scope
public
getScope() : string
Return values
string —getScopeAllowableValues()
Gets allowable values of the enum
public
getScopeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTarget()
Gets target
public
getTarget() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAction()
Sets action
public
setAction(string $action) : self
Parameters
- $action : string
-
action
Return values
self —setActive()
Sets active
public
setActive(bool $active) : self
Parameters
- $active : bool
-
Whether the ruleset is active
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setHandler()
Sets handler
public
setHandler(string $handler) : self
Parameters
- $handler : string
-
handler
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setPhoneId()
Sets phone_id
public
setPhoneId(string|null $phone_id) : self
Parameters
- $phone_id : string|null
-
phone_id
Return values
self —setScope()
Sets scope
public
setScope(string $scope) : self
Parameters
- $scope : string
-
scope
Return values
self —setTarget()
Sets target
public
setTarget(string $target) : self
Parameters
- $target : string
-
target
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>