forge-dashboard-sdk-php

ForgeHealth
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable

ForgeHealth 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
getDependabotCommandsBlocked() : string|null: Gets dependabot_commands_blocked
getError() : string|null: Gets error
getErrorKind() : ForgeErrorKind|null: Gets error_kind
getForge() : Forge: Gets forge
getModelName() : string: The original name of the model.
getRateLimitGraphQl() : RateLimit|null: Gets rate_limit_graph_ql
getRateLimitRest() : RateLimit|null: Gets rate_limit_rest
getReachable() : bool: Gets reachable
getRepoCount() : int: Gets repo_count
getStaleSince() : DateTime|null: Gets stale_since
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
setDependabotCommandsBlocked() : self: Sets dependabot_commands_blocked
setError() : self: Sets error
setErrorKind() : self: Sets error_kind
setForge() : self: Sets forge
setRateLimitGraphQl() : self: Sets rate_limit_graph_ql
setRateLimitRest() : self: Sets rate_limit_rest
setReachable() : self: Sets reachable
setRepoCount() : self: Sets repo_count
setStaleSince() : self: Sets stale_since
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

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
     = ['forge' => 'forge', 'reachable' => 'reachable', 'stale_since' => 'staleSince', 'error' => 'error', 'error_kind' => 'errorKind', 'repo_count' => 'repoCount', 'rate_limit_graph_ql' => 'rateLimitGraphQL', 'rate_limit_rest' => 'rateLimitREST', 'dependabot_commands_blocked' => 'dependabotCommandsBlocked']

$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
     = ['forge' => 'getForge', 'reachable' => 'getReachable', 'stale_since' => 'getStaleSince', 'error' => 'getError', 'error_kind' => 'getErrorKind', 'repo_count' => 'getRepoCount', 'rate_limit_graph_ql' => 'getRateLimitGraphQl', 'rate_limit_rest' => 'getRateLimitRest', 'dependabot_commands_blocked' => 'getDependabotCommandsBlocked']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['forge' => null, 'reachable' => null, 'stale_since' => 'date-time', 'error' => null, 'error_kind' => null, 'repo_count' => null, 'rate_limit_graph_ql' => null, 'rate_limit_rest' => null, 'dependabot_commands_blocked' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'ForgeHealth'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['forge' => false, 'reachable' => false, 'stale_since' => false, 'error' => false, 'error_kind' => false, 'repo_count' => false, 'rate_limit_graph_ql' => false, 'rate_limit_rest' => false, 'dependabot_commands_blocked' => 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
     = ['forge' => '\ForgeDashboard\Generated\Model\Forge', 'reachable' => 'bool', 'stale_since' => '\DateTime', 'error' => 'string', 'error_kind' => '\ForgeDashboard\Generated\Model\ForgeErrorKind', 'repo_count' => 'int', 'rate_limit_graph_ql' => '\ForgeDashboard\Generated\Model\RateLimit', 'rate_limit_rest' => '\ForgeDashboard\Generated\Model\RateLimit', 'dependabot_commands_blocked' => 'string']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['forge' => 'setForge', 'reachable' => 'setReachable', 'stale_since' => 'setStaleSince', 'error' => 'setError', 'error_kind' => 'setErrorKind', 'repo_count' => 'setRepoCount', 'rate_limit_graph_ql' => 'setRateLimitGraphQl', 'rate_limit_rest' => 'setRateLimitRest', 'dependabot_commands_blocked' => 'setDependabotCommandsBlocked']

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

getDependabotCommandsBlocked()

Gets dependabot_commands_blocked


    public
                    getDependabotCommandsBlocked() : string|null

Return values

string|null

getError()

Gets error


    public
                    getError() : string|null

Return values

string|null

getErrorKind()

Gets error_kind


    public
                    getErrorKind() : ForgeErrorKind|null

Return values

ForgeErrorKind|null

getForge()

Gets forge


    public
                    getForge() : Forge

Return values

Forge

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getRateLimitGraphQl()

Gets rate_limit_graph_ql


    public
                    getRateLimitGraphQl() : RateLimit|null

Return values

RateLimit|null

getRateLimitRest()

Gets rate_limit_rest


    public
                    getRateLimitRest() : RateLimit|null

Return values

RateLimit|null

getReachable()

Gets reachable


    public
                    getReachable() : bool

Return values

bool

getRepoCount()

Gets repo_count


    public
                    getRepoCount() : int

Return values

int

getStaleSince()

Gets stale_since


    public
                    getStaleSince() : DateTime|null

Return values

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

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>

setDependabotCommandsBlocked()

Sets dependabot_commands_blocked


    public
                    setDependabotCommandsBlocked(string|null $dependabot_commands_blocked) : self

Parameters

$dependabot_commands_blocked : string|null: Why a "@dependabot" comment sent through this forge's credential would be refused. Dependabot only honours commands from a user with push access and ignores GitHub App accounts whatever permissions the App holds. Set only for GitHub when the connected credential is an App with no personal access token saved to send commands as. The Dependabot buttons lock with this text, auto-update-branch skips Dependabot pull requests, and the dependabot-action endpoint answers 409 with it. Omitted when commands work.

Return values

self

setError()

Sets error


    public
                    setError(string|null $error) : self

Parameters

$error : string|null: A human-readable explanation of the last failure, if reachable is false. Mapped from errorKind, not the raw underlying error text. Omitted when reachable.

Return values

self

setErrorKind()

Sets error_kind


    public
                    setErrorKind(ForgeErrorKind|null $error_kind) : self

Parameters

$error_kind : ForgeErrorKind|null: error_kind

Return values

self

setForge()

Sets forge


    public
                    setForge(Forge $forge) : self

Parameters

$forge : Forge: forge

Return values

self

setRateLimitGraphQl()

Sets rate_limit_graph_ql


    public
                    setRateLimitGraphQl(RateLimit|null $rate_limit_graph_ql) : self

Parameters

$rate_limit_graph_ql : RateLimit|null: GitHub's GraphQL budget — a completely separate 5000/hour allowance from rateLimitREST, populated from the rateLimit block GitHub embeds in every GraphQL response. Never set for a forge with no GraphQL API (Forgejo).

Return values

self

setRateLimitRest()

Sets rate_limit_rest


    public
                    setRateLimitRest(RateLimit|null $rate_limit_rest) : self

Parameters

$rate_limit_rest : RateLimit|null: The forge's REST budget, from real X-RateLimit-* response headers. For GitHub, this is checkWebhooks and every write action (merge, update branch, comment, label) — a different 5000/hour allowance from rateLimitGraphQL, not a duplicate of it. Omitted on a poll that made no REST call at all (no webhook path configured). For Forgejo, or any forge reached through GenericSource, this is the only budget there is to report — GenericSource makes exclusively REST-style calls.

Return values

self

setReachable()

Sets reachable


    public
                    setReachable(bool $reachable) : self

Parameters

$reachable : bool: Whether the last refresh attempt against this forge succeeded.

Return values

self

setRepoCount()

Sets repo_count


    public
                    setRepoCount(int $repo_count) : self

Parameters

$repo_count : int: Repositories with write access this forge reported.

Return values

self

setStaleSince()

Sets stale_since


    public
                    setStaleSince(DateTime|null $stale_since) : self

Parameters

$stale_since : DateTime|null: Present when the last refresh against this forge failed and the pull requests, issues and repos in the response are the last good ones, fetched at this time, instead of none. Absent when the data is current, and for a forge that has never fetched successfully, which has nothing to show. A client can say "unreachable, showing data from 3 minutes ago".

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>

ForgeHealth 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

getDependabotCommandsBlocked()

Return values

getError()

Return values

getErrorKind()

Return values

getForge()

Return values

getModelName()

Return values

getRateLimitGraphQl()

Return values

getRateLimitRest()

Return values

getReachable()

Return values

getRepoCount()

Return values

getStaleSince()

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

Return values

setDependabotCommandsBlocked()

Parameters

Return values

setError()

ForgeHealth
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable