forge-dashboard-sdk-php

BotRequest
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable

BotRequest Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

ACTION_REBASE : mixed = 'rebase'
ACTION_RECREATE : mixed = 'recreate'
BOT_DEPENDABOT : mixed = 'dependabot'
BOT_RENOVATE : mixed = 'renovate'
DISCRIMINATOR : mixed = null
PHASE_EXPIRED : mixed = 'expired'
PHASE_QUEUED : mixed = 'queued'
PHASE_REBASING : mixed = 'rebasing'

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
getBot() : string: Gets bot
getBotAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getExpiresAt() : DateTime: Gets expires_at
getModelName() : string: The original name of the model.
getPhase() : string: Gets phase
getPhaseAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getRequestedAt() : DateTime: Gets requested_at
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
setBot() : self: Sets bot
setExpiresAt() : self: Sets expires_at
setPhase() : self: Sets phase
setRequestedAt() : self: Sets requested_at
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

ACTION_REBASE


    public
        mixed
    ACTION_REBASE
    = 'rebase'

ACTION_RECREATE


    public
        mixed
    ACTION_RECREATE
    = 'recreate'

BOT_DEPENDABOT


    public
        mixed
    BOT_DEPENDABOT
    = 'dependabot'

BOT_RENOVATE


    public
        mixed
    BOT_RENOVATE
    = 'renovate'

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

PHASE_EXPIRED


    public
        mixed
    PHASE_EXPIRED
    = 'expired'

PHASE_QUEUED


    public
        mixed
    PHASE_QUEUED
    = 'queued'

PHASE_REBASING


    public
        mixed
    PHASE_REBASING
    = 'rebasing'

$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
     = ['bot' => 'bot', 'action' => 'action', 'phase' => 'phase', 'requested_at' => 'requestedAt', 'expires_at' => 'expiresAt']

$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
     = ['bot' => 'getBot', 'action' => 'getAction', 'phase' => 'getPhase', 'requested_at' => 'getRequestedAt', 'expires_at' => 'getExpiresAt']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['bot' => null, 'action' => null, 'phase' => null, 'requested_at' => 'date-time', 'expires_at' => 'date-time']

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'BotRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['bot' => false, 'action' => false, 'phase' => false, 'requested_at' => false, 'expires_at' => 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
     = ['bot' => 'string', 'action' => 'string', 'phase' => 'string', 'requested_at' => '\DateTime', 'expires_at' => '\DateTime']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['bot' => 'setBot', 'action' => 'setAction', 'phase' => 'setPhase', 'requested_at' => 'setRequestedAt', 'expires_at' => 'setExpiresAt']

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

getBot()

Gets bot


    public
                    getBot() : string

Return values

string

getBotAllowableValues()

Gets allowable values of the enum


    public
                    getBotAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getExpiresAt()

Gets expires_at


    public
                    getExpiresAt() : DateTime

Return values

DateTime

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getPhase()

Gets phase


    public
                    getPhase() : string

Return values

string

getPhaseAllowableValues()

Gets allowable values of the enum


    public
                    getPhaseAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getRequestedAt()

Gets requested_at


    public
                    getRequestedAt() : DateTime

Return values

DateTime

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

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

#[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: recreate is Dependabot's only. Renovate's rebase label is reported as rebase.

Return values

self

setBot()

Sets bot


    public
                    setBot(string $bot) : self

Parameters

$bot : string: bot

Return values

self

setExpiresAt()

Sets expires_at


    public
                    setExpiresAt(DateTime $expires_at) : self

Parameters

$expires_at : DateTime: When the server stops waiting in the current phase: 5 minutes after the request while queued, 2 minutes after the pickup while rebasing.

Return values

self

setPhase()

Sets phase


    public
                    setPhase(string $phase) : self

Parameters

$phase : string: queued: asked, and nothing seen yet. rebasing: the bot pushed (the head changed, or the pull request was behind and isn't), and CI hasn't restarted yet. expired: the bot didn't act within 5 minutes. An expired request stays until the pull request is gone, a new request replaces it, or an hour passes. A request is dropped once CI shows pending after the push, 2 minutes into rebasing, or when the pull request is gone.

Return values

self

setRequestedAt()

Sets requested_at


    public
                    setRequestedAt(DateTime $requested_at) : self

Parameters

$requested_at : DateTime: requested_at

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

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>

BotRequest in package ForgeDashboard Generated implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

ACTION_REBASE

ACTION_RECREATE

BOT_DEPENDABOT

BOT_RENOVATE

DISCRIMINATOR

PHASE_EXPIRED

PHASE_QUEUED

PHASE_REBASING

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getAction()

Return values

getActionAllowableValues()

Return values

getBot()

Return values

getBotAllowableValues()

Return values

getExpiresAt()

Return values

getModelName()

Return values

getPhase()

Return values

getPhaseAllowableValues()

Return values

getRequestedAt()

Return values

getters()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

openAPITypes()

BotRequest
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable