AuditLogSearchOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AuditLogSearchOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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|null
- Gets action
- getActorUserId() : string|null
- Gets actor_user_id
- getBefore() : DateTime|null
- Gets before
- getCursor() : string|null
- Gets cursor
- getEventId() : string|null
- Gets event_id
- getIpAddress() : string|null
- Gets ip_address
- getModelName() : string
- The original name of the model.
- getOutcome() : string|null
- Gets outcome
- getPageSize() : int|null
- Gets page_size
- getRequestId() : string|null
- Gets request_id
- getResourceId() : string|null
- Gets resource_id
- getResourceType() : string|null
- Gets resource_type
- getSince() : DateTime|null
- Gets since
- getTargetUserId() : string|null
- Gets target_user_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserId() : string|null
- Gets user_id
- 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
- setActorUserId() : self
- Sets actor_user_id
- setBefore() : self
- Sets before
- setCursor() : self
- Sets cursor
- setEventId() : self
- Sets event_id
- setIpAddress() : self
- Sets ip_address
- setOutcome() : self
- Sets outcome
- setPageSize() : self
- Sets page_size
- setRequestId() : self
- Sets request_id
- setResourceId() : self
- Sets resource_id
- setResourceType() : self
- Sets resource_type
- setSince() : self
- Sets since
- setTargetUserId() : self
- Sets target_user_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserId() : self
- Sets user_id
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['since' => 'since', 'before' => 'before', 'action' => 'action', 'user_id' => 'userId', 'actor_user_id' => 'actorUserId', 'target_user_id' => 'targetUserId', 'resource_type' => 'resourceType', 'resource_id' => 'resourceId', 'outcome' => 'outcome', 'request_id' => 'requestId', 'ip_address' => 'ipAddress', 'event_id' => 'eventId', 'page_size' => 'pageSize', 'cursor' => 'cursor']
$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
= ['since' => 'getSince', 'before' => 'getBefore', 'action' => 'getAction', 'user_id' => 'getUserId', 'actor_user_id' => 'getActorUserId', 'target_user_id' => 'getTargetUserId', 'resource_type' => 'getResourceType', 'resource_id' => 'getResourceId', 'outcome' => 'getOutcome', 'request_id' => 'getRequestId', 'ip_address' => 'getIpAddress', 'event_id' => 'getEventId', 'page_size' => 'getPageSize', 'cursor' => 'getCursor']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['since' => 'date-time', 'before' => 'date-time', 'action' => null, 'user_id' => 'uuid', 'actor_user_id' => 'uuid', 'target_user_id' => 'uuid', 'resource_type' => null, 'resource_id' => null, 'outcome' => null, 'request_id' => null, 'ip_address' => null, 'event_id' => null, 'page_size' => 'int32', 'cursor' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AuditLogSearchOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['since' => true, 'before' => true, 'action' => true, 'user_id' => true, 'actor_user_id' => true, 'target_user_id' => true, 'resource_type' => true, 'resource_id' => true, 'outcome' => true, 'request_id' => true, 'ip_address' => true, 'event_id' => true, 'page_size' => true, 'cursor' => true]
$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
= ['since' => '\\DateTime', 'before' => '\\DateTime', 'action' => 'string', 'user_id' => 'string', 'actor_user_id' => 'string', 'target_user_id' => 'string', 'resource_type' => 'string', 'resource_id' => 'string', 'outcome' => 'string', 'request_id' => 'string', 'ip_address' => 'string', 'event_id' => 'string', 'page_size' => 'int', 'cursor' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['since' => 'setSince', 'before' => 'setBefore', 'action' => 'setAction', 'user_id' => 'setUserId', 'actor_user_id' => 'setActorUserId', 'target_user_id' => 'setTargetUserId', 'resource_type' => 'setResourceType', 'resource_id' => 'setResourceId', 'outcome' => 'setOutcome', 'request_id' => 'setRequestId', 'ip_address' => 'setIpAddress', 'event_id' => 'setEventId', 'page_size' => 'setPageSize', 'cursor' => 'setCursor']
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|null
Return values
string|null —getActorUserId()
Gets actor_user_id
public
getActorUserId() : string|null
Return values
string|null —getBefore()
Gets before
public
getBefore() : DateTime|null
Return values
DateTime|null —getCursor()
Gets cursor
public
getCursor() : string|null
Return values
string|null —getEventId()
Gets event_id
public
getEventId() : string|null
Return values
string|null —getIpAddress()
Gets ip_address
public
getIpAddress() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOutcome()
Gets outcome
public
getOutcome() : string|null
Return values
string|null —getPageSize()
Gets page_size
public
getPageSize() : int|null
Return values
int|null —getRequestId()
Gets request_id
public
getRequestId() : string|null
Return values
string|null —getResourceId()
Gets resource_id
public
getResourceId() : string|null
Return values
string|null —getResourceType()
Gets resource_type
public
getResourceType() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime|null
Return values
DateTime|null —getTargetUserId()
Gets target_user_id
public
getTargetUserId() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUserId()
Gets user_id
public
getUserId() : string|null
Return values
string|null —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|null $action) : self
Parameters
- $action : string|null
-
action
Return values
self —setActorUserId()
Sets actor_user_id
public
setActorUserId(string|null $actor_user_id) : self
Parameters
- $actor_user_id : string|null
-
actor_user_id
Return values
self —setBefore()
Sets before
public
setBefore(DateTime|null $before) : self
Parameters
- $before : DateTime|null
-
before
Return values
self —setCursor()
Sets cursor
public
setCursor(string|null $cursor) : self
Parameters
- $cursor : string|null
-
cursor
Return values
self —setEventId()
Sets event_id
public
setEventId(string|null $event_id) : self
Parameters
- $event_id : string|null
-
event_id
Return values
self —setIpAddress()
Sets ip_address
public
setIpAddress(string|null $ip_address) : self
Parameters
- $ip_address : string|null
-
ip_address
Return values
self —setOutcome()
Sets outcome
public
setOutcome(string|null $outcome) : self
Parameters
- $outcome : string|null
-
outcome
Return values
self —setPageSize()
Sets page_size
public
setPageSize(int|null $page_size) : self
Parameters
- $page_size : int|null
-
page_size
Return values
self —setRequestId()
Sets request_id
public
setRequestId(string|null $request_id) : self
Parameters
- $request_id : string|null
-
request_id
Return values
self —setResourceId()
Sets resource_id
public
setResourceId(string|null $resource_id) : self
Parameters
- $resource_id : string|null
-
resource_id
Return values
self —setResourceType()
Sets resource_type
public
setResourceType(string|null $resource_type) : self
Parameters
- $resource_type : string|null
-
resource_type
Return values
self —setSince()
Sets since
public
setSince(DateTime|null $since) : self
Parameters
- $since : DateTime|null
-
since
Return values
self —setTargetUserId()
Sets target_user_id
public
setTargetUserId(string|null $target_user_id) : self
Parameters
- $target_user_id : string|null
-
target_user_id
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> —setUserId()
Sets user_id
public
setUserId(string|null $user_id) : self
Parameters
- $user_id : string|null
-
user_id
Return values
self —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>