API Add BuildTask to populate sample data, starting with a contact user form

tasks/PopulateThemeSampleDataTask.php

+<?php
+/**
+ * Used to populate sample data when installing the starter or Wātea theme
+ */
+class PopulateThemeSampleDataTask extends BuildTask
+{
+	protected $title = 'Populate sample data for theme demo';
+
+	protected $description = 'Populates some sample data for showcasing the functionality of the starter and Wātea themes';
+
+	/**
+	 * A series of method calls to create sample data
+	 *
+	 * @param SS_HTTPRequest $request
+	 */
+	public function run($request)
+	{
+		$this->handleContactForm();
+	}
+
+	/**
+	 * Decide whether to create a contact user defined form, and call it to be be created if so
+	 *
+	 * @return $this
+	 */
+	protected function handleContactForm()
+	{
+		if (!$this->getContactFormExists()) {
+			$this->createContactForm();
+		}
+		return $this;
+	}
+
+	/**
+	 * Determine whether a "contact us" userform exists yet
+	 *
+	 * @return bool
+	 */
+	protected function getContactFormExists()
+	{
+		$exists = false;
+		foreach (UserDefinedForm::get()->column('ID') as $formId) {
+			$count = Versioned::get_all_versions('UserDefinedForm', $formId)
+				->filter('URLSegment', 'contact')
+				->count();
+
+			if ($count >= 1) {
+				$exists = true;
+				break;
+			}
+		}
+		return $exists;
+	}
+
+	/**
+	 * Create a "contact us" userform. Please note that this form does not have any recipients by default, so
+	 * no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
+	 * tab.
+	 *
+	 * @return $this
+	 */
+	protected function createContactForm()
+	{
+		$form = UserDefinedForm::create(array(
+			'Title' => 'Contact',
+			'URLSegment' => 'contact',
+			'Content' => '<p>$UserDefinedForm</p>',
+			'SubmitButtonText' => 'Submit',
+			'ClearButtonText' => 'Clear',
+			'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
+			'EnableLiveValidation' => true
+		));
+
+		$form->write();
+
+		// Add form fields
+		$fields = array(
+			EditableFormStep::create(array(
+				'Title' => _t('EditableFormStep.TITLE_FIRST', 'First Page')
+			)),
+			EditableTextField::create(array(
+				'Title' => 'Name',
+				'Required' => true,
+				'RightTitle' => 'Please enter your first and last name'
+			)),
+			EditableEmailField::create(array(
+				'Title' => 'Email',
+				'Required' => true,
+				'Placeholder' => 'example@example.com'
+			)),
+			EditableTextField::create(array(
+				'Title' => 'Subject'
+			)),
+			EditableTextField::create(array(
+				'Title' => 'Message',
+				'Required' => true,
+				'Rows' => 5
+			))
+		);
+
+		foreach ($fields as $field) {
+			$field->write();
+			$form->Fields()->add($field);
+			$field->publish('Stage', 'Live');
+		}
+
+		$form->publish('Stage', 'Live');
+		$form->flushCache();
+
+		$this->output(' + Created "contact" UserDefinedForm page');
+
+		return $this;
+	}
+
+	/**
+	 * Output a message either to the console or browser
+	 *
+	 * @param  string $message
+	 * @return $this
+	 */
+	protected function output($message)
+	{
+		if (Director::is_cli()) {
+			$message .= PHP_EOL;
+		} else {
+			$message = sprintf('<p>%s</p>', $message);
+		}
+		echo $message;
+
+		return $this;
+	}
+}

tests/tasks/PopulateThemeSampleDataTaskTest.php

+<?php
+
+class PopulateThemeSampleDataTaskTest extends SapphireTest
+{
+	protected $usesDatabase = true;
+
+	/**
+	 * Ensure that the "contact" user form is only created once
+	 */
+	public function testOnlyCreateContactFormOnce()
+	{
+		$createdMessage = 'Created "contact" UserDefinedForm';
+
+		$task = new PopulateThemeSampleDataTask;
+
+		// Run the task
+		$this->assertContains($createdMessage, $this->bufferedTask($task));
+
+		// Run a second time
+		$this->assertNotContains($createdMessage, $this->bufferedTask($task));
+
+		// Change the page name
+		$form = UserDefinedForm::get()->filter('URLSegment', 'contact')->first();
+		$form->URLSegment = 'testing';
+		$form->write();
+
+		// Ensure the old version is still detected in draft, so not recreated
+		$this->assertNotContains($createdMessage, $this->bufferedTask($task));
+
+		// Delete the page, then ensure it's recreated again (DataObject::delete will remove staged versions)
+		$form->delete();
+		$this->assertContains($createdMessage, $this->bufferedTask($task));
+	}
+
+	/**
+	 * Run a BuildTask while buffering its output, and return the result
+	 *
+	 * @param  BuildTask $task
+	 * @return string
+	 */
+	protected function bufferedTask(BuildTask $task)
+	{
+		ob_start();
+		$task->run(new SS_HTTPRequest('GET', '/'));
+		return ob_get_clean();
+	}
+}