UpdateMigrationIssueDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Data Transfer Object for updating migration issues in Canvas LMS
This DTO handles updating the workflow state of migration issues. The only updateable field is the workflow_state.
Table of Contents
Interfaces
Properties
- $workflowState : string|null
- Set the workflow_state of the issue (required) Allowed values: active, resolved
- $apiPropertyName : string
- The API property name for multipart requests
Methods
- __construct() : mixed
- Constructor
- getWorkflowState() : string|null
- setActive() : void
- Set state to active
- setResolved() : void
- Set state to resolved
- setWorkflowState() : void
- toApiArray() : array<int, array<string, mixed>>
- Transform the DTO to the API-expected array format
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
- validate() : bool
- Validate the DTO
- formatMultipartValue() : mixed
- Format a value for multipart form contents
Properties
$workflowState
Set the workflow_state of the issue (required) Allowed values: active, resolved
public
string|null
$workflowState
= null
$apiPropertyName
The API property name for multipart requests
protected
string
$apiPropertyName
= ''
Methods
__construct()
Constructor
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
getWorkflowState()
public
getWorkflowState() : string|null
Return values
string|nullsetActive()
Set state to active
public
setActive() : void
setResolved()
Set state to resolved
public
setResolved() : void
setWorkflowState()
public
setWorkflowState(string|null $workflowState) : void
Parameters
- $workflowState : string|null
toApiArray()
Transform the DTO to the API-expected array format
public
toApiArray() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>validate()
Validate the DTO
public
validate() : bool
Return values
boolformatMultipartValue()
Format a value for multipart form contents
protected
static formatMultipartValue(mixed $value) : mixed
Booleans must be converted explicitly: Guzzle's multipart encoder string-casts contents, turning false into an empty string instead of 'false', which Canvas may interpret differently than an unset flag.
Parameters
- $value : mixed
-
The value to format