hush-hush

AuditLogEntry
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AuditLogEntry Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

ACTION_CREATE  : mixed = 'create'
ACTION_DELETE  : mixed = 'delete'
ACTION_READ  : mixed = 'read'
ACTION_UPDATE  : mixed = 'update'
ACTOR_TYPE_CONSUMER_TOKEN  : mixed = 'consumer_token'
ACTOR_TYPE_SESSION  : mixed = 'session'
ACTOR_TYPE_TOKEN  : mixed = 'token'
DISCRIMINATOR  : mixed = null

Properties

$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, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
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)

Methods

__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
getActorId()  : string|null
Gets actor_id
getActorType()  : string|null
Gets actor_type
getActorTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCaller()  : string|null
Gets caller
getId()  : int
Gets id
getIp()  : string
Gets ip
getModelName()  : string
The original name of the model.
getObjectId()  : string
Gets object_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimestamp()  : DateTime
Gets timestamp
getVariantId()  : string|null
Gets variant_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
setActorId()  : self
Sets actor_id
setActorType()  : self
Sets actor_type
setCaller()  : self
Sets caller
setId()  : self
Sets id
setIp()  : self
Sets ip
setObjectId()  : self
Sets object_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimestamp()  : self
Sets timestamp
setVariantId()  : self
Sets variant_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

ACTOR_TYPE_CONSUMER_TOKEN

public mixed ACTOR_TYPE_CONSUMER_TOKEN = 'consumer_token'

ACTOR_TYPE_SESSION

public mixed ACTOR_TYPE_SESSION = 'session'

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', 'object_id' => 'object_id', 'variant_id' => 'variant_id', 'action' => 'action', 'timestamp' => 'timestamp', 'caller' => 'caller', 'ip' => 'ip', 'actor_type' => 'actor_type', 'actor_id' => 'actor_id']

$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', 'object_id' => 'getObjectId', 'variant_id' => 'getVariantId', 'action' => 'getAction', 'timestamp' => 'getTimestamp', 'caller' => 'getCaller', 'ip' => 'getIp', 'actor_type' => 'getActorType', 'actor_id' => 'getActorId']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['id' => 'int64', 'object_id' => null, 'variant_id' => 'uuid', 'action' => null, 'timestamp' => 'date-time', 'caller' => null, 'ip' => null, 'actor_type' => null, 'actor_id' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'AuditLogEntry'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['id' => false, 'object_id' => false, 'variant_id' => false, 'action' => false, 'timestamp' => false, 'caller' => false, 'ip' => false, 'actor_type' => false, 'actor_id' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, bool> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['id' => 'int', 'object_id' => 'string', 'variant_id' => 'string', 'action' => 'string', 'timestamp' => '\DateTime', 'caller' => 'string', 'ip' => 'string', 'actor_type' => 'string', 'actor_id' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['id' => 'setId', 'object_id' => 'setObjectId', 'variant_id' => 'setVariantId', 'action' => 'setAction', 'timestamp' => 'setTimestamp', 'caller' => 'setCaller', 'ip' => 'setIp', 'actor_type' => 'setActorType', 'actor_id' => 'setActorId']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

Associated array of property values initializing the model

__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>

getActorId()

Gets actor_id

public getActorId() : string|null
Return values
string|null

getActorType()

Gets actor_type

public getActorType() : string|null
Return values
string|null

getActorTypeAllowableValues()

Gets allowable values of the enum

public getActorTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getCaller()

Gets caller

public getCaller() : string|null
Return values
string|null

getIp()

Gets ip

public getIp() : string
Return values
string

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getObjectId()

Gets object_id

public getObjectId() : 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>

getTimestamp()

Gets timestamp

public getTimestamp() : DateTime
Return values
DateTime

getVariantId()

Gets variant_id

public getVariantId() : 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

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|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
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

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

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

setActorId()

Sets actor_id

public setActorId(string|null $actor_id) : self
Parameters
$actor_id : string|null

The specific token id or admin account this call was authenticated as - absent for an unauthenticated read.

Return values
self

setActorType()

Sets actor_type

public setActorType(string|null $actor_type) : self
Parameters
$actor_type : string|null

The kind of verified credential that authenticated this call - absent for an unauthenticated read. Unlike caller, this is never self-reported.

Return values
self

setCaller()

Sets caller

public setCaller(string|null $caller) : self
Parameters
$caller : string|null

The caller's presented identity, if any.

Return values
self

setId()

Sets id

public setId(int $id) : self
Parameters
$id : int

This entry's own id - stable and strictly increasing, so it doubles as the cursor for the after query parameter.

Return values
self

setIp()

Sets ip

public setIp(string $ip) : self
Parameters
$ip : string

The request's source IP. Unlike caller, this is never self-reported - it's the one piece of the request nobody gets to lie about via a header. Currently the immediate TCP peer's address; this service isn't deployed behind a reverse proxy or load balancer, so X-Forwarded-For (or similar) support isn't implemented yet.

Return values
self

setObjectId()

Sets object_id

public setObjectId(string $object_id) : self
Parameters
$object_id : string

A caller-chosen, unique identifier for an object - what every documented request path (URL, CLI, API) addresses it by. Letters of either case, digits, _ and -, starting with a letter or digit; names are case-sensitive, so Api_Token and api_token are two secrets. Create and rename follow the same rule. The object's internal id is a separate, opaque value never exposed to or accepted from a caller (specs/secret-objects/spec.md's "Internal id decoupled from user-facing slug" requirement).

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>

setTimestamp()

Sets timestamp

public setTimestamp(DateTime $timestamp) : self
Parameters
$timestamp : DateTime

timestamp

Return values
self

setVariantId()

Sets variant_id

public setVariantId(string|null $variant_id) : self
Parameters
$variant_id : string|null

The UUID of the object the entry is about. object_id is only its name, which several variants can share. Left out of an entry written before this was recorded.

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

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>
On this page

Search results