TDBArrowStep
extends TArrowStep
in package
uses
AdiantiDatabaseWidgetTrait
Database Arrow Step
Tags
Table of Contents
Properties
- $action : mixed
- $className : mixed
- $color : mixed
- $colorcolumn : mixed
- $colorItems : mixed
- $container : mixed
- $criteria : mixed
- $database : mixed
- $disableColor : mixed
- $disableFontColor : mixed
- $editable : mixed
- $fontColor : mixed
- $fontSize : mixed
- $formName : mixed
- $height : mixed
- $hideText : mixed
- $id : mixed
- $items : mixed
- $key : mixed
- $label : mixed
- $model : mixed
- $name : mixed
- $ordercolumn : mixed
- $properties : mixed
- $selected : mixed
- $size : mixed
- $tag : mixed
- $value : mixed
- $valueCallback : mixed
- $width : mixed
- $validations : mixed
Methods
- __call() : mixed
- Redirects function call
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class Constructor
- __get() : mixed
- Returns a property value
- __isset() : mixed
- Returns if the property is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- addItem() : mixed
- Add an item
- addItems() : mixed
- Add items
- addValidation() : mixed
- Add a field validator
- clearField() : mixed
- Clear currents item on steps
- defineCurrent() : mixed
- Define current item on steps
- disableField() : mixed
- Disable field
- enableField() : mixed
- Enable field
- getAction() : mixed
- Get action
- getContents() : mixed
- Returns the element content as a string
- getCurrent() : mixed
- Get current item
- getEditable() : A
- Returns if the field is editable
- getFormName() : mixed
- Return the name of the form to wich the field is attached
- getHeight() : mixed
- Get heigth
- getId() : mixed
- Returns the field's id
- getItem() : mixed
- Get item
- getItems() : mixed
- Get items
- getItemsFromModel() : mixed
- Get items (key/value) from database to populate widget
- getLabel() : mixed
- Returns the field's label
- getName() : mixed
- Get name
- getObjectsFromModel() : mixed
- Get objects from database to populate widget
- getPostData() : mixed
- Return the post data
- getPropertiesAsString() : mixed
- Get properties as string
- getProperty() : mixed
- Return a field property
- getSize() : mixed
- Get size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Get value current step
- getWidth() : mixed
- Get width
- isRequired() : mixed
- Returns if the field is required
- setAction() : mixed
- Set action
- setColorColumn() : mixed
- setColorItems() : mixed
- Set color items
- setCurrent() : mixed
- Select current item
- setCurrentKey() : mixed
- Select current item
- setEditable() : mixed
- Define if the field is editable
- setFilledColor() : mixed
- Set color arrows
- setFilledFontColor() : mixed
- Set font color arrows
- setFontSize() : mixed
- Set font size
- setFormName() : mixed
- Set form name
- setHeight() : mixed
- Set height arrows
- setHideText() : mixed
- Set hide text
- setId() : mixed
- Define the field's id
- setItems() : mixed
- Set items
- setLabel() : mixed
- Define the field's label
- setName() : mixed
- Set name
- setProperty() : mixed
- Define a field property
- setSize() : mixed
- Set sizes
- setTagName() : mixed
- Change input tag name
- setTip() : mixed
- Define the field's tooltip
- setUnfilledColor() : mixed
- Set color arrows
- setUnfilledFontColor() : mixed
- Set color arrows
- setValue() : mixed
- Set value current step
- setValueCallback() : mixed
- Set callback for setValue method
- setWidth() : mixed
- Set width
- show() : mixed
- Show component
- validate() : mixed
- Validate a field
- getSerializedAction() : mixed
- Get action in serialized way
- makeItem() : mixed
- Make a html of item
- makeStyle() : mixed
- Make component style
Properties
$action
protected
mixed
$action
$className
protected
mixed
$className
$color
protected
mixed
$color
$colorcolumn
protected
mixed
$colorcolumn
$colorItems
protected
mixed
$colorItems
$container
protected
mixed
$container
$criteria
protected
mixed
$criteria
$database
protected
mixed
$database
$disableColor
protected
mixed
$disableColor
$disableFontColor
protected
mixed
$disableFontColor
$editable
protected
mixed
$editable
$fontColor
protected
mixed
$fontColor
$fontSize
protected
mixed
$fontSize
$formName
protected
mixed
$formName
$height
protected
mixed
$height
$hideText
protected
mixed
$hideText
$id
protected
mixed
$id
$items
protected
mixed
$items
$key
protected
mixed
$key
$label
protected
mixed
$label
$model
protected
mixed
$model
$name
protected
mixed
$name
$ordercolumn
protected
mixed
$ordercolumn
$properties
protected
mixed
$properties
$selected
protected
mixed
$selected
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$width
protected
mixed
$width
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call(mixed $method, mixed $param) : mixed
Parameters
- $method : mixed
-
Method name
- $param : mixed
-
Array of parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct(mixed $name, mixed $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, mixed $criteria = NULL ]) : mixed
Parameters
- $name : mixed
-
widget's name
- $database : mixed
-
database name
- $model : mixed
-
model class name
- $key : mixed
-
table field to be used as key in the combo
- $value : mixed
-
table field to be listed in the combo
- $ordercolumn : mixed = NULL
-
column to order the fields (optional)
- $criteria : mixed = NULL
-
criteria (TCriteria object) to filter the model (optional)
__get()
Returns a property value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns if the property 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
addItem()
Add an item
public
addItem(mixed $title[, mixed $id = null ][, mixed $color = null ]) : mixed
Parameters
- $title : mixed
-
Item title
- $id : mixed = null
-
Item id
- $color : mixed = null
-
Item color
addItems()
Add items
public
addItems(mixed $items) : mixed
Parameters
- $items : mixed
addValidation()
Add a field validator
public
addValidation(mixed $label, mixed $validator[, mixed $parameters = NULL ]) : mixed
Parameters
- $label : mixed
-
Field name
- $validator : mixed
-
TFieldValidator object
- $parameters : mixed = NULL
-
Aditional parameters
clearField()
Clear currents item on steps
public
static clearField(mixed $formName, mixed $name) : mixed
Parameters
- $formName : mixed
- $name : mixed
-
name of arrow steps
defineCurrent()
Define current item on steps
public
static defineCurrent(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
name of arrow steps
- $value : mixed
-
value current
disableField()
Disable field
public
static disableField(mixed $formName, mixed $name) : mixed
Parameters
- $formName : mixed
- $name : mixed
-
name of arrow steps
enableField()
Enable field
public
static enableField(mixed $formName, mixed $name) : mixed
Parameters
- $formName : mixed
- $name : mixed
-
name of arrow steps
getAction()
Get action
public
getAction() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getCurrent()
Get current item
public
getCurrent() : mixed
getEditable()
Returns if the field is editable
public
getEditable() : A
Return values
A —boolean
getFormName()
Return the name of the form to wich the field is attached
public
getFormName() : mixed
getHeight()
Get heigth
public
getHeight() : mixed
getId()
Returns the field's id
public
getId() : mixed
getItem()
Get item
public
getItem(mixed $key) : mixed
Parameters
- $key : mixed
getItems()
Get items
public
getItems() : mixed
getItemsFromModel()
Get items (key/value) from database to populate widget
public
static getItemsFromModel(mixed $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, TCriteria|null $criteria = NULL ]) : mixed
Parameters
- $database : mixed
- $model : mixed
- $key : mixed
- $value : mixed
- $ordercolumn : mixed = NULL
- $criteria : TCriteria|null = NULL
getLabel()
Returns the field's label
public
getLabel() : mixed
getName()
Get name
public
getName() : mixed
getObjectsFromModel()
Get objects from database to populate widget
public
static getObjectsFromModel(mixed $database, mixed $model, mixed $key[, mixed $ordercolumn = NULL ][, TCriteria|null $criteria = NULL ]) : mixed
Parameters
- $database : mixed
- $model : mixed
- $key : mixed
- $ordercolumn : mixed = NULL
- $criteria : TCriteria|null = NULL
getPostData()
Return the post data
public
getPostData() : mixed
getPropertiesAsString()
Get properties as string
public
getPropertiesAsString([mixed $filter = null ]) : mixed
Parameters
- $filter : mixed = null
getProperty()
Return a field property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
getSize()
Get size
public
getSize() : mixed
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Get value current step
public
getValue() : mixed
getWidth()
Get width
public
getWidth() : mixed
isRequired()
Returns if the field is required
public
isRequired() : mixed
setAction()
Set action
public
setAction(mixed $action) : mixed
Parameters
- $action : mixed
-
Action
setColorColumn()
public
setColorColumn(mixed $colorcolumn) : mixed
Parameters
- $colorcolumn : mixed
setColorItems()
Set color items
public
setColorItems(mixed $colorItems) : mixed
Parameters
- $colorItems : mixed
-
Items
setCurrent()
Select current item
public
setCurrent(mixed $title) : mixed
Parameters
- $title : mixed
setCurrentKey()
Select current item
public
setCurrentKey(mixed $key) : mixed
Parameters
- $key : mixed
setEditable()
Define if the field is editable
public
setEditable(mixed $editable) : mixed
Parameters
- $editable : mixed
-
A boolean
setFilledColor()
Set color arrows
public
setFilledColor(mixed $color[, mixed $fontColor = null ]) : mixed
Parameters
- $color : mixed
-
string to color
- $fontColor : mixed = null
-
string to color font
setFilledFontColor()
Set font color arrows
public
setFilledFontColor(string $fontColor) : mixed
Parameters
- $fontColor : string
setFontSize()
Set font size
public
setFontSize(mixed $fontSize) : mixed
Parameters
- $fontSize : mixed
setFormName()
Set form name
public
setFormName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the name of the form
setHeight()
Set height arrows
public
setHeight(mixed $height) : mixed
Parameters
- $height : mixed
-
int|float to height
setHideText()
Set hide text
public
setHideText([mixed $hide = true ]) : mixed
Parameters
- $hide : mixed = true
-
bool
setId()
Define the field's id
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
-
A string containing the field's id
setItems()
Set items
public
setItems(mixed $items) : mixed
Parameters
- $items : mixed
setLabel()
Define the field's label
public
setLabel(mixed $label) : mixed
Parameters
- $label : mixed
-
A string containing the field's label
setName()
Set name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the field's name
setProperty()
Define a field property
public
setProperty(mixed $name, mixed $value[, mixed $replace = TRUE ]) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
- $replace : mixed = TRUE
setSize()
Set sizes
public
setSize(mixed $width[, mixed $height = null ]) : mixed
Parameters
- $width : mixed
- $height : mixed = null
setTagName()
Change input tag name
public
setTagName(mixed $name) : mixed
Parameters
- $name : mixed
setTip()
Define the field's tooltip
public
setTip(mixed $tip) : mixed
Parameters
- $tip : mixed
setUnfilledColor()
Set color arrows
public
setUnfilledColor(mixed $color[, mixed $fontColor = null ]) : mixed
Parameters
- $color : mixed
-
string to color
- $fontColor : mixed = null
-
string to color font
setUnfilledFontColor()
Set color arrows
public
setUnfilledFontColor(string $color) : mixed
Parameters
- $color : string
setValue()
Set value current step
public
setValue(mixed $value) : mixed
Parameters
- $value : mixed
-
A string containing the field's value
setValueCallback()
Set callback for setValue method
public
setValueCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
setWidth()
Set width
public
setWidth(mixed $width) : mixed
Parameters
- $width : mixed
-
int|float to width
show()
Show component
public
show() : mixed
validate()
Validate a field
public
validate() : mixed
getSerializedAction()
Get action in serialized way
private
getSerializedAction(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
- $key : mixed
- $value : mixed
- $selected : mixed = false
makeItem()
Make a html of item
private
makeItem(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
- $key : mixed
- $value : mixed
- $selected : mixed = false
makeStyle()
Make component style
private
makeStyle() : mixed