Create a table that is orderable via drag and drop
- Extends
-
Implements
Countable PHPFUI \Interfaces \Walkable Stringable - Traits
Constants |
public
PHPFUI |
Methods |
public PHPFUI\HTML5Element :: __clone () |
public
__construct
(
PHPFUI |
public PHPFUI\Base :: __toString () : string |
public
PHPFUI\Base
::
add
(
$item
) Base add function. Adds to the end of the current objects
|
public
PHPFUI\Table
::
addArrowNavigation
(
PHPFUI Allow arrow keys to move up and down rows with edit controls in them. |
public
PHPFUI\Base
::
addAsFirst
(
$item
) Base addAsFirst function. Adds to the front of the current
|
public
PHPFUI\HTML5Element
::
addAttribute
(
string
$attribute
,
string
$value
=
''
) :
PHPFUI Add an attribute the the object
|
public
PHPFUI\HTML5Element
::
addClass
(
string
$class
) :
PHPFUI Add a class to an object
|
public
PHPFUI\Table
::
addColumnAttribute
(
string
$column
,
array
$attributePairs
) :
PHPFUI Add an attribute to a column
|
public
PHPFUI\Table
::
addFooter
(
string
$field
,
string
$footer
) :
PHPFUI Add one footer field
|
public
PHPFUI\Table
::
addHeader
(
string
$field
,
string
$header
) :
PHPFUI Add one header field
|
public
PHPFUI\Table
::
addNextRowAttribute
(
string
$attribute
,
string
$value
) :
PHPFUI You can add any attribute to the next row (tr) that you want. This only applies to the next row to be output and is reset for the next row. |
public
PHPFUI\HTML5Element
::
addPHPClassName
() :
PHPFUI Adds the base PHP class name as a class to this object |
public
PHPFUI\Table
::
addRow
(
array
$row
,
array
$colspans
=
[
]
) :
PHPFUI Add a row. You can also pass column spans which are
|
public
PHPFUI\Table
::
count
() :
int
Number of rows in the table. |
public
PHPFUI\HTML5Element
::
deleteAttribute
(
string
$attribute
) :
PHPFUI Deletes the passed attribute |
public
PHPFUI\HTML5Element
::
deleteAttributes
() :
PHPFUI Deletes all attributes |
public
PHPFUI\HTML5Element
::
deleteClass
(
string
$classToDelete
) :
PHPFUI Delete a class from the object |
public
PHPFUI\Table
::
deleteHeader
(
string
$field
) :
PHPFUI Delete header field. Deletes the column. Can be called at anytime after a header is set but before output.
|
public
PHPFUI\HTML5Element
::
disabled
() :
PHPFUI Disabled the element |
public
PHPFUI\Table
::
displayHeaders
(
bool
$display
=
true
) :
PHPFUI Turn off headers by passing false |
public
PHPFUI\Base
::
done
(
bool
$done
=
true
) :
PHPFUI Form is done rendering |
public
PHPFUI\HTML5Element
::
getAttribute
(
string
$attribute
) : ?
string
Get an attribute
|
public
PHPFUI\HTML5Element
::
getAttributes
() :
string
Returns the attribute strings. Attributes with values are returned as name/value pairs, |
public
PHPFUI\HTML5Element
::
getClass
() :
string
Returns the class attribute ready for insertion into an element. |
public
PHPFUI\HTML5Element
::
getClasses
() :
array
Returns all classes for the object |
public
static
PHPFUI\Base
::
getDebug
(
int
$flags
=
0
) :
int
Gets the current debug setting |
public
PHPFUI\HTML5Element
::
getElement
() :
string
Return the type of the element |
public
PHPFUI\HTML5Element
::
getId
() :
string
Return the id of the object. Elements will not have an id unless this method is called. The id is returned as a string |
public
PHPFUI\HTML5Element
::
getIdAttribute
() :
string
Return the id attribute of the object as a name/value pair. If no id has been requested, and empty string is returned. |
public
PHPFUI\Table
::
getRecordId
() :
string
Return the index key used to give each row a unique id. |
public
PHPFUI\Base
::
getResponse
() :
string
Get the current response |
public
PHPFUI\HTML5Element
::
getToolTip
(
string
$label
) Get the tool tip as a string
|
public
PHPFUI\HTML5Element
::
hasClass
(
string
$class
) :
bool
Return true if the class is present on the object |
public
PHPFUI\HTML5Element
::
hasId
() :
bool
Does this object have an id set already? |
public
PHPFUI\HTML5Element
::
hasToolTip
() :
bool
|
public
PHPFUI\Base
::
isDone
() :
bool
Returns true if the page needs no more processing |
public
PHPFUI\HTML5Element
::
newId
() :
PHPFUI Assign a new id to this element. |
public
PHPFUI\Base
::
prepend
(
$item
) :
PHPFUI Add an object in front of existing object |
public
PHPFUI\Table
::
setAlwaysOutput
(
bool
$alwaysOutput
=
true
) :
PHPFUI By default, tables will not output if they have no rows |
public
PHPFUI\HTML5Element
::
setAttribute
(
string
$attribute
,
string
$value
=
''
) :
PHPFUI Set the attribute overwriting the prior value
|
public
PHPFUI\Table
::
setCaption
(
string
$caption
) :
PHPFUI Set the table caption |
public
PHPFUI\HTML5Element
::
setConfirm
(
$text
) :
PHPFUI A simple way to set a confirm on click
|
public
static
PHPFUI\Base
::
setDebug
(
int
$level
=
0
) :
void
Set the debug level, 1 or higher is on |
public
PHPFUI\HTML5Element
::
setElement
(
$element
) :
PHPFUI You can set the element type if you need to morph it for some reason
|
public
PHPFUI\Table
::
setFooters
(
array
$footers
) :
PHPFUI Set the footers for the table. Array indexes should |
public
PHPFUI\Table
::
setHeaders
(
array
$headers
) :
PHPFUI Set the headers
|
public
PHPFUI\HTML5Element
::
setId
(
$id
) :
PHPFUI Set the base id of the object
|
public
PHPFUI\Base
::
setRawResponse
(
string
$response
,
bool
$asJSON
=
true
) :
PHPFUI Sets the page response directly |
public
PHPFUI\Table
::
setRecordId
(
string
$key
) :
PHPFUI Specify the row index key that will be used to form a unique Id for the row. $key should be the index into the row array that uniquely identifies the row in the table. |
public
PHPFUI\Base
::
setResponse
(
string
$response
,
string
$color
=
'lime'
) :
PHPFUI Set a response in the standard format ('reponse' and 'color' array)
|
public
PHPFUI\Table
::
setRows
(
array
$rows
) :
PHPFUI Set all the rows for a table |
public
PHPFUI\Table
::
setStrict
(
bool
$strict
=
true
) :
PHPFUI Display "Missing X" for each field in a row that does not |
public
PHPFUI\HTML5Element
::
setToolTip
(
$tip
) :
PHPFUI Set the tool tip. Can either be a ToolTip or a string. If it is a string, it will be converted to a ToolTip
|
public
PHPFUI\Table
::
setWidths
(
array
$widths
) :
PHPFUI Set widths for each column
|
public
PHPFUI\HTML5Element
::
toggleAnimate
(
PHPFUI Will toggle the provided element on click with the provided animation. |
public
PHPFUI\HTML5Element
::
toggleClass
(
PHPFUI Will toggle the class on the provided element on click. |
public
PHPFUI\HTML5Element
::
transferAttributes
(
PHPFUI Moves attributes into this object from the passed object |
public
PHPFUI\HTML5Element
::
transferClasses
(
PHPFUI Moves classes into this object from the passed object |
public
PHPFUI\Base
::
walk
(
string
$method
,
$argument
=
NULL
) Recursively walks all objects and calls the passed method on each object where it exists
|
Properties |
protected bool PHPFUI\Table :: $alwaysOutput |
protected string PHPFUI\Table :: $caption |
protected array PHPFUI\Table :: $colspans |
protected array PHPFUI\Table :: $columnAttributes |
protected bool PHPFUI\Table :: $displayHeaders |
protected array PHPFUI\Table :: $footers |
protected array PHPFUI\Table :: $headers |
protected array PHPFUI\Table :: $nextRowAttributes |
protected
PHPFUI |
protected string PHPFUI\Table :: $recordId |
protected array PHPFUI\Table :: $rowAttributes |
protected array PHPFUI\Table :: $rows |
protected string PHPFUI\Table :: $sortableBodyClass |
protected string PHPFUI\Table :: $sortableTrClass |
protected bool PHPFUI\Table :: $strict |
protected array PHPFUI\Table :: $widths |
Methods |
protected PHPFUI\Table :: getBody () : string |
protected PHPFUI\Table :: getEnd () : string |
protected PHPFUI\Table :: getSortHeader ( string $field , string $title ) : string |
protected PHPFUI\Table :: getStart () : string |
protected PHPFUI\Table :: outputRow ( string $td , array $row , string $type = '' , array $rowAttributes = [ ] , array $attribute = [ ] , string $attributeName = 'colspan' ) : string |
protected
PHPFUI\HTML5Element
::
upCastCopy
(
PHPFUI Clones the first object and fills it with properties from the second object |
Methods |
public
static
PHPFUI\Base
::
getDebug
(
int
$flags
=
0
) :
int
Gets the current debug setting |
public
static
PHPFUI\Base
::
setDebug
(
int
$level
=
0
) :
void
Set the debug level, 1 or higher is on |