TKanban
extends TElement
in package
Kanban
Tags
Table of Contents
Properties
- $children : mixed
- $editForm : mixed
- $itemActions : mixed
- $itemDatabase : mixed
- $itemDropAction : mixed
- $items : mixed
- $itemTemplate : mixed
- $itemTemplateCallback : mixed
- $kanban : mixed
- $metadata : mixed
- $searchForm : mixed
- $stageActions : mixed
- $stageDropAction : mixed
- $stageHeight : mixed
- $stages : mixed
- $stageShortcuts : mixed
- $templatePath : mixed
- $topScrollbar : mixed
- $afterElement : mixed
- $hidden : mixed
- $isVoidElement : mixed
- $properties : mixed
- $tagname : mixed
- $useLineBreaks : mixed
- $useSingleQuotes : mixed
- $voidelements : mixed
- $wrapped : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class Constructor
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addItem() : mixed
- Add item to stage
- addItemAction() : mixed
- Add item action
- addMany() : mixed
- Add many children
- addObject() : mixed
- addStage() : mixed
- Add stage to kanban board
- addStageAction() : mixed
- Add stage action
- addStageShortcut() : mixed
- Add stage shortcut
- after() : mixed
- Insert element after
- clear() : mixed
- Clear items
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableTopScrollbar() : mixed
- Enable Top Scrollbar
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getEditForm() : TForm
- Return the assigned Edit form object
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getMetadata() : mixed
- Get metadata
- getName() : mixed
- Returns tag name
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getSearchForm() : TForm
- Return the assigned Search form object
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- setEditForm() : mixed
- Assign a TForm object
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setItemDatabase() : mixed
- Set item min database
- setItemDropAction() : mixed
- Set item drop action
- setItemTemplate() : mixed
- Set card item template for rendering
- setItemTemplateCallback() : mixed
- Set card item callback for rendering
- setMetadata() : mixed
- Set metadata
- setName() : mixed
- Change the element name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setSearchForm() : mixed
- Assign a TForm object
- setStageDropAction() : mixed
- Set stage drop action
- setStageHeight() : mixed
- setTemplatePath() : mixed
- Set kanban item template for rendering
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Show kanban
- tag() : mixed
- Create an element
- renderItem() : mixed
- Render item
- renderItemActions() : mixed
- Render item actions
- renderStageActions() : mixed
- Render stage actions
- renderStageItems() : mixed
- Render stage items
- renderStages() : mixed
- Render stages
- renderStageShortcuts() : mixed
- Render stage shortcuts
Properties
$children
protected
mixed
$children
$editForm
protected
mixed
$editForm
$itemActions
protected
mixed
$itemActions
$itemDatabase
protected
mixed
$itemDatabase
$itemDropAction
protected
mixed
$itemDropAction
$items
protected
mixed
$items
$itemTemplate
protected
mixed
$itemTemplate
$itemTemplateCallback
protected
mixed
$itemTemplateCallback
$kanban
protected
mixed
$kanban
$metadata
protected
mixed
$metadata
$searchForm
protected
mixed
$searchForm
$stageActions
protected
mixed
$stageActions
$stageDropAction
protected
mixed
$stageDropAction
$stageHeight
protected
mixed
$stageHeight
$stages
protected
mixed
$stages
$stageShortcuts
protected
mixed
$stageShortcuts
$templatePath
protected
mixed
$templatePath
$topScrollbar
protected
mixed
$topScrollbar
$afterElement
private
mixed
$afterElement
$hidden
private
mixed
$hidden
$isVoidElement
private
mixed
$isVoidElement
$properties
private
mixed
$properties
$tagname
private
mixed
$tagname
$useLineBreaks
private
mixed
$useLineBreaks
$useSingleQuotes
private
mixed
$useSingleQuotes
$voidelements
private
static mixed
$voidelements
$wrapped
private
mixed
$wrapped
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct() : mixed
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addItem()
Add item to stage
public
addItem(mixed $id, mixed $stage_id, mixed $title, mixed $content[, mixed $color = null ][, mixed $object = null ]) : mixed
Parameters
- $id : mixed
-
Item id
- $stage_id : mixed
-
Stage id
- $title : mixed
-
Item title
- $content : mixed
-
Item content
- $color : mixed = null
-
Item color
- $object : mixed = null
-
Item data object
addItemAction()
Add item action
public
addItemAction(mixed $label, mixed $action[, mixed $icon = NULL ][, mixed $display_condition = NULL ][, mixed $useButton = FALSE ]) : mixed
Parameters
- $label : mixed
-
Action label
- $action : mixed
-
Action callback (TAction)
- $icon : mixed = NULL
-
Action icon
- $display_condition : mixed = NULL
-
Display condition
- $useButton : mixed = FALSE
-
Action displat button
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
addObject()
public
addObject(TRecord $object) : mixed
Parameters
- $object : TRecord
addStage()
Add stage to kanban board
public
addStage(mixed $id, mixed $title[, mixed $object = null ][, mixed $color = null ]) : mixed
Parameters
- $id : mixed
-
Stage id
- $title : mixed
-
Stage title
- $object : mixed = null
-
Stage data object
- $color : mixed = null
-
Stage color
addStageAction()
Add stage action
public
addStageAction(mixed $label, mixed $action[, mixed $icon = NULL ][, mixed $display_condition = NULL ]) : mixed
Parameters
- $label : mixed
-
Action label
- $action : mixed
-
Action callback (TAction)
- $icon : mixed = NULL
-
Action icon
- $display_condition : mixed = NULL
addStageShortcut()
Add stage shortcut
public
addStageShortcut(mixed $label, mixed $action[, mixed $icon = NULL ]) : mixed
Parameters
- $label : mixed
-
Action label
- $action : mixed
-
Action callback (TAction)
- $icon : mixed = NULL
-
Action icon
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clear()
Clear items
public
clear() : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableTopScrollbar()
Enable Top Scrollbar
public
enableTopScrollbar() : mixed
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getEditForm()
Return the assigned Edit form object
public
getEditForm() : TForm
Return values
TForm —object
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getMetadata()
Get metadata
public
getMetadata(mixed $metadata) : mixed
Parameters
- $metadata : mixed
getName()
Returns tag name
public
getName() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getSearchForm()
Return the assigned Search form object
public
getSearchForm() : TForm
Return values
TForm —object
hide()
hide object
public
hide() : mixed
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
setEditForm()
Assign a TForm object
public
setEditForm(mixed $editForm) : mixed
Parameters
- $editForm : mixed
-
object
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setItemDatabase()
Set item min database
public
setItemDatabase(mixed $database) : mixed
Parameters
- $database : mixed
-
min database
setItemDropAction()
Set item drop action
public
setItemDropAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object
setItemTemplate()
Set card item template for rendering
public
setItemTemplate(mixed $template) : mixed
Parameters
- $template : mixed
-
Template content
setItemTemplateCallback()
Set card item callback for rendering
public
setItemTemplateCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
-
Callback
setMetadata()
Set metadata
public
setMetadata(mixed $metadata, mixed $value) : mixed
Parameters
- $metadata : mixed
- $value : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setSearchForm()
Assign a TForm object
public
setSearchForm(mixed $searchForm) : mixed
Parameters
- $searchForm : mixed
-
object
setStageDropAction()
Set stage drop action
public
setStageDropAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object
setStageHeight()
public
setStageHeight(mixed $height) : mixed
Parameters
- $height : mixed
setTemplatePath()
Set kanban item template for rendering
public
setTemplatePath(mixed $path) : mixed
Parameters
- $path : mixed
-
Template path
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
show()
Show kanban
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes
renderItem()
Render item
private
renderItem(mixed $item) : mixed
Parameters
- $item : mixed
renderItemActions()
Render item actions
private
renderItemActions(mixed $itemId[, mixed $object = NULL ]) : mixed
Parameters
- $itemId : mixed
- $object : mixed = NULL
renderStageActions()
Render stage actions
private
renderStageActions(mixed $stage_id, mixed $stage) : mixed
Parameters
- $stage_id : mixed
- $stage : mixed
renderStageItems()
Render stage items
private
renderStageItems(mixed $stage) : mixed
Parameters
- $stage : mixed
renderStages()
Render stages
private
renderStages() : mixed
renderStageShortcuts()
Render stage shortcuts
private
renderStageShortcuts(mixed $stage) : mixed
Parameters
- $stage : mixed