Class app

The application object model

Must derive from it in order to define application's supported frames.
The default implementation integrates the "documentFrame" frame There should be only one app or derived class instance in the program

cmc\app implements cmc\core\ISerializable

Namespace: cmc
Copyright: Copyright (c) Calmarsoft company (FRANCE) (http://calmarsoft.com)
License: GNU General Public License version 3
Version: 0.9
Link: CMC Project
Located at app.php

Methods summary

`public static type`	# `current( string $ClassName = __CLASS__ )` takes an application instance from session, cache, or creates it takes an application instance from session, cache, or creates it Parameters `$ClassName` `string` $ClassName the custom application class name (use __CLASS__) Returns `type`
`protected`	# `initialize( )` initialization after each application "refresh" (retrieval from session or first create) initialization after each application "refresh" (retrieval from session or first create)
`public`	# `invalidateViews( )` used to mark all views as invalid in the cache used to mark all views as invalid in the cache after this all views in the session will be recalculated
`public`	# `OnSerialize( )` called before serialize called before serialize Implementation of `cmc\core\ISerializable::OnSerialize()`
`public`	# `OnUnserialize( )` called after unserialize called after unserialize Implementation of `cmc\core\ISerializable::OnUnserialize()`
`protected`	# `setRanOK( )` used to mark current request as OK used to mark current request as OK this is useful for error handling
`public boolean`	# `bRanOK( )` test the 'RanOK' status test the 'RanOK' status Returns `boolean`
`protected array`	# `getFrameClasses( )` retrives the list of supported frame classes retrives the list of supported frame classes Returns `array`
`public string`	# `dft_Parameter( string $key )` retieves a parameter in the application retieves a parameter in the application $key can be 'lang', 'path',... Parameters `$key` `string` $key Returns `string`
`public boolean\|string`	# `Language( string $key )` returns the Language name for a language key returns the Language name for a language key Parameters `$key` `string` $key Returns `boolean\|string`
`public array`	# `getLanguageList( )` returns the list of language keys returns the list of language keys Returns `array`
`public`	# `getLanguageUrlRegex( )`
`public boolean\|cmc\ui\view`	# `load_viewbase( string $path )` loads a static view from given path and session language loads a static view from given path and session language Parameters `$path` `string` $path Returns `boolean\|cmc\ui\view`
`protected`	# `__construct( )`
`public`	# `__destruct( )`
`public type`	# `getSession( )` retrieves related session object retrieves related session object Returns `type`
`public boolean\|cmc\ui\frame`	# `getFrameInstance( string $frameid, boolean $reset = false )` retrieves, creates or creates an application's frame (static frames) retrieves, creates or creates an application's frame (static frames) Parameters `$frameid` `string` $frameid `$reset` `boolean` $reset used to recreate the frame object Returns `boolean\|cmc\ui\frame`
`public boolean`	# `hasBaseView( string $view_pathloc )` test if a view is allready present in the application test if a view is allready present in the application Parameters `$view_pathloc` `string` $view_pathloc specific view path Returns `boolean`
`public null\|cmc\ui\view`	# `getRequestBaseView( string $view_path, string $view_pathloc, mixed $lang )` main view seek and initialization function main view seek and initialization function find the most appropriate view, or error view for given with paths then instantiates the view and related frames, and widgets Parameters `$view_path` `string` $view_path regular view path `$view_pathloc` `string` $view_pathloc localized view path `$lang` Returns `null\|cmc\ui\view`
`public boolean`	# `run( )` runs the current request - either initial or Ajax one runs the current request - either initial or Ajax one Returns `boolean`

Magic methods summary

Constants summary

`string`	`APP_appobj`	`'APP_appobj'`	#
`integer`	`_refreshSecs`	`60`	#
`integer`	`_expireSecs`	`3600`	#

Properties summary

`protected array`	`$dft_Parameters`	#
`protected array`	`$_languages`	#

Namespaces

Classes

Functions

Class app

Methods summary

Parameters

Returns

Implementation of

Implementation of

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Magic methods summary

Constants summary

Properties summary