- Class name: HelperListCore
- Parent class: Helper
- Source: classes/helper/HelperList.php line 30
- $_defaultOrderBy
- $_filter
- $_list
- $_pagination
- $actions
- $ajax_params
- $bulk_actions
- $cache_lang
- $colorOnBackground
- $content_tpl
- $deleted
- $fields_list
- $footer_tpl
- $header_tpl
- $identifier
- $is_cms
- $listTotal
- $list_skip_actions
- $no_link
- $orderBy
- $orderWay
- $position_identifier
- $row_hover
- $simple_header
- $specificConfirmDelete
- $title
- $tpl_delete_link_vars
- $base_folder
- $base_tpl
- $context
- $currentIndex
- $module
- $override_folder
- $ps_help_context
- $show_toolbar
- $table
- $token
- $toolbar_btn
- $toolbar_scroll
- $tpl
- $tpl_vars
- __construct
- createTemplate
- displayDefaultLink
- displayDeleteLink
- displayDetailsLink
- displayDuplicateLink
- displayEditLink
- displayEnableLink
- displayListContent
- displayListFooter
- displayListHeader
- displayViewLink
- generate
- generateList
- l
- renderAdminCategorieTree
- renderCategoryTree
- renderRequiredFields
- renderShopList
- setTpl
public string $_defaultOrderBy = false
- Visibility: public
- Source: classes/helper/HelperList.php line 48.
protected array $_filter
- Visibility: protected
- Source: classes/helper/HelperList.php line 39.
protected array $_list = array()
- Visibility: protected
- Source: classes/helper/HelperList.php line 33.
protected array $_pagination = array(20, 50, 100, 300)
- Visibility: protected
- Source: classes/helper/HelperList.php line 42.
public array $actions = array()
- Visibility: public
- Source: classes/helper/HelperList.php line 87.
public mixed $ajax_params = array()
- Visibility: public
- Source: classes/helper/HelperList.php line 105.
public mixed $bulk_actions = false
- Visibility: public
- Source: classes/helper/HelperList.php line 92.
public array $cache_lang = array()
- Visibility: public
- This property is static.
- Source: classes/helper/HelperList.php line 61.
public mixed $colorOnBackground
- Visibility: public
- Source: classes/helper/HelperList.php line 94.
protected mixed $content_tpl = 'list_content.tpl'
- Visibility: protected
- Source: classes/helper/HelperList.php line 83.
protected mixed $deleted
- Visibility: protected
- Source: classes/helper/HelperList.php line 58.
protected string $fields_list
- Visibility: protected
- Source: classes/helper/HelperList.php line 77.
protected mixed $footer_tpl = 'list_footer.tpl'
- Visibility: protected
- Source: classes/helper/HelperList.php line 84.
protected mixed $header_tpl = 'list_header.tpl'
- Visibility: protected
- Source: classes/helper/HelperList.php line 82.
public mixed $identifier
- Visibility: public
- Source: classes/helper/HelperList.php line 56.
protected mixed $is_cms = false
- Visibility: protected
- Source: classes/helper/HelperList.php line 63.
public integer $listTotal
- Visibility: public
- Source: classes/helper/HelperList.php line 36.
public array $list_skip_actions = array()
- Visibility: public
- Source: classes/helper/HelperList.php line 90.
public boolean $no_link = false
- Visibility: public
- Source: classes/helper/HelperList.php line 80.
public string $orderBy
- Visibility: public
- Source: classes/helper/HelperList.php line 45.
public string $orderWay
- Visibility: public
- Source: classes/helper/HelperList.php line 54.
public mixed $position_identifier
- Visibility: public
- Source: classes/helper/HelperList.php line 65.
public boolean $row_hover = true
- Visibility: public
- Source: classes/helper/HelperList.php line 97.
public boolean $simple_header = false
- Visibility: public
- Source: classes/helper/HelperList.php line 103.
public mixed $specificConfirmDelete = null
- Visibility: public
- Source: classes/helper/HelperList.php line 93.
public \if $title = null
- Visibility: public
- Source: classes/helper/HelperList.php line 100.
public array $tpl_delete_link_vars = array()
- Visibility: public
- Source: classes/helper/HelperList.php line 51.
public string $base_folder
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 46.
public string $base_tpl = 'content.tpl'
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 59.
public mixed $context
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 37.
public mixed $currentIndex
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 29.
public \Module $module
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 43.
public string $override_folder
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 49.
public mixed $ps_help_context
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 34.
public mixed $show_toolbar = true
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 36.
public mixed $table
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 30.
public mixed $token
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 32.
public mixed $toolbar_btn
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 33.
public mixed $toolbar_scroll = false
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 38.
protected \smartyTemplate $tpl
- Visibility: protected
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 54.
public mixed $tpl_vars = array()
- Visibility: public
- This property is defined by HelperCore.
- Source: classes/helper/Helper.php line 61.
mixed HelperListCore::__construct()
- Visibility: public
- Source: classes/helper/HelperList.php line 107
\Template HelperCore::createTemplate(string $tpl_name)
Create a template from the override file, else from the base file.
- Visibility: public
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 79
- $tpl_name string - filename
mixed HelperListCore::displayDefaultLink($token, $id, $name)
Display delete action link
- Visibility: public
- Source: classes/helper/HelperList.php line 469
- $token mixed
- $id mixed
- $name mixed
mixed HelperListCore::displayDeleteLink($token, $id, $name)
Display delete action link
- Visibility: public
- Source: classes/helper/HelperList.php line 436
- $token mixed
- $id mixed
- $name mixed
mixed HelperListCore::displayDetailsLink($token, $id, $name)
Display action show details of a table row This action need an ajax request with a return like this: { use_parent_structure: true // If false, data need to be an html data: [ {field_name: 'value'} ], fields_display: // attribute $fields_list of the admin controller } or somethins like this: { use_parent_structure: false // If false, data need to be an html data: '
My html content
', fields_display: // attribute $fields_list of the admin controller }- Visibility: public
- Source: classes/helper/HelperList.php line 376
- $token mixed
- $id mixed
- $name mixed
mixed HelperListCore::displayDuplicateLink($token, $id, $name)
Display duplicate action link
- Visibility: public
- Source: classes/helper/HelperList.php line 334
- $token mixed
- $id mixed
- $name mixed
mixed HelperListCore::displayEditLink($token, $id, $name)
Display edit action link
- Visibility: public
- Source: classes/helper/HelperList.php line 418
- $token mixed
- $id mixed
- $name mixed
string HelperListCore::displayEnableLink(string $token, integer $id, integer $value, string $active, integer $id_category, integer $id_product)
Fetch the template for action enable
- Visibility: public
- Source: classes/helper/HelperList.php line 163
- $token string
- $id integer
- $value integer - state enabled or not
- $active string - status
- $id_category integer
- $id_product integer
mixed HelperListCore::displayListContent()
- Visibility: public
- Source: classes/helper/HelperList.php line 174
mixed HelperListCore::displayListFooter()
Close list table and submit button
- Visibility: public
- Source: classes/helper/HelperList.php line 615
mixed HelperListCore::displayListHeader()
Display list header (filtering, pagination and column names)
- Visibility: public
- Source: classes/helper/HelperList.php line 487
mixed HelperListCore::displayViewLink($token, $id, $name)
Display view action link
- Visibility: public
- Source: classes/helper/HelperList.php line 400
- $token mixed
- $id mixed
- $name mixed
void HelperCore::generate()
default behaviour for helper is to return a tpl fetched
- Visibility: public
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 110
string HelperListCore::generateList(array $list, array $fields_display)
Return an html list given the data to fill it up
- Visibility: public
- Source: classes/helper/HelperList.php line 122
- $list array - entries to display (rows)
- $fields_display array - fields (cols)
string HelperCore::l(mixed $string, string $class, \boolan $addslashes, boolean $htmlentities)
use translations files to replace english expression.
- Visibility: protected
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 307
- $string mixed - term or expression in english
- $class string
- $addslashes boolan - if set to true, the return value will pass through addslashes(). Otherwise, stripslashes().
- $htmlentities boolean - if set to true(default), the return value will pass through htmlentities($string, ENT_QUOTES, 'utf-8')
mixed HelperCore::renderAdminCategorieTree($translations, $selected_cat, $input_name, $use_radio, $use_search, $disabled_categories, $use_in_popup)
- Visibility: public
- This method is static.
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 119
- $translations mixed
- $selected_cat mixed
- $input_name mixed
- $use_radio mixed
- $use_search mixed
- $disabled_categories mixed
- $use_in_popup mixed
string HelperCore::renderCategoryTree(array $root, \type $selected_cat, string $input_name, boolean $use_radio, boolean $use_search, array $disabled_categories, boolean $use_in_popup, boolean $use_shop_context)
- Visibility: public
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 167
- $root array - array with the name and ID of the tree root category, if null the Shop's root category will be used
- $selected_cat type - array of selected categories Format Array ( [0] => 1 [1] => 2 ) OR Array ( [1] => Array ( [id_category] => 1 [name] => Home page ) )
- $input_name string - name of input
- $use_radio boolean - use radio tree or checkbox tree
- $use_search boolean - display a find category search box
- $disabled_categories array
- $use_in_popup boolean
- $use_shop_context boolean
string HelperCore::renderRequiredFields(string $class_name, string $identifier, array $table_fields)
Render a form with potentials required fields
- Visibility: public
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 325
- $class_name string
- $identifier string
- $table_fields array
mixed HelperCore::renderShopList()
- Visibility: public
- This method is static.
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 354
mixed HelperCore::setTpl($tpl)
- Visibility: public
- This method is defined by HelperCore.
- Source: classes/helper/Helper.php line 68
- $tpl mixed