Forms#

Copy	$form = new Form(
		$controller, // the Controller to render this form on 
		$name, // name of the method that returns this form on the controller
		FieldList $fields, // list of FormField instances 
		FieldList $actions, // list of FormAction instances
		$required // optional use of RequiredFields object
	);

Copy	<?php

	class Page_Controller extends ContentController {
		
		private static $allowed_actions = array(
			'HelloForm'
		);
		
		public function HelloForm() {
			$fields = new FieldList(
				TextField::create('Name', 'Your Name')
			);

			$actions = new FieldList(
				FormAction::create("doSayHello")->setTitle("Say hello")
			);

			$required = new RequiredFields('Name');

			$form = new Form($this, 'HelloForm', $fields, $actions, $required);
	
			return $form;
		}
	
		public function doSayHello($data, Form $form) {
			$form->sessionMessage('Hello '. $data['Name'], 'success');

			return $this->redirectBack();
		}
	}

Copy	$HelloForm

Copy	private static $allowed_actions = array(
		'HelloForm'
	);

Copy	TextField::create($name, $title, $value);

Copy	$fields = new FieldList(
		TextField::create('Name'),
		EmailField::create('Email')
	);

	$form = new Form($controller, 'MethodName', $fields, ...);

	// or use `setFields`
	$form->setFields($fields);

	// to fetch the current fields..
	$fields = $form->getFields();

Copy	$fields = $form->Fields();

	// add a field
	$fields->push(TextField::create(..));

	// insert a field before another one
	$fields->insertBefore(TextField::create(..), 'Email');

	// insert a field after another one
	$fields->insertAfter(TextField::create(..), 'Name');
	
	// insert a tab before the main content tab (used to position tabs in the CMS)
	$fields->insertBefore(Tab::create(...), 'Main');
	// Note: you need to create and position the new tab prior to adding fields via addFieldToTab()

Copy	$email = $form->Fields()->dataFieldByName('Email');
	$email->setTitle('Your Email Address');

Copy	$form->getFields()->removeByName('Email');

Copy	$field = new TextField(..);

	$field
		->setMaxLength(100)
		->setAttribute('placeholder', 'Enter a value..')
		->setTitle('');

Copy	$form = new Form(..);

	$form->setTemplate('CustomForm');

	// or, for a FormField
	$field = new TextField(..);

	$field->setTemplate('CustomTextField');
	$field->setFieldHolderTemplate('CustomTextField_Holder');

Copy	FormAction::create($action, $title);

Copy	public function MyForm() {
		$fields = new FieldList(..);

		$actions = new FieldList(
			FormAction::create('doSubmitForm', 'Submit')
		);

		$form = new Form($controller, 'MyForm', $fields, $actions);

		// Get the actions
		$actions = $form->Actions();

		// As actions is a FieldList, push, insertBefore, removeByName and other
		// methods described for `Fields` also work for actions.

		$actions->push(
			FormAction::create('doSecondaryFormAction', 'Another Button')
		);

		$actions->removeByName('doSubmitForm');
		$form->setActions($actions);

		return $form
	}

	public function doSubmitForm($data, $form) {
		//
	}

	public function doSecondaryFormAction($data, $form) {
		//
	}

Copy	<?php

	class Page_Controller extends ContentController {

		private static $allowed_actions = array(
			'MyForm'
		);

		public function MyForm() {
			$fields = new FieldList(
				TextField::create('Name'),
				EmailField::create('Email')
			);

			$actions = new FieldList(
				FormAction::create('doSubmitForm', 'Submit')
			);

			$form = new Form($controller, 'MyForm', $fields, $actions);

			return $form
		}

		public function doSubmitForm($data, $form) {
			// Submitted data is available as a map.
			echo $data['Name'];
			echo $data['Email'];

			// You can also fetch the value from the field.
			echo $form->Fields()->dataFieldByName('Email')->Value();

			// Using the Form instance you can get / set status such as error messages.
			$form->sessionMessage("Successful!", 'good');

			// After dealing with the data you can redirect the user back.
			return $this->redirectBack();
		}
	}

Copy	$validator = new RequiredFields(array(
		'Name', 'Email'
	));

	$form = new Form($this, 'MyForm', $fields, $actions, $validator);