PasswordResetDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Data Transfer Object for password reset request
Table of Contents
Interfaces
Properties
- $email : string|null
- The user's email address to send password recovery to
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- BaseDto constructor.
- getEmail() : string|null
- setEmail() : void
- toApiArray() : array<string|int, array{name: string, contents: string}>
- Transform DTO properties to Canvas API multipart format
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
- validateParameters() : void
- Validate parameters
Properties
The user's email address to send password recovery to
public
string|null
$email
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= ''
Methods
__construct()
BaseDto constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
getEmail()
public
getEmail() : string|null
Return values
string|nullsetEmail()
public
setEmail(string|null $email) : void
Parameters
- $email : string|null
toApiArray()
Transform DTO properties to Canvas API multipart format
public
toApiArray() : array<string|int, array{name: string, contents: string}>
Return values
array<string|int, array{name: string, contents: string}>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>validateParameters()
Validate parameters
private
validateParameters() : void