PHPFUI/InstaDoc
 
Copied!
Cloneable Instantiable
Constants
public PHPFUI\Base ::DEBUG_SOURCE = 1
Methods
public PHPFUI\Base :: __clone ()
public __construct ( PHPFUI\HTML5Element $mainContent )
public PHPFUI\Base :: __toString () : string
public PHPFUI\Base :: add ( $item )
 

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

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

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

  • param mixed $item should be convertable to string
  • return PHPFUI\Base
public addOff ( PHPFUI\HTML5Element $content , PHPFUI\HTML5Element $toggle ) : string
 

Add something off the canvas to come in when the toggle is
activated.

  • param PHPFUI\HTML5Element $content what you want to slide in from off canvas
  • param PHPFUI\HTML5Element $toggle what to toggle to get the off canvas piece to slide in
  • return string id of the content added. Used to specify postion and transition attributes
public addWrapper () : PHPFUI\OffCanvas
public PHPFUI\Base :: count () : int
 

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

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

Form is done rendering

public static PHPFUI\Base :: getDebug ( int $flags = 0 ) : int
 

Gets the current debug setting

public PHPFUI\Base :: getResponse () : string
 

Get the current response

public PHPFUI\Base :: isDone () : bool
 

Returns true if the page needs no more processing

public PHPFUI\Base :: prepend ( $item ) : PHPFUI\Base
 

Add an object in front of existing object

public static PHPFUI\Base :: setDebug ( int $level = 0 ) : void
 

Set the debug level, 1 or higher is on

public setInCanvasFor ( string $id , string $screenSize ) : PHPFUI\OffCanvas
 

Set the transition canvas position

  • param string $id id from addOff when the off canvas was added.
public setPosition ( string $id , string $position ) : PHPFUI\OffCanvas
 

Set the incoming canvas position

  • param string $id id from addOff when the off canvas was added.
  • param string $position one of ['left', 'right', 'top', 'bottom']
public PHPFUI\Base :: setRawResponse ( string $response , bool $asJSON = true ) : PHPFUI\Base
 

Sets the page response directly

public PHPFUI\Base :: setResponse ( string $response , string $color = 'lime' ) : PHPFUI\Base
 

Set a response in the standard format ('reponse' and 'color' array)

  • param string $color used for the save button
public setRevealFor ( string $id , string $screenSize ) : PHPFUI\OffCanvas
public setTransition ( string $id , string $transition ) : PHPFUI\OffCanvas
 

Set the transition canvas position

  • param string $id id from addOff when the off canvas was added.
  • param string $transition one of ['over', 'push']
public PHPFUI\Base :: walk ( string $method , $argument = NULL )
 

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
  • return $this
Methods
protected getBody () : string
protected getEnd () : string
protected getStart () : string
Properties
private PHPFUI\HTML5Element $mainContent
private PHPFUI\HTML5Element $offCanvas
private array $offCanvasCollection
private bool $wrapper
Methods
private setScreenAttribute ( string $attribute , string $id , string $screenSize ) : PHPFUI\OffCanvas
private validateId ( string $id ) : PHPFUI\OffCanvas
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
© 2021 Bruce Wells
Search Namespaces \ Classes
Configuration