API Documentation
\

\HelperCore

Summary

Methods
Properties
Constants
__construct()
setTpl()
createTemplate()
generate()
renderAdminCategorieTree()
renderCategoryTree()
renderRequiredFields()
renderModulesList()
renderShopList()
$currentIndex
$table
$identifier
$token
$toolbar_btn
$ps_help_context
$title
$show_toolbar
$context
$toolbar_scroll
$bootstrap
$module
$base_folder
$override_folder
$base_tpl
$tpl_vars
No constants found
l()
$tpl
N/A
No private methods found
No private properties found
N/A

Properties

$currentIndex

$currentIndex :

Type

$table

$table :

Type

$identifier

$identifier :

Type

$token

$token :

Type

$toolbar_btn

$toolbar_btn :

Type

$ps_help_context

$ps_help_context :

Type

$title

$title :

Type

$show_toolbar

$show_toolbar :

Type

$context

$context :

Type

$toolbar_scroll

$toolbar_scroll :

Type

$bootstrap

$bootstrap :

Type

$module

$module : \Module

Type

\Module

$base_folder

$base_folder : string

Type

string — Helper tpl folder

$override_folder

$override_folder : string

Type

string — Controller tpl folder

$base_tpl

$base_tpl : string

Type

string — base template name

$tpl_vars

$tpl_vars :

Type

$tpl

$tpl : \smartyTemplate

Type

\smartyTemplate — base template object

Methods

__construct()

__construct()

setTpl()

setTpl(  $tpl)

Parameters

$tpl

createTemplate()

createTemplate(string  $tpl_name) : \Template

Create a template from the override file, else from the base file.

Parameters

string $tpl_name

filename

Returns

\Template

generate()

generate() : string

default behaviour for helper is to return a tpl fetched

Returns

string

renderAdminCategorieTree()

renderAdminCategorieTree(  $translations,   $selected_cat = array(),   $input_name = 'categoryBox',   $use_radio = false,   $use_search = false,   $disabled_categories = array(),   $use_in_popup = false)

Parameters

$translations
$selected_cat
$input_name
$use_radio
$use_search
$disabled_categories
$use_in_popup

renderCategoryTree()

renderCategoryTree(array  $root = null, \type  $selected_cat = array(), string  $input_name = 'categoryBox', boolean  $use_radio = false, boolean  $use_search = false, array  $disabled_categories = array(), boolean  $use_in_popup = false, boolean  $use_shop_context = false) : string

Parameters

array $root

array with the name and ID of the tree root category, if null the Shop's root category will be used
\type $selected_cat

array of selected categories Format Array ( [0] => 1 [1] => 2 ) OR Array ( [1] => Array ( [id_category] => 1 [name] => Home page ) )
string $input_name

name of input
boolean $use_radio

use radio tree or checkbox tree
boolean $use_search

display a find category search box
array $disabled_categories
boolean $use_in_popup
boolean $use_shop_context

Returns

string

renderRequiredFields()

renderRequiredFields(string  $class_name, string  $identifier, array  $table_fields) : string

Render a form with potentials required fields

Parameters

string $class_name
string $identifier
array $table_fields

Returns

string

renderModulesList()

renderModulesList(  $modules_list)

Parameters

$modules_list

renderShopList()

renderShopList()

l()

l(mixed  $string, string  $class = 'AdminTab', \boolan  $addslashes = false, boolean  $htmlentities = true) : string

use translations files to replace english expression.

Parameters

mixed $string

term or expression in english
string $class
\boolan $addslashes

if set to true, the return value will pass through addslashes(). Otherwise, stripslashes().
boolean $htmlentities

if set to true(default), the return value will pass through htmlentities($string, ENT_QUOTES, 'utf-8')

Returns

string —

the translation if available, or the english default text.