Версия: 5.x
Класс Front
Граф наследования:Front:
AbstractClient AbstractModule AbstractController IController Affiliates Change Contacts PreviewList Rss View AllBrands Brand Compare Favorite ListProducts OneClick Product Warehouse TelephonyEvents Gate Gate ApiGate Form Download Captcha CmsSign QRCode RsRequestGate Stub CheckForFatal RemInstall Tmp MenuPage Profile AuthorizedFront CartCheckout CartPage CashRegister Checkout Documents LicenseAgreement MultiOffers OnlinePay RegionTools Reservation SelectedAddressChange SelectPvz Agreement PersonalData Sitemap Auth Register Verify

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

Базовый класс всех фронтальных контроллеров

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

 wrapOutput ($bool)
 
 exec ($returnAsIs=false)
 
 myBlockIdInput ()
 
 isMyPost ()
 
 getMyId ()
 
 authPage ($error="", $referer=null)
 
 checkRedirectToAliasUrl ($id, $item, $redirect_url, $alias_field= 'alias', $id_field= 'id')
 
- Открытые члены унаследованные от AbstractClient
 __construct ($param=array())
 
 isConstructorBlock ()
 
 processResult ($result)
 
 getDebugGroup ()
 
 wrapHtml ($body, $html_template=null)
 
- Открытые члены унаследованные от AbstractModule
 __construct ($param=array())
 
 getParam ($key=null, $default=null, $checkempty=false)
 
 setParam ($key, $value=null)
 
 setResource ()
 
 getControllerName ()
 
 addResource ()
 
 init ()
 
 fetch ($tpl, $param_name= 'tpl')
 
 request ($key, $type, $default=null, $strip= '')
 
 getKeyName ($keyname)
 
 comError ($error_text)
 
 checkAccessRight ()
 
 exec ($returnAsIs=false)
 
 getDebugGroup ()
 
 getModTplPath ()
 
 getModuleConfig ()
 
- Открытые члены унаследованные от AbstractController
 __construct ()
 
 isViewCacheExpired (string $cache_id_str, string $template)
 
 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 CONTROLLER_ID_PARAM = '_controller_id'
 
- Поля данных унаследованные от AbstractClient
 $debug_group = null
 
- Поля данных унаследованные от AbstractController
const DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'
 
 $view
 
 $url
 
 $app
 
 $router
 

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

 $wrap_template = DEFAULT_LAYOUT
 
 $wrap_output = true
 
- Защищенные данные унаследованные от AbstractModule
 $user
 
 $access_right = 1
 
 $default_params = array()
 
 $param = array()
 
 $mod_name = ''
 
 $controller_name = ''
 
 $mod_css = '/modules/%MODULE%/view/css/'
 
 $mod_js = '/modules/%MODULE%/view/js/'
 
 $mod_img = '/modules/%MODULE%/view/img/'
 
 $mod_tpl = '/modules/%MODULE%/view/'
 
- Защищенные данные унаследованные от AbstractController
 $act = null
 
 $action_var = 'Act'
 
 $result
 

Дополнительные унаследованные члены

- Защищенные члены унаследованные от AbstractClient
 isDebugModeEnabled ()
 
 canProcessResult ()
 

Методы

authPage (   $error = "",
  $referer = null 
)

Выполняет redirect На страницу авторизации

Аргументы
string$error- ошибка
null | string$referer- страница с которой пришли
Возвращает
Result
checkRedirectToAliasUrl (   $id,
  $item,
  $redirect_url,
  $alias_field = 'alias',
  $id_field = 'id' 
)

Проверяет нужен ли редирект на адрес, где адрес формируется не id объекта, а указанного значения в alias

Аргументы
integer | string$id- идентификатор
\RS\Orm\OrmObject$item- объект для просмотра
string$redirect_url- адрес для редиректа
string$alias_field- наименование поля с alias
string$id_field- идентификатор поля
exec (   $returnAsIs = false)

Возвращает отрендеренный шаблон фронт контроллера

Аргументы
bool$returnAsIs- возвращать как есть? Если true, то метод будет возвращать точно то, что вернет действие, иначе результат будет обработан методом processResult
Возвращает
mixed|string|void|null
Исключения
Exception
RS
RS
SmartyException
getMyId ( )

Возвращает id текущего контроллера

Возвращает
integer
isMyPost ( )

Возвращает true, если инициатором POST запроса выступил данный контроллер

Возвращает
bool
myBlockIdInput ( )

Возвращает input[type="hidden"] с id текущего контроллера, чтобы отметить, что данный пост идет по его инициативе.

Возвращает
string
wrapOutput (   $bool)

Устанавливает, оборачивать ли вывод шаблоном текущей страницы.

Аргументы
boolean$bool- true или false
Возвращает
$this

Поля

$wrap_output = true
protected
$wrap_template = DEFAULT_LAYOUT
protected
const CONTROLLER_ID_PARAM = '_controller_id'