Версия: 4.x
Класс Crud
Граф наследования:Crud:
Front AbstractAdmin AbstractModule AbstractController IController Ctrl Ctrl Ctrl AbstractDocument BrandCtrl CostCtrl Ctrl CurrencyCtrl InventorizationCtrl InventoryCtrl InventoryMovementCtrl OneClickCtrl Propctrl UnitCtrl WareHouseCtrl Ctrl Ctrl AuthTokenCtrl LogCtrl Ctrl ResultCtrl BlockedIp FastLinksCtrl License Ctrl Ctrl Ctrl ActionTemplatesCtrl BalanceCtrl DeliveryCtrl DiscountCtrl OrderCtrl PaymentCtrl ReceiptsCtrl RegionCtrl ReservationCtrl ReturnsCtrl SubStatusCtrl TaxCtrl TransactionCtrl ZoneCtrl Control SupportCtrl TopicsCtrl BlockCtrl Ctrl Ctrlgroup

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

Стандартный конроллер спискового компонента. У которого есть табличная форма, форма создания, форма редактирования, форма мультиредактирования

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

 __construct (\RS\Module\AbstractModel\EntityList $api)
 
 actionIndex ()
 
 actionAdd ($primaryKeyValue=null, $returnOnSuccess=false, $helper=null)
 
 actionEdit ()
 
 actionDel ()
 
 redirectToIndex ()
 
 successSave ()
 
 actionTableOptions ()
 
 helperTableOptions ()
 
 actionMultiedit ()
 
 helperMultiedit ()
 
 modifySelectAll ($ids)
 
 buttons ($buttons, $buttons_text=null, $ajax=true)
 
 setHelper ($helper)
 
 getHelper ()
 
 setCrudActions ($actions=null)
 
 exec ($returnAsIs=false)
 
 actionClone ()
 
 actionMarkOneAsViewed ()
 
 actionMarkAllAsViewed ()
 
- Открытые члены унаследованные от Front
 __construct ()
 
 wrapOutput ($bool)
 
 checkAccessRight ()
 
 exec ($returnAsIs=false)
 
- Открытые члены унаследованные от AbstractAdmin
 __construct ($param=array())
 
 checkAccessRight ()
 
- Открытые члены унаследованные от AbstractModule
 __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 ()
 

Поля данных

 $sqlMultiUpdate = true
 
 $selectAllVar = 'selectAll'
 
 $edit_url_var = 'edit_url'
 
 $sess_where = '_list'
 
 $multiedit_check_func
 
 $user_post_data = array()
 
 $api
 
 $edit_call_action = 'actionAdd'
 
- Поля данных унаследованные от Front
 $result
 
 $action_var = 'do'
 
 $wrap_output = true
 
 $wrap_template = '%SYSTEM%/admin/body.tpl'
 
 $block_tpl = '%SYSTEM%/admin/block.tpl'
 
 $block_form_tpl = '%SYSTEM%/admin/crud_form.tpl'
 
 $help
 
- Поля данных унаследованные от AbstractAdmin
 $change_site_var = 'site_id_context'
 
 $before_site_id
 
- Поля данных унаследованные от AbstractController
const DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'
 
 $view
 
 $url
 
 $app
 
 $router
 
 $action_var = 'Act'
 
 $result
 

Защищенные члены

 helperIndex ()
 
 helperAdd ()
 
 helperEdit ()
 
- Защищенные члены унаследованные от AbstractAdmin
 changeSiteIdIfNeed ($new_site_id)
 
 setSiteIdByOrmObject ($api, $orm_object=null)
 
 restoreSiteId ()
 

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

 $allow_crud_actions
 
- Защищенные данные унаследованные от 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
 

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

__construct ( \RS\Module\AbstractModel\EntityList  $api)

Методы

actionAdd (   $primaryKeyValue = null,
  $returnOnSuccess = false,
  $helper = null 
)

Форма добавления элемента

Аргументы
mixed$primaryKeyValue- id редактируемой записи
boolean$returnOnSuccess- Если true, то будет возвращать === true при успешном сохранении, иначе будет вызов стандартного _successSave метода
null | Helper\CrudCollection$helper- текуй хелпер
Возвращает
|bool
actionClone ( )

Метод для клонирования

Возвращает
bool|
Исключения
RS
actionDel ( )

Удаляет записи

Возвращает
mixed
actionEdit ( )

Редактирование элемента

Возвращает
mixed
actionIndex ( )

Отображение списка

actionMarkAllAsViewed ( )

Метод обеспечивает отметку о прочтении всех объектов, если API объекта это поддерживает

Возвращает
Исключения
RS
actionMarkOneAsViewed ( )

Метод обеспечивает отметку о прочтении одного объекта, если API объекта это поддерживает

Возвращает
Исключения
RS
actionMultiedit ( )

Групповое редактирование элементов

Возвращает
Исключения
Exception
SmartyException
actionTableOptions ( )

Возвращает диалог настройки таблицы

Возвращает
mixed
Исключения
Exception
SmartyException
buttons (   $buttons,
  $buttons_text = null,
  $ajax = true 
)

Возвращает массив для элемента html/toolbar со стандартными кнопками и установленными для контроллеров crud параметрами

Аргументы
array | string$buttons- имя кнопок, которые должны присутствовать: add,delete,multiedit,save,cancel
array$buttons_text- массив с текстами для кнопок. например: 'add' => 'Добавить .....'
bool$ajax- Если true, то кнопкам будут спецпараметры для работы в ajax режиме
Возвращает
Toolbar
exec (   $returnAsIs = false)

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

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

Event: controller.exec.Короткое имя контроллера.Имя действия Вызывается перед рендерингом страницы. Обработчики данного события могут изменить содержимое helper'а paramtype mixed - helper

getHelper ( )

Возвращает установленный helper

Возвращает
Helper
helperAdd ( )
protected

Подготавливает Helper объекта для добавления

Возвращает
Helper
helperEdit ( )
protected

Подготавливает Helper объекта для редактирования

Возвращает
Helper
helperIndex ( )
protected

Вызывается перед действием Index и возвращает коллекцию элементов, которые будут находиться на экране.

helperMultiedit ( )
helperTableOptions ( )

Подготавливает Helper для опций таблицы

Возвращает
Helper
Исключения
RS
modifySelectAll (   $ids)

Если был выделен checkbox "Выделить все на всех страницах", то добываем все id, которые были на странице, иначе возвращаем, входящий параметр

redirectToIndex ( )
setCrudActions (   $actions = null)

Устанавливает какие действия могут быть запущены именно из данного класса.

Аргументы
string | array$actions,$actions,....
Возвращает
void
setHelper (   $helper)

Устанавливает произвольный helper, который потом может использоваться в Action

Аргументы
Helper\CrudCollection$helper- объект crud coolection
Возвращает
Helper
successSave ( )

Успешное сохранение объекта и редирект

Поля

$allow_crud_actions
protected
$api
$edit_call_action = 'actionAdd'
$edit_url_var = 'edit_url'
$multiedit_check_func
$selectAllVar = 'selectAll'
$sess_where = '_list'
$sqlMultiUpdate = true
$user_post_data = array()