phpDocumentor ZNF
Action
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]

Class: ZNF_Action_ActionForm

Source Location: /Action/ActionForm.php

Class ZNF_Action_ActionForm

Class Overview

ZNF_Action_ActionForm checks and filters all properties coming from the form before the ZNF_Action_Action->execute() method is called.

Is associated with one or more ZNF_Action_ActionMapping.

First the properties must be populated, then if in the module configuration file the validate attribute of the action element is set to true the ZNF_Action_ActionForm->validate() method will be called by the controller ZNF_Action_RequestProcessor, which gives a chance to verify that the properties submitted are corrects and valids.

If this method finds problems adds error messages to a ZNF_Action_ActionErrors object. Otherwise, the ZNF_Action_ActionForm->validate() method returns an empty ZNF_Action_ActionErrors object, indicating that everything is acceptable and the corresponding ZNF_Action_Action->execute() method should be called.

Subclasses should provide appropriate getter and setter methods for all of the properties they wish to expose, plus override any of the public or protected methods for which they wish to provide modified functionality.

Located in /Action/ActionForm.php [line 55]



		
				Author(s):
		
		
		API Tags:
Access:  public

Information Tags:
Version:  SVN $Id: ActionForm.php 43 2007-06-26 23:36:35Z aronnax $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.5.0
License:  LGPL

Methods

[ Top ]
Method Summary
ZNF_Action_ActionForm   __construct()   Constructs a new ZNF_Action_ActionForm object.
void   __destruct()   Destroys the ZNF_Action_ActionForm object.
boolean   populate()   Populates the properties of the class with the properties submitted, must be implemented by subclasses.
ZNF_Action_ActionErrors   validate()   Validates the properties submitted, must be implemented by subclasses.

[ Top ]
Methods
Constructor __construct  [line 63]

  ZNF_Action_ActionForm __construct( )

Constructs a new ZNF_Action_ActionForm object.


API Tags:
Access:  public


[ Top ]
Destructor __destruct  [line 94]

  void __destruct( )

Destroys the ZNF_Action_ActionForm object.


API Tags:
Access:  public


[ Top ]
populate  [line 73]

  boolean populate( )

Populates the properties of the class with the properties submitted, must be implemented by subclasses.


API Tags:
Access:  public


[ Top ]
validate  [line 84]

  ZNF_Action_ActionErrors validate( )

Validates the properties submitted, must be implemented by subclasses.


API Tags:
Access:  public


[ Top ]

Documentation generated on Wed, 14 Nov 2007 23:47:33 +0100 by phpDocumentor 1.4.0