ModuleInstall/PackageManager/ListViewPackages.php
\ListViewPackages
- Parent(s)
- \ListViewSmarty < \ListViewDisplay
Properties
$actionsMenuExtraItems= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$actionsMenuExtraItems
- Inherited_from
- \ListViewSmarty::$$actionsMenuExtraItems
$contextMenus= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$contextMenus
$data= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$data
$delete= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$delete
$displayColumns= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$displayColumns
$email= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$email
$export= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$export
$listViewCounter= '0'
0
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$listViewCounter
- Inherited_from
- \ListViewSmarty::$$listViewCounter
$lvd= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$lvd
$mailMerge= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$mailMerge
$mass= 'null'
null
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$mass
- Inherited_from
- \ListViewSmarty::$$mass
$menu_location= ''top''
'top'
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$menu_location
$mergeDisplayColumns= 'false'
false
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$mergeDisplayColumns
- Inherited_from
- \ListViewSmarty::$$mergeDisplayColumns
$mergeduplicates= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$mergeduplicates
$moduleString= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$moduleString
$multiSelect= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$multiSelect
$multi_select_popup= ''
- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$multi_select_popup
- Inherited_from
- \ListViewSmarty::$$multi_select_popup
$quickViewLinks= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$quickViewLinks
$rowCount= ''
- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$rowCount
- Inherited_from
- \ListViewSmarty::$$rowCount
$searchColumns= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$searchColumns
$seed= ''
- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$seed
- Inherited_from
- \ListViewSmarty::$$seed
$select= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$select
$should_process= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$should_process
- Inherited_from
- \ListViewSmarty::$$should_process
$showMassupdateFields= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$showMassupdateFields
$show_action_dropdown= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$show_action_dropdown
- Inherited_from
- \ListViewSmarty::$$show_action_dropdown
$show_mass_update_form= 'false'
false
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$show_mass_update_form
- Inherited_from
- \ListViewSmarty::$$show_mass_update_form
$show_plus= 'false'
false
Details- Type
- n/a
- Inherited_from
- \ListViewDisplay::$$show_plus
- Inherited_from
- \ListViewSmarty::$$show_plus
$ss= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$ss
$targetList= 'false'
false
Details- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$targetList
$tpl= ''
- Type
- n/a
- Inherited_from
- \ListViewSmarty::$$tpl
Methods
ListViewDisplay(
)
:
null
Constructor
Inherited from: \ListViewDisplay::ListViewDisplay()\ListViewSmarty::ListViewDisplay()Type | Description |
---|---|
null |
ListViewSmarty(
)
:
void
Constructor, Smarty object immediately available after
Inherited from: \ListViewSmarty::ListViewSmarty()buildActionsLink(
string $id
=
'actions_link', $location
=
'top'
)
:
string
Display the actions link
Inherited from: \ListViewDisplay::buildActionsLink()\ListViewSmarty::buildActionsLink()Name | Type | Description |
---|---|---|
$id | string | link id attribute, defaults to 'actions_link' |
$location |
Type | Description |
---|---|
string | HTML source |
buildComposeEmailLink(
$totalCount, $loc
=
'top'
)
:
string
Builds the compose email link
Inherited from: \ListViewDisplay::buildComposeEmailLink()\ListViewSmarty::buildComposeEmailLink()Name | Type | Description |
---|---|---|
$totalCount | ||
$loc |
Type | Description |
---|---|
string | HTML |
buildDeleteLink(
$loc
=
'top'
)
:
string
Builds the delete link
Inherited from: \ListViewDisplay::buildDeleteLink()\ListViewSmarty::buildDeleteLink()Name | Type | Description |
---|---|---|
$loc |
Type | Description |
---|---|
string | HTML |
buildExportLink(
$loc
=
'top'
)
:
string
Builds the export link
Inherited from: \ListViewDisplay::buildExportLink()\ListViewSmarty::buildExportLink()Name | Type | Description |
---|---|---|
$loc |
Type | Description |
---|---|
string | HTML |
buildMassUpdateLink(
$loc
=
'top'
)
:
string
Builds the massupdate link
Inherited from: \ListViewDisplay::buildMassUpdateLink()\ListViewSmarty::buildMassUpdateLink()Name | Type | Description |
---|---|---|
$loc |
Type | Description |
---|---|
string | HTML |
buildMergeDuplicatesLink(
$loc
=
'top'
)
:
string
Builds the mail merge link The link can be disabled by setting module level duplicate_merge property to false in the moudle's vardef file.
Inherited from: \ListViewDisplay::buildMergeDuplicatesLink()\ListViewSmarty::buildMergeDuplicatesLink()Name | Type | Description |
---|---|---|
$loc |
Type | Description |
---|---|
string | HTML |
buildMergeLink(
$modules_array
=
null, $loc
=
'top'
)
:
string
Builds the mail merge link
Inherited from: \ListViewDisplay::buildMergeLink()\ListViewSmarty::buildMergeLink()Name | Type | Description |
---|---|---|
$modules_array | ||
$loc |
Type | Description |
---|---|
string | HTML |
buildSelectLink(
\echo $id
=
'select_link', $total
=
0, $pageTotal
=
0, $location
=
"top"
)
:
string
Display the select link
Inherited from: \ListViewDisplay::buildSelectLink()\ListViewSmarty::buildSelectLink()Name | Type | Description |
---|---|---|
$id | \echo | Bool set true if you want it echo'd, set false to have contents returned |
$total | ||
$pageTotal | ||
$location |
Type | Description |
---|---|
string | select link html |
buildSelectedObjectsSpan(
$echo
=
true, $total
=
0
)
:
string
Display the selected object span object
Inherited from: \ListViewDisplay::buildSelectedObjectsSpan()\ListViewSmarty::buildSelectedObjectsSpan()Name | Type | Description |
---|---|---|
$echo | ||
$total |
Type | Description |
---|---|
string | select object span |
buildTargetList(
$loc
=
'top'
)
:
string
Builds the add to target list link
Inherited from: \ListViewDisplay::buildTargetList()\ListViewSmarty::buildTargetList()Name | Type | Description |
---|---|---|
$loc |
Type | Description |
---|---|
string | HTML |
displayEnd(
)
:
string
Display the bottom of the ListView (ie MassUpdate
Inherited from: \ListViewSmarty::displayEnd()Type | Description |
---|---|
string | contents |
getMultiSelectData(
)
:
string
Display the multi select data box etc.
Inherited from: \ListViewDisplay::getMultiSelectData()\ListViewSmarty::getMultiSelectData()Type | Description |
---|---|
string | contents |
process(
\file $file, \data $data, \html_var $htmlVar
)
:
void
Processes the request. Calls ListViewData process. Also assigns all lang strings, export links, This is called from ListViewDisplay
Inherited from: \ListViewSmarty::process()Name | Type | Description |
---|---|---|
$file | \file | file Template file to use |
$data | \data | array from ListViewData |
$htmlVar | \html_var | string the corresponding html var in xtpl per row |
processArrows(
\ordering $ordering
)
:
void
Name | Type | Description |
---|---|---|
$ordering | \ordering | array data that contains the ordering info |
setup(
\data $data, \file $file
)
:
void
Override the setup method in ListViewSmarty since we are not passing in a bean
Name | Type | Description |
---|---|---|
$data | \data | the data to display on the page |
$file | \file | the template file to parse |
setupFilterFields(
$filter_fields
=
array()
)
:
void
Name | Type | Description |
---|---|---|
$filter_fields |