Class icms_ipf_view_Table

icms_ipf_view_Table base class

Base class representing a table for displaying icms_ipf_Object objects

Direct known subclasses

Package: ICMS\IPF\View
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Since: 1.1
Located at ipf/view/Table.php

Methods summary
`public array`	# `__construct( object & $objectHandler, array $criteria = false, object $actions = array('edit', 'delete'), array $userSide = false )` Constructor Constructor Parameters `$objectHandler` `icms_ipf_Handler` `$criteria` $columns array representing the columns to display in the table `$actions` $criteria `$userSide` $actions array representing the actions to offer Returns array
`public`	# `addActionButton( $op, $caption = false, $text = false )` Parameters `$op` `$caption` `$text`
`public`	# `addColumn( $columnObj )` Parameters `$columnObj`
`public`	# `addIntroButton( $name, $location, $value )` Parameters `$name` `$location` `$value`
`public`	# `addPrinterFriendlyLink( )`
`public`	# `addQuickSearch( $fields, $caption = _CO_ICMS_QUICK_SEARCH )` Parameters `$fields` `$caption`
`public`	# `addHeader( unknown_type $content )` Parameters `$content`
`public`	# `addFooter( $content )` Parameters `$content`
`public`	# `addDefaultIntroButton( $caption )` Parameters `$caption`
`public`	# `addCustomAction( $method )` Parameters `$method`
`public`	# `setDefaultSort( $default_sort )` Parameters `$default_sort`
`public`	# `getDefaultSort( )` get the default sorting get the default sorting
`public`	# `setDefaultOrder( unknown_type $default_order )` Parameters `$default_order`
`public string`	# `getDefaultOrder( )` Returns string the default order returned from a cookie
`public`	# `addWithSelectedActions( $actions = array() )` Parameters `$actions`
`public`	# `addFilter( string $key, string $method, $default = false )` Adding a filter in the table Adding a filter in the table Parameters `$key` key to the field that will be used for sorting `$method` method of the handler that will be called to populate the options when this filter is selected `$default`
`public`	# `setDefaultFilter( $default_filter )` Parameters `$default_filter`
`public`	# `isForUserSide( )`
`public`	# `setCustomTemplate( $template )` Parameters `$template`
`public`	# `setSortOrder( )`
`public`	# `setTableId( $id )` Parameters `$id`
`public`	# `setObjects( $objects )` Parameters `$objects`
`public`	# `createTableRows( )`
`public`	# `fetchObjects( unknown_type $debug = false )` Parameters `$debug`
`public`	# `getDefaultFilter( )`
`public`	# `getFiltersArray( )`
`public`	# `setDefaultFilter2( unknown_type $default_filter2 )` Parameters `$default_filter2`
`public`	# `getDefaultFilter2( )`
`public`	# `getFilters2Array( )`
`public`	# `renderOptionSelection( $limitsArray, $params_of_the_options_sel )` Parameters `$limitsArray` `$params_of_the_options_sel`
`public`	# `getLimitsArray( )`
`public`	# `getObjects( )`
`public`	# `hideActionColumnTitle( )`
`public`	# `hideFilterAndLimit( )`
`public`	# `getOrdersArray( )`
`public`	# `renderD( )`
`public`	# `renderForPrint( )`
`protected string`	# `getCookie( string $fieldName, string\|null $defaultValue = null )` Gets from cookie Gets from cookie Parameters `$fieldName` Field name read from cookie `$defaultValue` Default value Returns string
`protected`	# `setCookie( string $fieldName, string $value )` Sets cookie Sets cookie Parameters `$fieldName` `$value`
`public`	# `render( $fetchOnly = false, $debug = false )` Render the table of records for an IPF object Render the table of records for an IPF object Parameters `$fetchOnly` `$debug`
`public`	# `disableColumnsSorting( )`
`public`	# `fetch( $debug = false )` Parameters `$debug`

Properties summary
`public`	`$_id`	#
`public`	`$_objectHandler`	#
`public`	`$_columns`	#
`public`	`$_criteria`	#
`public`	`$_actions`	#
`public boolean`	`$_objects`	# `false`
`public`	`$_aObjects`	#
`public`	`$_custom_actions`	#
`public`	`$_sortsel`	#
`public`	`$_ordersel`	#
`public`	`$_limitsel`	#
`public`	`$_filtersel`	#
`public`	`$_filterseloptions`	#
`public`	`$_filtersel2`	#
`public`	`$_filtersel2options`	#
`public`	`$_filtersel2optionsDefault`	#
`public`	`$_tempObject`	#
`public`	`$_tpl`	#
`public`	`$_introButtons`	#
`public boolean`	`$_quickSearch`	# `false`
`public boolean`	`$_actionButtons`	# `false`
`public string`	`$_head_css_class`	# `'bg3'`
`public boolean`	`$_hasActions`	# `false`
`public boolean`	`$_userSide`	# `false`
`public boolean`	`$_printerFriendlyPage`	# `false`
`public boolean`	`$_tableHeader`	# `false`
`public boolean`	`$_tableFooter`	# `false`
`public boolean`	`$_showActionsColumnTitle`	# `true`
`public boolean`	`$_isTree`	# `false`
`public boolean`	`$_showFilterAndLimit`	# `true`
`public boolean`	`$_enableColumnsSorting`	# `true`
`public boolean`	`$_customTemplate`	# `false`
`public array`	`$_withSelectedActions`	# `array()`

Packages

Classes

Class icms_ipf_view_Table

Direct known subclasses

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters