CMC for PHP
  • Namespace
  • Class
  • Tree

Namespaces

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

Classes

  • dynframe
  • dynview
  • frame
  • view

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 frame

frame is a container of other frames or widgets and linked to html view

Direct known subclasses

cmc\core\ui\documentFrame, cmc\ui\dynframe

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

Methods summary

public static string|null
# getId( )

returns the Id of the frame in the view
this value must match a section id in the view

returns the Id of the frame in the view
this value must match a section id in the view

Returns

string|null

See

cmc\dftconfig::VW_ACMCID
public
# __construct( )
public cmc\ui\widgets\widget
# addWidget( type $name, cmc\ui\widgets\widget $obj )

adds a new widget in the frame

adds a new widget in the frame

Parameters

$name
type
$name
$obj
cmc\ui\widgets\widget
$obj

Returns

cmc\ui\widgets\widget
public
# initialize( )

frame initialize can be used dynamically add and create widgets call parent function when implent this

frame initialize can be used dynamically add and create widgets call parent function when implent this

public cmc\ui\widget
# w( string $widget_name )

'short' widget access function

'short' widget access function

Parameters

$widget_name
string
$widget_name

Returns

cmc\ui\widget
public false
# is_dynamic( )

not dynamic ...

not dynamic ...

Returns

false
public
# is_dynamic_state( )

true if in dynamic state: dynamic and linked to a session

true if in dynamic state: dynamic and linked to a session

abstract public
# getName( )

successors must implement a name

successors must implement a name

public
# viewAttach( type $view )

update/set frame->view link

update/set frame->view link

Parameters

$view
type
$view
public
# viewStaticUpdate( cmc\view $view )

main static update override this function to process components before it is cached in the application

  • called each time the view must be entirely calculated (i.e: not in application or in session material cache)
  • APP_cache, SESS_save and SESS_save_mat parameter change the cases when this function is called

main static update override this function to process components before it is cached in the application

  • called each time the view must be entirely calculated (i.e: not in application or in session material cache)
  • APP_cache, SESS_save and SESS_save_mat parameter change the cases when this function is called

Parameters

$view
cmc\view
$view
public
# viewInitialUpdate( cmc\view $view )

first dynamic update on view override this function to process components before material is processed from the application cache into the session cache

  • called each time the session material is intialized (warning, this may be during POST if SESS_save_mat=false)
  • APP_cache, SESS_save and SESS_save_mat parameter change the cases when this function is called

first dynamic update on view override this function to process components before material is processed from the application cache into the session cache

  • called each time the session material is intialized (warning, this may be during POST if SESS_save_mat=false)
  • APP_cache, SESS_save and SESS_save_mat parameter change the cases when this function is called

Parameters

$view
cmc\view
$view
public
# viewPostStaticUpdate( cmc\view $view )

after static update

after static update

Parameters

$view
cmc\view
$view
public
# viewRemoveElements( cmc\ui\view $view, string $class )

definitive elements removal

definitive elements removal

Parameters

$view
cmc\ui\view
$view
$class
string
$class classname
public type
# getScriptCode( )

gets the frame's scripting code

gets the frame's scripting code

Returns

type
public boolean
# bIsSessionValid( type $view, type $sess )

is the session still valid ?

is the session still valid ?

if not the application may return to a fallback page

Parameters

$view
type
$view
$sess
type
$sess

Returns

boolean
public
# OnSerialize( )
public
# OnUnserialize( )
public
# OnClone( mixed $srcinstance )
public cmc\core\ui\request
# qry( )

shortcut for current request

shortcut for current request

Returns

cmc\core\ui\request
public cmc\app
# app( )

shortcut for current application

shortcut for current application

Returns

cmc\app
public cmc\sess
# sess( )

shortcut for current session

shortcut for current session

Returns

cmc\sess
public cmc\db\dataenv
# dtaenv( )

shortcut for current data environment

shortcut for current data environment

Returns

cmc\db\dataenv
public null|cmc\db\datasource
# datasource( type $dsName )

shortcut for a datasource of the data environment

shortcut for a datasource of the data environment

Parameters

$dsName
type
$dsName

Returns

null|cmc\db\datasource
public null|array
# dataSourceFirst( string $dsName, array $params = false )

shortcut for a datasource's first record

shortcut for a datasource's first record

Parameters

$dsName
string
$dsName
$params
array
$params

Returns

null|array
public null|boolean
# dataSourceExec( string $dsName, array $params = false )

shortcut for datasource execution

shortcut for datasource execution

Parameters

$dsName
string
$dsName
$params
array
$params

Returns

null|boolean

Magic methods summary

Properties summary

protected array $_widgetdef
#
protected mixed $_widgets
#
protected string $_code
#
CMC for PHP API documentation generated by ApiGen 2.8.0