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 dynframe

dynamic frame

cmc\ui\frame
Extended by 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/dynframe.php

Methods summary

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

Overrides

cmc\ui\frame::initialize
public true
# is_dynamic( )

Returns

true

Overrides

cmc\ui\frame::is_dynamic
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

Overrides

cmc\ui\frame::is_dynamic_state
public cmc\sess
# getSession( )

Returns

cmc\sess
public
# setSession( cmc\sess $sess )

Parameters

$sess
cmc\sess
$sess
public
# viewPreUpdate( type $view, type $sess )

prepares dynamic update

prepares dynamic update

Parameters

$view
type
$view
$sess
type
$sess
public
# viewUpdate( cmc\ui\view $view, cmc\sess $sess )

dynamic update override this function to make process each time the view is refreshed
(not called when class is used for POST processing; you need to use specific overrides or handlers for this)

dynamic update override this function to make process each time the view is refreshed (not called when class is used for POST processing; you need to use specific overrides or handlers for this)

Parameters

$view
cmc\ui\view
$view
$sess
cmc\sess
$sess
public
# viewPostUpdate( type $view, type $sess )

implementation of dynamic updating

implementation of dynamic updating

updates widgets and related scripting code, according to changes made by viewUpdate method

Parameters

$view
type
$view
$sess
type
$sess
public mixed
# getAjaxData( mixed $view )

returns the frame's data part of Ajax answer

returns the frame's data part of Ajax answer

Returns

mixed
public boolean
# getAjaxProcess( )

return's the frame's process part of Ajax answer this is some action to perform on client just after rendering changes

return's the frame's process part of Ajax answer this is some action to perform on client just after rendering changes

Returns

boolean
public
# AddClickEvent( type $widget_name, callable $cb )

binds a callback for 'click' event on given widget

binds a callback for 'click' event on given widget

Parameters

$widget_name
type
$widget_name
$cb
cmc\ui\callable
$cb
public
# AddChangeEvent( type $widget_name, callable $cb )

binds a callback for 'change' event on givent widget

binds a callback for 'change' event on givent widget

Parameters

$widget_name
type
$widget_name
$cb
cmc\ui\callable
$cb
public
# AddProcessEvent( callable $cb )

binds a callback for processing the 'process' event

binds a callback for processing the 'process' event

Parameters

$cb
cmc\ui\callable
$cb
public
# AddEventListener( type $eventname, type $widget_name, callable $cb )

adds a callback listened for given event on given widget

adds a callback listened for given event on given widget

Parameters

$eventname
type
$eventname
$widget_name
type
$widget_name
$cb
cmc\ui\callable
$cb
public
# clientSetValidationCB( type $cb_name, mixed $timeout = null )

defines a client side validation callback

defines a client side validation callback

the callback function will be used each time the validation state of the frame is changing (and also on first load with all values ready)

Parameters

$cb_name
type
$cb_name
$timeout
public
# clientSetTypingCB( type $cb_name )

defines a client side keyboard typing callback

defines a client side keyboard typing callback

Parameters

$cb_name
type
$cb_name
public
# clientAddClickCB( type $widget_name, type $cb_name )

defines a client side click callback

defines a client side click callback

Parameters

$widget_name
type
$widget_name
$cb_name
type
$cb_name
public
# setPending( type $pendingData )

defines pending data information

defines pending data information

this will ensure a return on the server just after client rendering

Parameters

$pendingData
type
$pendingData
public
# cancelPend( )

cancels other pending processes

cancels other pending processes

public
# isPending( )

retreives if we ask for a new pending request

retreives if we ask for a new pending request

public
# onEvent( type $view, type $name, type $widget, type $eventData )

general event handler

general event handler

dispatches the POST events on callbacks and listeners

Parameters

$view
type
$view
$name
type
$name
$widget
type
$widget
$eventData
type
$eventData
public
# onClick( type $view, type $widget, type $eventData )

onClick default handler

onClick default handler

Parameters

$view
type
$view
$widget
type
$widget
$eventData
type
$eventData
public
# onUpload( type $view, type $widget, type $eventData )

onUpload default handler

onUpload default handler

Parameters

$view
type
$view
$widget
type
$widget
$eventData
type
$eventData
public
# onProcess( type $view, type $widget, type $eventData )

onProcess default handler

onProcess default handler

Parameters

$view
type
$view
$widget
type
$widget
$eventData
type
$eventData
public
# onPOSTDone( type $view )

POST 'done' event

POST 'done' event

Parameters

$view
type
$view
public type
# POSTfireEvent( type $view, type $event )

called for each event present in the POST request

called for each event present in the POST request

Parameters

$view
type
$view
$event
type
$event

Returns

type
public
# POSTupdatedata( type $view, type $data )

called after POST process for preparing POST answer data

called after POST process for preparing POST answer data

Parameters

$view
type
$view
$data
type
$data
public
# OnSerialize( )

Overrides

cmc\ui\frame::OnSerialize

Methods inherited from cmc\ui\frame

OnClone(), OnUnserialize(), __construct(), addWidget(), app(), bIsSessionValid(), dataSourceExec(), dataSourceFirst(), datasource(), dtaenv(), getId(), getName(), getScriptCode(), qry(), sess(), viewAttach(), viewInitialUpdate(), viewPostStaticUpdate(), viewRemoveElements(), viewStaticUpdate(), w()

Magic methods summary

Properties summary

Properties inherited from cmc\ui\frame

$_code, $_widgetdef, $_widgets

CMC for PHP API documentation generated by ApiGen 2.8.0