forge-dashboard-sdk-php

ReviewState
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ReviewState Class Doc Comment

Tags
category

Class

description

Where a pull request stands on code review. The whole object is omitted when the owning forge couldn't report it (a Forgejo reviews call that failed, a draft Forgejo pull request this service doesn't spend a call on), so a missing "review" means "unknown" and never "nobody reviewed it." GitHub: read from fields on the existing GraphQL query (reviewDecision, reviewRequests, latestReviews), so it adds no per-pull-request requests. Forgejo: requestedReviewers comes free on the pull request list, but approvals and the decision need one reviews call per open, non-draft pull request, cached until that pull request's updatedAt changes.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DECISION_APPROVED  : mixed = 'approved'
DECISION_CHANGES_REQUESTED  : mixed = 'changes_requested'
DECISION_NONE  : mixed = 'none'
DECISION_REVIEW_REQUIRED  : mixed = 'review_required'
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
getApprovals()  : int
Gets approvals
getDecision()  : string
Gets decision
getDecisionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getRequestedReviewers()  : int
Gets requested_reviewers
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
setApprovals()  : self
Sets approvals
setDecision()  : self
Sets decision
setRequestedReviewers()  : self
Sets requested_reviewers
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

Constants

DECISION_APPROVED

public mixed DECISION_APPROVED = 'approved'

DECISION_CHANGES_REQUESTED

public mixed DECISION_CHANGES_REQUESTED = 'changes_requested'

DECISION_REVIEW_REQUIRED

public mixed DECISION_REVIEW_REQUIRED = 'review_required'

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 = ['decision' => 'decision', 'approvals' => 'approvals', 'requested_reviewers' => 'requestedReviewers']

$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 = ['decision' => 'getDecision', 'approvals' => 'getApprovals', 'requested_reviewers' => 'getRequestedReviewers']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['decision' => null, 'approvals' => null, 'requested_reviewers' => 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 = 'ReviewState'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['decision' => false, 'approvals' => false, 'requested_reviewers' => 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 = ['decision' => 'string', 'approvals' => 'int', 'requested_reviewers' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['decision' => 'setDecision', 'approvals' => 'setApprovals', 'requested_reviewers' => 'setRequestedReviewers']

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>

getApprovals()

Gets approvals

public getApprovals() : int
Return values
int

getDecision()

Gets decision

public getDecision() : string
Return values
string

getDecisionAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRequestedReviewers()

Gets requested_reviewers

public getRequestedReviewers() : int
Return values
int

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

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>

setApprovals()

Sets approvals

public setApprovals(int $approvals) : self
Parameters
$approvals : int

Reviewers whose latest review is an approval. GitHub counts at most the 10 most recent reviewers.

Return values
self

setDecision()

Sets decision

public setDecision(string $decision) : self
Parameters
$decision : string

"approved" and "changes_requested" mean what they say. "review_required" means a review is still outstanding: GitHub says so itself when branch protection requires one, and on Forgejo it means reviewers are requested and nobody has approved. "none" means no review activity and nothing required or requested.

Return values
self

setRequestedReviewers()

Sets requested_reviewers

public setRequestedReviewers(int $requested_reviewers) : self
Parameters
$requested_reviewers : int

Users and teams still asked to review.

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>
On this page

Search results