LimitSelect is a Select box with the number of records to
show per page.
It automatically generates and sets window.location to the
new URL refetching the page with the correct parameters. It
keeps the top record in the new view to not completely
disorient the user.
You can override the p (page) and l (limit) query string
parameters.
Default limits are 10, 25, 50 and 100
- 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(?mixed $item) : static Base add function. Adds to the end of the current objects
|
public PHPFUI\Base::addAsFirst(?mixed $item) : static Base addAsFirst function. Adds to the front of the current
|
public PHPFUI\HTML5Element::addAttribute(string $attribute, string $value = '') : static Add an attribute the the object
|
public PHPFUI\HTML5Element::addClass(string $class) : static Add a class to an object
|
public PHPFUI\Input\Input::addErrorMessage(string $error) : static Set a specific error
|
public PHPFUI\Input\Select::addLabelClass(string $class) : static |
public PHPFUI\Input\Select::addOptGroup(PHPFUI Add an OptGroup |
public PHPFUI\Input\Select::addOption(string $label, ?string $value = NULL, bool $selected = false, bool $disabled = false) : static Add an option
|
public PHPFUI\HTML5Element::addPHPClassName() : static Adds the base PHP class name as a class to this object |
public PHPFUI\Input\Select::count() : int Return the number of options added |
public PHPFUI\HTML5Element::deleteAttribute(string $attribute) : static Deletes the passed attribute |
public PHPFUI\HTML5Element::deleteAttributes() : static Deletes all attributes |
public PHPFUI\HTML5Element::deleteClass(string $classToDelete) : static Delete a class from the object |
public PHPFUI\HTML5Element::disabled() : static Disabled the element |
public PHPFUI\Base::done(bool $done = true) : static 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\Input::getDisabled() : bool Return true if disabled |
public PHPFUI\HTML5Element::getElement() : string Return the type of the element |
public PHPFUI\Input\Input::getError() : ?PHPFUI Get the error message for placement else where. If this is |
public PHPFUI\Input\Input::getHint() : ?PHPFUI |
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\Input\Input::getLabel() : string Return the label for the input field |
public PHPFUI\Input::getName() : string Returns the name of the input field |
public getPage() : PHPFUI |
public PHPFUI\Input::getPlaceholder() : string Returns the current placeholder |
public PHPFUI\Input\Input::getRequired() : bool |
public PHPFUI\Base::getResponse() : string Get the current response |
public getStart() : string |
public PHPFUI\HTML5Element::getToolTip(string $label) : PHPFUI Get the tool tip as a string
|
public PHPFUI\Input::getType() : string Returns the type of the input field |
public PHPFUI\Input::getValue() : string Return the initial value of the input field |
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 PHPFUI\Base::prepend(?mixed $item) : static Add an object in front of existing object |
public PHPFUI\Input\Select::removeAll() : static Remove all options. |
public PHPFUI\Input\Select::removeOption(string $value) : bool Remove an option. Returns true on success.
|
public PHPFUI\Input\Select::select(string $selection) : static Select an option based on the value passed
|
public PHPFUI\HTML5Element::setAttribute(string $attribute, string $value = '') : static Set the attribute overwriting the prior value
|
public PHPFUI\HTML5Element::setConfirm( $text) : static A simple way to set a confirm on click
|
public PHPFUI\Input\Input::setDataMask(PHPFUI |
public static PHPFUI\Base::setDebug(int $level = 0) : void Set the debug level, 1 or higher is on |
public PHPFUI\Input::setDisabled(bool $disabled = true) : static Set disabled |
public PHPFUI\HTML5Element::setElement( $element) : static You can set the element type if you need to morph it for some reason
|
public PHPFUI\Input\Input::setErrorMessages(array $errors) : static Set all error messages
|
public PHPFUI\Input\Input::setHint(string $hint) : static Set a hint
|
public PHPFUI\HTML5Element::setId( $id) : static Set the base id of the object
|
public PHPFUI\Input\Input::setLabel(string $label) : static Set a label if not specified in constructor |
public setLimitName(string $limitName = 'l') : static Set the parameter name for the limit. Default is l. |
public setLimits(array $limits = [10, 25, 50, 100]) : static Specify the limits to use
|
public PHPFUI\Input::setName(string $name) : static |
public setPageName(string $pageName = 'p') : static Set the parameter name for the page. Default is p. |
public PHPFUI\Input::setPlaceholder(string $placeholder) : static |
public PHPFUI\Base::setRawResponse(string $response, bool $asJSON = true) : static Sets the page response directly and exits the program
|
public PHPFUI\Input\Input::setRequired(bool $required = true) : static Set required
|
public PHPFUI\Base::setResponse(string $response, string $color = 'lime') : static Set a response in the standard format ('reponse' and 'color' array)
|
public PHPFUI\HTML5Element::setToolTip(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\Input\Input::setValidator(PHPFUI Set the validator for this input field. You must also add it to the page with addAbideValidator() |
public PHPFUI\Input::setValue(string $value) : static Set the initial value of the input field |
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\Input\Input::toggleFocus(PHPFUI Toggle the passed in element when this field gets focus. |
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, ?mixed $argument = NULL) : static Recursively walks all objects and calls the passed method on each object where it exists
|
Properties |
protected bool PHPFUI\Input::$disabled = false |
protected ?PHPFUI |
protected array PHPFUI\Input\Input::$errorMessages = []
|
protected ?PHPFUI |
protected string PHPFUI\Input\Input::$hintText = '' |
protected ?string PHPFUI\Input\Input::$label |
protected array PHPFUI\Input\Select::$labelClass = []
|
protected string PHPFUI\Input::$name |
protected array PHPFUI\Input\Select::$options = []
|
protected string PHPFUI\Input::$placeholder = '' |
protected bool PHPFUI\Input\Input::$required = false |
protected string PHPFUI\Input::$type = '' |
protected ?string PHPFUI\Input::$value |
Methods |
protected PHPFUI\HTML5Element::getBody() : string |
protected PHPFUI\Input\Select::getEnd() : string |
protected PHPFUI\Base::getItems() : array
|
protected PHPFUI\Input\Input::setAutoCompleteRequired(PHPFUI |
protected PHPFUI\HTML5Element::upCastCopy(PHPFUI Clones the first object and fills it with properties from the second object |
Properties |
private int $currentLimit |
private string $limitName |
private array $limits
|
private PHPFUI |
private string $pageName |
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 |