ViewInterface
in
Base interface for all views
Table of Contents
- getErrorCode() : int
- Method returns code of the last error
- getErrorMessage() : string
- Method return last error message
- getSuccessMessage() : string
- Method return last success message
- 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 message
- setErrorMessageContent() : void
- Method sets last error message content
- setSuccessMessage() : void
- Method sets last success message
- setSuccessMessageContent() : void
- Method sets last success message content
- setViewParameter() : void
- Method sets view's var
Methods
getErrorCode()
Method returns code of the last error
public
getErrorCode() : int
Return values
int —code of the last error
getErrorMessage()
Method return last error message
public
getErrorMessage() : string
Return values
string —last error message
getSuccessMessage()
Method return last success message
public
getSuccessMessage() : string
Return values
string —last success message
getViewName()
Method returns view name
public
getViewName() : string
Return values
string —view name
getViewParameter()
Method sets view's var
public
getViewParameter(string $name) : mixed
Parameters
- $name : string
-
var name
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 message
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 last success message
public
setSuccessMessage(string $successMessage) : void
Parameters
- $successMessage : string
-
last 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) : void
Parameters
- $name : string
-
var name
- $value : mixed
-
var value
- $setTemplateVar : bool
-
do we need to set template parameter