API Documentation
\

\HelperListCore

Summary

Methods
Properties
Constants
__construct()
generateList()
displayEnableLink()
displayListContent()
displayDuplicateLink()
displayDetailsLink()
displayViewLink()
displayEditLink()
displayDeleteLink()
displayDefaultLink()
displayListHeader()
hasBulkActions()
displayListFooter()
$listTotal
$_pagination
$_default_pagination
$orderBy
$_defaultOrderBy
$tpl_delete_link_vars
$orderWay
$identifier
$cache_lang
$is_cms
$position_identifier
$table_id
$no_link
$actions
$list_skip_actions
$bulk_actions
$force_show_bulk_actions
$specificConfirmDelete
$colorOnBackground
$row_hover
$title
$simple_header
$ajax_params
No constants found
No protected methods found
$_list
$_filter
$deleted
$fields_list
$header_tpl
$content_tpl
$footer_tpl
N/A
No private methods found
No private properties found
N/A

Properties

$listTotal

$listTotal : integer

Type

integer — Number of results in list

$_pagination

$_pagination : array

Type

array — Number of results in list per page (used in select field)

$_default_pagination

$_default_pagination : integer

Type

integer — Default number of results in list per page

$orderBy

$orderBy : string

Type

string — ORDER BY clause determined by field/arrows in list header

$_defaultOrderBy

$_defaultOrderBy : string

Type

string — Default ORDER BY clause when $orderBy is not defined

$tpl_delete_link_vars

$tpl_delete_link_vars : array

Type

array — : list of vars for button delete

$orderWay

$orderWay : string

Type

string — Order way (ASC, DESC) determined by arrows in list header

$identifier

$identifier :

Type

$cache_lang

$cache_lang : array

Type

array — use to cache texts in current language

$is_cms

$is_cms :

Type

$position_identifier

$position_identifier :

Type

$table_id

$table_id :

Type

$no_link

$no_link : boolean

Type

boolean — Content line is clickable if true

$actions

$actions : array

Type

array — list of required actions for each list row

$list_skip_actions

$list_skip_actions : array

Type

array — list of row ids associated with a given action for witch this action have to not be available

$bulk_actions

$bulk_actions :

Type

$force_show_bulk_actions

$force_show_bulk_actions :

Type

$specificConfirmDelete

$specificConfirmDelete :

Type

$colorOnBackground

$colorOnBackground :

Type

$row_hover

$row_hover : boolean

Type

boolean — If true, activates color on hover

$title

$title : \if

Type

\if — not null, a title will be added on that list

$simple_header

$simple_header : boolean

Type

boolean — ask for simple header : no filters, no paginations and no sorting

$ajax_params

$ajax_params :

Type

$_list

$_list : array

Type

array — Cache for query results

$_filter

$_filter : array

Type

array — WHERE clause determined by filter fields

$deleted

$deleted :

Type

$fields_list

$fields_list : array

Type

array — Customize list display align : determine value alignment prefix : displayed before value suffix : displayed after value image : object image icon : icon determined by values active : allow to toggle status

$header_tpl

$header_tpl :

Type

$content_tpl

$content_tpl :

Type

$footer_tpl

$footer_tpl :

Type

Methods

__construct()

__construct()

generateList()

generateList(array  $list, array  $fields_display) : string

Return an html list given the data to fill it up

Parameters

array $list

entries to display (rows)
array $fields_display

fields (cols)

Returns

string —

html

displayEnableLink()

displayEnableLink(string  $token, integer  $id, integer  $value, string  $active, integer  $id_category = null, integer  $id_product = null,   $ajax = false) : string

Fetch the template for action enable

Parameters

string $token
integer $id
integer $value

state enabled or not
string $active

status
integer $id_category
integer $id_product
$ajax

Returns

string

displayListContent()

displayListContent()

displayDuplicateLink()

displayDuplicateLink(  $token = null,   $id,   $name = null)

Display duplicate action link

Parameters

$token
$id
$name

displayDetailsLink()

displayDetailsLink(  $token = null,   $id,   $name = null)

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: '<p>My html content</p>', fields_display: // attribute $fields_list of the admin controller }

Parameters

$token
$id
$name

displayViewLink()

displayViewLink(  $token = null,   $id,   $name = null)

Display view action link

Parameters

$token
$id
$name

displayEditLink()

displayEditLink(  $token = null,   $id,   $name = null)

Display edit action link

Parameters

$token
$id
$name

displayDeleteLink()

displayDeleteLink(  $token = null,   $id,   $name = null)

Display delete action link

Parameters

$token
$id
$name

displayDefaultLink()

displayDefaultLink(  $token = null,   $id,   $name = null)

Display delete action link

Parameters

$token
$id
$name

displayListHeader()

displayListHeader()

Display list header (filtering, pagination and column names)

hasBulkActions()

hasBulkActions(  $has_value = false)

Parameters

$has_value

displayListFooter()

displayListFooter()

Close list table and submit button