AbstractNormForm
abstract class AbstractNormForm
NormFom is a simple template application to gather, validate and process form data in a flexible way.
This abstract class represents a well known process of gathering, validating and processing form data within a single PHP structure. To use it, simple extend this class and implement the abstract methods isValid() (for validation) and business() for processing/business logic. Then create an object of your subclass, supply an View object and start the process by calling normForm. The initial call will show the form supplied by the View object. Submitted form data will then be validated by your implementation of isValid(). Occurring error messages can be passed on to the View object and displayed in the template output. Once validation is passed, the data entered in the form can be processed in business() in any suitable way.
Properties
| protected View | $currentView | Holds the currently supplied view object that will be used in the template to render output. | |
| protected array | $errorMessages | An array containing all error messages being set by isValid(). | |
| protected string | $statusMessage | An optional status message that can be set in business() when processing data was successful. |
Methods
Abstract method used to validate the form input. Must be implemented in the subclass.
Abstract method for processing the validated form input (a.k.a. business logic). Must be implemented in the subclass.
Creates a new instance for a norm form object and initializes all necessary fields. A View object is used to initially define how and where output is displayed via the template engine and supply parameters to the template.
Main "decision" method for the form processing. This decision tree uses isFormSubmission() to check if the form is being initially displayed or shown again after a form submission and either calls show() to display the form (using the supplied View object) or validate the received input in isValid(). If validation failed, show() is called again. Possible error messages provided as parameters to the View object in isValid() can now be displayed. Once the submission was correct, business() is called where the data can be processed as needed.
Checks if the current request was an initial one (thus using GET) or a recurring one after a form submission (where POST was used).
Used to display output. The currently used object of type View is used to display the content by calling the display() method. Depending on the type of View object, a certain template engine will be used to render the output. The view object will handle passing on the parameters to the template engine.
Convenience method to check if a form field is empty, thus contains only an empty string. This is preferred to PHP's own empty() method which also defines inputs such as "0" as empty.
Details
at line 52
abstract protected bool
isValid()
Abstract method used to validate the form input. Must be implemented in the subclass.
at line 58
abstract protected
business()
Abstract method for processing the validated form input (a.k.a. business logic). Must be implemented in the subclass.
at line 66
__construct(View $defaultView)
Creates a new instance for a norm form object and initializes all necessary fields. A View object is used to initially define how and where output is displayed via the template engine and supply parameters to the template.
The template engine itself is also set up, two optional parameters allow setting the template paths.
at line 80
normForm()
Main "decision" method for the form processing. This decision tree uses isFormSubmission() to check if the form is being initially displayed or shown again after a form submission and either calls show() to display the form (using the supplied View object) or validate the received input in isValid(). If validation failed, show() is called again. Possible error messages provided as parameters to the View object in isValid() can now be displayed. Once the submission was correct, business() is called where the data can be processed as needed.
at line 99
protected bool
isFormSubmission()
Checks if the current request was an initial one (thus using GET) or a recurring one after a form submission (where POST was used).
at line 109
protected
show()
Used to display output. The currently used object of type View is used to display the content by calling the display() method. Depending on the type of View object, a certain template engine will be used to render the output. The view object will handle passing on the parameters to the template engine.
at line 120
protected bool
isEmptyPostField(string $index)
Convenience method to check if a form field is empty, thus contains only an empty string. This is preferred to PHP's own empty() method which also defines inputs such as "0" as empty.