Agile Toolkit  4.2
Agile Toolkit is a powerful web development framework. Inspired by GUI Applications development
ApiWeb Class Reference
Inheritance diagram for ApiWeb:
ApiCLI AbstractView AbstractObject ApiFrontend

Public Member Functions

 __construct ($realm=null, $skin='default')
 init ()
 cleanMagicQuotes ()
 sendHeaders ()
 showExecutionTime ()
 _showExecutionTime ()
 _showExecutionTimeJS ()
 license ()
 license_checksum ()
 licenseCheck ($product)
 upgradeChecker ()
 caughtException ($e)
 outputWarning ($msg, $shift=0)
 outputDebug ($msg, $shift=0)
 outputInfo ($msg, $shift=0)
 initializeSession ($create=true)
 stickyGET ($name)
 stickyForget ($name)
 getStickyArguments ()
 main ()
 execute ()
 render ()
 redirect ($page=null, $args=array())
 setTags ($t)
 isAjaxOutput ()
 renderOnly ($object)
 initLayout ()
 addLayout ($name)
 layout_Content ()
 defaultTemplate ()

Data Fields

 $page = null
 $index_page = 'index'
 $start_time = null
 $_is_session_initialized = false
 $sticky_get_arguments = array()

Detailed Description

ApiWeb extends an api of CommandLine applications with knowlnedge of HTML templates, understanding of pages and routing.

Constructor & Destructor Documentation

__construct ( realm = null,
skin = 'default' 

Member Function Documentation

addLayout ( name)

Register new layout, which, if has method and tag in the template, will be rendered

caughtException ( e)

Reimplemented from ApiCLI.

Magic Quotes were a design error. Let's strip them if they are enabled

Default template for the application. Redefine to add your own rules.

Reimplemented from AbstractView.

execute ( )

Main execution loop

Reimplemented in ApiFrontend.

- used by URL class

init ( )

Redifine this function instead of default constructor

In addition to default initialization, set up logger and template

Reimplemented from AbstractObject.

initializeSession ( create = true)

Implements Layouts. Layout is region in shared template which may be replaced by object

Reimplemented in ApiFrontend.

Returns true if browser is going to EVAL output.

Default handling of Content page. To be replaced by ApiFrontend

Reimplemented in ApiFrontend.

license ( ) [final]

This function will return type of the license used: agpl, single, multi

license_checksum ( ) [final]

This function will return installation signature. It is used by add-ons when communicating with to detect tampering with license system.

licenseCheck ( product) [final]
main ( )

Call this method from your index file. It is the main method of Agile Toolkit

outputDebug ( msg,
shift = 0 

Reimplemented from ApiCLI.

outputInfo ( msg,
shift = 0 

Reimplemented from ApiCLI.

outputWarning ( msg,
shift = 0 

Reimplemented from ApiCLI.

redirect ( page = null,
args = array() 

Perform instant redirect to another page

Redirect to specified page. $args are $_GET arguments. Use this function instead of issuing header("Location") stuff

render ( )

Renders all objects inside applications and echo all output to the browser

Reimplemented from AbstractView.

renderOnly ( object)

Only show $object in the final rendering

Sends default headers. Re-define to send your own headers

setTags ( t)

Called on all templates in the system, populates some system-wide tags

Call this method if you want to see execution time on the bottom of your pages

stickyForget ( name)

Remove sticky GET which was set by stickyGET

stickyGET ( name)

Make current get argument with specified name automatically appended to all generated URLs

If version tag is defined in template, inserts current version of Agile Toolkit there. When newer verison is available, it will be displayed. Override this with empty function to disable.

Field Documentation

$_is_session_initialized = false

Initializes existing or new session

$index_page = 'index'
$page = null

Cleaned up name of the currently requested page

$start_time = null

recorded time when execution has started

$sticky_get_arguments = array()

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Enumerations