PHPFUI/InstaDoc
 
Copied!

The basic HTML5Element that handles common Foundation things and HTML closing tags

CloneableInstantiable
Constants
public PHPFUI\Base::DEBUG_SOURCE = 1
Methods
public __clone()
public __construct(string $element)
 

Construct an object with the tag name, ie. DIV, SPAN, TEXTAREA, etc

public PHPFUI\Base::__toString() : string
public PHPFUI\Base::add(?mixed $item) : static
 

Base add function. Adds to the end of the current objects

  • param mixed $item should be convertable to string
public PHPFUI\Base::addAsFirst(?mixed $item) : static
 

Base addAsFirst function. Adds to the front of the current object

  • param mixed $item should be convertable to string
public addAttribute(string $attribute, string $value = '') : static
 

Add an attribute the the object

  • param string $value of the attribute, blank for just a plain attribute
public addClass(string $class) : static
 

Add a class to an object

  • param string $class name(s) to add
public addPHPClassName() : static
 

Adds the base PHP class name as a class to this object

public PHPFUI\Base::count() : int
 

Number of object in this object. Does not count sub objects.

public deleteAttribute(string $attribute) : static
 

Deletes the passed attribute

public deleteAttributes() : static
 

Deletes all attributes

public deleteClass(string $classToDelete) : static
 

Delete a class from the object

public disabled() : static
 

Disabled the element

public PHPFUI\Base::done(bool $done = true) : static
 

Form is done rendering

public getAttribute(string $attribute) : ?string
 

Get an attribute

  • return ?string does not exist if null
public 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 getClass() : string
 

Returns the class attribute ready for insertion into an element.

public getClasses() : array
 

Returns all classes for the object

  • return string[]
public static PHPFUI\Base::getDebug(int $flags = 0) : int
 

Gets the current debug setting

public getElement() : string
 

Return the type of the element

public 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 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\Base::getResponse() : string
 

Get the current response

public getToolTip(string $label) : PHPFUI\ToolTip|string
 

Get the tool tip as a string

  • return \ToolTip|string return type depends on if the tip was set as a string or ToolTip object.
public hasClass(string $class) : bool
 

Return true if the class is present on the object

public hasId() : bool
 

Does this object have an id set already?

public hasToolTip() : bool
 
  • return bool if there is a tool tip associated with this element
public PHPFUI\Base::isDone() : bool
 

Returns true if the page needs no more processing

public 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 setAttribute(string $attribute, string $value = '') : static
 

Set the attribute overwriting the prior value

  • param string $value of the attribute, blank for just a plain attribute
public setConfirm( $text) : static
 

A simple way to set a confirm on click

  • param string $text confirm text
public static PHPFUI\Base::setDebug(int $level = 0) : void
 

Set the debug level, 1 or higher is on

public setElement( $element) : static
 

You can set the element type if you need to morph it for some reason

  • param string $element
public setId( $id) : static
 

Set the base id of the object

  • param string $id to set. Will be returned as set. It is up to the caller to prevent duplicate ids.
public PHPFUI\Base::setRawResponse(string $response, bool $asJSON = true) : static
 

Sets the page response directly and exits the program

  • return never|static
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

  • param string $response to return
  • param string $color used for the save button
  • return never|static
public 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 toggleAnimate(PHPFUI\HTML5Element $element, string $animation) : static
 

Will toggle the provided element on click with the provided animation.

public toggleClass(PHPFUI\HTML5Element $element, string $class) : static
 

Will toggle the class on the provided element on click.

public transferAttributes(PHPFUI\HTML5Element $from) : static
 

Moves attributes into this object from the passed object

public 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

  • param string $method to call on the object in the collection
  • param mixed $argument to pass to the method
Methods
protected getBody() : string
protected getEnd() : string
protected PHPFUI\Base::getItems() : array
 
  • return array
protected getStart() : string
protected upCastCopy(PHPFUI\HTML5Element $to, PHPFUI\HTML5Element $from) : object
 

Clones the first object and fills it with properties from the second object

Properties
private array $attributes = []
 
  • var array<string,string>
private array $classes = []
 
  • var array<string,true>
private string $element = ''
private ?string $id = NULL
private static array $masterId = ['Reveal' => 2, 'Hidden' => 1, 'AccordionMenu' => 1, 'HTML5Element' => 2, 'Input' => 1, 'Callout' => 1]
 
  • var array<string,int>
private bool $noEndTag = false
private static array $noEndTags = ['area' => true, 'base' => true, 'br' => true, 'col' => true, 'command' => true, 'embed' => true, 'hr' => true, 'img' => true, 'input' => true, 'keygen' => true, 'link' => true, 'meta' => true, 'param' => true, 'source' => true, 'track' => true, 'wbr' => true]
 
  • var array<string,true>
private PHPFUI\ToolTip|string|?null $tooltip = NULL
Properties
private static array $masterId = ['Reveal' => 2, 'Hidden' => 1, 'AccordionMenu' => 1, 'HTML5Element' => 2, 'Input' => 1, 'Callout' => 1]
 
  • var array<string,int>
private static array $noEndTags = ['area' => true, 'base' => true, 'br' => true, 'col' => true, 'command' => true, 'embed' => true, 'hr' => true, 'img' => true, 'input' => true, 'keygen' => true, 'link' => true, 'meta' => true, 'param' => true, 'source' => true, 'track' => true, 'wbr' => true]
 
  • var array<string,true>
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

© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration