Версия: 4.x
Класс AbstractModule
Граф наследования:AbstractModule:
AbstractController IController Wizard AbstractAdmin AbstractClient Block Front Block Front OfferBlock PropertyValuesBlock Dialog Files HeaderPanel RsAlerts RsNews View BlockPhotos Widget BlockSelectSite BlockTags Tools Tools AjaxList ImportPhotos ImportYml InventoryStatisticsCtrl Tools Ctrl Download Csv Debug Lang MetaData Routes SystemCheck WallPost Widgets Ctrl Proxy Tools Control Tools ConfigEdit Crud CorrectionReceiptCtrl Tools PersonalData Wizard FileManager HookSort SelectTemplate SelectTheme Tools AjaxList UserDialog MainContent UserHtml Contacts StandartBlock ProductReturns NewMessages ModuleBlockStub PreviewList Rss View AllBrands Brand Compare Favorite ListProducts OneClick Product Warehouse Gate Gate ApiGate Form Download Captcha CmsSign RsRequestGate Stub CheckForFatal RemInstall Tmp MenuPage Profile AuthorizedFront CartPage CashRegister Checkout Documents LicenseAgreement MultiOffers OnlinePay RegionTools Reservation Agreement PersonalData Sitemap Auth Register

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

Базовый контроллер для модулей.

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

 __construct ($param=array())
 
 getParam ($key=null, $default=null, $checkempty=false)
 
 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 ()
 
 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 ()
 

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

 $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
 

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

- Поля данных унаследованные от AbstractController
const DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'
 
 $view
 
 $url
 
 $app
 
 $router
 
 $action_var = 'Act'
 
 $result
 

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

__construct (   $param = array())

Методы

addResource ( )

Здесь добавляем все css, js которые требует компонент

checkAccessRight ( )

Возвращает false, если нет ограничений по досуту к данному контроллеру, иначе возвращает текст ошибки

Возвращает
string | bool(false)
comError (   $error_text)

Возвращает ошибку $error_text, в удобном виде (обернутую в HTML)

Аргументы
string$error_text
exec (   $returnAsIs = false)

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

Аргументы
boolean$returnAsIs- возвращать как есть. Если true, то метод будет возвращать точно то, что вернет действие, иначе результат будет обработан методом processResult
Возвращает
mixed
fetch (   $tpl,
  $param_name = 'tpl' 
)

готовим Output компонента

getControllerName ( )
getDebugGroup ( )

У контроллеров админки не может быть отладочной информации

Возвращает
| null
getKeyName (   $keyname)

Возвращает имя переменной с учетом префикса

getModTplPath ( )

Возвращает путь к шаблонам модуля

getModuleConfig ( )

Возвращает объект с конфигурацией модуля, к которому относится данный контроллер

Возвращает
RS
getParam (   $key = null,
  $default = null,
  $checkempty = false 
)

Возвращает значение параметра по ключу, заданного в конструкторе или default - если такового не существует Поиск значения по ключу также ведется в массиве $this->default_params, если не задан параметр $default Если ключ не задан, возвращает все параметры

Аргументы
string$key- название параметра, если key == null, то вернётся весь массив параметров
mixed$default- значение параметра по-умолчанию
bool$checkempty- Если true, то наличие значеня для key будет проверяться функцией empty иначе isset
Возвращает
mixed
init ( )

Функция, вызывающяся сразу после конструктора в случае успешной инициализации ничего не должна возвращать (null), в случае ошибки должна вернуть текст ошибки, который будет возвращен при вызове _exec();

request (   $key,
  $type,
  $default = null,
  $strip = '' 
)

Метод возвращает параметры из $_request с учетом установленных префиксов для компонента. (префиксы можно устанавливать, если на одной странице имеется несколько одинаковых компонентов)

setResource ( )

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

Возвращает
void

Поля

$access_right = 1
protected
$controller_name = ''
protected
$default_params = array()
protected
$mod_css = '/modules/%MODULE%/view/css/'
protected
$mod_img = '/modules/%MODULE%/view/img/'
protected
$mod_js = '/modules/%MODULE%/view/js/'
protected
$mod_name = ''
protected
$mod_tpl = '/modules/%MODULE%/view/'
protected
$param = array()
protected
Users Model Orm User $user
protected

Текущий пользователь