Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/mitarbeiter/sven/public_html/tmp/devcon_php_base/proc/application.class
dev/con php base - Application server

application

application

Application base class

 

public class application

Application base class

AuthorsSven Klose <sven@devcon.net>

 
Direct known subclasses: hello_world, hello_world_linked, hello_world_ui, form_in_table, form_edit, list_records

Public Method Summary

void

run()

Execute application.
void

close()

Shutdown application.
object event

&event()

Return reference to last triggered event.
void

&call_single(object event &$e)

Call single event.
void

&call(object event $v)

Call batch of events.
void

add_function(string $handler, [ string $token_type ])

Register event handler.
void

add_method(string $method, object [unknown] &$class, [ string $token_type ])

Register event handler method in particular object..
string

link(object event $v)

Create URL containing an event that is triggered when the URL is
void

return2caller()

Return from a subsession.
void

&arg(string $name, [ integer $flags ])

Get an argument from current event.
array

&args()

Get all arguments.
void

application_define_database()

Define tables for application class.
void

set_timeout(integer $seconds)

Set time to live until auto-logout.

Private Method Summary

void

_set_type(string $name, integer $t)

Set token type for event for a particular event handler.
void

__call_sub()

Create new subsession for next event.
void

_url2event()

Get event object from URL.
void

_application_install()

Install sql tables.
void

_application_init()

Initialize everything.
void

_application_dump()

Warning: documentation is missing.

Private Field Summary

unknown

$db

unknown

$session

unknown

$_subargs

unknown

$_event

unknown

$_handlers

unknown

$_types

unknown

$_tokens

Private Constant Summary

ARG_OPTIONAL >>1<< Warning: documentation is missing.
ARG_SUB >>2<< Warning: documentation is missing.

Public Method Details

run

public void run( )

  Execute application.

Returns void


close

public void close( )

  Shutdown application.

Returns void


&event

public object event &event( )

  Return reference to last triggered event.

Returns object event


&call_single

public void &call_single( object event &$e )

  Call single event.
Even if a next event is defined by use of event::set_caller() thisfunction will ignore it. Use call() instead.

Parameter
object event &$e
Event to trigger.
Returns void


&call

public void &call( object event $v )

  Call batch of events.

Parameter
object event $v
Event to trigger.
Returns void


add_function

public void add_function( string $handler, [ string $token_type ] )

  Register event handler.

Parameter
string $handler
Name of event handler.
string $token_type = >>TOKEN_DEFAULT<<
Token type to use for links to the function.
Returns void


add_method

public void add_method( string $method, object [unknown] &$class, [ string $token_type ] )

  Register event handler method in particular object..

Parameter
string $method
Name of event handler.
object [unknown] &$class
Reference to object.
string $token_type = >>TOKEN_DEFAULT<<
Token type to use for links to the method.
Returns void


link

public string link( object event $v )

  Create URL containing an event that is triggered when the URL is
requested.

Parameter
object event $v
View object.
Returns string

URL to trigger event.


return2caller

public void return2caller( )

  Return from a subsession.

Returns void


&arg

public void &arg( string $name, [ integer $flags ] )

  Get an argument from current event.

Parameter
string $name
Name of argument.
integer $flags = >>0<<
Type of argument (TOKEN_SUB | TOKEN_OPTIONAL).
Returns void


&args

public array &args( )

  Get all arguments.

Returns array

Array of arguments keyed by name.


application_define_database

public void application_define_database( )

  Define tables for application class.

Returns void


set_timeout

public void set_timeout( integer $seconds )

  Set time to live until auto-logout.

Parameter
integer $seconds
Number of seconds which must be >1.
Returns void


Private Method Details

_set_type

private void _set_type( string $name, integer $t )

  Set token type for event for a particular event handler.

Parameter
string $name
Name of the event handler.
integer $t
Token type.
Returns void


__call_sub

private void __call_sub( )

  Create new subsession for next event.
Argument 'caller' contains the event object of the caller. It isstored in a new subsession object and called by return2caller().

Returns void


_url2event

private void _url2event( )

  Get event object from URL.

Returns void


_application_install

private void _application_install( )

  Install sql tables.

Returns void


_application_init

private void _application_init( )

  Initialize everything.

Returns void


_application_dump

private void _application_dump( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$db

private unknown $db

>><<



$session

private unknown $session

>><<



$_subargs

private unknown $_subargs

>><<



$_event

private unknown $_event

>><<



$_handlers

private unknown $_handlers

>><<



$_types

private unknown $_types

>><<



$_tokens

private unknown $_tokens

>><<



Private Constant Details

ARG_OPTIONAL

define( ARG_OPTIONAL, >>1<< )
Case: default: case sensitive



ARG_SUB

define( ARG_SUB, >>2<< )
Case: default: case sensitive




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta