Constants |
public PHPFUI\Base::DEBUG_SOURCE = 1 |
Methods |
public PHPFUI\HTML5Element::__clone() |
public __construct() |
public PHPFUI\Base::__toString() : string |
public PHPFUI\Base::add(?mixed $item) : static Base add function. Adds to the end of the current objects |
public addArrowNavigation(PHPFUI\Interfaces\Page $page) : static Allow arrow keys to move up and down rows with edit controls in them. |
public PHPFUI\Base::addAsFirst(?mixed $item) : static Base addAsFirst function. Adds to the front of the current
object |
public PHPFUI\HTML5Element::addAttribute(string $attribute, string $value = '') : static Add an attribute the the object |
public PHPFUI\HTML5Element::addClass(string $class) : static |
public addColumnAttribute(string $column, array $attributePairs) : static Add an attribute to a column |
public addFooter(string $field, string $footer) : static |
public addFooterAttribute(string $key, array $values) : static Add a footer row attribute |
public addHeader(string $field, string $header) : static |
public addNextRowAttribute(string $attribute, string $value) : static 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() : static Adds the base PHP class name as a class to this object |
public addRow(array $row, array $colspans = []) : static Add a row. You can also pass column spans which are
possitional and do not need keys corresponding index to the row. |
public count() : int Number of rows in the table. |
public PHPFUI\HTML5Element::deleteAttribute(string $attribute) : static Deletes the passed attribute |
public PHPFUI\HTML5Element::deleteAttributes() : static |
public PHPFUI\HTML5Element::deleteClass(string $classToDelete) : static Delete a class from the object |
public deleteHeader(string $field) : static Delete header field. Deletes the column. Can be called at anytime after a header is set but before output. |
public PHPFUI\HTML5Element::disabled() : static |
public displayHeaders(bool $display = true) : static Turn off headers by passing false |
public PHPFUI\Base::done(bool $done = true) : static |
public PHPFUI\HTML5Element::getAttribute(string $attribute) : ?string |
public PHPFUI\HTML5Element::getAttributes() : string Returns the attribute strings. Attributes with values are returned as name/value pairs,
attributes without values are returned as just the attribute name. |
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
starting with id followed by a unique number to the page. Id numbers are deterministic and start start with 1. Once assigned
an id, an element will always have the same id. It will get a new id if cloned. |
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 getRecordId() : string Return the index key used to give each row a unique id. |
public PHPFUI\Base::getResponse() : string |
public PHPFUI\HTML5Element::getToolTip(string $label) : PHPFUI\ToolTip|string 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() : static Assign a new id to this element. |
public outputBodyRows() : string outputBodyRows returns the contents of the table body for partical table output |
public outputFooter() : string outputFooter returns the table footer for partical table output |
public outputHeader() : string outputHeader returns the table header for partical table output |
public PHPFUI\Base::prepend(?mixed $item) : static Add an object in front of existing object |
public setAlwaysOutput(bool $alwaysOutput = true) : static By default, tables will not output if they have no rows |
public PHPFUI\HTML5Element::setAttribute(string $attribute, string $value = '') : static Set the attribute overwriting the prior value |
public setCaption(string $caption) : static |
public PHPFUI\HTML5Element::setConfirm( $text) : static 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) : static You can set the element type if you need to morph it for some reason |
public setFooters(array $footers) : static Set the footers for the table. Array indexes should
correspond to the row indexs. |
public setHeaders(array $headers) : static |
public PHPFUI\HTML5Element::setId( $id) : static Set the base id of the object |
public PHPFUI\Base::setRawResponse(string $response, bool $asJSON = true) : static Sets the page response directly and exits the program |
public setRecordId(string $key) : static 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') : static Set a response in the standard format ('reponse' and 'color' array)
exit will be called after returning the encoded response |
public setRows(array $rows) : static Set all the rows for a table |
public setStrict(bool $strict = true) : static Display "Missing X" for each field in a row that does not
have a index corresponding to a header. Useful for
debugging. |
public PHPFUI\HTML5Element::setToolTip(PHPFUI\ToolTip|string $tip) : static 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 setWidths(array $widths) : static Set widths for each column - param phpDocumentor\Reflection\Types\Array_ $widths array containing the column widths. The
width should contain % (preferred) or px
(discouraged). The array is positional and does
not need the keys to correspond to the column
names.
|
public PHPFUI\HTML5Element::toggleAnimate(PHPFUI\HTML5Element $element, string $animation) : static Will toggle the provided element on click with the provided animation. |
public PHPFUI\HTML5Element::toggleClass(PHPFUI\HTML5Element $element, string $class) : static Will toggle the class on the provided element on click. |
public PHPFUI\HTML5Element::transferAttributes(PHPFUI\HTML5Element $from) : static Moves attributes into this object from the passed object |
public PHPFUI\HTML5Element::transferClasses(PHPFUI\HTML5Element $from) : static Moves classes into this object from the passed object |
public PHPFUI\Base::walk(string $method, ?mixed $argument = NULL) : static Recursively walks all objects and calls the passed method on each object where it exists |