Версия: 6.x
burger close
Класс AbstractController
Граф наследования:AbstractController:
IController Index AbstractModule SiteClosed Wizard AbstractAdmin AbstractClient Block Front Block Front OfferBlock PropertyValuesBlock Dialog CrmBlock DealBlock InteractionBlock TaskBlock Files HeaderPanel RsAlerts RsNews RsVisibleAlerts View BlockPhotos Widget BlockSelectSite BlockTags Tools AjaxList ImportPhotos ImportYml InventoryStatisticsCtrl Tools AjaxList BoardCtrl CallActions LinkCtrl TaskGantCtrl TelphinCtrl Tools Ctrl OauthVK VkCtrl Download Csv Debug ExternalRequestLogViewer LangCtrl LogView LongPollingGate MetaData ModuleLicensesControl OrmFieldRequester Routes SystemCheck WallPost Widgets Ctrl Proxy Tools Control Tools ConfigEdit Crud CorrectionReceiptCtrl Tools PersonalData Wizard FileManager HookSort SelectTemplate SelectTheme Tools AjaxList Tools UserDialog MainContent UserHtml Contacts ShortContacts StandartBlock NewMessages ModuleBlockStub Affiliates Change Contacts Robots PreviewList Rss View AllBrands Brand Category Compare Favorite ListProducts OneClick Product Warehouse TelephonyEvents Gate Gate ApiGate Form Download Captcha CmsSign DaData Manifest QRCode RsRequestGate Stub CheckForFatal RemInstall Tmp MenuPage Profile AuthorizedFront CartCheckout CartPage CashRegister Checkout DeliveryWebHooks Documents LicenseAgreement MultiOffers OnlinePay RegionTools Reservation SelectedAddressChange SelectPvz Agreement PersonalData Sitemap Auth Register Verify

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

Абстрактный класс контроллера.

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

 __construct ()
 
 isViewCacheExpired (string $cache_id_str, string $template, int $lifetime=null)
 
 wrapHtml ($body, $html_template=null)
 
 getAction ()
 
 exec ($returnAsIs=false)
 
 processResult ($result)
 
 presetAct ($act)
 
 e404 ($reason=null)
 
 redirect ($url=null, $status=302)
 
 refreshPage ()
 
 getUrlName ()
 
- Открытые члены унаследованные от IController
 exec ()
 

Поля данных

const DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'
 
 $view
 
 $url
 
 $app
 
 $router
 

Защищенные данные

 $act = null
 
 $action_var = 'Act'
 
 $result
 

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

__construct ( )

Базовый конструктор контроллера. желательно вызывать в конструкторах порожденных классов.

Методы

e404 (   $reason = null)

Отдает в output страницу с ошибкой 404. Прекращает выполнение скрипта

Аргументы
mixed$reason
Исключения
ExceptionPageNotFound
exec (   $returnAsIs = false)

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

Аргументы
boolean$returnAsIs- возвращать как есть. Если true, то метод будет возвращать точно то, что вернет действие, иначе результат будет обработан методом processResult
Возвращает
mixed|null
Исключения
Exception
ExceptionPageNotFound
EventException
getAction ( )

Взвращает Action который будет вызван

Возвращает
string
getUrlName ( )

Возврщает имя текущего контроллера для использования в URL

Возвращает
string
isViewCacheExpired ( string  $cache_id_str,
string  $template,
int  $lifetime = null 
)

Включает кэширование шаблонов и проверяет истёк ли кэш

Аргументы
string$cache_id_str- идентификатор кэша, для последующих вызовов is_cached, fetch, display
string$template- шаблон
int | null$lifetime- время кэширования
Возвращает
bool
presetAct (   $act)

Позволяет переопределить вызываемый метод в контроллере

Аргументы
string$act- метод контроллера
Возвращает
void

Замещает IController.

processResult (   $result)

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

Аргументы
string | Result\IResult$result
Возвращает
string
Исключения
Exception
redirect (   $url = null,
  $status = 302 
)

Перенаправляет браузер пользователя на другую страницу. Прекращает выполнение скрипта

Аргументы
string$urlЕсли url не задан, то перенаправляет на корневую страницу сайта
int$status- номер статуса редиректа с которым выполнять редирект
refreshPage ( )

Перезагружает у пользователя текущую страницу

Возвращает
void
wrapHtml (   $body,
  $html_template = null 
)

Оборачивает HTML секциями body, html добавляет секцию head с мета тегами, заголовком

Аргументы
string$body- HTML, внутри тега body, который нужно обернуть
string$html_template- имя оборачивающего шаблона
Возвращает
string
Исключения
EventException
\SmartyException

Поля

$act = null
protected
$action_var = 'Act'
protected
$app
$result
protected
$router
$url
$view
const DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'