AdminItemListViewer Class Reference

AdminItemListViewer Input.
Display customisable admin list of objects. More...

Inheritance diagram for AdminItemListViewer:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	display ($panel='list')
	set_params ($params=array())
	add_param ($type, $name, $value)
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Public Attributes
	$selectionValues = array()
	Store current selection values. More...
	$sortValues = array('column'=>'id', 'way'=>'')
	Store current selection values. More...
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...

Protected Member Functions
	get_itemDisplay ($object, $name, $column, $line)
	get_icon ($icon, $mode='std')
	is_columnSortable ($column='')
	get_listLinkColspans ($link=array())
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Protected Attributes
	$preRenders = array()
	Store pre rendered columns. More...
	$icons = array()
	Cache of button icon urls. More...

Private Member Functions
	check_params ()
	get_selectorValue ($name, $params)
	get_selectorDefaultValue ($name, $params)
	build_panelsData ()
	build_listData ()
	get_columnPosition ($column)

Private Attributes
	$valide = true
	Indicate if given parameters are valid. More...

Detailed Description

AdminItemListViewer Input.
Display customisable admin list of objects.

Plugin / Input Engine

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1.4

Date

Creation: Sep 2008

Modification: Jul 2025

Copyright

2008 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. AdminItemListViewer Input class.

Constructor & Destructor Documentation

__construct()

AdminItemListViewer::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Member Function Documentation

initialise()

AdminItemListViewer::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

display()

AdminItemListViewer::display

(

$panel = 'list'

)

Display input.

Parameters

string

$panel

Returns

void

set_params()

AdminItemListViewer::set_params

(

$params = array()

)

Set all params.

Parameters

array

$params

Returns

void

add_param()

AdminItemListViewer::add_param	(		$type,
			$name,
			$value
	)

Add a head param.

Parameters

string	$type
string	$name
mixed	$value

Returns

void

check_params()

AdminItemListViewer::check_params ( )

private

Check paramaters.

Returns

void

get_selectorValue()

AdminItemListViewer::get_selectorValue (   $name,   $params  )

private

Return header selector value.

Parameters

string	$name
array	$params

Returns

mixed

get_selectorDefaultValue()

AdminItemListViewer::get_selectorDefaultValue (   $name,   $params  )

private

Return header selector default value.

Parameters

string	$name
array	$params

Returns

mixed

build_panelsData()

AdminItemListViewer::build_panelsData ( )

private

Build every params needed into the display panels.

Returns

void

build_listData()

AdminItemListViewer::build_listData ( )

private

Build list data.

Returns

void

get_itemDisplay()

AdminItemListViewer::get_itemDisplay (   $object,   $name,   $column,   $line  )

protected

Return object item display.

Parameters

object	$object
string	$name
array	$column
integer	$line

Returns

string

get_icon()

AdminItemListViewer::get_icon (   $icon,   $mode = 'std'  )

protected

Return generic icon URL.

Parameters

string	$icon
string	$mode

Returns

string

is_columnSortable()

AdminItemListViewer::is_columnSortable (   $column = '' )

protected

Check if given column can be use as sort.

Parameters

string

$column

Returns

boolean

get_listLinkColspans()

AdminItemListViewer::get_listLinkColspans (   $link = array() )

protected

Calculate and return list link button position.

Parameters

array

$link

Returns

array

get_columnPosition()

AdminItemListViewer::get_columnPosition (   $column )

private

Calculate and return column position.

Parameters

mixed

$column

Returns

integer

Member Data Documentation

$valide

AdminItemListViewer::$valide = true

private

Indicate if given parameters are valid.

var boolean $valide

$selectionValues

array AdminItemListViewer::$selectionValues = array()

Store current selection values.

$sortValues

AdminItemListViewer::$sortValues = array('column'=>'id', 'way'=>'')

Store current selection values.

var array $selectionValues

$preRenders

AdminItemListViewer::$preRenders = array()

protected

Store pre rendered columns.

var array $preRenders

$icons

AdminItemListViewer::$icons = array()

protected

Cache of button icon urls.

var array $icons

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/AdminItemListViewer/AdminItemListViewer.php.inc