Class PifaAbstractFormModule

Abstract base class for all classes that are used as PIFA form module.

In order for an extension class to be displayed in the CMS_PIFAFORM's editor as module class it has to extend this class and implement its abstract methods doGet() & doPost().

Direct known subclasses

DefaultFormModule

Abstract
Package: Plugin\FormAssistant
Copyright: four for business AG
Author: Marcus Gnaß <marcus.gnass@4fb.de>
Located at plugins/form_assistant/classes/class.pifa.abstract_form_module.php

Methods summary
`public`	# `__construct( array $settings = NULL )` Parameters `$settings` `array` $settings as defined for cContentTypePifaForm Throws `cException`
`public array`	# `getSettings( )` Returns `array`
`public mixed`	# `getSetting( string $key )` Parameters `$key` `string` $key Returns `mixed`
`public`	# `setSettings( array $_settings )` Parameters `$_settings` `array` $_settings
`public integer`	# `getIdform( )` Returns `integer`
`public`	# `setIdform( integer $_idform )` Parameters `$_idform` `integer` $_idform
`public string`	# `getTemplateName( )` Returns `string`
`public`	# `setTemplateName( string $_templateName )` Parameters `$_templateName` `string` $_templateName
`public cSmartyWrapper`	# `getTpl( )` Returns `cSmartyWrapper`
`public`	# `setTpl( cSmartyWrapper $_tpl )` Parameters `$_tpl` `cSmartyWrapper` $_tpl
`protected string`	# `_getRequestMethod( )` Helper method to determine the current request method. The request method is returned as uppercase string. Helper method to determine the current request method. The request method is returned as uppercase string. Returns `string`
`public mixed\|string`	# `render( boolean $return = false )` Parameters `$return` `boolean` $return Returns `mixed\|string` Throws `PifaException` if request method is unknown
`abstract protected`	# `doGet( array $values = array(), array $errors = array() )` Handle GET request. Handle GET request. Parameters `$values` `array` $values `$errors` `array` $errors
`abstract protected`	# `doPost( )` Handle POST request. Handle POST request.

Constants summary
`string`	`GET`	`'GET'`	# The HTTP GET request method. The HTTP GET request method.
`string`	`POST`	`'POST'`	# The HTTP POST request method. The HTTP POST request method.

Properties summary
`protected array`	`$_settings`	`array()`	# Array of settings as defined for a content type CMS_PIFAFORM. Array of settings as defined for a content type CMS_PIFAFORM.
`private integer`	`$_idform`	`0`	# The unique ID of the form to be displayed and processed by this module. This ID is read from the given settings (pifaform_idform). The unique ID of the form to be displayed and processed by this module. This ID is read from the given settings (pifaform_idform).
`private string`	`$_templateName`	`''`	# The current template name to be used when displaying the form. This name usually depends upon the request method to be used. These names are read from the given settings. The current template name to be used when displaying the form. This name usually depends upon the request method to be used. These names are read from the given settings.
`private cSmartyWrapper`	`$_tpl`	`NULL`	#

Packages

Classes

Exceptions

Class PifaAbstractFormModule

Direct known subclasses

Parameters

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters