View
extends ViewBase
in package
Base class for all views
Table of Contents
- ERROR_CODE = 'error-code'
- Template variable
- ERROR_MESSAGE = 'error-message'
- Template variable
- SUCCESS_MESSAGE = 'success-message'
- Template variable
- $errorCode : int
- Error code
- $errorMessage : string
- Error message
- $successMessage : string
- Success message
- $template : HtmlTemplate|null
- Active template
- $variables : array<string|int, mixed>
- View variables
- $viewName : string
- View's name
- __construct() : mixed
- Constructor
- getErrorCode() : int
- Method returns code of the last error
- getErrorMessage() : string
- Method return last error description
- getSuccessMessage() : string
- Method return success message
- getTemplate() : HtmlTemplate
- Method returns template
- getViewName() : string
- Method returns view name
- getViewParameter() : mixed
- Method sets view's var
- render() : string
- Method renders content from view
- setErrorCode() : void
- Method sets code of the last error
- setErrorMessage() : void
- Method sets last error description
- setErrorMessageContent() : void
- Method sets last error message content
- setSuccessMessage() : void
- Method sets success message
- setSuccessMessageContent() : void
- Method sets last success message content
- setViewParameter() : void
- Method sets view's var
- templateWasSetup() : bool
- Method checks if the template was setup
Constants
ERROR_CODE
Template variable
public
string
ERROR_CODE
= 'error-code'
ERROR_MESSAGE
Template variable
public
string
ERROR_MESSAGE
= 'error-message'
SUCCESS_MESSAGE
Template variable
public
string
SUCCESS_MESSAGE
= 'success-message'
Properties
$errorCode
Error code
private
int
$errorCode
= 0
$errorMessage
Error message
private
string
$errorMessage
= ''
$successMessage
Success message
private
string
$successMessage
= ''
$template
Active template
private
HtmlTemplate|null
$template
= null
$variables
View variables
private
array<string|int, mixed>
$variables
= []
$viewName
View's name
private
string
$viewName
= ''
Methods
__construct()
Constructor
public
__construct([HtmlTemplate|null $template = null ][, string $viewName = '' ]) : mixed
Parameters
- $template : HtmlTemplate|null = null
-
template
- $viewName : string = ''
-
View name to be rendered
Return values
mixed —getErrorCode()
Method returns code of the last error
public
getErrorCode() : int
Return values
int —code of the last error
getErrorMessage()
Method return last error description
public
getErrorMessage() : string
Return values
string —last error description
getSuccessMessage()
Method return success message
public
getSuccessMessage() : string
Return values
string —success message
getTemplate()
Method returns template
public
getTemplate() : HtmlTemplate
Return values
HtmlTemplate —template
getViewName()
Method returns view name
public
getViewName() : string
Return values
string —view name
getViewParameter()
Method sets view's var
public
getViewParameter(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
-
var name
- $default : mixed = null
-
default value for unexisting parameter
Return values
mixed —view's variable value
render()
Method renders content from view
public
render([string $viewName = '' ]) : string
Parameters
- $viewName : string = ''
-
View name to be rendered
Return values
string —Generated content
setErrorCode()
Method sets code of the last error
public
setErrorCode(int $errorCode) : void
Parameters
- $errorCode : int
Return values
void —setErrorMessage()
Method sets last error description
public
setErrorMessage(string $errorMessage) : void
Parameters
- $errorMessage : string
-
last error message
Return values
void —setErrorMessageContent()
Method sets last error message content
public
setErrorMessageContent(string $errorMessageLocator) : void
Parameters
- $errorMessageLocator : string
-
last error message locator
Return values
void —setSuccessMessage()
Method sets success message
public
setSuccessMessage(string $successMessage) : void
Parameters
- $successMessage : string
-
success message
Return values
void —setSuccessMessageContent()
Method sets last success message content
public
setSuccessMessageContent(string $successMessageLocator) : void
Parameters
- $successMessageLocator : string
-
last success message locator
Return values
void —setViewParameter()
Method sets view's var
public
setViewParameter(string $name, mixed $value[, bool $setTemplateVar = true ]) : void
Parameters
- $name : string
-
var name
- $value : mixed
-
var value
- $setTemplateVar : bool = true
-
do we need to set template parameter
Return values
void —templateWasSetup()
Method checks if the template was setup
public
templateWasSetup() : bool
Return values
bool —true if the method was setup, false otherwise