Component extends HtmlContent
FinalYes
Response type for rendering ajax html content from action
Table of Contents
Constants
- STATUS_DENIED = 'denied'
- STATUS_ERROR = 'error'
- STATUS_SUCCESS = 'success'
Methods
- __construct() : mixed
- Component constructor.
- createDenied() : mixed
- createError() : mixed
- createSuccess() : mixed
- getErrorByCode() : Error
- Getting once error with the necessary code.
- getErrors() : array<string|int, Error>
- Getting array of errors.
- send() : mixed
- setData() : mixed
Constants
STATUS_DENIED
public
mixed
STATUS_DENIED
= 'denied'
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'error'
STATUS_SUCCESS
public
mixed
STATUS_SUCCESS
= 'success'
Methods
__construct()
Component constructor.
public
__construct(string $componentName[, string $componentTemplate = '' ][, array<string|int, mixed> $componentParams = [] ][, array<string|int, mixed> $additionalResponseParams = [] ][, mixed $dataKeys = [] ]) : mixed
Parameters
- $componentName : string
- $componentTemplate : string = ''
- $componentParams : array<string|int, mixed> = []
- $additionalResponseParams : array<string|int, mixed> = []
- $dataKeys : mixed = []
createDenied()
public
final static createDenied([ErrorCollection $errorCollection = null ][, mixed $data = null ]) : mixed
Parameters
- $errorCollection : ErrorCollection = null
- $data : mixed = null
createError()
public
final static createError([ErrorCollection $errorCollection = null ][, mixed $data = null ]) : mixed
Parameters
- $errorCollection : ErrorCollection = null
- $data : mixed = null
createSuccess()
public
final static createSuccess([mixed $data = null ]) : mixed
Parameters
- $data : mixed = null
getErrorByCode()
Getting once error with the necessary code.
public
final getErrorByCode(string $code) : Error
Parameters
- $code : string
-
Code of error.
Return values
ErrorgetErrors()
Getting array of errors.
public
final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>send()
public
send() : mixed
setData()
public
final setData(mixed $data) : mixed
Parameters
- $data : mixed