CMC for PHP
  • Namespace
  • Class
  • Tree

Namespaces

  • cmc
    • core
      • ui
    • db
      • mysqli
    • error
    • ui
      • widgets
  • PHP

Classes

  • app
  • cmc
  • dftconfig
  • sess

Functions

  • app
  • qry
  • sess

CMC for PHP is a web framework for PHP.
Copyright (c) 2014 by Calmarsoft company http://calmarsoft.com (FRANCE). All rights reserved.
Project information available here.

Class sess

Default session class

Implementation must derive this class in order to store session specific data like data environment, current user's id, ...

cmc\sess 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 sess.php

Methods summary

public static
# session_shutdown( )

shutdown handler

shutdown handler

public static cmc\sess
# current( cmc\app $app, string $ClassName = __CLASS__ )

general function for using the session

general function for using the session

Parameters

$app
cmc\app
$app
$ClassName
string
$ClassName

Returns

cmc\sess
protected
# initialize( )

init done when the session is created or recovered the first time

init done when the session is created or recovered the first time

public string
# getViewPath( )

returns a view path from current request

returns a view path from current request

Returns

string
public string
# getViewPathLoc( )

returns a localized view path from current request

returns a localized view path from current request

Returns

string
public cmc\ui\view
# getRequestView( )

returns a view object from current request

returns a view object from current request

it can be retrieved in the session, application cache or re-instantiated

Returns

cmc\ui\view
protected
# __construct( mixed $app )
public
# getSeq( )
public static
# multitask_enter( )
public static
# multitask_leave( )
public
# __destruct( )
public boolean
# dynFrameExist( string $cmcId )

checks a dynamic frame instance

checks a dynamic frame instance

Parameters

$cmcId
string
$cmcId

Returns

boolean
public
# addNewDynFrame( string $cmcId, cmc\ui\frame $frame )

adds a new dynamic frame instance in the session

adds a new dynamic frame instance in the session

Parameters

$cmcId
string
$cmcId the frame id
$frame
cmc\ui\frame
$frame
public null|cmc\ui\dynframe
# getDynFrame( string $cmcId )

retrieves a dynamic frame instance by Id

retrieves a dynamic frame instance by Id

Parameters

$cmcId
string
$cmcId

Returns

null|cmc\ui\dynframe
public null|cmc\ui\dynframe
# getDynFrameByName( string $name )

retrieves a dynamic frame instance by name

retrieves a dynamic frame instance by name

Parameters

$name
string
$cmcId

Returns

null|cmc\ui\dynframe
public
# onNewpage( )

called on 'newpage' load

called on 'newpage' load

public
# getHistoryLocation( integer & $steps )

gets the url of the session navigation history

gets the url of the session navigation history

Parameters

$steps
integer
$steps number of steps back
public
# truncHistoryLocation( integer $steps )

updates the history if we perform a 'back' redirection

updates the history if we perform a 'back' redirection

Parameters

$steps
integer
$steps
public cmc\core\translation
# getTranslation( )

returns current translation object

returns current translation object

Returns

cmc\core\translation
public
# setTextData( array $locData )

defines some direct translation or text; can override framework internal messages

defines some direct translation or text; can override framework internal messages

Parameters

$locData
array
$locData
public false|string
# translate( string $key )

translates a text or key

translates a text or key

Parameters

$key
string
$key

Returns

false|string
public
# translateFmt( mixed $key )
public cmc\db\dataenv
# getDataEnv( )

linked data enviroment

linked data enviroment

Returns

cmc\db\dataenv
public string|false
# getReqViewPath( )

retrives the view path (unlocalized)

retrives the view path (unlocalized)

Returns

string|false
public string|false
# getPathInfo( )

retrieves the request path (without REST part)

retrieves the request path (without REST part)

Returns

string|false
public string|false
# getParams( )

retrieves the request parameters

retrieves the request parameters

Returns

string|false
public string|false
# getParam( cmc\app $paramname )

retrieves a request parameter

retrieves a request parameter

Parameters

$paramname
cmc\app
$app

Returns

string|false
public cmc\core\request
# getRequest( )

retrieves the request object

retrieves the request object

Returns

cmc\core\request
public string
# getLangName( )

retrives current language name

retrives current language name

Returns

string
public
# isEnabled( )
public cmc\app
# getApp( )

retrives the linked application object

retrives the linked application object

Returns

cmc\app
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()

Magic methods summary

Constants summary

string SESS_sessobj 'SESS_sessobj'
#
CMC for PHP API documentation generated by ApiGen 2.8.0