forge-dashboard-sdk-php

RepoStatus
in package
implements ModelInterface, ArrayAccess, JsonSerializable

RepoStatus Class Doc Comment

Tags
category

Class

description

One tracked repository, whether or not it currently has anything open — repoCount alone can't name it, and it wouldn't otherwise appear anywhere pullRequests/issues don't already mention it.

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
getAutoUpdateBranch()  : bool
Gets auto_update_branch
getCanManageWebhooks()  : bool
Gets can_manage_webhooks
getForge()  : Forge
Gets forge
getFullName()  : string
Gets full_name
getHasWebhook()  : bool
Gets has_webhook
getIgnored()  : bool
Gets ignored
getIgnoredIssues()  : bool
Gets ignored_issues
getIgnoredPrs()  : bool
Gets ignored_prs
getModelName()  : string
The original name of the model.
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
setAutoUpdateBranch()  : self
Sets auto_update_branch
setCanManageWebhooks()  : self
Sets can_manage_webhooks
setForge()  : self
Sets forge
setFullName()  : self
Sets full_name
setHasWebhook()  : self
Sets has_webhook
setIgnored()  : self
Sets ignored
setIgnoredIssues()  : self
Sets ignored_issues
setIgnoredPrs()  : self
Sets ignored_prs
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

Constants

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', 'full_name' => 'fullName', 'url' => 'url', 'ignored' => 'ignored', 'ignored_prs' => 'ignoredPRs', 'ignored_issues' => 'ignoredIssues', 'has_webhook' => 'hasWebhook', 'can_manage_webhooks' => 'canManageWebhooks', 'auto_update_branch' => 'autoUpdateBranch']

$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', 'full_name' => 'getFullName', 'url' => 'getUrl', 'ignored' => 'getIgnored', 'ignored_prs' => 'getIgnoredPrs', 'ignored_issues' => 'getIgnoredIssues', 'has_webhook' => 'getHasWebhook', 'can_manage_webhooks' => 'getCanManageWebhooks', 'auto_update_branch' => 'getAutoUpdateBranch']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['forge' => null, 'full_name' => null, 'url' => 'uri', 'ignored' => null, 'ignored_prs' => null, 'ignored_issues' => null, 'has_webhook' => null, 'can_manage_webhooks' => null, 'auto_update_branch' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'RepoStatus'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['forge' => false, 'full_name' => false, 'url' => false, 'ignored' => false, 'ignored_prs' => false, 'ignored_issues' => false, 'has_webhook' => false, 'can_manage_webhooks' => false, 'auto_update_branch' => 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', 'full_name' => 'string', 'url' => 'string', 'ignored' => 'bool', 'ignored_prs' => 'bool', 'ignored_issues' => 'bool', 'has_webhook' => 'bool', 'can_manage_webhooks' => 'bool', 'auto_update_branch' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['forge' => 'setForge', 'full_name' => 'setFullName', 'url' => 'setUrl', 'ignored' => 'setIgnored', 'ignored_prs' => 'setIgnoredPrs', 'ignored_issues' => 'setIgnoredIssues', 'has_webhook' => 'setHasWebhook', 'can_manage_webhooks' => 'setCanManageWebhooks', 'auto_update_branch' => 'setAutoUpdateBranch']

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>

getAutoUpdateBranch()

Gets auto_update_branch

public getAutoUpdateBranch() : bool
Return values
bool

getCanManageWebhooks()

Gets can_manage_webhooks

public getCanManageWebhooks() : bool
Return values
bool

getFullName()

Gets full_name

public getFullName() : string
Return values
string

getHasWebhook()

Gets has_webhook

public getHasWebhook() : bool
Return values
bool

getIgnored()

Gets ignored

public getIgnored() : bool
Return values
bool

getIgnoredIssues()

Gets ignored_issues

public getIgnoredIssues() : bool
Return values
bool

getIgnoredPrs()

Gets ignored_prs

public getIgnoredPrs() : bool
Return values
bool

getModelName()

The original name of the model.

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

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

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>

setAutoUpdateBranch()

Sets auto_update_branch

public setAutoUpdateBranch(bool $auto_update_branch) : self
Parameters
$auto_update_branch : bool

Whether the signed-in user has turned on automatic branch updates for this repo — any of its pull requests the background refresh finds behind its base branch gets updated the same way a manual "Update branch" click would. A Dependabot pull request gets its own rebase comment instead, and a Renovate one its own rebase label, mirroring their manual action buttons. A release-please pull request is always skipped by this background pass, so no unattended write lands on a release branch. The dashboard's manual "Update branch" button is still offered on it, since release-please has no rebase action of its own.

Return values
self

setCanManageWebhooks()

Sets can_manage_webhooks

public setCanManageWebhooks(bool $can_manage_webhooks) : self
Parameters
$can_manage_webhooks : bool

Whether the signed-in user's own permission on this repo is enough to list/create its webhooks — GitHub requires admin specifically (write/maintain can push but still 404 on the hooks endpoint, by GitHub's own design); Forgejo's equivalent is its own admin permission flag. Always false for a repo reached through an unauthenticated, username-only listing. A point-in-time snapshot: a permission change since the last refresh can still make a following ensure-webhook call fail despite this having said true.

Return values
self

setForge()

Sets forge

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

forge

Return values
self

setFullName()

Sets full_name

public setFullName(string $full_name) : self
Parameters
$full_name : string

full_name

Return values
self

setHasWebhook()

Sets has_webhook

public setHasWebhook(bool $has_webhook) : self
Parameters
$has_webhook : bool

Whether this app has ever recorded a signature-verified webhook delivery for this repo. Passive: it reflects a real delivery having arrived, not whether a webhook object exists on the forge — a correctly configured webhook that just hasn't fired yet still reads false here, the same as a misconfigured one would.

Return values
self

setIgnored()

Sets ignored

public setIgnored(bool $ignored) : self
Parameters
$ignored : bool

Whether the signed-in user has ignored this repo in either scope below — true whenever ignoredPRs or ignoredIssues is true. The repo itself still appears here with accurate hasWebhook/canManageWebhooks regardless.

Return values
self

setIgnoredIssues()

Sets ignored_issues

public setIgnoredIssues(bool $ignored_issues) : self
Parameters
$ignored_issues : bool

Whether the signed-in user has ignored this repo's issues specifically — its issues entries are excluded from this same response and from Insights.

Return values
self

setIgnoredPrs()

Sets ignored_prs

public setIgnoredPrs(bool $ignored_prs) : self
Parameters
$ignored_prs : bool

Whether the signed-in user has ignored this repo's pull requests specifically — its pullRequests entries are excluded from this same response and from Insights.

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

The repo's own page on its forge, for linking out.

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