Base class for all forms.

The form class is an extensible base for all forms on a sapphire application. It can be used either by extending it, and creating processor methods on the subclass, or by creating instances of form whose actions are handled by the parent controller.

In either case, if you want to get a form to do anything, it must be inextricably tied to a controller. The constructor is passed a controller and a method on that controller. This method should return the form object, and it shouldn't require any arguments. Parameters, if necessary, can be passed using the URL or get variables. These restrictions are in place so that we can recreate the form object upon form submission, without the use of a session, which would be too resource-intensive.

You will need to create at least one method for processing the submission (through FormAction). This method will be passed two parameters: the raw request data, and the form object. Usually you want to save data into a DataObject by using saveInto(). If you want to process the submitted data in any way, please use getData() rather than the raw request data.

Located in /cms/code/Newsletter/Unsubscribe.php (line 166)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --Form
            |
            --Unsubscribe_Successful

Inherited Variables

Inherited from Form

Form::$actions
Form::$buttonClickedFunc
Form::$controller
Form::$current_action
Form::$fields
Form::$formMethod
Form::$hasDefaultAction
Form::$IncludeFormTag
Form::$jsValidationIncluded
Form::$message
Form::$messageType
Form::$name
Form::$record
Form::$security
Form::$target
Form::$url_handlers
Form::$validator

Inherited from RequestHandlingData

RequestHandlingData::$allowed_actions
RequestHandlingData::$request

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached

Inherited Methods

Inherited From Form

Form::__construct()
Form::Actions()
Form::addErrorMessage()
Form::buttonClicked()
Form::callfieldmethod()
Form::clearMessage()
Form::Controller()
Form::current_action()
Form::dataFieldByName()
Form::debug()
Form::defaultAction()
Form::disableDefaultAction()
Form::disableSecurityToken()
Form::disable_all_security_tokens()
Form::FieldMap()
Form::Fields()
Form::forAjaxTemplate()
Form::FormAction()
Form::FormAttributes()
Form::FormEncType()
Form::formHtmlContent()
Form::FormHttpMethod()
Form::FormMethod()
Form::FormName()
Form::forTemplate()
Form::getData()
Form::getExtraFields()
Form::getMessageFromSession()
Form::getRecord()
Form::getValidator()
Form::handleField()
Form::HiddenFields()
Form::httpSubmission()
Form::loadDataFrom()
Form::loadNonBlankDataFrom()
Form::makeReadonly()
Form::Message()
Form::messageForForm()
Form::MessageType()
Form::Name()
Form::renderWithoutActionButton()
Form::resetData()
Form::resetField()
Form::resetValidation()
Form::saveInto()
Form::securityTokenEnabled()
Form::sessionMessage()
Form::setActions()
Form::setButtonClicked()
Form::setFields()
Form::setFormAction()
Form::setFormMethod()
Form::setHTMLID()
Form::setMessage()
Form::setTarget()
Form::setValidator()
Form::set_current_action()
Form::single_field_required()
Form::testAjaxSubmission()
Form::testSubmission()
Form::transform()
Form::transformTo()
Form::unsetActionByName()
Form::unsetAllActions()
Form::unsetDataFieldByName()
Form::unsetFieldFromTab()
Form::unsetValidator()
Form::validate()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()