forge-dashboard-sdk-php

Issue
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Issue 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

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
getAuthor()  : string
Gets author
getCreatedAt()  : DateTime
Gets created_at
getForge()  : Forge
Gets forge
getHousekeeping()  : bool
Gets housekeeping
getLabels()  : array<string|int, Label>
Gets labels
getModelName()  : string
The original name of the model.
getNumber()  : int
Gets number
getRepo()  : string
Gets repo
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTitle()  : string
Gets title
getUpdatedAt()  : DateTime
Gets updated_at
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
setAuthor()  : self
Sets author
setCreatedAt()  : self
Sets created_at
setForge()  : self
Sets forge
setHousekeeping()  : self
Sets housekeeping
setLabels()  : self
Sets labels
setNumber()  : self
Sets number
setRepo()  : self
Sets repo
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitle()  : self
Sets title
setUpdatedAt()  : self
Sets updated_at
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

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

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 = ['forge' => 'forge', 'repo' => 'repo', 'number' => 'number', 'title' => 'title', 'url' => 'url', 'housekeeping' => 'housekeeping', 'author' => 'author', 'labels' => 'labels', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$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', 'repo' => 'getRepo', 'number' => 'getNumber', 'title' => 'getTitle', 'url' => 'getUrl', 'housekeeping' => 'getHousekeeping', 'author' => 'getAuthor', 'labels' => 'getLabels', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['forge' => null, 'repo' => null, 'number' => null, 'title' => null, 'url' => 'uri', 'housekeeping' => null, 'author' => null, 'labels' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'Issue'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['forge' => false, 'repo' => false, 'number' => false, 'title' => false, 'url' => false, 'housekeeping' => false, 'author' => false, 'labels' => false, 'created_at' => false, 'updated_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 = ['forge' => '\ForgeDashboard\Generated\Model\Forge', 'repo' => 'string', 'number' => 'int', 'title' => 'string', 'url' => 'string', 'housekeeping' => 'bool', 'author' => 'string', 'labels' => '\ForgeDashboard\Generated\Model\Label[]', 'created_at' => '\DateTime', 'updated_at' => '\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['forge' => 'setForge', 'repo' => 'setRepo', 'number' => 'setNumber', 'title' => 'setTitle', 'url' => 'setUrl', 'housekeeping' => 'setHousekeeping', 'author' => 'setAuthor', 'labels' => 'setLabels', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']

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>

getAuthor()

Gets author

public getAuthor() : string
Return values
string

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime

getHousekeeping()

Gets housekeeping

public getHousekeeping() : bool
Return values
bool

getLabels()

Gets labels

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNumber()

Gets number

public getNumber() : int
Return values
int

getRepo()

Gets repo

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

getTitle()

Gets title

public getTitle() : string
Return values
string

getUpdatedAt()

Gets updated_at

public getUpdatedAt() : DateTime
Return values
DateTime

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
Tags
link
https://www.php.net/manual/en/jsonserializable.jsonserialize.php
Attributes
#[ReturnTypeWillChange]
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

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>

setAuthor()

Sets author

public setAuthor(string $author) : self
Parameters
$author : string

author

Return values
self

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self

setForge()

Sets forge

public setForge(Forge $forge) : self
Parameters
$forge : Forge

forge

Return values
self

setHousekeeping()

Sets housekeeping

public setHousekeeping(bool $housekeeping) : self
Parameters
$housekeeping : bool

True for an issue a bot keeps open and rewrites, Renovate's "Dependency Dashboard", which is not work for a person. The server decides, so every client lists and counts the same issues. It stays in issues; openIssueCount leaves it out.

Return values
self

setLabels()

Sets labels

public setLabels(array<string|int, Label> $labels) : self
Parameters
$labels : array<string|int, Label>

labels

Return values
self

setNumber()

Sets number

public setNumber(int $number) : self
Parameters
$number : int

number

Return values
self

setRepo()

Sets repo

public setRepo(string $repo) : self
Parameters
$repo : string

repo

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>

setTitle()

Sets title

public setTitle(string $title) : self
Parameters
$title : string

title

Return values
self

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

updated_at

Return values
self

setUrl()

Sets url

public setUrl(string $url) : self
Parameters
$url : string

The real issue URL on its own forge.

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