forge-dashboard-sdk-php

Dashboard
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable

Dashboard 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
getForges() : array<string|int, ForgeHealth>: Gets forges
getGeneratedAt() : DateTime: Gets generated_at
getHiddenDrafts() : int: Gets hidden_drafts
getIssues() : array<string|int, Issue>: Gets issues
getModelName() : string: The original name of the model.
getOpenIssueCount() : int: Gets open_issue_count
getPullRequests() : array<string|int, PullRequest>: Gets pull_requests
getRepos() : array<string|int, RepoStatus>: Gets repos
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
setForges() : self: Sets forges
setGeneratedAt() : self: Sets generated_at
setHiddenDrafts() : self: Sets hidden_drafts
setIssues() : self: Sets issues
setOpenIssueCount() : self: Sets open_issue_count
setPullRequests() : self: Sets pull_requests
setRepos() : self: Sets repos
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
     = ['open_issue_count' => 'openIssueCount', 'generated_at' => 'generatedAt', 'hidden_drafts' => 'hiddenDrafts', 'forges' => 'forges', 'pull_requests' => 'pullRequests', 'issues' => 'issues', 'repos' => 'repos']

$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
     = ['open_issue_count' => 'getOpenIssueCount', 'generated_at' => 'getGeneratedAt', 'hidden_drafts' => 'getHiddenDrafts', 'forges' => 'getForges', 'pull_requests' => 'getPullRequests', 'issues' => 'getIssues', 'repos' => 'getRepos']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['open_issue_count' => null, 'generated_at' => 'date-time', 'hidden_drafts' => null, 'forges' => null, 'pull_requests' => null, 'issues' => null, 'repos' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'Dashboard'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['open_issue_count' => false, 'generated_at' => false, 'hidden_drafts' => false, 'forges' => false, 'pull_requests' => false, 'issues' => false, 'repos' => 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
     = ['open_issue_count' => 'int', 'generated_at' => '\DateTime', 'hidden_drafts' => 'int', 'forges' => '\ForgeDashboard\Generated\Model\ForgeHealth[]', 'pull_requests' => '\ForgeDashboard\Generated\Model\PullRequest[]', 'issues' => '\ForgeDashboard\Generated\Model\Issue[]', 'repos' => '\ForgeDashboard\Generated\Model\RepoStatus[]']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['open_issue_count' => 'setOpenIssueCount', 'generated_at' => 'setGeneratedAt', 'hidden_drafts' => 'setHiddenDrafts', 'forges' => 'setForges', 'pull_requests' => 'setPullRequests', 'issues' => 'setIssues', 'repos' => 'setRepos']

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

getForges()

Gets forges


    public
                    getForges() : array<string|int, ForgeHealth>

Return values

array<string|int, ForgeHealth>

getGeneratedAt()

Gets generated_at


    public
                    getGeneratedAt() : DateTime

Return values

DateTime

getHiddenDrafts()

Gets hidden_drafts


    public
                    getHiddenDrafts() : int

Return values

int

getIssues()

Gets issues


    public
                    getIssues() : array<string|int, Issue>

Return values

array<string|int, Issue>

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getOpenIssueCount()

Gets open_issue_count


    public
                    getOpenIssueCount() : int

Return values

int

getPullRequests()

Gets pull_requests


    public
                    getPullRequests() : array<string|int, PullRequest>

Return values

array<string|int, PullRequest>

getRepos()

Gets repos


    public
                    getRepos() : array<string|int, RepoStatus>

Return values

array<string|int, RepoStatus>

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>

setForges()

Sets forges


    public
                    setForges(array<string|int, ForgeHealth> $forges) : self

Parameters

$forges : array<string|int, ForgeHealth>: forges

Return values

self

setGeneratedAt()

Sets generated_at


    public
                    setGeneratedAt(DateTime $generated_at) : self

Parameters

$generated_at : DateTime: When this snapshot was refreshed, not when it was requested.

Return values

self

setHiddenDrafts()

Sets hidden_drafts


    public
                    setHiddenDrafts(int $hidden_drafts) : self

Parameters

$hidden_drafts : int: How many draft pull requests pullRequests leaves out. Always present, and 0 when the request set includeDrafts=true, so a client can render "N hidden" without a special case. Drafts in a repo the account ignores aren't counted, since none of that repo's pull requests show.

Return values

self

setIssues()

Sets issues


    public
                    setIssues(array<string|int, Issue> $issues) : self

Parameters

$issues : array<string|int, Issue>: issues

Return values

self

setOpenIssueCount()

Sets open_issue_count


    public
                    setOpenIssueCount(int $open_issue_count) : self

Parameters

$open_issue_count : int: How many of issues are real work: all of them except the housekeeping ones. What the Issues badge shows.

Return values

self

setPullRequests()

Sets pull_requests


    public
                    setPullRequests(array<string|int, PullRequest> $pull_requests) : self

Parameters

$pull_requests : array<string|int, PullRequest>: pull_requests

Return values

self

setRepos()

Sets repos


    public
                    setRepos(array<string|int, RepoStatus> $repos) : self

Parameters

$repos : array<string|int, RepoStatus>: repos

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>

Dashboard 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

getForges()

Return values

getGeneratedAt()

Return values

getHiddenDrafts()

Return values

getIssues()

Return values

getModelName()

Return values

getOpenIssueCount()

Return values

getPullRequests()

Return values

getRepos()

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

setForges()

Parameters

Return values

setGeneratedAt()

Parameters

Return values

setHiddenDrafts()

Parameters

Dashboard
in package

ForgeDashboard

Generated

implements ModelInterface, ArrayAccess, JsonSerializable