CreateSharedBrandConfigDTO
extends AbstractBaseDto
in package
CreateSharedBrandConfigDTO
Data Transfer Object for creating a shared brand configuration. Handles the data transformation for the POST endpoint.
Canvas API Documentation: https://canvas.instructure.com/doc/api/shared_brand_configs.html
Table of Contents
Properties
- $brandConfigMd5 : string|null
- MD5 of brand_config to share
- $name : string|null
- Name to share this BrandConfig (theme) as
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- Constructor
- toApiArray() : array<int, array<string, string>>
- Convert DTO to API array format
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
- validate() : void
- Validate the DTO data
Properties
$brandConfigMd5
MD5 of brand_config to share
public
string|null
$brandConfigMd5
= null
$name
Name to share this BrandConfig (theme) as
public
string|null
$name
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= 'shared_brand_config'
The API property name for multipart form data
Methods
__construct()
Constructor
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
-
The data for creating a shared brand config
toApiArray()
Convert DTO to API array format
public
toApiArray() : array<int, array<string, string>>
Return values
array<int, array<string, string>> —The formatted data for the Canvas API
toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>validate()
Validate the DTO data
public
validate() : void