Client

# Class: ViewManager Source Location: /client/Views.php
### Class Overview
Global views management. | ### Variables $cartoclient $data $isActionSuccess $log $message $metas $metasList $sessionCacheLocation $viewablePlugins $viewId $wc $wf $wh | ### Constants BASE_METAS | ### Methods __construct checkViewId getActionSuccess getCatalog getDefaultSessionData getId getMessage getMetas getMetasList getPluginSession getRequestValue getSessionCacheLocation getViewablePlugins getViewContainer getViewId handleView hasRole makeSessionCache setMetasFromRequest
### Class Details [line 28] Global views management. [ Top ] ### Class Variables #### $cartoclient = [line 38] #### Tags:
access: | private
Type: | Cartoclient
[ Top ] #### $data = [line 63] #### Tags:
access: | private
Type: | stdClass
[ Top ] #### $isActionSuccess = [line 88] #### Tags:
access: | private
Type: | boolean
[ Top ] #### $log = [line 33] #### Tags:
access: | private
Type: | Logger
[ Top ] #### $message = [line 68] #### Tags:
access: | private
Type: | string
[ Top ] #### $metas = [line 78] #### Tags:
access: | private
Type: | array
[ Top ] #### $metasList = [line 73] #### Tags:
access: | private
Type: | array
[ Top ] #### $sessionCacheLocation = [line 93] #### Tags:
access: | private
Type: | string
[ Top ] #### $viewablePlugins = [line 83] #### Tags:
access: | private
Type: | array
[ Top ] #### $viewId = [line 58] #### Tags:
access: | private
Type: | int
[ Top ] #### $wc = [line 43] #### Tags:
access: | private
Type: | ViewContainer
[ Top ] #### $wf = [line 48] #### Tags:
access: | private
Type: | ViewFilter
[ Top ] #### $wh = [line 53] #### Tags:
access: | private
Type: | ViewHook
[ Top ] ### Class Methods ### constructor __construct [line 101]
`ViewManager __construct( Cartoclient $cartoclient)`
Constructor #### Tags:
access: | public
#### Parameters:
Cartoclient | $cartoclient |
[ Top ] ### method checkViewId [line 188]
`int checkViewId( mixed $viewId, [boolean $mute = false])`
Checks view ID validity (non zero positive integer). #### Tags:
return: | view ID if valid, else 0
access: | public
#### Parameters:
mixed | $viewId | viewId
boolean | $mute | if true, no message is issued when ID is invalid
[ Top ] ### method getActionSuccess [line 526]
`boolean getActionSuccess( )`
#### Tags:
access: | public
[ Top ] ### method getCatalog [line 508]
`void getCatalog( )`
Returns view catalog. #### Tags:
access: | public
see: | ViewContainer::getCatalog()
[ Top ] ### method getDefaultSessionData [line 241]
`ClientSession getDefaultSessionData( )`
Returns default session. #### Tags:
access: | public
[ Top ] ### method getId [line 203]
`int getId( string $source)`
Gets id from given request parameter and checks its validity. #### Tags:
return: | id
access: | private
#### Parameters:
string | $source | request parameter name
[ Top ] ### method getMessage [line 473]
`string getMessage( )`
Returns result message if any. #### Tags:
access: | public
[ Top ] ### method getMetas [line 516]
`array getMetas( )`
Returns metadata. #### Tags:
return: | metadata
access: | public
[ Top ] ### method getMetasList [line 492]
`array getMetasList( )`
Returns ViewManager::metasList, list of metadata fields. #### Tags:
return: | list of metadata fields
access: | public
[ Top ] ### method getPluginSession [line 172]
`stdClass getPluginSession( ClientSession $sessionData)`
#### Tags:
return: | collection of viewable plugins states
access: | private
#### Parameters:
ClientSession | $sessionData |
[ Top ] ### method getRequestValue [line 441]
`string getRequestValue( string $name)`
Returns value of given request parameter if exists. #### Tags:
return: | parameter value
access: | private
#### Parameters:
string | $name | parameter name
[ Top ] ### method getSessionCacheLocation [line 228]
`string getSessionCacheLocation( )`
Returns path of cached session file. #### Tags:
access: | public
[ Top ] ### method getViewablePlugins [line 157]
`array getViewablePlugins( )`
Returns the list of plugins that have their data recorded in views (set in client.ini "viewablePlugins" parameter). #### Tags:
access: | private
[ Top ] ### method getViewContainer [line 465]
`ViewContainer getViewContainer( )`
Returns view container instance (file or DB using). #### Tags:
access: | public
[ Top ] ### method getViewId [line 481]
`int getViewId( )`
Returns current view ID. #### Tags:
access: | public
[ Top ] ### method handleView [line 278]
`bool handleView( ClientSession &$sessionData)`
Main view handler: detects what action to perform. #### Tags:
return: | true if some view has been processed
access: | public
#### Parameters:
ClientSession | &$sessionData |
[ Top ] ### method hasRole [line 211]
`boolean hasRole( [mixed $mute = false])`
Checks that user is allowed to perform special view actions. #### Tags:
access: | public
[ Top ] ### method makeSessionCache [line 258]
`bool makeSessionCache( ClientSession $clientSession)`
Writes cached session file. #### Tags:
return: | true if success
access: | public
#### Parameters:
ClientSession | $clientSession |
[ Top ] ### method setMetasFromRequest [line 455]
`void setMetasFromRequest( )`
Sets metadata from request. #### Tags:
access: | private
[ Top ] ### Class Constants #### BASE_METAS = 'viewTitle, viewShow, viewLocationId' [line 95] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:11 +0200 by phpDocumentor 1.3.0RC3