forge-dashboard-sdk-php

Check
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable

Check Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

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
getDurationSeconds() : int|null: Gets duration_seconds
getExcerpt() : string|null: Gets excerpt
getFailedStep() : string|null: Gets failed_step
getModelName() : string: The original name of the model.
getName() : string: Gets name
getRequired() : bool|null: Gets required
getState() : CheckState: Gets state
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUrl() : string: Gets url
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
setDurationSeconds() : self: Sets duration_seconds
setExcerpt() : self: Sets excerpt
setFailedStep() : self: Sets failed_step
setName() : self: Sets name
setRequired() : self: Sets required
setState() : self: Sets state
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setUrl() : self: Sets url
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$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
     = ['name' => 'name', 'state' => 'state', 'url' => 'url', 'required' => 'required', 'duration_seconds' => 'durationSeconds', 'failed_step' => 'failedStep', 'excerpt' => 'excerpt']

$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
     = ['name' => 'getName', 'state' => 'getState', 'url' => 'getUrl', 'required' => 'getRequired', 'duration_seconds' => 'getDurationSeconds', 'failed_step' => 'getFailedStep', 'excerpt' => 'getExcerpt']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['name' => null, 'state' => null, 'url' => null, 'required' => null, 'duration_seconds' => null, 'failed_step' => null, 'excerpt' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'Check'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['name' => false, 'state' => false, 'url' => false, 'required' => false, 'duration_seconds' => false, 'failed_step' => false, 'excerpt' => 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
     = ['name' => 'string', 'state' => '\ForgeDashboard\Generated\Model\CheckState', 'url' => 'string', 'required' => 'bool', 'duration_seconds' => 'int', 'failed_step' => 'string', 'excerpt' => 'string']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['name' => 'setName', 'state' => 'setState', 'url' => 'setUrl', 'required' => 'setRequired', 'duration_seconds' => 'setDurationSeconds', 'failed_step' => 'setFailedStep', 'excerpt' => 'setExcerpt']

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

getDurationSeconds()

Gets duration_seconds


    public
                    getDurationSeconds() : int|null

Return values

int|null

getExcerpt()

Gets excerpt


    public
                    getExcerpt() : string|null

Return values

string|null

getFailedStep()

Gets failed_step


    public
                    getFailedStep() : string|null

Return values

string|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getName()

Gets name


    public
                    getName() : string

Return values

string

getRequired()

Gets required


    public
                    getRequired() : bool|null

Return values

bool|null

getState()

Gets state


    public
                    getState() : CheckState

Return values

CheckState

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getUrl()

Gets url


    public
                    getUrl() : string

Return values

string

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>

setDurationSeconds()

Sets duration_seconds


    public
                    setDurationSeconds(int|null $duration_seconds) : self

Parameters

$duration_seconds : int|null: How long a completed check ran. Absent while it runs, or when the forge doesn't say. GitHub only: Forgejo's API doesn't give a job's timing.

Return values

self

setExcerpt()

Sets excerpt


    public
                    setExcerpt(string|null $excerpt) : self

Parameters

$excerpt : string|null: The tail of the failed job's log as plain text: the last lines, with per-line timestamps and colour codes removed, at most 2,000 characters. Never markup, and a client must render it as text. Whatever the forge already masks stays masked. Absent when the log can't be read or has expired. GitHub only: Forgejo's API doesn't serve job logs, so there the link to the run is all a failed check offers.

Return values

self

setFailedStep()

Sets failed_step


    public
                    setFailedStep(string|null $failed_step) : self

Parameters

$failed_step : string|null: The name of the step of a failed job that broke. Absent when the check isn't a job the token can read (a third-party check, a forge with no step data, a token without access).

Return values

self

setName()

Sets name


    public
                    setName(string $name) : self

Parameters

$name : string: name

Return values

self

setRequired()

Sets required


    public
                    setRequired(bool|null $required) : self

Parameters

$required : bool|null: Whether the base branch's protection makes this check block the merge (GitHub required status checks and rulesets, Forgejo status_check_contexts). Absent when the forge can't tell — a token that can't read protection, or a check that can't be mapped to a protection entry. Absent is not the same as false.

Return values

self

setState()

Sets state


    public
                    setState(CheckState $state) : self

Parameters

$state : CheckState: state

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>

setUrl()

Sets url


    public
                    setUrl(string $url) : self

Parameters

$url : string: That job's own page on the forge that ran it — never the pull request's own page.

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>

Check in package ForgeDashboard Generated implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getDurationSeconds()

Return values

getExcerpt()

Return values

getFailedStep()

Return values

getModelName()

Return values

getName()

Return values

getRequired()

Return values

getState()

Return values

getters()

Return values

getUrl()

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

Return values

setDurationSeconds()

Parameters

Return values

setExcerpt()

Parameters

Return values

setFailedStep()

Parameters

Check
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable