File: /forms.inc.php

Description

This file is part of the VCL for PHP project

Copyright (c) 2004-2008 qadram software S.L. <support@qadram.com>

Checkout AUTHORS file for more information on the developers

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Classes defined in this file

CLASS NAME

DESCRIPTION

Application A class to reference all the forms created on your application.
ScrollingControl Base class for controls with scrolling area
CustomPage Base class for Page component
DataModule DataModule class, basically a non visible holder for direct Component descendants
Window A class to encapsulate a window living on the browser
Page A class to encapsulate a web page.
HiddenField A component to generate an html hidden field.
Frameset A class to encapsulate a frame set and generate frames.
Frame A frame represents a view of a document embedded into a parent document

Include/Require Statements

Global Variables

Constants

ddLeftToRight (line 43)

ddLeftToRight : 'ddLeftToRight'

ddRightToLeft (line 44)

ddRightToLeft : 'ddRightToLeft'

dtHTML_4_01_Frameset (line 40)

dtHTML_4_01_Frameset : 'HTML 4.01 Frameset'

dtHTML_4_01_Strict (line 38)

dtHTML_4_01_Strict : 'HTML 4.01 Strict'

dtHTML_4_01_Transitional (line 39)

dtHTML_4_01_Transitional : 'HTML 4.01 Transitional'

dtNone (line 34)

dtNone : '(none)'

dtXHTML_1_0_Frameset (line 37)

dtXHTML_1_0_Frameset : 'XHTML 1.0 Frameset'

dtXHTML_1_0_Strict (line 35)

dtXHTML_1_0_Strict : 'XHTML 1.0 Strict'

dtXHTML_1_0_Transitional (line 36)

dtXHTML_1_0_Transitional : 'XHTML 1.0 Transitional'

dtXHTML_1_1 (line 41)

dtXHTML_1_1 : 'XHTML 1.1'

fbDefault (line 2152)

fbDefault : 'fbDefault'

fbNo (line 2150)

fbNo : 'fbNo'

fbYes (line 2151)

fbYes : 'fbYes'

fsAuto (line 2449)

fsAuto : 'fsAuto'

fsNo (line 2451)

fsNo : 'fsNo'

fsYes (line 2450)

fsYes : 'fsYes'

mmFrame (line 385)

mmFrame : 'frame'

mmOpaque (line 386)

mmOpaque : 'opaque'

mmTranslucent (line 387)

mmTranslucent : 'translucent'

rmFrame (line 380)

rmFrame : 'frame'

rmLazyOpaque (line 382)

rmLazyOpaque : 'lazyopaque'

rmOpaque (line 381)

rmOpaque : 'opaque'

rmTranslucent (line 383)

rmTranslucent : 'translucent'

Functions

ajaxDump (line 280)

void ajaxDump( object $object)

This function dumps an object into the ajaxresponse, so it's added to be updated when the ajax request is returned

This function is used by the internal Ajax system to get the code for a component and add it to the Ajax response, so it gets updated when the response is returned.

It relays on the dumpForAjax method that may be implemented by a component to specify which javascript code must be executed in order to update such component.

If no dumpForAjax method implementation exists, it tries to get the object code and split the javascript and html code to add it to the response, so it gets correctly processed.

Parameters

  • object $object: Object to be added

Info


ajaxProcess (line 323)

string ajaxProcess( string $owner, string $sender, mixed $params, string $event, array $postvars, array $comps)

Function responsible to dispatch ajax requests to the right events

This function is used by the Page when UseAjax is true to process the ajax requests and fire the right events.

It also creates the response to update the browser according to the component updates.

Parameters

  • string $owner: Name of the owner that owns all the components for this request, usually a Page component
  • string $sender: Object that produced the ajaxCall
  • mixed $params: Parameters to be sent to the function to be executed
  • string $event: Name of the PHP function to execute
  • array $postvars: Variables from the _POST stream
  • array $comps: Names of the components to add to the stream to get updated

Info


VCLShutdown (line 58)

void VCLShutdown( )

Shutdown function, called by the PHP engine as the last thing to do before shutdown.

This function is automatically called by the PHP engine just before shutdown, and it's the right moment to serialize all components as no more user code is going to be executed.

This way, the status of all objects in the aplication is stored to be recovered later without user intervention.

Info



Documentation generated on Fri, 26 Dec 2008 11:45:10 +0100 by phpDocumentor 1.4.0a2