icms_ipf_view_Table

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_ipf_view_Table

icms_ipf_view_Table base class

Base class representing a table for displaying icms_ipf_Object objects

• Class name: icms_ipf_view_Table
• Namespace:

Properties

$_id

protected mixed $_id

• Visibility: protected

$_objectHandler

protected mixed $_objectHandler

• Visibility: protected

$_columns

protected mixed $_columns

• Visibility: protected

$_criteria

protected mixed $_criteria

• Visibility: protected

$_actions

protected mixed $_actions

• Visibility: protected

$_objects

protected mixed $_objects = \false

• Visibility: protected

$_aObjects

protected mixed $_aObjects

• Visibility: protected

$_custom_actions

protected mixed $_custom_actions

• Visibility: protected

$_sortsel

protected mixed $_sortsel

• Visibility: protected

$_ordersel

protected mixed $_ordersel

• Visibility: protected

$_limitsel

protected mixed $_limitsel

• Visibility: protected

$_filtersel

protected mixed $_filtersel

• Visibility: protected

$_filterseloptions

protected mixed $_filterseloptions

• Visibility: protected

$_filtersel2

protected mixed $_filtersel2

• Visibility: protected

$_filtersel2options

protected mixed $_filtersel2options

• Visibility: protected

$_filtersel2optionsDefault

protected mixed $_filtersel2optionsDefault

• Visibility: protected

$_tempObject

protected mixed $_tempObject

• Visibility: protected

$_tpl

protected mixed $_tpl

• Visibility: protected

$_introButtons

protected mixed $_introButtons

• Visibility: protected

$_quickSearch

protected mixed $_quickSearch = \false

• Visibility: protected

$_actionButtons

protected mixed $_actionButtons = \false

• Visibility: protected

$_head_css_class

protected mixed $_head_css_class = bg3

• Visibility: protected

$_hasActions

protected mixed $_hasActions = \false

• Visibility: protected

$_userSide

protected mixed $_userSide = \false

• Visibility: protected

$_printerFriendlyPage

protected mixed $_printerFriendlyPage = \false

• Visibility: protected

$_tableHeader

protected mixed $_tableHeader = \false

• Visibility: protected

$_tableFooter

protected mixed $_tableFooter = \false

• Visibility: protected

$_showActionsColumnTitle

protected mixed $_showActionsColumnTitle = \true

• Visibility: protected

$_isTree

protected mixed $_isTree = \false

• Visibility: protected

$_showFilterAndLimit

protected mixed $_showFilterAndLimit = \true

• Visibility: protected

$_enableColumnsSorting

protected mixed $_enableColumnsSorting = \true

• Visibility: protected

$_customTemplate

protected mixed $_customTemplate = \false

• Visibility: protected

$_withSelectedActions

protected mixed $_withSelectedActions = array()

• Visibility: protected

Methods

__construct

mixed icms_ipf_view_Table::__construct(\icms_ipf_Handler objectHandler, bool|\icms_db_criteria_Element criteria, string[] actions, bool userSide)

Constructor

• Visibility: public

Arguments

• objectHandler icms_ipf_Handler - <p>Handler</p>
• criteria bool|bool - <p>Criteria</p>
• actions string[] - <p>array representing the actions to offer</p>
• userSide bool - <p>For user side?</p>

__get

mixed icms_ipf_view_Table::__get(string name)

Magic getter to make some variables for class read-only from outside

• Visibility: public

Arguments

• name string - <p>Variable name</p>

addActionButton

mixed icms_ipf_view_Table::addActionButton(op, caption, text)

• Visibility: public

Arguments

• op mixed
• caption mixed
• text mixed

addColumn

mixed icms_ipf_view_Table::addColumn(columnObj)

• Visibility: public

Arguments

• columnObj mixed

addIntroButton

mixed icms_ipf_view_Table::addIntroButton(name, location, value)

• Visibility: public

Arguments

• name mixed
• location mixed
• value mixed

addPrinterFriendlyLink

mixed icms_ipf_view_Table::addPrinterFriendlyLink()

• Visibility: public

addQuickSearch

mixed icms_ipf_view_Table::addQuickSearch(fields, caption)

• Visibility: public

Arguments

• fields mixed
• caption mixed

addHeader

mixed icms_ipf_view_Table::addHeader(\unknown_type content)

• Visibility: public

Arguments

• content unknown_type

addFooter

mixed icms_ipf_view_Table::addFooter(content)

• Visibility: public

Arguments

• content mixed

addDefaultIntroButton

mixed icms_ipf_view_Table::addDefaultIntroButton(caption)

• Visibility: public

Arguments

• caption mixed

addCustomAction

mixed icms_ipf_view_Table::addCustomAction(method)

• Visibility: public

Arguments

• method mixed

setDefaultSort

mixed icms_ipf_view_Table::setDefaultSort(default_sort)

• Visibility: public

Arguments

• default_sort mixed

getDefaultSort

mixed icms_ipf_view_Table::getDefaultSort()

• Visibility: public

setDefaultOrder

mixed icms_ipf_view_Table::setDefaultOrder(\unknown_type default_order)

• Visibility: public

Arguments

• default_order unknown_type

getDefaultOrder

mixed icms_ipf_view_Table::getDefaultOrder()

• Visibility: public

addWithSelectedActions

mixed icms_ipf_view_Table::addWithSelectedActions(actions)

• Visibility: public

Arguments

• actions mixed

addFilter

mixed icms_ipf_view_Table::addFilter(string key, string method, mixed default)

Adding a filter in the table

• Visibility: public

Arguments

• key string - <p>key to the field that will be used for sorting</p>
• method string - <p>method of the handler that will be called to populate the options when this filter is selected</p>
• default mixed

setDefaultFilter

mixed icms_ipf_view_Table::setDefaultFilter(default_filter)

• Visibility: public

Arguments

• default_filter mixed

isForUserSide

mixed icms_ipf_view_Table::isForUserSide()

• Visibility: public

setCustomTemplate

mixed icms_ipf_view_Table::setCustomTemplate(template)

• Visibility: public

Arguments

• template mixed

setSortOrder

mixed icms_ipf_view_Table::setSortOrder()

• Visibility: public

setTableId

mixed icms_ipf_view_Table::setTableId(id)

• Visibility: public

Arguments

• id mixed

setObjects

mixed icms_ipf_view_Table::setObjects(objects)

• Visibility: public

Arguments

• objects mixed

createTableRows

mixed icms_ipf_view_Table::createTableRows()

• Visibility: public

fetchObjects

mixed icms_ipf_view_Table::fetchObjects(\unknown_type debug)

• Visibility: public

Arguments

• debug unknown_type

getDefaultFilter

mixed icms_ipf_view_Table::getDefaultFilter()

• Visibility: public

getFiltersArray

mixed icms_ipf_view_Table::getFiltersArray()

• Visibility: public

setDefaultFilter2

mixed icms_ipf_view_Table::setDefaultFilter2(\unknown_type default_filter2)

• Visibility: public

Arguments

• default_filter2 unknown_type

getDefaultFilter2

mixed icms_ipf_view_Table::getDefaultFilter2()

• Visibility: public

getFilters2Array

mixed icms_ipf_view_Table::getFilters2Array()

• Visibility: public

renderOptionSelection

mixed icms_ipf_view_Table::renderOptionSelection(limitsArray, params_of_the_options_sel)

• Visibility: public

Arguments

• limitsArray mixed
• params_of_the_options_sel mixed

getLimitsArray

mixed icms_ipf_view_Table::getLimitsArray()

• Visibility: public

getObjects

mixed icms_ipf_view_Table::getObjects()

• Visibility: public

hideActionColumnTitle

mixed icms_ipf_view_Table::hideActionColumnTitle()

• Visibility: public

hideFilterAndLimit

mixed icms_ipf_view_Table::hideFilterAndLimit()

• Visibility: public

getOrdersArray

mixed icms_ipf_view_Table::getOrdersArray()

• Visibility: public

renderD

mixed icms_ipf_view_Table::renderD()

• Visibility: public

renderForPrint

mixed icms_ipf_view_Table::renderForPrint()

• Visibility: public

render

mixed icms_ipf_view_Table::render(fetchOnly, debug)

• Visibility: public

Arguments

• fetchOnly mixed
• debug mixed

disableColumnsSorting

mixed icms_ipf_view_Table::disableColumnsSorting()

• Visibility: public

fetch

mixed icms_ipf_view_Table::fetch(debug)

• Visibility: public

Arguments

• debug mixed