Contentserv PHP API

CSGuiList extends CSGuiDialog
in package

Core

GUI

The CSGuiDialog is a classical CONTENTSERV window with a toolbar and an inner area

The inner area can be filled with content by simple echo statements. At the end the makeHtml method creates the output. This class has no public constructor, use the factory method instead.

$additionalHead


    public
        mixed
    $additionalHead
     = ""

$ajaxReloadCompleteWindow


    public
        mixed
    $ajaxReloadCompleteWindow
     = \false

$ajaxReloadParts


    public
        mixed
    $ajaxReloadParts
     = array()

$bodyAttributes


    public
        mixed
    $bodyAttributes
     = ''

$bodyClasses


    public
        mixed
    $bodyClasses
     = array()

$charset


    public
        mixed
    $charset

$csscodes


    public
        mixed
    $csscodes
     = array()

$csslinks


    public
        mixed
    $csslinks
     = array()

$doctype


    public
        mixed
    $doctype

$isAjaxReloadable


    public
        mixed
    $isAjaxReloadable
     = \false

$isDisabled


    public
        mixed
    $isDisabled
     = \false

$isPortal


    public
    static    mixed
    $isPortal
     = \false

$jscodes


    public
        mixed
    $jscodes
     = array('before' => array(), 'after' => array(), 'important' => array())

$jslinks


    public
        mixed
    $jslinks
     = array()

$jsprototyping


    public
        mixed
    $jsprototyping
     = \true

$menubar


    public
        CSGuiMenubar
    $menubar

$menubarIsVisible


    public
        mixed
    $menubarIsVisible
     = \true

$metaData


    public
        mixed
    $metaData
     = array()

$popup


    public
        mixed
    $popup

$popupIDField


    public
        mixed
    $popupIDField

$popupUrl


    public
        mixed
    $popupUrl

$rightTitle


    public
        mixed
    $rightTitle
     = ''

$subTitleIsVisible


    public
        mixed
    $subTitleIsVisible
     = \true

$title


    public
        mixed
    $title

$titleIsDark


    public
        mixed
    $titleIsDark
     = \FALSE

$titleIsVisible


    public
        mixed
    $titleIsVisible
     = \true

$toolbar


    public
        CSGuiToolbar
    $toolbar

$toolbarIsVisible


    public
        mixed
    $toolbarIsVisible
     = \true

$toolbarSize


    public
        mixed
    $toolbarSize
     = \true

$type


    public
        mixed
    $type

$visibility


    public
        mixed
    $visibility
     = array()

$windowTitle


    public
        mixed
    $windowTitle

__construct()

CSGuiList constructor.


    public
                __construct([null $RecordName = null ]) : mixed

Parameters

$RecordName : null = null

Return values

mixed —

activateCompression()

Activates GZIP-Compression for this window


    public
            static    activateCompression([bool $activate = true ]) : mixed

Parameters

$activate : bool = true: whether the window should be compressed using gzip, or not

Return values

mixed —

activateDragAndDropHandling()

Activates drag and drop support for all browsers on this window.


    public
                activateDragAndDropHandling() : void

If required special mouse handlers are registered.

Return values

void —

activateEditorFrame()

Activates or deactives the editor frame direction


    public
                activateEditorFrame([string $frameDirection = 'right' ][, string $frameSource = '' ], int $frameSize) : void

Parameters

$frameDirection : string = 'right': the direction where the editor frame should be opened as default (left, right, top, bottom or none if no editor frame should be used)
$frameSource : string = '': the source which should be displayed as start editor
$frameSize : int: the size of the frame at the first load (without cookie)

Return values

void —

activateNotes()

Activates the note mode for this window. If activated notes can be placed anywhere within the given target


    public
                activateNotes(mixed $mContextModules, string $contextRecord, string $contextID[, string $subContext = '' ][, float $zoom = '100' ][, string $targetElementID = '' ][, bool $autoLoad = true ]) : mixed

Parameters

$mContextModules : mixed: The context module of the note as a string (for a single module) or an array in case the notes for multiple modules should be returned.
$contextRecord : string: The record context the notes should be stored for
$contextID : string: The context id the notes should be stored for
$subContext : string = '': An optional subcontext the notes should be stored for
$zoom : float = '100': The current zoom level in percent
$targetElementID : string = '': The ID of the element the notes should be placed relative to. If null the window is the target
$autoLoad : bool = true: If true, the CSNotes.LoadNotes-JS-Method is executed to load all notes. Otherwise this method must be called by the developer

Return values

mixed —

addAlternativeSortQuery()

Adds a alternative sort for a field with a given name. It can be used to sort on multiple fields or to define a complex sort criteria


    public
                addAlternativeSortQuery(string $fieldName, mixed $alternativeSortAsc[, mixed $alternativeSortDesc = null ]) : void

Parameters

$fieldName : string: the column for which the alternative sort should be applied
$alternativeSortAsc : mixed: the sql command which defines the ascending sort as sql string or as array of fieldnames (where the sort is reversed if the fieldname begins with '!')
$alternativeSortDesc : mixed = null: the sql command which defines the descending sort as sql string or as array of fieldnames (where the sort is reversed if the fieldname begins with '!'). If it is null the same fields are used as defined in $alternativeSortAsc

Return values

void —

addBodyAttributes()

Adds attributes to the body tag of the window


    public
                addBodyAttributes(string $bodyAttributes) : void

Parameters

$bodyAttributes : string: the additional attributes to be added to the body tag

Return values

void —

addBodyClass()

Adds a class to the body tag of the window


    public
                addBodyClass(string $className) : void

Parameters

$className : string: the additional classname to be added to the body tag

Return values

void —

addBooleanFilter()

Adds a boolean filter option to the top of the column


    public
                addBooleanFilter(string $name[, string $yesText = "" ][, string $noText = "" ]) : void

Parameters

$name : string: the name of the column
$yesText : string = "": an optional label that should be used for the 'yes' filter setting
$noText : string = "": an optional label that should be used for the 'no' filter setting

Return values

void —

addColumn()

Adds another column description to the end of the list


    public
                addColumn(string $name[, string $label = '' ][, string $type = '' ][, string $phpValue = '' ][, bool $isSortable = true ][, string $isFilterable = true ][, mixed $isColumnUpdatable = true ][, int $newPosition = null ][, array<string|int, mixed> $additionalOptions = array() ]) : void

Parameters

$name : string: the database field name of the column
$label : string = '': the displayed label if this should not be the field name
$type : string = '': the type of the added column as documented at
$phpValue : string = '': an alternative value that should be displayed instead of the database content - see the phpValue documentation at
$isSortable : bool = true: whether the list can be sortable after this column
$isFilterable : string = true: whether the list should display a filter option at the column header
$isColumnUpdatable : mixed = true
$newPosition : int = null: the new index of the element, to be able to move before others
$additionalOptions : array<string|int, mixed> = array(): further settings for this column

Return values

void —

addColumnUpdateButton()

Adds explicitly a complete column update option for a specific column The type of the option depends on the type of the column


    public
                addColumnUpdateButton(string $name, string $type) : void

Parameters

$name : string: the name of the column
$type : string: the type of the column as documented at

Return values

void —

addColumnUpdateComponent()

Adds an arbitrary html text at the end of the column This html text appears in the last line of the table.


    public
                addColumnUpdateComponent(string $name, string $html) : void

Parameters

$name : string: the name of the column
$html : string: the html text that should appear at the bottom of the column

Return values

void —

addColumnUpdateDialog()

Adds explicitly a complete column update dialog for a specific column


    public
                addColumnUpdateDialog(string $name, string $dialogURL[, string $dialogParams = 'dialogWidth=350px;dialogHeight=450px;status=yes;' ]) : void

Parameters

$name : string: the name of the column
$dialogURL : string: the modal dialog which is shown when clicking on the update. It must return the new value
$dialogParams : string = 'dialogWidth=350px;dialogHeight=450px;status=yes;': the modal dialog parameters

Return values

void —

addContent()

Adds any html output to the inner area of the window


    public
                addContent(string $content) : void

The inner content is captured with output buffering and returned later with the makeHtml method. Alternatively it's therefore possible to echo or output content directly.

Parameters

$content : string: the content to be added

Return values

void —

addCSSCode()

Adds a css snippet to the windows internal css code as they are used in the head Note that links to urls within the file must be relative to the forward.php


    public
                addCSSCode(string $code) : void

Parameters

$code : string: the code of the css without any <style> elements

Return values

void —

addCSSLink()

Adds a link to the windows external cascading style sheets Note that - that the admin.css is included by default - the link to the file is from the browsers point of view relative to the forward.php - that links to urls within the file are relative to the css file location.


    public
                addCSSLink(string $href) : void

Parameters

$href : string: the href of the css file

Return values

void —

addDefaultFilter()

Adds the default filter for a special type


    public
                addDefaultFilter(string $name, string $type[, array<string|int, mixed> $additionalSettings = array() ]) : void

Parameters

$name : string: the name of the column
$type : string: the type of the column
$additionalSettings : array<string|int, mixed> = array(): further arguments if supported by the filter

Return values

void —

addDefaultUpdate()

Adds the default column update for a special type


    public
                addDefaultUpdate(string $name, string $type[, string $subType = '' ]) : void

Parameters

$name : string: the name of the column
$type : string: the type of the column or null to remove an existing one
$subType : string = '': the optional subtype (for some types)

Return values

void —

addEvaluateRecordCode()

Adds php eval code after (TRUE) or before (FALSE) of the eval record code @see setEvaluateRecordCode Pay Attention to add necessary ';' to your code (ending).


    public
                addEvaluateRecordCode(string $sEvalPhpCode[, bool $bAddAfter = true ]) : void

Parameters

$sEvalPhpCode : string: The PHP Code which can modify the $data array
$bAddAfter : bool = true: Flag to add after (TRUE) or before (FALSE) previously defined eval strings.

Return values

void —

addFile()

Includes any html or php file to the inner area of the window while executing contained php code


    public
                addFile(string $file) : void

Parameters

$file : string: the file to be added relative to the admin/forward.php

Return values

void —

addFilterURLVariable()

Defines one Request variable to be a filter This variable is added to the ListURL. If it is set the remove filter button is displayed If remove filter is applied this variable will be removed


    public
                addFilterURLVariable(mixed $name) : mixed

Parameters

$name : mixed: the name of the request variable which is a filter (as string or array)

Return values

mixed —

addHeadHtml()

Add head content


    public
                addHeadHtml(string $html) : void

Parameters

$html : string: the content in form of HTML which should be added to the head

Return values

void —

addImportantJSCode()

Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.


    public
                addImportantJSCode(string $sCodeSnippet) : void

The added code snippet is marked as 'important'. This code snippets are added BEFORE JavaScript code snippets added with addJSCode-method

Parameters

$sCodeSnippet : string: The pure JavaScript code (without script-tags)

Return values

void —

addItemSelectorOption()

Adds an option to the ItemSelector (mass action on lists).


    public
                addItemSelectorOption(string $sText, string $sPhpCode[, string $sJsCode = '' ][, bool|false $bSendWithAjax = false ][, string $sIconPath = '' ][, bool|false $bDisplayInStandardPopup = false ][, string $sUniqueActionName = '' ][, string $sGroupIdentifier = '' ], int $iGroupIndex) : void

Parameters

$sText : string: The optional name of the selector (translated value). For unique name use $sUniqueActionName-parameter).
$sPhpCode : string: The php code which is executed when the action is confirmed. The variable $ids contains the ids of the selected elements in the list.
$sJsCode : string = '': The optional javascript code which should be executed on action selection. Following function variable are accessible at this point. "resolve" - Calling resolve function with a first parameter must be an plain object with {key : value} for URI string which will be added to the current list URL and navigate/reload the list to that URL. "reject" - Calling reject function cancels the action completely.

Like: resolve({'myParam' : '404'}); // to append parameters to the list resolve(); // no params

In both cases the list will be reloaded. The "reject" function need not to be called to cancel the JavaScript action, only the JavaScript action is canceled not the PhpCode (by default cancelled) Following utility functions can be used: getNumberOfSelectedItems - To retrieve the number of selected items csListBuilderGetMarkedIDs - To retrieve selected item ids (as array)

To get the current list URL, please use the following variable: CSListbuilderURL.
$bSendWithAjax : bool|false = false: Whether the $sPhpCode should be sent using ajax keeping the list unchanged in the foreground either as boolean or the target window as string.
$sIconPath : string = '': Relative path to an icon.
$bDisplayInStandardPopup : bool|false = false: Whether the entry should also be added to popups of one single unmarked element (and not only if multiple are marked)
$sUniqueActionName : string = '': The unique name of the action.
$sGroupIdentifier : string = '': The identifier to add the popup item to a group, which has separator at the beginning and at the end.
$iGroupIndex : int: The index of the group. The index will be used to order the groups. The lowest index will be taken of all popup items inside of a group.

Return values

void —

addJoin()

Adds a sql join to the query


    public
                addJoin(string $sqlJoin[, string $prefix = null ]) : mixed

Parameters

$sqlJoin : string: the sql of the joined table
$prefix : string = null: the prefix of the database table in the join

Return values

mixed —

addJoinedTable()

Adds a joined table to the default query of the list. This only works, if the query is not set manually using the setSqlQuery method.


    public
                addJoinedTable(Record $joinrecord[, string $joinField = '' ][, string $alias = '' ][, string $aliasField = '' ][, string $joinFilter = '' ]) : void

Parameters

$joinrecord : Record: the record which should be joined
$joinField : string = '': the field in the list
$alias : string = '': the alias of the joined table
$aliasField : string = '': the field in the joined table
$joinFilter : string = '': an additional filter on the join

Return values

void —

addJSAPI()

Preloads a js API library instead of using CS.loadAPI in the code


    public
                addJSAPI(string $api) : void

Parameters

$api : string: the name of the CS API library in the ../admin/modules/[MODULE]/CS[MODULE].js directory

Return values

void —

addJSCode()

Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.


    public
                addJSCode(string $code[, bool $before = true ]) : void

Parameters

$code : string: The code of the js without any <javasctipt> elements
$before : bool = true: If set to TRUE, the given code snippet is added to the head otherwise after BODY

Return values

void —

addJSLink()

Adds a link to the windows external js scripts Note that the link to the file is from the browsers point of view relative to the forward.php


    public
                addJSLink(string $href) : void

Parameters

$href : string: the href of the js

Return values

void —

addJSUtils()

Preloads a js util library instead of using CS.loadUtils in the code


    public
                addJSUtils(string $util) : void

Parameters

$util : string: the name of the CS Util library in the ../admin/core/utils/js/ directory

Return values

void —

addMeta()

Adds a meta data to the windows head


    public
                addMeta(string $name, string $content) : void

Parameters

$name : string
$content : string

Return values

void —

addMultipleFieldTextFilter()

Adds a text filter option to the top of the column that allows to combine multiple fields with an OR filter


    public
                addMultipleFieldTextFilter(string $name, string $fields) : additionalTextLookupFilter

Parameters

$name : string: the name of the column
$fields : string: an array with the database field names the filter should be applied to

Return values

additionalTextLookupFilter —

the internal filter object

addRightTitle()

Adds content to the right part of the title label below the toolbar The title is not translated.


    public
                addRightTitle(string $sTitle) : void

Parameters

$sTitle : string: the title of the caption below the toolbar

Return values

void —

addSelectFilter()

Adds a combobox filter option to the top of the column


    public
                addSelectFilter(string $name, array<string|int, mixed> $options[, bool $sqlQueryKeys = false ][, bool $multiple = false ][, array<string|int, mixed> $additionalOptions = array() ]) : additionalCombo

Parameters

$name : string

the name of the column

$options : array<string|int, mixed>

Either a simple or complex array with the filter options. It can be:

An array where keys are filter conditions and values are the corresponding labels
An array where keys are option values, and values are sub arrays containing 'query' and 'label'

$sqlQueryKeys : bool = false

whether the keys are just values of the field (false) or are a complete sql filter (true)

$multiple : bool = false

whether the column may contain multiple values seperated by a comma

$additionalOptions : array<string|int, mixed> = array()

further settings, like 'join' defining a table which should be joined, if the filter is applied

Return values

additionalCombo —

the internal filter object

addSetting()

Adds a field to the list settings dialog


    public
                addSetting(string $name[, string $label = '' ][, string $type = '' ][, string $default = '' ][, array<string|int, mixed> $additionalOptions = array() ]) : void

Parameters

$name : string: the name of the field
$label : string = '': the label of the field
$type : string = '': the type of the field as documented at
$default : string = '': the default value of this field when the editor creates a new record
$additionalOptions : array<string|int, mixed> = array(): further option as documented at

Return values

void —

addSQLFilter()

Adds a constant filter to the list, which is applied additional to group filters, etc.


    public
                addSQLFilter(string $filter) : void

Parameters

$filter : string: the additional constant filter for the list

Return values

void —

addSqlTextFilter()

Adds a filter option to the top of the column that allows to filter with a sql query The following keyword are supported within the sqlFilter to replace it with the filtered content: - {search} : replace this with the entered value - {quotesearch} : replace this with a quoted entered value where slashes have been added - {likesearch} : replace this with a quoted entered value where slashes have been added and additional a beginning and ending search pattern %


    public
                addSqlTextFilter(string $name, string $sqlFilter[, mixed $filterColumn = null ]) : additionalTextFilter

Parameters

$name : string: the name of the column
$sqlFilter : string: the filter which should be applied if the field is filtered.
$filterColumn : mixed = null

Return values

additionalTextFilter —

the internal filter object

addTextFilter()

Adds a text filter option to the top of the column


    public
                addTextFilter(string $name) : void

Parameters

$name : string: the name of the column

Return values

void —

addTimeFilter()

Adds a time filter option to the top of the column


    public
                addTimeFilter(string $name[, string $timeType = 'datetime' ]) : void

Parameters

$name : string: the name of the column
$timeType : string = 'datetime': the type of the column (either date, datetime, time or timestamp)

Return values

void —

addView()

Adds or overwrites a view to the list which is selectable using the view selector combo


    public
                addView(string $name, string $label[, string $phpCode = NULL ][, int $index = NULL ][, string $icon = NULL ][, bool $bReplaceList = false ]) : void

If a $phpCode is set the following variables might be used:

$row for the current row as array in the form $fieldName => $value
$id for the current row ID
$count for the current row number
$records for an array of all displayed rows

Parameters

$name : string: the name of the view
$label : string: the displayed label of the view
$phpCode : string = NULL: PHP code which should be displayed instead of the original list view.
$index : int = NULL: the optional position the view should have in the combo. Note: If no view had been selected before the first is displayed as selected view.
$icon : string = NULL: an icon path that is used to show an icon next to the view entry in the view popup.
$bReplaceList : bool = false: If this parameter is true the added view completely replaces the gui list. That means that the php code passed is not executed for each item in the list but only once to render the complete view.

Return values

void —

changeColumn()

Changes an existing column description in the list


    public
                changeColumn(string $name[, string $label = '' ][, string $type = '' ][, string $phpValue = '' ][, bool $isSortable = true ][, bool $isFilterable = true ][, bool $isUpdatable = true ][, int $newPosition = null ][, array<string|int, mixed> $additionalOptions = array() ]) : void

Parameters

$name : string: the database field name of the column
$label : string = '': the displayed label if this should not be the field name
$type : string = '': the type of the added column as documented at
$phpValue : string = '': an alternative value that should be displayed instead of the database content - see the phpValue documentation at
$isSortable : bool = true: whether the list can be sortable after this column
$isFilterable : bool = true: whether the list should display a filter option at the column header
$isUpdatable : bool = true: whether the list should support an update button for the complete column at the bottom
$newPosition : int = null: the new index of the element, to be able to move before others
$additionalOptions : array<string|int, mixed> = array(): further settings for this column

Return values

void —

disableItemSelectorOption()

Disables one mass action (item selector option) even if the user should have the right to use them Possible standard values are: - deletemarked - checkoutmarked - checkinmarked - copymarked - clonemarked - movemarked - addkeywordmarked - setkeywordsmarked - applyactionmarked - changeconfiguration - csvexportmarked- - excelxmlexportmarked- - GUI_ITEM_EDIT_SHOW_MASSEDITOR - MAM_GUI_POP_RESYNCHRONIZE_FILE - MAM_GUI_POP_DOWNLOAD_FILES_AS_ZIP - MAM_GUI_POP_MAIL_DOWNLOAD_FILES_AS_ZIP


    public
                disableItemSelectorOption(string|array<string|int, mixed> $actionName[, bool $disable = true ]) : void

Parameters

$actionName : string|array<string|int, mixed>: the name of the mass action (e.g. 'deletemarked', 'csvexportmarked-') or an array of mass actions
$disable : bool = true: whether the mass action is available

Return values

void —

disableJSPrototyping()

Due to backward compatibility CONTENTSERV uses prototyping on the javascript Object context (Object.prototype).


    public
                disableJSPrototyping() : mixed

This causes error in many scripts as the can not iterate through objects using for (var XXX in object) If no internal CS method is used which requires prototyping it can be disabled. In future version it might be disabled as standard behaviour

Return values

mixed —

enableJQuery()

Enables JQuery by loading all required libraries


    public
                enableJQuery() : void

Return values

void —

enableJQueryEasy()

Enables JQuery easy by loading all required libraries (experimental only)


    public
                enableJQueryEasy() : void

Return values

void —

enableJQueryPlugin()

Enables jQuery plugin.


    public
                enableJQueryPlugin(string $sPluginName) : bool

For possible plugins see ADMIN_LOCAL/lib/javascript/jquery/plugins subfolder.

Parameters

$sPluginName : string: The name of the jquery plugin (case sensitive) and without the "jquery." prefix. To load the jquery.cookie.js plugin give only "cookie" as param.

Return values

bool —

Whenever the plugin path was found or not.

enableJQueryUI()

Enables JQuery UI by loading all required libraries (experimental only)


    public
                enableJQueryUI() : void

Return values

void —

enablePluginCalls()

Enables / disables all calls to CSGuiComponent plugins, if it is not wanted


    public
            static    enablePluginCalls([bool $enabled = false ]) : mixed

Parameters

$enabled : bool = false: whether plugin calls may be used

Return values

mixed —

getBasePath()

Returns the path to be used as a base for other page links


    public
                getBasePath() : string

Return values

string —

getController()

returns the controller of this gui component


    public
                getController() : object

Return values

object —

the controller of the gui component

getCurrentIds()

Returns an array of all IDs in the list which are selected (or displayed - if none are selected)


    public
                getCurrentIds() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of IDs

getDefinedColumns()

Returns the names of all defined columns in the form name => label. These names can e.g. be used to fill the $columnNames array for the setCurrentColumns method.


    public
                getDefinedColumns() : void

Return values

void —

getEditUrl()

Returns the url of the editors which will be called, if an editor is opened


    public
                getEditUrl() : string

Return values

string —

the url of the editor

getFilteredFields()

Returns the fields on which a filter is selected. This can e.g. be used to reduce joins Attention: Only those filters are checked which are already defined before this method call.


    public
                getFilteredFields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

an array with all names of fields where a filter has been defined

getIEMetaCompatible()

Get the X-UA-Compatible meta tag string with given IE version.


    public
                getIEMetaCompatible(mixed $iIEVersion) : mixed

This string is used to render the window in desired mode (+ quircks mode).

Parameters

$iIEVersion : mixed

Return values

mixed —

getLanguageFlagImage()

Returns the separator for the language flag, if the record supports languages. It will be replaced later by the correct flag.


    public
                getLanguageFlagImage() : string

Return values

string —

a html code containing the image

getListUrl()

Returns the url of the list which can be used e.g. to execute actions


    public
                getListUrl() : string

Return values

string —

the url of the list

getRecord()

Return an instance of the record, which is the root folder of the list.


    public
                getRecord() : Record

Return values

Record —

an instance of the record

getSessionValue()

Gets a value from the lists session for a given name.


    public
                getSessionValue(string $name[, mixed $defaultValue = null ]) : mixed

Parameters

$name : string: the name of the lists session variable
$defaultValue : mixed = null: the default value if no value is set

Return values

mixed —

the session value

getSetting()

Returns the value of a defined Setting for the current user


    public
                getSetting(string $name[, string $default = '' ]) : string

Parameters

$name : string: the name of the setting
$default : string = '': the default value if no value is set

Return values

string —

the defined value of the setting

getSortedField()

Returns the field which the user has selected in the list for sorting


    public
                getSortedField([string &$sortOrder = null ]) : string

Parameters

$sortOrder : string = null: the optional variable where the sort order should be written to.

Return values

string —

the name of the sorted field

getSqlName()

Prepares the given field name by creating all necessary joins and returning the name which should be used instead


    public
                getSqlName(string $name[, bool $forFilter = false ]) : string

Parameters

$name : string: the name of the field which should be shown in the list
$forFilter : bool = false: if this flag is set to true the name in database is retured which must be used in sqlfilters. If set to false the alias for the fieldname is returned.

Return values

string —

the new name of the field in sql queries

getTopWindow()

Returns the instance of the first opened CSGuiWindow component, which had not been build using makeHtml This method offers the possibility to place scripts, ... in the windows head section


    public
            static    getTopWindow() : CSGuiWindow

Return values

CSGuiWindow —

the top CSGuiWindow in the script

getView()

Returns the name of the current selected view


    public
                getView() : string

Return values

string —

the name of the view which is displayed at the moment

hasAlreadyBeenSend()

This method can be called to check whenever a request is send to the CSGui List before.


    public
                hasAlreadyBeenSend() : bool

Therefore a unique ID is added to the getListUrl() which can be used to call actions. If the a request has the same ID, it is supposed, that the user presses the refresh button. Often this may not execute the action another time. Therefore this method can be called before, to ensure that the request has been send the first time.

Return values

bool —

whether the request has already been send

hideCurrentColumns()

This method can be used to hide defined columns.


    public
                hideCurrentColumns(mixed $columnNames) : void

Instead of using the removeColumn method the columns may be selectable using the list settings This setting may be overwritten using the list settings

Parameters

$columnNames : mixed

Return values

void —

isAjaxReloadRequest()

Returns whether this request is a ajax reload request


    public
                isAjaxReloadRequest() : bool

Return values

bool —

whether a ajax reload request is passed

isDroppable()

Returns whether the list supports CSGuiUpload drag&drop


    public
                isDroppable() : bool

Return values

bool —

listbuilder isDropppable value

isMultiplePopupRequest()

Returns whether rows are selected and a popup is requested for them


    public
                isMultiplePopupRequest() : array<string|int, mixed>

Return values

array<string|int, mixed> —

whether a popup is requested for multiple selected list items

isPortal()

Returns whether the component is used in the portal


    public
            static    isPortal() : bool

Return values

bool —

whether the portal mode is activated

makeBody()


    public
                makeBody() : mixed

Return values

mixed —

makeForwardUrl()


    public
            static    makeForwardUrl(mixed $url[, mixed $useRequestParams = array() ]) : mixed

Parameters

$url : mixed
$useRequestParams : mixed = array()

Return values

mixed —

makeHead()


    public
                makeHead() : mixed

Return values

mixed —

makeHtml()

Creates an html representation of the window according to the current settings


    public
                makeHtml() : string

Return values

string —

html of the window

makeHtmlBegin()


    public
                makeHtmlBegin() : mixed

Return values

mixed —

makeHtmlEnd()


    public
                makeHtmlEnd() : mixed

Return values

mixed —

makeJSCode()

Returns a string with script-tags.


    public
                makeJSCode([string $section = 'before' ]) : string

Parameters

$section : string = 'before'

Return values

string —

makeOuterBody()


    public
                makeOuterBody() : mixed

Return values

mixed —

makeOuterHead()


    public
                makeOuterHead() : mixed

Return values

mixed —

menubarAddHandle()

Adds a handle as next item in the dialogs Menubar


    public
                menubarAddHandle() : void

Return values

void —

menubarAddHelp()

Adds a help popup menu to the dialogs Menubar


    public
                menubarAddHelp([string $module = '' ]) : void

Parameters

$module : string = '': the module for which the help should be displayed

Return values

void —

menubarAddItem()

Adds a menu entry to the dialogs Menubar


    public
                menubarAddItem(string $label, string $javascript[, string $img = "" ][, string $menubar = 'GUI_MENU_FILE' ]) : void

Parameters

$label : string: the label which is displayed in the entry
$javascript : string: the javascript code which is executed when clickin on the entry
$img : string = "": the image of the popup relative to the images/popup folder
$menubar : string = 'GUI_MENU_FILE': the label which is displayed in the menu

Return values

void —

menubarAddLink()

Adds a menu to the dialogs Menubar, which represents a link


    public
                menubarAddLink(string $label[, string $href = '#' ][, string $target = '' ][, string $onClick = '' ][, string $accesskey = '' ]) : void

Parameters

$label : string: the label which is displayed in the menu
$href : string = '#': the href of the link
$target : string = '': the target frame of the link
$onClick : string = '': the javascript code which is called when clicking on the link
$accesskey : string = '': the keybord access key of the menu

Return values

void —

menubarAddMenu()

Adds a popup menu to the dialogs Menubar, which request a popup menu from the server if it is clicked


    public
                menubarAddMenu(string $id, string $label[, string $src = '' ][, string $accesskey = '' ]) : void

Parameters

$id : string: the id which is added to the popup request
$label : string: the label which is displayed in the menu
$src : string = '': the url where the popup is requested from. If it is not set the url definied with the menubarSetUrl method is taken.
$accesskey : string = '': the keybord access key of the menu

Return values

void —

menubarAddPopup()

Adds a popup menu to the dialogs Menubar. If there had been already one popup defined with the same label this popup is appended to it.


    public
                menubarAddPopup(string $label[, CSGuiComponent $popup = null ][, string $accesskey = '' ]) : void

Parameters

$label : string: the label which is displayed in the menu.
$popup : CSGuiComponent = null: the CSGuiComponent which contains the Popup or null if it is the popup defined in the dialog
$accesskey : string = '': the keybord access key of the menu

Return values

void —

menubarAddUploadItem()

Adds an upload button to the menubar The button is displayed on the upper border of the dialog.


    public
                menubarAddUploadItem(string $title, string $onUpload[, string $image = '' ][, array<string|int, mixed> $allowedFileTypes = array() ]) : CSGuiToolbarButton

Parameters

$title : string: the label of the button
$onUpload : string: the javascript to execute where the javascript variable 'filePath' contains the path to the uploaded file
$image : string = '': the image file relative to the admin/images/toolbar directory
$allowedFileTypes : array<string|int, mixed> = array(): the filetypes which may be uploaded

Return values

CSGuiToolbarButton —

menubarIsCollapsed()

Tells if the menubar is collapsed, either by explicitly calling the setCollapsed method or by the default settings in the skin options.


    public
                menubarIsCollapsed() : bool

Return values

bool —

true if collapsed, false otherwise

menubarRemoveAllMenus()

Removes all menus from the dialogs Menubar


    public
                menubarRemoveAllMenus() : void

Return values

void —

menubarSetCollapsed()

Collapses the menubar into a toolbar button with context menu


    public
                menubarSetCollapsed([bool $boolean = true ]) : mixed

Parameters

$boolean : bool = true

Return values

mixed —

menubarSetRightTitle()

Sets an arbitrary html text on the right end of the menubar


    public
                menubarSetRightTitle(string $title[, string $tooltip = '' ]) : void

Parameters

$title : string: the text in the menubar
$tooltip : string = '': the tooltip of the title text in the menubar

Return values

void —

menubarSetUrl()

Changes the url where the menubar should be loaded from when using the menubarAddMenu function.


    public
                menubarSetUrl([string $menubarUrl = '' ]) : void

It can be set if the pure forward name is not sufficient or another file should be used for a popup request This is an important option to add additional GET parameters, which should be available again for popups You can add additionalParameters to the forward url using the & seperator, e.g 'destination.php&param1=true'

Parameters

$menubarUrl : string = '': the url where the menubar popups are defined

Return values

void —

menubarSetVisible()

Sets the visibility of the menubar


    public
                menubarSetVisible(bool $boolean) : void

By default the menubar is visible but can be hidden with this method.

Parameters

$boolean : bool: whether to show the menubar or not

Return values

void —

popupAddCheckboxItem()

Adds a checkbox popup item to the end of the current component's popup


    public
                popupAddCheckboxItem(mixed $sLabel, mixed $sJavascript[, mixed $bIsEnabled = true ][, mixed $bIsSelected = false ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void

Parameters

$sLabel : mixed
$sJavascript : mixed
$bIsEnabled : mixed = true
$bIsSelected : mixed = false
$sAccessKey : mixed = ''
$bEvalCondition : mixed = true
$mNamespaces : mixed = array()
$sGroupIdentifier : mixed = ''
$iGroupIndex : mixed

Return values

void —

popupAddItem()

Adds a popup item to the end of the current component's popup


    public
                popupAddItem(string $sLabel[, string $sJavascript = '' ][, int $bIsEnabled = true ][, string $sIconPath = '' ][, string $sAccessKey = '' ][, bool $bEvalCondition = true ][, array<string|int, mixed>|string $mNamespaces = array() ][, string $sGroupIdentifier = '' ], int $iGroupIndex) : void

Parameters

$sLabel : string: label of the popup item. It can use '//' to create a submenu, e.g. 'submenu_label//sub_submenu_label//label'
$sJavascript : string = '': Javascript code to call with the popup item
$bIsEnabled : int = true: can be false if the popup item should be visible but disabled
$sIconPath : string = '': Image of the item relative to the admin/images/popup/ directory
$sAccessKey : string = '': Keyboard access key of the popup item
$bEvalCondition : bool = true: If the condition should be evaluated.
$mNamespaces : array<string|int, mixed>|string = array(): The namespace for the button like "workflow"
$sGroupIdentifier : string = '': The identifier to add the popup item to a group, which has separator at the beginning and at the end.
$iGroupIndex : int: The index of the group. The index will be used to order the groups. The lowest index will be taken of all popup items inside of a group.

Return values

void —

popupAddJavascriptFunction()

Adds a Javascript method to the components Javascript which can be used to display a popup.


    public
                popupAddJavascriptFunction([string $jsName = 'displayComponentPopup' ]) : void

It can be called with the given name and the requested POPUPID and event (event object) as argument, e.g. displayComponentPopup(ID, event)

Parameters

$jsName : string = 'displayComponentPopup': the name of the Javascript method, if it should be different from the standard 'displayComponentPopup'

Return values

void —

popupAddSeparator()

Adds a popup separator item to the end of the current component's popup


    public
                popupAddSeparator([string $evalCondition = true ][, string $subMenu = '' ]) : void

Parameters

$evalCondition : string = true: optional php condition to be evaluated as true to let the popup item be available
$subMenu : string = '': optional sub menu the separator should be placed within. It can use '//' to add the seperator within a submenu, e.g. 'submenu_label//subsubmenu_label'

Return values

void —

popupAddShowInTree()

Adds a popup menu show in tree to the list


    public
                popupAddShowInTree([bool $bShow = TRUE ], int $iPopupID) : bool

Parameters

$bShow : bool = TRUE: If TRUE the popup-menu-entry will be shown
$iPopupID : int: Requested popup ID

Return values

bool —

popupAddSubMenuDefinition()

Adds a definition (Icon, GroupIdentifier, GroupIndex) for a sub menu entry.


    public
                popupAddSubMenuDefinition(string $sSubMenuLabel, string $sIcon[, string $sGroupIdentifier = '' ], int $iGroupIndex) : void

Parameters

$sSubMenuLabel : string: The target sub menu label
$sIcon : string: THe icon of the sub menu.
$sGroupIdentifier : string = '': The group identifier
$iGroupIndex : int: The index of the group.

Return values

void —

popupEnableDebugMode()


    public
                popupEnableDebugMode() : mixed

Return values

mixed —

popupEvaluateCode()

Provides a condition which must be true if the popup item should be available


    public
                popupEvaluateCode(mixed $evalCode) : mixed

Sometimes it is necessary to evaluate further code to define a $evalCondition. As the condition only returns one value, this can not be done there. Therefore any phpCode can be evaluated using the popupEvaluateCode method. Here e.g. conditions can be stored in variables which can be used in the $evalCondition later. {RecordID} can be used to get the id of the current selected item

Parameters

$evalCode : mixed

Return values

mixed —

popupGetJavascript()

Creates a javascript onContext='...' code, which can be inserted in a html component


    public
                popupGetJavascript(string $id[, string $innerHtml = "" ][, string $elementName = 'span' ][, string $embedAttribute = 'oncontextmenu' ][, string $additionalAttributes = "" ][, string $popupUrl = '' ][, string $popupIDField = '' ][, string $jsCode = '' ]) : string

Parameters

$id : string: The value which will can be received using the popupGetRequestID() method
$innerHtml : string = "": The content of the optional html element is not empty. If this value is not set the $id is used instead
$elementName : string = 'span': An optional html element name which will contain the attribute
$embedAttribute : string = 'oncontextmenu': The attribute which should contain the JavaScript code
$additionalAttributes : string = "": Additional attributes which should be additionally added to the oncontext command
$popupUrl : string = '': Overwrites the standard url where the popup is defined
$popupIDField : string = '': Overwrites the standard IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified
$jsCode : string = '': The JavaScript code which should be evaluated before the contextmenu is shown

Return values

string —

The JavaScript code or a complete html element which will create the popup request

popupGetMultipleRequestID()

This function may be used to check whether the request is a popupRequest for multiple elements.


    public
                popupGetMultipleRequestID() : bool

Return values

bool —

whether a popup request for multiple items have been sent

popupGetRequestID()

If a user request a popup the id describing the kind of request is returned here This function may also be used to check whether the request is a popupRequest.


    public
                popupGetRequestID() : string

Return values

string —

the ID for which a popup is requested

popupInsertItem()

Adds a popup item into a specified location of the current component's popup


    public
                popupInsertItem(mixed $mIndex, mixed $sLabel[, mixed $sJavascript = '' ][, mixed $bIsEnabled = true ][, mixed $sIconPath = '' ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void

Parameters

$mIndex : mixed
$sLabel : mixed
$sJavascript : mixed = ''
$bIsEnabled : mixed = true
$sIconPath : mixed = ''
$sAccessKey : mixed = ''
$bEvalCondition : mixed = true
$mNamespaces : mixed = array()
$sGroupIdentifier : mixed = ''
$iGroupIndex : mixed

Return values

void —

popupMakeHtml()

Creates the final popup html code


    public
                popupMakeHtml(mixed $PopupID) : mixed

Parameters

$PopupID : mixed

Return values

mixed —

popupRemoveAllItems()

Completely removes all popup items from the component


    public
                popupRemoveAllItems([array<string|int, mixed> $keep = array() ][, bool $recursive = false ]) : void

Parameters

$keep : array<string|int, mixed> = array(): the labels of the items which may be kept
$recursive : bool = false: whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees

Return values

void —

popupRemoveItem()

Remove one items from the popup for the component


    public
                popupRemoveItem(string $label[, string|bool $evalCondition = true ][, array<string|int, mixed>|string $aNamespaces = array() ]) : void

Parameters

$label : string: label of the popup item
$evalCondition : string|bool = true: optional php condition to be evaluated as true to let the popup item be available {RecordID} can be used to get the id of the current selected item
$aNamespaces : array<string|int, mixed>|string = array(): Either a simple string for a namespace like "workflow" or an array for further specification like array("Workflow", "123"). All items having the same label and all namespaces passed set (even if they are having more) will be removed.

Return values

void —

popupRemoveItemsByNamespace()

Remove multiple from the popup specified by the namespace. All items having all the passed namespaces will be removed even if they are having more than the passed.


    public
                popupRemoveItemsByNamespace([array<string|int, mixed> $aNamespaces = array() ]) : void

Parameters

$aNamespaces : array<string|int, mixed> = array(): An array containing all the defined namespaces for the popup items to be removed

Return values

void —

popupSetCharset()

Sets the encoding for the popup components


    public
                popupSetCharset(mixed $charset) : string

Parameters

$charset : mixed

Return values

string —

$charset the new characterset

popupSetDefaultPopup()

Sets the default popup for the component


    public
                popupSetDefaultPopup(CSGuiPopup $popup) : void

Parameters

$popup : CSGuiPopup: Popup object to use as popup for the component

Return values

void —

popupSetRequestID()

Overwrites the id returned by popupSetRequestID


    public
                popupSetRequestID(string $id) : void

Parameters

$id : string: the value of the id to overwrite

Return values

void —

popupSetUrl()

Changes the url where the popup should be loaded from.


    public
                popupSetUrl([string $popupUrl = '' ][, string $idField = 'POPUP_ID' ][, bool $recursive = false ]) : void

Parameters

$popupUrl : string = '': the url where the popup is defined
$idField : string = 'POPUP_ID': the IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified
$recursive : bool = false: whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees

Return values

void —

popupSetVisible()

Enables or disables the visiblity of the popup.


    public
                popupSetVisible([bool $visibility = null ]) : void

If a popupAddItem is called before, the popup is automatically set to visible . If you only create the popup menu when recieving the popupGetRequestID parameter you have to enable the popup menu manually. You can even hide the popup completly be setting the $visibility to false

Parameters

$visibility : bool = null: whether the component has a visible popup menu

Return values

void —

popupUseDefaultItem()

Adds a standard popup item to the end of the current component's popup


    public
                popupUseDefaultItem(string $label[, string|bool $evalCondition = true ]) : void

The popupitems defined using the popupSetDefaultPopup can be reused after popupRemoveAllItems has been called. This offers the possibility to reuse working popupitems in a userdefined popupmenu The type of popup item which should be used is defined by the $label parameter. This label represents the label of the original item

Parameters

$label : string: label of the popup item
$evalCondition : string|bool = true: php condition to be evaluated as true to let the popup item be available

Return values

void —

removeActionColumn()

Removes the Action (last) column in the list


    public
                removeActionColumn() : void

Return values

void —

removeAllColumns()

Removes all columns from the list


    public
                removeAllColumns() : void

Return values

void —

removeAllColumnUpdates()

Removes all columns bottom options from the list


    public
                removeAllColumnUpdates() : void

Return values

void —

removeAllFilters()

Removes all columns filter options from the list


    public
                removeAllFilters() : void

Return values

void —

removeColumn()

Removes a column from the list


    public
                removeColumn(string $name) : void

Parameters

$name : string: the database field name of the column

Return values

void —

removeColumnUpdate()

Removes all columns bottom options from the list


    public
                removeColumnUpdate(string $name) : void

Parameters

$name : string: the name of the column

Return values

void —

removeFilter()

Removes one columns filter option from the list


    public
                removeFilter(string $name) : void

Parameters

$name : string: the name of the column

Return values

void —

removeView()

Removes a view with a given name from the list


    public
                removeView(string $name) : void

Parameters

$name : string: the name of the view to be removed

Return values

void —

setAjaxReloadable()

Defines whether this window can be reloaded using ajax request to optimize performance


    public
                setAjaxReloadable([bool $isAjaxReloadable = true ]) : mixed

Parameters

$isAjaxReloadable : bool = true: whether this window can be ajax reloaded

Return values

mixed —

setAjaxReloadCompleteWindow()

Defines that the complete window contents must be reloaded If not set only the parts defined using the setAjaxReloadPart method are changed


    public
                setAjaxReloadCompleteWindow([mixed $ajaxReloadCompleteWindow = true ]) : void

Parameters

$ajaxReloadCompleteWindow : mixed = true

Return values

void —

setAjaxReloadPart()

If this window is defined ajax reloadable and a ajax reload request is passed this method can be used to change only parts of the html If no ajax part is defined the complete body ('CSGuiWindowBody') and head ('CSGuiWindowHead') is passed


    public
                setAjaxReloadPart(string $id, string $html) : string

Parameters

$id : string: the id of the html element which should be replaced
$html : string: the new html code for this element. If set to the boolean false this part is never added (until resetted with true)

Return values

string —

the $html

setAllowAll()

Activates or deactivates all rights for the list


    public
                setAllowAll(bool $boolean) : void

Parameters

$boolean : bool: whether all rights are activated or deactivated

Return values

void —

setAlternativeSortOrder()

Sets an alternative sort order for the list, which is used instead of the column name. This might be required, if a field is evaluated.


    public
                setAlternativeSortOrder(string $alternativeSortOrder) : void

Parameters

$alternativeSortOrder : string: the sort order to use instead of the default column

Return values

void —

setAutoReloadOnChangeEvents()

Activates the Autoupdate mode forcing a list reload, if a corresponding Record is changed


    public
                setAutoReloadOnChangeEvents([bool $autoUpdate = true ]) : void

Parameters

$autoUpdate : bool = true: whether the list should be autoUpdated

Return values

void —

setBasePath()

Defines the path to be used as a base for other page links


    public
                setBasePath(string $sHref) : void

Parameters

$sHref : string

Return values

void —

setBodyAttributes()

Sets the attributes in the body tag of the window


    public
                setBodyAttributes(string $bodyAttributes) : void

Parameters

$bodyAttributes : string: the attributes to be added to the body tag

Return values

void —

setBookmarkable()

Activates the bookmark functionality for this list.


    public
                setBookmarkable(bool $bookmarkable) : void

Parameters

$bookmarkable : bool: whether the list should show bookmarks

Return values

void —

setCharset()

Overwrites the default charset of the html document (UTF-8)


    public
                setCharset(mixed $charset[, mixed $changeLocale = true ]) : void

Parameters

$charset : mixed: the charset to use for the document
$changeLocale : mixed = true: whether the new characterset should be applied to all translations

Return values

void —

setCloneable()

Activates the clone popup menu items for the list


    public
                setCloneable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the clone popup items

Return values

void —

setController()

sets the controller for the gui component


    public
                setController(object $oController) : void

Parameters

$oController : object: the controller for the gui component

Return values

void —

setCreatable()

Activates the new button and popup menu item for the list


    public
                setCreatable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the create new button and popup item

Return values

void —

setCSVSupport()

Activates or deactivates the csv import and export button and massactions


    public
                setCSVSupport([mixed $csvSupport = true ]) : void

Parameters

$csvSupport : mixed = true: whether all bottons are visible (true), no actions are available (false) or only the export / import is available ('export' / 'import)

Return values

void —

setCurrentColumns()

This method can be used to manipulate the visiblity and order of all defined columns It can be used to easily change the column order and to display only some of the allowed columns This setting may be overwritten using the list settings


    public
                setCurrentColumns(mixed $columnNames) : void

Parameters

$columnNames : mixed

Return values

void —

setDefaultConfiguration()


    public
                setDefaultConfiguration() : mixed

Return values

mixed —

setDefaultSortOrder()

Sets a default sort order for the list, which is used if the user did not sort for any column yet in the session


    public
                setDefaultSortOrder(string $defaultSortOrder) : void

Parameters

$defaultSortOrder : string: the sort order to use by default

Return values

void —

setDeletable()

Activates the delete buttons and popup menu items for the list


    public
                setDeletable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the view buttons and popup items

Return values

void —

setDoctype()

Overwrites the default Doctype of the html document


    public
                setDoctype(string $sDocType) : void

Parameters

$sDocType : string: The DOCTYPE line to use for the document

Return values

void —

setDragable()

Sets the elements in the list dragable


    public
                setDragable([bool $dragable = true ]) : mixed

Parameters

$dragable : bool = true: whether the elements may be dragged

Return values

mixed —

setDroppable()

Activates the drag&drop zone support for the MAM studio list


    public
                setDroppable([bool $bDroppable = true ]) : void

Parameters

$bDroppable : bool = true: whether the list should have support for CSGuiUpload drag&drop

Return values

void —

setEditable()

Activates the edit buttons and popup menu items for the list.


    public
                setEditable(bool $boolean) : void

Note: if the list is viewable isViewable() but not editable, the buttons still occur but have the caption 'view' instead of 'edit'

Parameters

$boolean : bool: whether the list should support the editor buttons and popup items

Return values

void —

setEditUrl()

Sets the url of the list item editor, if the pure forward name is not sufficient or the default editor name is not correct Each list has an default editor that is opened upon edit, view or create actions. The url of the default editor is the forward url of the list itself, only that the term 'list' is replaced by 'edit'. For a list - ../admin/forward.php?forward=modules|foo|my-super-list-file.php the default editor would be - ../admin/forward.php?forward=modules|foo|my-super-edit-file.php&RecordID=1234 If this is not correct or you require additional GET parameters like a $FilterStoryID, etc. you may overwrite the editor url with this method. Then you may use the {RecordID} field to be replaced by the correct id.


    public
                setEditUrl(string $editUrl[, string $editTarget = 'edit' ][, string $editWindowParams = "width=538,height=600,status=yes,resizable=yes,left=300,top=200,scrollbars=yes" ]) : void

Parameters

$editUrl : string: the url of the list including all constant GET parameters
$editTarget : string = 'edit': the target of the editor window
$editWindowParams : string = "width=538,height=600,status=yes,resizable=yes,left=300,top=200,scrollbars=yes": the window parameters of the editor

Return values

void —

setEvaluateRecordCode()

The content of the list is read in a large array with the name $data.


    public
                setEvaluateRecordCode(string $phpCode) : void

This array has as key the id and as value an array of fieldname => value pairs It is possible to modify this array with php code to view additional or formatted output.

Parameters

$phpCode : string: the PhpCode which can modify the $data array

Return values

void —

setFilterValue()

Sets or removes a column filter in the list.


    public
                setFilterValue(string $name[, string $newValue = null ]) : void

Parameters

$name : string: the database field name of the column for which the filter should be set/removed or null to remove all filter. The $name null does not work to set all filters.
$newValue : string = null: the new value for the filter or null to remove the filter(s)

Return values

void —

setFooterVisible()

Sets the visibility of the the footer line below the list By default this line is visible.


    public
                setFooterVisible(bool $boolean) : void

Parameters

$boolean : bool: whether the footer line below the list should be visible or not

Return values

void —

setFullHeight()

Sets whether the html and body tag should get 100% height attributes


    public
                setFullHeight([bool $fullHeight = true ]) : void

Parameters

$fullHeight : bool = true: whether 100% height should be used

Return values

void —

setIDField()

Sets the name of the unique field that represents the primary key of the listed data


    public
                setIDField(string $fieldName) : void

Parameters

$fieldName : string: name of the field containing the unique id for the list

Return values

void —

setIEMetaCompatible()

Overwrites the default meta http-equiv of the html document.


    public
                setIEMetaCompatible(string $sNewIEMetaCompatible) : void

Parameters

$sNewIEMetaCompatible : string: The meta http-equiv line to use for the document. If set to FALSE the IE meta tag will be deactivated/removed.

Return values

void —

setItemSelectorVisible()

Activates the itemSelector action


    public
                setItemSelectorVisible(bool $boolean) : void

Parameters

$boolean : bool: whether the itemSelector is visible

Return values

void —

setListRecursive()

Sets whether listed folders should list their parents recursiv and whether to show a dialog to toggle this mode in the GUI


    public
                setListRecursive([bool $listRecursive = true ][, bool $showToggleButton = true ]) : void

Parameters

$listRecursive : bool = true: default value whether the list should show all children recursivly
$showToggleButton : bool = true: whether a button should be added to toggle this mode in the GUI

Return values

void —

setListUrl()

Sets the url of the list, if the pure forward name is not sufficient This is an important option to add additional GET parameters, which should be available again after filter or sort actions


    public
                setListUrl(string $listUrl[, array<string|int, mixed> $useRequestParams = array() ]) : void

Parameters

$listUrl : string: the url of the list including all constant GET parameters
$useRequestParams : array<string|int, mixed> = array(): an array of params which should be reused to complete the url

Return values

void —

setMaximumColumnLength()

Sets the maximum length for standard text fields in the list


    public
                setMaximumColumnLength([int $length = 40 ]) : mixed

Parameters

$length : int = 40: the new maximum length

Return values

mixed —

setMinimizeToContent()

Defines whether the dialog fills 100% width and 100% height or is should minized to its contents real size.


    public
                setMinimizeToContent([mixed $minimizeMode = true ]) : mixed

Parameters

$minimizeMode : mixed = true

Return values

mixed —

setOnClick()

Sets a javascript code to be evaluated onClick


    public
                setOnClick(string $javascript) : void

Parameters

$javascript : string: the javascript code to be executed - use {RecordID} for the row selector id

Return values

void —

setOnDblClick()

Sets a javascript code to be evaluated onDblClick


    public
                setOnDblClick(string $javascript) : void

Parameters

$javascript : string: the javascript code to be executed - use {RecordID} for the row selector id

Return values

void —

setOpenEditorWindowName()

sets the window name the editor of the clicked item should have


    public
                setOpenEditorWindowName(mixed $val) : void

Parameters

$val : mixed

Return values

void —

setOpenEditorWindowParams()

sets the window params the editor of the clicked item should have


    public
                setOpenEditorWindowParams(mixed $val) : void

Parameters

$val : mixed

Return values

void —

setPortalMode()

Sets the component to the browsers portal


    public
            static    setPortalMode([mixed $isPortal = true ]) : void

Parameters

$isPortal : mixed = true

Return values

void —

setPreviewImageUrl()

Sets a preview image that should be displayed next to the title


    public
                setPreviewImageUrl(string $sPreviewImageUrl) : void

Parameters

$sPreviewImageUrl : string: the URL of the image

Return values

void —

setRenameable()

Activates the rename popup menu items support for the list, if the record is a TreeRecord.


    public
                setRenameable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the rename popup items

Return values

void —

setRightTitle()

Sets the right part of the title label below the toolbar The title is not translated.


    public
                setRightTitle(string $title) : void

Parameters

$title : string: the title of the caption below the toolbar

Return values

void —

setRootItems()

Set's an array of root item IDs the list should be limited to


    public
                setRootItems([array<string|int, mixed> $rootIDs = array() ]) : void

Parameters

$rootIDs : array<string|int, mixed> = array(): array of root item IDs

Return values

void —

setRowSelectorField()

Sets the name of the column added to the url that represents the primary key of the listed data


    public
                setRowSelectorField(string $getName) : void

Parameters

$getName : string: name of the column with the primary key

Return values

void —

setSearchable()

defines whether this list is searchable and contains a search input


    public
                setSearchable(bool $searchable) : void

Parameters

$searchable : bool

Return values

void —

setSessionValue()

Stores a value in the lists session for a given name. This value is e.g. bookmarkable


    public
                setSessionValue(string $name[, mixed $newValue = null ][, bool $isFilter = false ]) : mixed

Parameters

$name : string: the name of the lists session variable
$newValue : mixed = null: the new session value which can be a string or a json serializable object
$isFilter : bool = false: whether this session value is defining a filter and can be removed using the "removeFilter" button

Return values

mixed —

setSetting()

Sets the value of a defined Setting for the current user


    public
                setSetting(string $name, string $value[, bool $permanently = false ]) : mixed

Parameters

$name : string: the name of the setting
$value : string: the new value
$permanently : bool = false: (default: false) whether this setting should be stored permanently

Return values

mixed —

setSettingsContext()

Sets a unique subcontext for the registry settings of the list Each list containing the same subcontext is using the same settings If it is not set each list with different forward-URLS has its own context


    public
                setSettingsContext(string $subcontext) : mixed

Parameters

$subcontext : string: the subcontext

Return values

mixed —

setSettingsContextData()

Sets the registry sub context data for the current registry.


    public
                setSettingsContextData(array<string|int, mixed> $aSubContextData[, bool $bPermanently = false ]) : void

Parameters

$aSubContextData : array<string|int, mixed>: An associative array of the data ("NAME" => "VALUE")
$bPermanently : bool = false: Whether this setting should be stored permanently

Return values

void —

setSettingsVisible()

Defines whether the settings buttons is visible in the toolbar


    public
                setSettingsVisible(bool $visible) : mixed

Parameters

$visible : bool: whether the settings may be changed by the users

Return values

mixed —

setSQLFilter()

Sets a constant filter to the list, which is applied additional to group filters, etc.


    public
                setSQLFilter(string $filter) : void

Parameters

$filter : string: the additional constant filter for the list

Return values

void —

setSQLQuery()

Overwrites the default query of the list, which is normally created out of the listed record type


    public
                setSQLQuery(string $query[, string $tableName = "" ][, string $countQuery = "" ]) : void

Parameters

$query : string: the sql query to use for the list instead of the default query
$tableName : string = "": the tablename of the record table in the sql query
$countQuery : string = "": the sql query to use to get the amount of hits for the list instead of the default query

Return values

void —

setSubTitleVisible()

Sets the visibility of the the sub title line below the title By default the subtitle is visible.


    public
                setSubTitleVisible(bool $boolean) : void

Parameters

$boolean : bool: whether the sub title should be visible or not

Return values

void —

setSwitchableList()

May use the New Studio List


    public
                setSwitchableList([bool $bShouldUseSwitchableList = true ]) : mixed

Parameters

$bShouldUseSwitchableList : bool = true: TRUE in case New Studio List can be used if available, FALSE Otherwise.

Return values

mixed —

setThumbListMode()

Sets the current list to a thumb list mode.


    public
                setThumbListMode([string $tdStyle = '' ][, bool $hideContentOfSelectedColumns = true ][, bool $showHeaderRows = true ]) : mixed

That means that each entry is displayed in a span and not in a own table row. Therefore multiple entries can be shown in one line.

Parameters

$tdStyle : string = '': this style is added to the td surrounding the complete content
$hideContentOfSelectedColumns : bool = true: if this flag is set the content of all defined columns at that time is hidden. This can be used, if the list should be filterable and sortable with those fields.
$showHeaderRows : bool = true: whether the header and footer rows of the list should be visible.

Return values

mixed —

setTitle()

Sets the left title label below the toolbar The title is not translated. Note that this is not the title of the window.


    public
                setTitle(string $title) : void

Parameters

$title : string: the title of the caption below the toolbar

Return values

void —

setTitleDark()

Gives the title a dark background, normally when later a toolbar is added etc.


    public
                setTitleDark([bool $boolean = TRUE ]) : void

Parameters

$boolean : bool = TRUE: whether the title should be dark, default TRUE

Return values

void —

setTitleVisible()

Sets the visibility of the title line below the toolbar By default this line is visible.


    public
                setTitleVisible(bool $boolean) : void

Parameters

$boolean : bool: whether the title line below the toolbar should be visible or not

Return values

void —

setType()

Changes the type of the dialog


    public
                setType([mixed $type = CSGUI_DIALOG_TYPE_WHITE_PADDING ]) : void

Parameters

$type : mixed = CSGUI_DIALOG_TYPE_WHITE_PADDING

Return values

void —

setUniqueID()

Sets the CSUniqueID for this window


    public
                setUniqueID([bool|string $id = true ]) : void

Parameters

$id : bool|string = true: the new uniqueID either as string or as bool (false: no uniqueID is set, true: a random uniqueID is set)

Return values

void —

setUpdatable()

Activates the mass updates for the list


    public
                setUpdatable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the defined mass updates

Return values

void —

setUsageControlsVisibility()

Sets the visibility of usage controls in the toolbar.


    public
                setUsageControlsVisibility([bool $bVisible = true ]) : bool

Parameters

$bVisible : bool = true: If true, the usage controls are visible, otherwise not.

Return values

bool —

The previous visibility state.

setView()

Sets the name of the current selected view


    public
                setView(string $name) : void

Parameters

$name : string: the name of the view which should be displayed

Return values

void —

setViewable()

Activates the view buttons and popup menu items for the list


    public
                setViewable(bool $boolean) : void

Parameters

$boolean : bool: whether the list should support the view buttons and popup items

Return values

void —

setVisibleItemsCount()

Sets the amount of items visible in the list.


    public
                setVisibleItemsCount([int $itemCount = 20 ]) : void

Parameters

$itemCount : int = 20: the amount of items shown at once in the list or all if set to "0"

Return values

void —

setWindowTitle()

Sets the window title as it is used in the heads title element


    public
                setWindowTitle(string $title) : void

Parameters

$title : string: the title to use for the document

Return values

void —

throwError()

Throws a CSException


    public
            static    throwError(string $sMessage, int $iCode) : void

Parameters

$sMessage : string
$iCode : int

Return values

void —

toolbarAddButton()

Adds a button to the toolbar The button is displayed on the upper border of the dialog.


    public
                toolbarAddButton(string $image, string $title[, string $href = '#' ][, string $target = '_self' ][, string $onclick = '' ][, string $accesskey = '' ][, string $menubar = 'GUI_MENU_FILE' ][, string $additionalAttributes = '' ][, string $index = -1 ]) : CSGuiToolbarButton

Parameters

$image : string: the image file relative to the admin/images/toolbar directory
$title : string: the label of the button
$href : string = '#': the url to open on click
$target : string = '_self': the target of the opened url
$onclick : string = '': javascript code to be evaluated on click
$accesskey : string = '': the keybord access key of the button
$menubar : string = 'GUI_MENU_FILE': the popupmenu in the menubar the button should be displayed or '' if it should not be displayed
$additionalAttributes : string = '': additional attributes which should be added to the button
$index : string = -1: either the index as a number or in the form GUI_MENU_UPDATE+1 to define the position of the toolbar button in the toolbar. If set to -1 it is appended to the end

Return values

CSGuiToolbarButton —

the defined button

toolbarAddCheckboxButton()

Adds a checkbox button to the toolbar


    public
                toolbarAddCheckboxButton(string $image, array<string|int, mixed> $titles[, array<string|int, mixed> $hrefs = array('#') ][, array<string|int, mixed> $targets = array('_self') ][, array<string|int, mixed> $onclicks = array('') ][, bool $defaultState = true ][, string $accesskey = '' ][, string $id = '' ][, string $visibility = '' ][, string $menubar = 'GUI_MENU_FILE' ][, string $additionalAttributes = '' ][, string $groupName = '' ]) : CSGuiToolbarButton

Parameters

$image : string: the images of the button relative to the admin/images/toolbar or in case of the CSGUI_TOOLBAR_TYPE_VERTICAL or CSGUI_TOOLBAR_TYPE_HORIZONTAL relative to the admin/images/popup directory
$titles : array<string|int, mixed>: the text or tooltip title of the button
$hrefs : array<string|int, mixed> = array('#'): the links of the button
$targets : array<string|int, mixed> = array('_self'): the targets of the link of the button
$onclicks : array<string|int, mixed> = array(''): javascript code to be evaluated onClick if this javascript functions return the boolean value 'false' the button toggle is canceld
$defaultState : bool = true: the default state of the button (true => first state is used, false => second state is used)
$accesskey : string = '': the keybord accelerator to navigate to the button with the alt key
$id : string = '': an optional id of the toolbar if you want to use more than one toolbar at the same time
$visibility : string = '': the visibility with the form GROUP:NAME
$menubar : string = 'GUI_MENU_FILE': the popupmenu in the menubar the button should be displayed or '' if it should not be displayed
$additionalAttributes : string = '': additional attributes which should be added to the button
$groupName : string = '': a string with a group name. Only one button of a group can be active at the same time

Return values

CSGuiToolbarButton —

the created button object

toolbarAddComponent()

Adds an arbitrary html text with subtitle to the toolbar


    public
                toolbarAddComponent(string $html[, string $title = "&nbsp;" ]) : void

Parameters

$html : string: the text in the first line
$title : string = " ": the text in the second line

Return values

void —

toolbarAddSeparator()

Adds a toolbar separator


    public
                toolbarAddSeparator() : CSGuiToolbarButton

Return values

CSGuiToolbarButton —

toolbarAddTextfield()

Adds a text input to the toolbar


    public
                toolbarAddTextfield(string $name, string $onsubmit[, string $title = '' ][, string $id = '' ][, string $visibility = '' ]) : CSGuiToolbarButton

Parameters

$name : string: the name of the textfield
$onsubmit : string: the js code which is called when pressing enter
$title : string = '': the text or tooltip title next to the textfield
$id : string = '': the id of the input
$visibility : string = '': the visibility with the form GROUP:NAME

Return values

CSGuiToolbarButton —

the created button object

toolbarAddUploadButton()

Adds an upload button to the toolbar The button is displayed on the upper border of the dialog.


    public
                toolbarAddUploadButton(string $title, string $onUpload[, string $image = '' ][, array<string|int, mixed> $allowedFileTypes = array() ]) : CSGuiToolbarButton

Parameters

$title : string: the label of the button
$onUpload : string: the javascript to execute where the javascript variable 'filePath' contains the path to the uploaded file
$image : string = '': the image file relative to the admin/images/toolbar directory
$allowedFileTypes : array<string|int, mixed> = array(): the filetypes which may be uploaded

Return values

CSGuiToolbarButton —

toolbarDisplayInBottombar()

Displays the toolbar buttons in the Lists Bottombar


    public
                toolbarDisplayInBottombar([bool $displayInBottombar = true ]) : void

Parameters

$displayInBottombar : bool = true

Return values

void —

toolbarRemoveAllButtons()

Removes all buttons from the toolbar


    public
                toolbarRemoveAllButtons() : void

Return values

void —

toolbarRemoveButton()

Removes a button from the toolbar


    public
                toolbarRemoveButton(string $name) : void

Parameters

$name : string: the name of the toolbar to remove

Return values

void —

toolbarSetRightTitle()

Sets an arbitrary html text with subtitle on the right end of the toolbar


    public
                toolbarSetRightTitle(string $menubarTitle[, string $toolbarTitle = '' ][, mixed $tooltip = '' ]) : void

Parameters

$menubarTitle : string: the text in the menubar
$toolbarTitle : string = '': the text in the toolbar
$tooltip : mixed = ''

Return values

void —

toolbarSetSize()

Can be set to false if the toolbar should appear in a small version


    public
                toolbarSetSize([bool $large = true ]) : void

Parameters

$large : bool = true: whether to use the large or small toolbar

Return values

void —

toolbarSetVisible()

Sets the visibility of the toolbar


    public
                toolbarSetVisible(bool $boolean) : void

By default the toolbar is visible but can be hidden with this method.

Parameters

$boolean : bool: whether to show the toolbar or not

Return values

void —

CSGuiList extends CSGuiDialog in package Core GUI

Tags

Table of Contents

Properties

$additionalHead

Tags

$ajaxReloadCompleteWindow

Tags

$ajaxReloadParts

Tags

$bodyAttributes

Tags

$bodyClasses

Tags

$charset

Tags

$csscodes

Tags

$csslinks

Tags

$doctype

Tags

$isAjaxReloadable

Tags

$isDisabled

Tags

$isPortal

Tags

$jscodes

Tags

$jslinks

Tags

$jsprototyping

Tags

$menubar

Tags

$menubarIsVisible

Tags

$metaData

Tags

$popup

Tags

$popupIDField

Tags

$popupUrl

Tags

$rightTitle

Tags

$subTitleIsVisible

Tags

$title

Tags

$titleIsDark

Tags

$titleIsVisible

Tags

$toolbar

Tags

$toolbarIsVisible

Tags

$toolbarSize

Tags

$type

Tags

$visibility

Tags

$windowTitle

Tags

Methods

__construct()

Parameters

Tags

Return values

activateCompression()

Parameters

Tags

Return values

activateDragAndDropHandling()

Tags

Return values

CSGuiList extends CSGuiDialog
in package

Core

GUI