PHPFUI/InstaDoc

Cloneable Instantiable

Extends

PHPFUI\Base
PHPFUI\VanillaPage
PHPFUI\Page
Example\Page
Implements

Countable
PHPFUI\Interfaces\Page
PHPFUI\Interfaces\Walkable
Stringable
Traits

PHPFUI\Traits\Walkable

Constants

public PHPFUI\Base ::DEBUG_SOURCE = 1

Methods

public PHPFUI\Base :: __clone ()

public __construct ()

public PHPFUI\Base :: __toString () : string

public PHPFUI\Base :: add ( $item )

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

return Base

public PHPFUI\Base :: addAsFirst ( $item )

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

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

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

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

Add a reveal dialog to the page

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

Add dedupped Style Sheet to the page

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

Add a dedupped script to the end of the page

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 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 ?.

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

Remove a javascript file

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)

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"

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)

public PHPFUI\Base :: walk ( string $method , $argument = NULL )

Recursively walks all objects and calls the passed method on each object where it exists

return $this

Methods

private getReveal ( PHPFUI\Button $button ) : void

Methods