Версия: 6.x
burger close
Класс Standard
Граф наследования:Standard:
ITemplateResult IResult

Подробное описание

Помогает формировать вывод контроллера в едином формате. Если это ajax запрос, то формирует json на выходе, в противном случае возвращает html

Открытые члены

 __construct (AbstractController $controller=null)
 
 getController ()
 
 setController (AbstractController $controller)
 
 setTemplate ($template)
 
 getTemplate ()
 
 getTemplateVars ()
 
 setNeedAuthorize ($bool)
 
 setSuccess ($success)
 
 isSuccess ()
 
 addMessage ($text, array $options=null)
 
 addEMessage ($text, array $options=null)
 
 setHtml ($html)
 
 setErrors (array $errors)
 
 setSuccessText ($text)
 
 setRedirect ($url)
 
 setAjaxRedirect ($url)
 
 setAjaxWindowRedirect ($url)
 
 setNoAjaxRedirect ($url)
 
 addSection ($key, $value=null)
 
 getHtml ()
 
 checkAjaxOutput ($bool=true)
 
 getOutput ($force_ajax=null)
 
- Открытые члены унаследованные от IResult
 getOutput ()
 

Конструктор(ы)

__construct ( AbstractController  $controller = null)

Методы

addEMessage (   $text,
array  $options = null 
)

Добавляет сообщение об ошибке, которое будет отображено пользователю

Аргументы
string$text- текст сообщений
array  |  null$options- параметры, которые будут переданы в виде объекта JS плагину
Возвращает
Standard
addMessage (   $text,
array  $options = null 
)

Добавляет сообщение, которое будет отображено пользователю

Аргументы
string$text- текст сообщений
array  |  null$options- параметры, которые будут переданы в виде объекта JS плагину
Возвращает
Standard
addSection (   $key,
  $value = null 
)

Дабваляет произвольную секцию в JSON ответ, который будет возвращен в случае ajax запроса

Аргументы
mixed$key
mixed$value
Возвращает
Standard
checkAjaxOutput (   $bool = true)

Включает/Отключает возможность вернуть результат в json в случае ajax запроса

Аргументы
bool$bool- Если true, то в случае ajax запроса getOutput вернет json, иначе HTML
Возвращает
Standard
getController ( )

Возвращает текущий контроллер

Возвращает
AbstractController | null
getHtml ( )

Возвращает HTML, который задан через setHtml или формирует его с помощью заданного шаблона

Возвращает
string

Замещает IResult.

getOutput (   $force_ajax = null)

Возвращает установленный html или выполнит заданный редирект, если это не ajax запрос. В случае ajax запроса возвращает в json формате установленные секции

Аргументы
bool | null$force_ajaxЕсли true, то результат будет возвращен, как будто это ajax запрос, если false - то как будто это не ajax запрос. null - автоопределение
Возвращает
mixed
getTemplate ( )

Возвращает шаблон, который используется для рендеринга

Возвращает
string

Замещает ITemplateResult.

getTemplateVars ( )

Возвращает переменные, переданные в шаблон

Возвращает
array

Замещает ITemplateResult.

isSuccess ( )

Возвращает true, если раннее был вызван метод setSuccess(true)

setAjaxRedirect (   $url)

Устанавливает редирект, который произойдет в контексте updatable, если это ajax запрос

Аргументы
string$url
Возвращает
Standard
setAjaxWindowRedirect (   $url)

Устанавливает редирект, который произойдет в окне браузера

Аргументы
string$url
Возвращает
Standard
setController ( AbstractController  $controller)

Устанавливает текущий контроллер

Аргументы
AbstractController$controller
Возвращает
Standard
setErrors ( array  $errors)

Устанавливает ошибки, которые произошли в форме

Аргументы
array$errors
Возвращает
Standard
setHtml (   $html)

Устанавливает html, который будет возвращен. В случае, если это ajax запрос, то возвращается в формате json в секции html с остальными данными, в противном случае возвращается только $html

Аргументы
mixed$html
Возвращает
Standard

Замещает IResult.

setNeedAuthorize (   $bool)

Нужен редирект на авторизацию

Аргументы
boolean$bool- если true, то произойдет редирект на страницу авторизации
Возвращает
Standard
setNoAjaxRedirect (   $url)

Устанавливает редирект, который произойдет, если это не ajax запрос

Аргументы
string$url
Возвращает
Standard
setRedirect (   $url)

Устанавливает редирект, который произойдет и если это ajax запрос и если это обычный запро

Аргументы
string$url
Возвращает
Standard
setSuccess (   $success)

Устанавливает успешно ли выполнено действие контроллера

Аргументы
boolean$success
Возвращает
Standard
setSuccessText (   $text)

Устанавливает текст успешного действия контроллера, например текст успешного сохранения.

Аргументы
string$text
Возвращает
Standard
setTemplate (   $template)

Устанавливает шаблон, который будет использован для рендеринга

Аргументы
mixed$template
Возвращает
Standard

Замещает ITemplateResult.