Class class_toolkit_admin

Description
Description | Vars | Methods (details)

Admin-Part of the toolkit-classes

Located in /admin/class_toolkit_admin.php (line 16) 

class_toolkit
   |
   --class_toolkit_admin
Method Summary
Description | Vars | Methods (details)
class_toolkit_admin __construct ([string $strSystemid = ""])
string adminwidgetSeparator ()
string adminwidgetText (string $strText)
string dataTable (mixed $arrHeader, mixed $arrValues)
string divider ([string $strClass = "divider"])
string dragableListFooter (string $strListId)
string dragableListHeader (string $strListId, [bool $bitOnlySameTable = false])
string formClose ([ $bitIncludePeFields = true])
string formDateSimple ([string $strName = ""], [int $intDay = ""], [int $intMonth = ""], [int $intYear = ""], [string $strTitle = ""], [bool $bitToday = true], [string $strClass = "inputDate"])
string formDateSingle (string $strName, string $strTitle, class_date $objDateToShow, [string $strClass = "inputDate"], [boolean $bitWithTime = false])
string formHeader (string $strAction, [string $strName = ""], [ $strEncoding = ""])
string formHeadline (string $strText, [string $strClass = "heading"])
string formInputCheckbox (string $strName, string $strTitle, [bool $bitChecked = false], [string $strClass = ""])
string formInputDropdown (string $strName, mixed $arrKeyValues, [string $strTitle = ""], [string $strKeySelected = ""], [string $strClass = "inputDropdown"], [bool $bitEnabled = true], [string $strAddons = ""])
string formInputHidden (string $strName, [string $strValue = ""])
string formInputPageSelector (string $strName, [string $strTitle = ""], [string $strValue = ""], [string $strClass = "inputText"])
string formInputPassword (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputText"])
string formInputSubmit ([string $strValue = "Submit"], [string $strName = "Submit"], [string $strEventhandler = ""], [ $strClass = "inputSubmit"])
string formInputText (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputText"], [string $strOpener = ""], [bool $bitReadonly = false])
string formInputTextArea (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputTextarea"])
string formInputUpload (string $strName, [string $strTitle = ""], [string $strClass = "inputText"], bool $bitMultiple)
string formInputUploadFlash (string $strName, string $strTitle, string $strAllowedFileTypes, [bool $bitMultiple = false], [bool $bitFallback = false])
string formOptionalElementsWrapper (string $strContent, [string $strTitle = ""], [bool $bitVisible = false])
string formTextRow (string $strText, [ $strClass = "text"])
string formWysiwygEditor ([string $strName = "inhalt"], [string $strTitle = ""], [string $strContent = ""], [string $strToolbarset = "standard"])
string getAdminModuleActionNavi ( $arrActions, mixed $arrModules)
string getAdminModuleNavi (mixed $arrModules, string $strCurrent)
string getAdminwidget (string $strSystemid, string $strName, string $strContent, [string $strEditLink = ""], [string $strDeleteLink = ""])
string getContentToolbar (mixed $arrEntries, [int $intActiveEntry = -1])
string getDashboardColumnFooter ()
string getDashboardColumnHeader (string $strColumnId)
string getDashboardWidgetEncloser (string $strDashboardEntryId, string $strWidgetContent)
string getFieldset (string $strTitle, string $strContent, [string $strClass = "fieldset"])
string getFilemanagerImageDetails (array $arrContent)
string getFilemanagerInfoBox (mixed $arrContent)
string getGraphContainer (string $strImgSrc)
string getLanguageButton (string $strLanguage, string $strLanguageName, [bool $bitActive = false])
string getLanguageSwitch (string $strLanguageButtons)
mixed getLayoutFolder (string $strContent, string $strLinkText, [bool $bitVisible = false], [string $strCallbackVisible = ""], [string $strCallbackInvisible = ""])
string getLayoutFolderPic (string $strContent, [string $strLinkText = ""], [string $strImageVisible = "icon_folderOpen.gif"], [string $strImageInvisible = "icon_folderClosed.gif"], [bool $bitVisible = true])
void getMainDashboard ( $arrColumn)
string getPageInfobox (mixed $arrContent)
mixed getPageview (array $arrData, int $intCurrentpage, string $strModule, string $strAction, [string $strLinkAdd = ""], [int $intElementPerPage = 15])
string getPathNavigation (mixed $arrEntries)
string getPreformatted (array $arrLines, [int $nrRows = 0])
mixed getSimplePageview (class_array_section_iterator $objArraySectionIterator, string $strModule, string $strAction, [string $strLinkAdd = ""])
unknown getTextRow (unknown_type $strText, [ $strClass = "text"])
string getTreeview (string $strLoadNodeDataFunction, string $strRootNodeSystemid, [array $arrNodesToExpand = array()], [string $strSideContent = ""], [string $strRootNodeTitle = " "])
string getValidationErrors ( $objCalling, mixed $arrErrors)
string jsDialog (int $intDialogType)
string listButton (string $strContent)
string listDeleteButton ($strElementName $strElementName, $strQuestion $strQuestion, $strLinkHref $strLinkHref)
string listFooter ()
string listHeader ()
string listRow2 (string $strName, string $strActions,  $intCount, [string $strType = ""], [string $strListitemID = ""], int $intCount,)
string listRow2Image (string $strImage, string $strName, string $strActions,  $intCount, [string $strType = ""], [string $strListitemID = ""], int $intCount,)
string listRow3 (string $strName, string $strCenter, string $strActions, string $strImage,  $intCount, [string $strListitemID = ""], int $intCount,)
string listStatusButton (string $strSystemid)
string percentBeam (float $floatPercent, [int $intLength = "300"])
string setBrowserFocus (string $strElementId)
string warningBox (string $strContent, [string $strClass = "warnbox"])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from class_toolkit

class_toolkit::$arrModul
 class_toolkit::$objTemplate
 class_toolkit::$strSystemid
Methods
Description | Vars Methods (details)
Constructor __construct (line 23)

Constructor

  • access: public
class_toolkit_admin __construct ([string $strSystemid = ""])
  • string $strSystemid
Redefinition of:
class_toolkit::__construct()
Contructor
adminwidgetSeparator (line 1503)

Generate a separator / divider in a widget

  • access: public
string adminwidgetSeparator ()
adminwidgetText (line 1493)

Generates a text-row in a widget

  • access: public
string adminwidgetText (string $strText)
  • string $strText
dataTable (line 749)

Returns a table filled with infos

  • access: public
string dataTable (mixed $arrHeader, mixed $arrValues)
  • mixed $arrHeader: the first row to name the columns
  • mixed $arrValues: every entry is one row
divider (line 193)

Returns a divider to split up a page in logical sections

  • access: public
string divider ([string $strClass = "divider"])
  • string $strClass
dragableListFooter (line 662)

Returns the code to finish the opened list

  • access: public
string dragableListFooter (string $strListId)
  • string $strListId
dragableListHeader (line 641)

Returns the htmlcode needed to start a proper list, supporting drag n drop to reorder list-items

  • access: public
string dragableListHeader (string $strListId, [bool $bitOnlySameTable = false])
  • string $strListId
  • bool $bitOnlySameTable: dropping only allowed within the same table or also in other tables
formClose (line 608)

Returns the tags to close an open form

  • access: public
string formClose ([ $bitIncludePeFields = true])
  • $bitIncludePeFields
formDateSimple (line 46)

Returns a simple Date-Form

  • deprecated: will be removed in 3.3.x Use formDateSingle() instead.
  • access: public
string formDateSimple ([string $strName = ""], [int $intDay = ""], [int $intMonth = ""], [int $intYear = ""], [string $strTitle = ""], [bool $bitToday = true], [string $strClass = "inputDate"])
  • string $strName
  • int $intDay
  • int $intMonth
  • int $intYear
  • string $strTitle
  • bool $bitToday: If set true, the current date will be inserted, if no date is passed
  • string $strClass
formDateSingle (line 96)

Returns a simple date-form element. By default used to enter a date without a time.

  • since: 3.2.0.9
  • access: public
string formDateSingle (string $strName, string $strTitle, class_date $objDateToShow, [string $strClass = "inputDate"], [boolean $bitWithTime = false])
  • string $strName
  • string $strTitle
  • class_date $objDateToShow
  • string $strClass
  • boolean $bitWithTime
formHeader (line 549)

Creates the header needed to open a form-element

  • access: public
string formHeader (string $strAction, [string $strName = ""], [ $strEncoding = ""])
  • string $strAction
  • string $strName
  • $strEncoding
formHeadline (line 595)

Returns a headline in a form

  • access: public
string formHeadline (string $strText, [string $strClass = "heading"])
  • string $strText
  • string $strClass
formInputCheckbox (line 244)

Returns a checkbox

  • access: public
string formInputCheckbox (string $strName, string $strTitle, [bool $bitChecked = false], [string $strClass = ""])
  • string $strName
  • string $strTitle
  • bool $bitChecked
  • string $strClass
formInputDropdown (line 517)

Returning a complete Dropdown

  • access: public
string formInputDropdown (string $strName, mixed $arrKeyValues, [string $strTitle = ""], [string $strKeySelected = ""], [string $strClass = "inputDropdown"], [bool $bitEnabled = true], [string $strAddons = ""])
  • string $strName
  • mixed $arrKeyValues
  • string $strTitle
  • string $strKeySelected
  • string $strClass
  • bool $bitEnabled
  • string $strAddons
formInputHidden (line 260)

Returns a regular hidden-input-field

  • access: public
string formInputHidden (string $strName, [string $strValue = ""])
  • string $strName
  • string $strValue
formInputPageSelector (line 301)

Returns a regular text-input field

  • access: public
string formInputPageSelector (string $strName, [string $strTitle = ""], [string $strValue = ""], [string $strClass = "inputText"])
  • string $strName
  • string $strTitle
  • string $strValue
  • string $strClass
formInputPassword (line 370)

Returns a password text-input field

  • access: public
string formInputPassword (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputText"])
  • string $strName
  • string $strTitle
  • string $strValue
  • $strClass
formInputSubmit (line 388)

Returns a button to submit a form

  • access: public
string formInputSubmit ([string $strValue = "Submit"], [string $strName = "Submit"], [string $strEventhandler = ""], [ $strClass = "inputSubmit"])
  • string $strValue
  • string $strName
  • string $strEventhandler
  • $strClass
formInputText (line 279)

Returns a regular text-input field

  • access: public
string formInputText (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputText"], [string $strOpener = ""], [bool $bitReadonly = false])
  • string $strName
  • string $strTitle
  • string $strValue
  • string $strOpener
  • bool $bitReadonly
  • $strClass
formInputTextArea (line 352)

Returns a text-input field as textarea

  • access: public
string formInputTextArea (string $strName, [string $strTitle = ""], [string $strValue = ""], [ $strClass = "inputTextarea"])
  • string $strName
  • string $strTitle
  • string $strValue
  • $strClass
formInputUpload (line 407)

Returns a input-file element

  • access: public
string formInputUpload (string $strName, [string $strTitle = ""], [string $strClass = "inputText"], bool $bitMultiple)
  • string $strName
  • string $strTitle
  • bool $bitMultiple
  • string $strClass
formInputUploadFlash (line 434)

Returns a input-file element for uploading multiple files with progress bar

  • access: public
string formInputUploadFlash (string $strName, string $strTitle, string $strAllowedFileTypes, [bool $bitMultiple = false], [bool $bitFallback = false])
  • string $strName
  • string $strTitle
  • string $strAllowedFileTypes
  • bool $bitMultiple
  • bool $bitFallback
formOptionalElementsWrapper (line 566)

Creates a foldable wrapper around optional form fields

  • access: public
string formOptionalElementsWrapper (string $strContent, [string $strTitle = ""], [bool $bitVisible = false])
  • string $strContent
  • string $strTitle
  • bool $bitVisible
formTextRow (line 580)

Returns a single TextRow in a form

  • access: public
string formTextRow (string $strText, [ $strClass = "text"])
  • string $strText
  • $strClass
formWysiwygEditor (line 144)

Returns a text-field using the cool WYSIWYG editor You can use the different toolbar sets defined in /admin/scripts/ckeditor/config.js

  • access: public
string formWysiwygEditor ([string $strName = "inhalt"], [string $strTitle = ""], [string $strContent = ""], [string $strToolbarset = "standard"])
  • string $strName
  • string $strTitle
  • string $strContent
  • string $strToolbarset
getAdminModuleActionNavi (line 1102)

Generates the moduleaction-navigation in the admin-area

  • access: public
string getAdminModuleActionNavi ( $arrActions, mixed $arrModules)
  • mixed $arrModules
  • $arrActions
getAdminModuleNavi (line 1049)

Generates the module-navigation in the admin-area

  • access: public
string getAdminModuleNavi (mixed $arrModules, string $strCurrent)
  • mixed $arrModules
  • string $strCurrent
getAdminwidget (line 1476)

Builds the widget out of its main components.

  • access: public
string getAdminwidget (string $strSystemid, string $strName, string $strContent, [string $strEditLink = ""], [string $strDeleteLink = ""])
  • string $strSystemid
  • string $strName
  • string $strContent
  • string $strEditLink
  • string $strDeleteLink
getContentToolbar (line 1151)

A content toolbar can be used to group a subset of actions linking different views

  • access: public
string getContentToolbar (mixed $arrEntries, [int $intActiveEntry = -1])
  • mixed $arrEntries
  • int $intActiveEntry: Array-counting, so first element is 0, last is array-length - 1
getDashboardColumnFooter (line 1445)

The footer of a dashboard column.

  • access: public
string getDashboardColumnFooter ()
getDashboardColumnHeader (line 1435)

Generates the header for a column on the dashboard.

Inits the ajax-componentes for this list

  • access: public
string getDashboardColumnHeader (string $strColumnId)
  • string $strColumnId
getDashboardWidgetEncloser (line 1458)

The widget-enclose is the code-fragment to be built around the widget itself.

Used to handle the widget on the current column.

  • access: public
string getDashboardWidgetEncloser (string $strDashboardEntryId, string $strWidgetContent)
  • string $strDashboardEntryId
  • string $strWidgetContent
getFieldset (line 1013)

Creates a fieldset to structure elements

  • access: public
string getFieldset (string $strTitle, string $strContent, [string $strClass = "fieldset"])
  • string $strTitle
  • string $strContent
  • string $strClass
getFilemanagerImageDetails (line 999)

Creates the page to view & manipulate image.

  • since: 3.2
  • access: public
string getFilemanagerImageDetails (array $arrContent)
  • array $arrContent
getFilemanagerInfoBox (line 986)

Returns a infox used by the filemanager

  • access: public
string getFilemanagerInfoBox (mixed $arrContent)
  • mixed $arrContent
getGraphContainer (line 1032)

Container for graphs, e.g. used by stats.

  • access: public
string getGraphContainer (string $strImgSrc)
  • string $strImgSrc
getLanguageButton (line 1243)

Creates the code for one button for a specified language, part of a language switch

  • access: public
string getLanguageButton (string $strLanguage, string $strLanguageName, [bool $bitActive = false])
  • string $strLanguage
  • string $strLanguageName: The full name of the language
  • bool $bitActive
getLanguageSwitch (line 1228)

Creates the sourrounding code of a language switch, places the buttons

  • access: public
string getLanguageSwitch (string $strLanguageButtons)
  • string $strLanguageButtons
getLayoutFolder (line 935)

Creates the mechanism to fold parts of the site / make them visible or invisible

  • return: 0: The html-layout code 1: The link to fold / unfold
  • access: public
mixed getLayoutFolder (string $strContent, string $strLinkText, [bool $bitVisible = false], [string $strCallbackVisible = ""], [string $strCallbackInvisible = ""])
  • string $strContent
  • string $strLinkText: The text / content,
  • bool $bitVisible
  • string $strCallbackVisible: JS function
  • string $strCallbackInvisible: JS function
getLayoutFolderPic (line 958)

Creates the mechanism to fold parts of the site / make them vivsible or invisible

  • access: public
string getLayoutFolderPic (string $strContent, [string $strLinkText = ""], [string $strImageVisible = "icon_folderOpen.gif"], [string $strImageInvisible = "icon_folderClosed.gif"], [bool $bitVisible = true])
  • string $strContent
  • string $strLinkText: Mouseovertext
  • string $strImageVisible: clickable
  • string $strImageInvisible: clickable
  • bool $bitVisible
getMainDashboard (line 1420)
  • access: public
void getMainDashboard ( $arrColumn)
  • $arrColumn
getPageInfobox (line 975)

Returns a infobox about the page being edited

  • access: public
string getPageInfobox (mixed $arrContent)
  • mixed $arrContent
getPageview (line 1272)

Creates a pageview

  • return: a one-dimensional array: ["elements"] and ["pageview"]
  • deprecated: migrate to getSimplePageview instead!
  • access: public
mixed getPageview (array $arrData, int $intCurrentpage, string $strModule, string $strAction, [string $strLinkAdd = ""], [int $intElementPerPage = 15])
  • array $arrData
  • int $intCurrentpage
  • string $strModule
  • string $strAction
  • string $strLinkAdd
  • int $intElementPerPage
getPathNavigation (line 1130)

Generates the layout for a small navigation

  • access: public
string getPathNavigation (mixed $arrEntries)
  • mixed $arrEntries
getPreformatted (line 1206)

Returns a simple

  • access: public
string getPreformatted (array $arrLines, [int $nrRows = 0])
  • array $arrLines
  • int $nrRows: number of rows to display
getSimplePageview (line 1351)

Creates a pageview

  • return: a two-dimensional array: ["elements"] and ["pageview"]
  • since: 3.3.0
  • access: public
mixed getSimplePageview (class_array_section_iterator $objArraySectionIterator, string $strModule, string $strAction, [string $strLinkAdd = ""])
getTextRow (line 915)

Returns a single TextRow

  • access: public
unknown getTextRow (unknown_type $strText, [ $strClass = "text"])
  • unknown_type $strText
  • $strClass
getTreeview (line 1589)

Create a tree-view UI-element. Please not, that currently it's only possible to use one tree-view per page.

The nodes are loaded via AJAX by calling the method passed as the first arg. The optional third param is an ordered list of systemid identifying the nodes to expand initially.

  • access: public
string getTreeview (string $strLoadNodeDataFunction, string $strRootNodeSystemid, [array $arrNodesToExpand = array()], [string $strSideContent = ""], [string $strRootNodeTitle = " "])
  • string $strLoadNodeDataFunction
  • string $strRootNodeSystemid
  • array $arrNodesToExpand
  • string $strSideContent
  • string $strRootNodeTitle
getValidationErrors (line 1175)

Generates a list of errors found by the form-validation

  • access: public
string getValidationErrors ( $objCalling, mixed $arrErrors)
  • mixed $arrErrors
  • $objCalling
jsDialog (line 1518)

Creates a modal dialog on the page. By default, the dialog is hidden, so has to be set visible.

The type-param decides what template is used for the dialog-layout. The name of the dialog is built via jsDialog_$intTypeNr. Set the contents via js-calls.

  • access: public
string jsDialog (int $intDialogType)
  • int $intDialogType: (0 = regular modal dialog, 1 = confirmation dialog, 2 = rawDialog, 3 = loadingDialog)
listButton (line 811)

Creates a action-Entry in a list

  • access: public
string listButton (string $strContent)
  • string $strContent
listDeleteButton (line 831)

Generates a delete-button. The passed element name and question is shown as a modal dialog when the icon was clicked. So set the link-href-param for the final deletion, otherwise the user has no more chance to delete the record!

  • access: public
string listDeleteButton ($strElementName $strElementName, $strQuestion $strQuestion, $strLinkHref $strLinkHref)
  • $strElementName $strElementName
  • $strQuestion $strQuestion
  • $strLinkHref $strLinkHref
listFooter (line 651)

Returns the code to finish the opened list

  • access: public
string listFooter ()
listHeader (line 628)

Returns the htmlcode needed to start a proper list

  • access: public
string listHeader ()
listRow2 (line 677)

Returns a row in a list with 2 columns

  • access: public
string listRow2 (string $strName, string $strActions,  $intCount, [string $strType = ""], [string $strListitemID = ""], int $intCount,)
  • string $strName
  • string $strActions
  • int $intCount,: used to determing the class needed
  • string $strType: to react on special cases
  • string $strListitemID: id of row-entry, e.g. to use in ajax elements
  • $intCount
listRow2Image (line 701)

Returns a row in a list with 2 columns and a leading image

  • access: public
string listRow2Image (string $strImage, string $strName, string $strActions,  $intCount, [string $strType = ""], [string $strListitemID = ""], int $intCount,)
  • string $strImage
  • string $strName
  • string $strActions
  • int $intCount,: used to determing the class needed
  • string $strType: to react on special cases
  • string $strListitemID: id of row-entry, e.g. to use in ajax elements
  • $intCount
listRow3 (line 726)

Returns a row in a list with 3 columns, with leading image

  • access: public
string listRow3 (string $strName, string $strCenter, string $strActions, string $strImage,  $intCount, [string $strListitemID = ""], int $intCount,)
  • string $strName
  • string $strCenter
  • string $strActions
  • string $strImage
  • int $intCount,: used to determing the class needed
  • string $strListitemID: id of row-entry, e.g. to use in ajax elements
  • $intCount
listStatusButton (line 853)

Generates a button allowing to change the status of the record passed.

Therefore an ajax-method is called.

  • access: public
string listStatusButton (string $strSystemid)
  • string $strSystemid
percentBeam (line 208)

Creates a percent-beam to illustrate proportions

  • access: public
string percentBeam (float $floatPercent, [int $intLength = "300"])
  • float $floatPercent
  • int $intLength
setBrowserFocus (line 1568)

Sets the users browser focus to the element with the given id

  • access: public
string setBrowserFocus (string $strElementId)
  • string $strElementId
warningBox (line 901)

Returns a warning box, e.g. shown before deleting a record

  • access: public
string warningBox (string $strContent, [string $strClass = "warnbox"])
  • string $strContent
  • string $strClass

Inherited Methods

Inherited From class_toolkit

class_toolkit::__construct()
class_toolkit::mimeType()

Documentation generated on Mon, 12 Apr 2010 21:21:49 +0200 by phpDocumentor 1.4.3