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

Add to the body element directly

public PHPFUI\Page :: addAbideValidator ( PHPFUI\Validator $validator ) : PHPFUI\Page
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 Base
public Example\Page :: addBody ( $item ) : self
public PHPFUI\VanillaPage :: addCSS ( string $css ) : PHPFUI\Interfaces\Page
 

Add dedupped inline css

public PHPFUI\VanillaPage :: addHeadJavaScript ( string $js ) : PHPFUI\Interfaces\Page
 

Add dedupped JavaScript to the header

public PHPFUI\VanillaPage :: addHeadScript ( string $module ) : PHPFUI\Interfaces\Page
 

Add a dedupped header script

  • param string $module path to script
public PHPFUI\VanillaPage :: addHeadTag ( string $tag ) : PHPFUI\Interfaces\Page
 

Add a meta tag to the head section of the page

public PHPFUI\VanillaPage :: addIEComments ( string $comment ) : PHPFUI\Interfaces\Page
 

Add IE commands. For example you should restrict IE 8 and lower clients.

$page->addIEComments('<!--[if lt IE9]><script>window.location="/old/index.html";</script><![endif]-->');
public PHPFUI\VanillaPage :: addJavaScript ( string $js ) : PHPFUI\Interfaces\Page
 

Add dedupped JavaScript to the page

public PHPFUI\VanillaPage :: addJavaScriptFirst ( string $js ) : PHPFUI\Interfaces\Page
 

Add dedupped JavaScript as the first JavaScript before Foundation

public PHPFUI\VanillaPage :: addJavaScriptLast ( string $js ) : PHPFUI\Interfaces\Page
 

Add dedupped JavaScript as the last JavaScript on the page

public PHPFUI\Page :: addPluginDefault ( string $pluginName , string $property , string $value ) : PHPFUI\Page
 

You can add various plugin default parameters

Examples:

$page->addPluginDefault('Abide', 'patterns["zip"]', '/^[0-9-]*$/');
$page->addPluginDefault('Abide', "validators['AutoCompleteRequired']", 'AutoCompleteRequired');

public PHPFUI\Page :: addReveal ( PHPFUI\Reveal $reveal ) : PHPFUI\Page
 

Add a reveal dialog to the page

  • param Reveal $reveal dialog to store in the page
public PHPFUI\VanillaPage :: addStyleSheet ( string $module ) : PHPFUI\Interfaces\Page
 

Add dedupped Style Sheet to the page

  • param string $module filename
public PHPFUI\VanillaPage :: addTailScript ( string $module ) : PHPFUI\Interfaces\Page
 

Add a dedupped script to the end of the page

  • param string $module path to script
public callback ( array $parameters ) : array
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 PHPFUI\VanillaPage :: getBaseURL () : string
 

Return just the base URI without the query string

public PHPFUI\VanillaPage :: getBodyElement () : PHPFUI\Container
 

Direct access to the page body element. Also accessed via add method.

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

Gets the current debug setting

public PHPFUI\VanillaPage :: getFavIcon () : string
 

Return the Fav Icon

public Example\Page :: getFooterMenu () : PHPFUI\Menu
public static Example\Page :: getMenu () : PHPFUI\Menu
public PHPFUI\VanillaPage :: getPageName () : string
 

Return the current page name

public PHPFUI\VanillaPage :: getQueryParameters () : array
 

Returns array of the current query parameters

public PHPFUI\VanillaPage :: getQueryString () : string
 

Returns the query string with leading ? if set

public PHPFUI\VanillaPage :: getResourcePath ( string $resource = '' ) : string
 

Get fully qualified resource path root relative with resource if passed

A $resource starting with / or http is not modified

public PHPFUI\Base :: getResponse () : string
 

Get the current response

public PHPFUI\VanillaPage :: hasDatePicker () : bool
 

return true if it has a built in date picker detectable by HTTP_USER_AGENT

public PHPFUI\VanillaPage :: hasDateTimePicker () : bool
 

return true if it has a built in date time picker detectable by HTTP_USER_AGENT

public PHPFUI\VanillaPage :: hasTimePicker () : bool
 

return true if it has a built in time picker detectable by HTTP_USER_AGENT

public PHPFUI\VanillaPage :: isAndroid () : bool
 

Return true if Android platform

public PHPFUI\VanillaPage :: isChrome () : bool
 

Return true if Chrome browser

public PHPFUI\Base :: isDone () : bool
 

Returns true if the page needs no more processing

public PHPFUI\VanillaPage :: isIEMobile () : bool
 

Return true if Windows Mobile browser

public PHPFUI\VanillaPage :: isIOS () : bool
 

Return true if IOS platform

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

Add an object in front of existing object

public PHPFUI\VanillaPage :: redirect ( string $url = '' , string $parameters = '' , int $timeout = 0 ) : PHPFUI\Interfaces\Page
 

Redirect page. Default will redirect to the current page
minus query string. Pass formatted query string as
$parameter with no leading ?.

  • param string $url default '', current url
  • param string $parameters default ''
  • param int $timeout default 0
public PHPFUI\VanillaPage :: removeCSS ( string $css ) : PHPFUI\Interfaces\Page
 

Remove inline css

public PHPFUI\VanillaPage :: removeHeadJavaScript ( string $js ) : PHPFUI\Interfaces\Page
 

Remove JavaScript from the header

public PHPFUI\VanillaPage :: removeHeadScript ( string $module ) : PHPFUI\Interfaces\Page
 

Remove header script

  • param string $module path to script
public PHPFUI\VanillaPage :: removeHeadTag ( string $tag ) : PHPFUI\Interfaces\Page
 

Remove a meta tag from the head section of the page

public PHPFUI\VanillaPage :: removeIEComments ( string $comment ) : PHPFUI\Interfaces\Page
 

Remove IE commands.

public PHPFUI\VanillaPage :: removeJavaScript ( string $js ) : PHPFUI\Interfaces\Page
 

Remove JavaScript from the page

public PHPFUI\VanillaPage :: removeJavaScriptFirst ( string $js ) : PHPFUI\Interfaces\Page
 

Remove JavaScript from the first JavaScript before Foundation

public PHPFUI\VanillaPage :: removeJavaScriptLast ( string $js ) : PHPFUI\Interfaces\Page
 

Remove JavaScript from the last JavaScript on the page

public PHPFUI\VanillaPage :: removeStyleSheet ( string $module ) : PHPFUI\Interfaces\Page
 

Remove a Style Sheet from the page

  • param string $module filename
public PHPFUI\VanillaPage :: removeTailScript ( string $module ) : PHPFUI\Interfaces\Page
 

Remove script from the end of the page

  • param string $module path to script
public static PHPFUI\Base :: setDebug ( int $level = 0 ) : void
 

Set the debug level, 1 or higher is on

public PHPFUI\VanillaPage :: setFavIcon ( string $path ) : PHPFUI\Interfaces\Page
 

Sets the Fav Icon (shown in browser tabs and elsewhere in the
browser)

  • param string $path to favicon
public PHPFUI\VanillaPage :: setLanguage ( string $lang ) : PHPFUI\Interfaces\Page
 

Set the page language

public PHPFUI\VanillaPage :: setPageName ( string $name ) : PHPFUI\Interfaces\Page
 

Set the page name. Defaults to "Created with Foundation"

  • param string $name of page
public PHPFUI\Base :: setRawResponse ( string $response , bool $asJSON = true ) : PHPFUI\Base
 

Sets the page response directly

public PHPFUI\VanillaPage :: setResourcePath ( string $resourcePath = '/' ) : PHPFUI\Interfaces\Page
 

$resoursePath should start from the public root directory and include a trailing forward slash

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

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

  • param string $response to return
  • param string $color used for the save button
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 PHPFUI\VanillaPage :: getBody () : string
protected PHPFUI\VanillaPage :: getEnd () : string
protected PHPFUI\Base :: getItems () : array
protected Example\Page :: getMagellanMenu () : ? PHPFUI\Menu
protected Example\Page :: getStart () : string
Properties
private Example\Model\Country $model
Methods
public static PHPFUI\Base :: getDebug ( int $flags = 0 ) : int
 

Gets the current debug setting

public static Example\Page :: getMenu () : PHPFUI\Menu
public static PHPFUI\Base :: setDebug ( int $level = 0 ) : void
 

Set the debug level, 1 or higher is on
© 2022 Bruce Wells
Search Namespaces \ Classes
Configuration