HTML_QuickForm_Controller
[ class tree: HTML_QuickForm_Controller ] [ index: HTML_QuickForm_Controller ] [ all elements ]
Packages:
HTML_QuickForm_Controller


Classes:
HTML_QuickForm_Action
HTML_QuickForm_Action_Back
HTML_QuickForm_Action_Direct
HTML_QuickForm_Action_Display
HTML_QuickForm_Action_Jump
HTML_QuickForm_Action_Next
HTML_QuickForm_Action_Submit
HTML_QuickForm_Controller
HTML_QuickForm_Page
HTML_QuickForm_Controller
   ActionDisplay
   ActionProcess
   ActionUpload
   PageBar
   PageBaz
   PageFirst
   PageFirstActionNext
   PageFoo
   PageSecond
   PageSecondActionBack
   PageSecondActionNext
   PageSecondAlpha
   PageSecondBeta
   PageThird
   PageThirdActionBack
   Page_Account_Credentials
   Page_Account_Information
   Page_CMS_Fill
   Page_CMS_Layout
   Page_CMS_Preview
   SimplePage
   TabbedPage
Files:
Action.php
Back.php
Controller.php
Direct.php
Display.php
Jump.php
Next.php
Page.php
regWizard.php
simple.php
statemachine.php
Submit.php
tabbed.php
upload.php
wizard.php

Class: HTML_QuickForm_Page

Source Location: /HTML_QuickForm_Controller-1.0.7/Page.php

Class Overview

HTML_QuickForm
   |
   --HTML_QuickForm_Page

The class represents a page of a multipage form.


Author(s):

Version:

  • $Revision: 1.6 $

Variables

Methods

Child classes:

SimplePage
The class represents a page of a multipage form.
TabbedPage
The class represents a page of a multipage form.
The class represents a page of a multipage form.
PageSecond
The class represents a page of a multipage form.
The class represents a page of a multipage form.
Page_Account_Credentials
The class represents a page of a multipage form.
Page_Account_Information
The class represents a page of a multipage form.
Page_CMS_Layout
The class represents a page of a multipage form.
Page_CMS_Fill
The class represents a page of a multipage form.
Page_CMS_Preview
The class represents a page of a multipage form.
PageSecondAlpha
The class represents a page of a multipage form.
PageSecondBeta
The class represents a page of a multipage form.

Inherited Variables

Inherited Methods

Class Details

[line 35]
The class represents a page of a multipage form.

Generally you'll need to subclass this and define your buildForm() method that will build the form. While it is also possible to instantiate this class and build the form manually, this is not the recommended way.

  • Version: $Revision: 1.6 $
  • Author: Alexey Borzov <avb@php.net>


[ Top ]

Class Variables

$controller =  null

[line 48]

Contains a reference to a Controller object containing this page
  • Access: public

Type:   object HTML_QuickForm_Controller


[ Top ]


Method Detail

HTML_QuickForm_Page (Constructor)   [line 61]

HTML_QuickForm_Page HTML_QuickForm_Page( $formName, [ $method = 'post'], [ $target = ''], [ $attributes = null])

Class constructor
  • Access: public

Parameters:

   $formName   —   
   $method   —   
   $target   —   
   $attributes   —   

[ Top ]

addAction   [line 74]

void addAction( string $actionName, object HTML_QuickForm_Action &$action)

Registers a handler for a specific action.
  • Access: public

Parameters:

string   $actionName   —   name of the action
object HTML_QuickForm_Action   &$action   —   the handler for the action

[ Top ]

buildForm   [line 143]

void buildForm( )

Builds a form.

You should override this method when you subclass HTML_QuickForm_Page, it should contain all the necessary addElement(), applyFilter(), addRule() and possibly setDefaults() and setConstants() calls. The method will be called on demand, so please be sure to set $_formBuilt property to true to assure that the method works only once.

  • Abstract:
  • Access: public

Overridden in child classes as:

SimplePage::buildForm()
PageFoo::buildForm()
PageBar::buildForm()
PageBaz::buildForm()
PageFirst::buildForm()
PageSecond::buildForm()
PageThird::buildForm()
Page_Account_Credentials::buildForm()
Page_Account_Information::buildForm()
Page_CMS_Layout::buildForm()
Page_CMS_Fill::buildForm()
Page_CMS_Preview::buildForm()
PageSecondAlpha::buildForm()
PageSecondBeta::buildForm()

[ Top ]

exportValues   [line 188]

void exportValues( [mixed $elementList = null], [bool $filterInternal = false])

Returns 'safe' elements' values

Parameters:

mixed   $elementList   —   Array/string of element names, whose values we want. If not set then return all elements.
bool   $filterInternal   —   Whether to remove internal (_qf_...) values from the resultant array

[ Top ]

getButtonName   [line 107]

string getButtonName( string $actionName)

Returns a name for a submit button that will invoke a specific action.
  • Return: "name" attribute for a submit button
  • Access: public

Parameters:

string   $actionName   —   Name of the action

[ Top ]

handle   [line 90]

void handle( string $actionName)

Handles an action.

If an Action object was not registered here, controller's handle() method will be called.

  • Throws: PEAR_Error
  • Access: public

Parameters:

string   $actionName   —   Name of the action

[ Top ]

isFormBuilt   [line 155]

bool isFormBuilt( )

Checks whether the form was already built.
  • Access: public

[ Top ]

loadValues   [line 121]

void loadValues( array $values)

Loads the submit values from the array.

The method is NOT intended for general usage.

  • Access: public

Parameters:

array   $values   —   'submit' values

[ Top ]

setDefaultAction   [line 171]

void setDefaultAction( string $actionName)

Sets the default action invoked on page-form submit

This is necessary as the user may just press Enter instead of clicking one of the named submit buttons and then no action name will be passed to the script.

  • Access: public

Parameters:

string   $actionName   —   default action name

[ Top ]
Documentation generated on Sat, 14 Oct 2006 08:32:16 -0400 by phpDocumentor 1.3.0. PEAR Logo Copyright © PHP Group 2004.