silverstripe / cwp

src/Extensions/CustomSiteConfig.php

Indentation +46 added lines, -46 removed lines

@@ -11,55 +11,55 @@
  */
 class CustomSiteConfig extends DataExtension
 {
-    private static $db = array(
-        'GACode' => 'Varchar(16)',
-        'FacebookURL' => 'Varchar(256)', // multitude of ways to link to Facebook accounts, best to leave it open.
-        'TwitterUsername' => 'Varchar(16)', // max length of Twitter username 15
-    );
+	private static $db = array(
+		'GACode' => 'Varchar(16)',
+		'FacebookURL' => 'Varchar(256)', // multitude of ways to link to Facebook accounts, best to leave it open.
+		'TwitterUsername' => 'Varchar(16)', // max length of Twitter username 15
+	);
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        $fields->addFieldToTab(
-            'Root.Main',
-            $gaCode = TextField::create(
-                'GACode',
-                _t(__CLASS__ . '.GaField', 'Google Analytics account')
-            )
-        );
+	public function updateCMSFields(FieldList $fields)
+	{
+		$fields->addFieldToTab(
+			'Root.Main',
+			$gaCode = TextField::create(
+				'GACode',
+				_t(__CLASS__ . '.GaField', 'Google Analytics account')
+			)
+		);
 
-        $gaCode->setRightTitle(
-            _t(
-                __CLASS__ . '.GaFieldDesc',
-                'Account number to be used all across the site (in the format <strong>UA-XXXXX-X</strong>)'
-            )
-        );
+		$gaCode->setRightTitle(
+			_t(
+				__CLASS__ . '.GaFieldDesc',
+				'Account number to be used all across the site (in the format <strong>UA-XXXXX-X</strong>)'
+			)
+		);
 
-        $fields->findOrMakeTab('Root.SocialMedia', _t(__CLASS__ . '.SocialMediaTab', 'Social Media'));
+		$fields->findOrMakeTab('Root.SocialMedia', _t(__CLASS__ . '.SocialMediaTab', 'Social Media'));
 
-        $fields->addFieldToTab(
-            'Root.SocialMedia',
-            $facebookURL = TextField::create(
-                'FacebookURL',
-                _t(__CLASS__ . '.FbField', 'Facebook UID or username')
-            )
-        );
-        $facebookURL->setRightTitle(
-            _t(
-                __CLASS__ . '.FbFieldDesc',
-                'Facebook link (everything after the "http://facebook.com/", eg http://facebook.com/'
-                . '<strong>username</strong> or http://facebook.com/<strong>pages/108510539573</strong>)'
-            )
-        );
+		$fields->addFieldToTab(
+			'Root.SocialMedia',
+			$facebookURL = TextField::create(
+				'FacebookURL',
+				_t(__CLASS__ . '.FbField', 'Facebook UID or username')
+			)
+		);
+		$facebookURL->setRightTitle(
+			_t(
+				__CLASS__ . '.FbFieldDesc',
+				'Facebook link (everything after the "http://facebook.com/", eg http://facebook.com/'
+				. '<strong>username</strong> or http://facebook.com/<strong>pages/108510539573</strong>)'
+			)
+		);
 
-        $fields->addFieldToTab(
-            'Root.SocialMedia',
-            $twitterUsername = TextField::create(
-                'TwitterUsername',
-                _t(__CLASS__ . '.TwitterField', 'Twitter username')
-            )
-        );
-        $twitterUsername->setRightTitle(
-            _t(__CLASS__ . '.TwitterFieldDesc', 'Twitter username (eg, http://twitter.com/<strong>username</strong>)')
-        );
-    }
+		$fields->addFieldToTab(
+			'Root.SocialMedia',
+			$twitterUsername = TextField::create(
+				'TwitterUsername',
+				_t(__CLASS__ . '.TwitterField', 'Twitter username')
+			)
+		);
+		$twitterUsername->setRightTitle(
+			_t(__CLASS__ . '.TwitterFieldDesc', 'Twitter username (eg, http://twitter.com/<strong>username</strong>)')
+		);
+	}
 }

src/Extensions/CwpCommentingExtension.php

Indentation +14 added lines, -14 removed lines

@@ -13,20 +13,20 @@
  */
 class CwpCommentingExtension extends Extension
 {
-    public function alterCommentForm(Form $form)
-    {
-        $fields = $form->Fields();
+	public function alterCommentForm(Form $form)
+	{
+		$fields = $form->Fields();
 
-        if ($emailField = $fields->dataFieldByName(Email::class)) {
-            $emailField
-                ->setTitle(_t(__CLASS__ . '.EMAIL_TITLE', Email::class))
-                ->setDescription(_t(__CLASS__ . '.WILL_NOT_BE_PUBLISHED', 'Will not be published.'));
-        }
+		if ($emailField = $fields->dataFieldByName(Email::class)) {
+			$emailField
+				->setTitle(_t(__CLASS__ . '.EMAIL_TITLE', Email::class))
+				->setDescription(_t(__CLASS__ . '.WILL_NOT_BE_PUBLISHED', 'Will not be published.'));
+		}
 
-        if ($urlField = $fields->dataFieldByName('URL')) {
-            $urlField
-                ->setTitle(_t(__CLASS__ . '.WEBSITE_TITLE', 'Your website (optional)'))
-                ->setAttribute('placeholder', 'http://');
-        }
-    }
+		if ($urlField = $fields->dataFieldByName('URL')) {
+			$urlField
+				->setTitle(_t(__CLASS__ . '.WEBSITE_TITLE', 'Your website (optional)'))
+				->setAttribute('placeholder', 'http://');
+		}
+	}
 }

src/Extensions/CwpSearchBoostExtension.php

Indentation +41 added lines, -41 removed lines

@@ -12,45 +12,45 @@
 class CwpSearchBoostExtension extends DataExtension
 {
 
-    /**
-     * Quality to boost the 'SearchBoost' field by.
-     * Default boost is 2x
-     *
-     * @config
-     * @var string
-     */
-    private static $search_boost = '2';
-
-    private static $db = array(
-        'SearchBoost' => 'Text'
-    );
-
-    /**
-     * Adds boost fields to this page
-     *
-     * @param FieldList $fields
-     */
-    public function updateCMSFields(FieldList $fields)
-    {
-        parent::updateCMSFields($fields);
-
-        // Rename metafield
-        $meta = $fields->fieldByName('Root.Main.Metadata');
-        $meta->setTitle(_t(__CLASS__ . '.PAGEINFO', 'Page info and SEO'));
-
-        $boostTitle = _t(__CLASS__ . '.SearchBoost', 'Boost Keywords');
-        $boostNote = _t(
-            __CLASS__ . '.SearchBoostNote',
-            '(Only applies to the search results on this site e.g. not on Google search)'
-        );
-        $boostDescription = _t(
-            __CLASS__ . '.SearchBoostDescription',
-            'Enter keywords separated by comma ( , ) for which to boost the ranking of this page '
-            . 'within the search results on this site.'
-        );
-        $boostField = TextareaField::create('SearchBoost', $boostTitle)
-            ->setRightTitle($boostNote)
-            ->setDescription($boostDescription);
-        $fields->insertBefore('MetaDescription', $boostField);
-    }
+	/**
+	 * Quality to boost the 'SearchBoost' field by.
+	 * Default boost is 2x
+	 *
+	 * @config
+	 * @var string
+	 */
+	private static $search_boost = '2';
+
+	private static $db = array(
+		'SearchBoost' => 'Text'
+	);
+
+	/**
+	 * Adds boost fields to this page
+	 *
+	 * @param FieldList $fields
+	 */
+	public function updateCMSFields(FieldList $fields)
+	{
+		parent::updateCMSFields($fields);
+
+		// Rename metafield
+		$meta = $fields->fieldByName('Root.Main.Metadata');
+		$meta->setTitle(_t(__CLASS__ . '.PAGEINFO', 'Page info and SEO'));
+
+		$boostTitle = _t(__CLASS__ . '.SearchBoost', 'Boost Keywords');
+		$boostNote = _t(
+			__CLASS__ . '.SearchBoostNote',
+			'(Only applies to the search results on this site e.g. not on Google search)'
+		);
+		$boostDescription = _t(
+			__CLASS__ . '.SearchBoostDescription',
+			'Enter keywords separated by comma ( , ) for which to boost the ranking of this page '
+			. 'within the search results on this site.'
+		);
+		$boostField = TextareaField::create('SearchBoost', $boostTitle)
+			->setRightTitle($boostNote)
+			->setDescription($boostDescription);
+		$fields->insertBefore('MetaDescription', $boostField);
+	}
 }

src/Extensions/CwpSiteTreeFileExtension.php

Indentation +49 added lines, -49 removed lines

@@ -11,53 +11,53 @@
 class CwpSiteTreeFileExtension extends DataExtension
 {
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        Requirements::css('cwp/cwp:css/fieldDescriptionToggle.css');
-        Requirements::javascript('cwp/cwp:javascript/fieldDescriptionToggle.js');
-
-        $fields->insertAfter(
-            'LastEdited',
-            ReadonlyField::create(
-                'BackLinkCount',
-                _t('SilverStripe\\CMS\\Model\\SiteTreeFileExtension.BACKLINKCOUNT', 'Used on:'),
-                $this->owner->BackLinkTracking()->Count() . ' '
-                    . _t('SilverStripe\\CMS\\Model\\SiteTreeFileExtension.PAGES', 'page(s)')
-            )
-            ->addExtraClass('cms-description-toggle')
-            ->setDescription($this->BackLinkHTMLList())
-        );
-    }
-
-    /**
-     * Generate an HTML list which provides links to where a file is used.
-     *
-     * @return string
-     */
-    public function BackLinkHTMLList()
-    {
-        $html = '<em>' . _t(
-            __CLASS__ . '.BACKLINK_LIST_DESCRIPTION',
-            'This list shows all pages where the file has been added through a WYSIWYG editor.'
-        ) . '</em>';
-        $html .= '<ul>';
-
-        foreach ($this->owner->BackLinkTracking() as $backLink) {
-            $listItem = '<li>';
-
-            // Add the page link
-            $listItem .= '<a href="' . $backLink->Link() . '" target="_blank">'
-                . Convert::raw2xml($backLink->MenuTitle) . '</a> &ndash; ';
-
-            // Add the CMS link
-            $listItem .= '<a href="' . $backLink->CMSEditLink() . '">'
-                . _t(__CLASS__ . '.EDIT', 'Edit') . '</a>';
-
-            $html .= $listItem . '</li>';
-        }
-
-        $html .= '</ul>';
-
-        return $html;
-    }
+	public function updateCMSFields(FieldList $fields)
+	{
+		Requirements::css('cwp/cwp:css/fieldDescriptionToggle.css');
+		Requirements::javascript('cwp/cwp:javascript/fieldDescriptionToggle.js');
+
+		$fields->insertAfter(
+			'LastEdited',
+			ReadonlyField::create(
+				'BackLinkCount',
+				_t('SilverStripe\\CMS\\Model\\SiteTreeFileExtension.BACKLINKCOUNT', 'Used on:'),
+				$this->owner->BackLinkTracking()->Count() . ' '
+					. _t('SilverStripe\\CMS\\Model\\SiteTreeFileExtension.PAGES', 'page(s)')
+			)
+			->addExtraClass('cms-description-toggle')
+			->setDescription($this->BackLinkHTMLList())
+		);
+	}
+
+	/**
+	 * Generate an HTML list which provides links to where a file is used.
+	 *
+	 * @return string
+	 */
+	public function BackLinkHTMLList()
+	{
+		$html = '<em>' . _t(
+			__CLASS__ . '.BACKLINK_LIST_DESCRIPTION',
+			'This list shows all pages where the file has been added through a WYSIWYG editor.'
+		) . '</em>';
+		$html .= '<ul>';
+
+		foreach ($this->owner->BackLinkTracking() as $backLink) {
+			$listItem = '<li>';
+
+			// Add the page link
+			$listItem .= '<a href="' . $backLink->Link() . '" target="_blank">'
+				. Convert::raw2xml($backLink->MenuTitle) . '</a> &ndash; ';
+
+			// Add the CMS link
+			$listItem .= '<a href="' . $backLink->CMSEditLink() . '">'
+				. _t(__CLASS__ . '.EDIT', 'Edit') . '</a>';
+
+			$html .= $listItem . '</li>';
+		}
+
+		$html .= '</ul>';
+
+		return $html;
+	}
 }

src/Extensions/CwpSiteTreeExtension.php

Indentation +31 added lines, -31 removed lines

@@ -9,39 +9,39 @@
 
 class CwpSiteTreeExtension extends DataExtension
 {
-    private static $db = array(
-        'ShowPageUtilities' => 'Boolean(1)'
-    );
+	private static $db = array(
+		'ShowPageUtilities' => 'Boolean(1)'
+	);
 
-    private static $defaults = array(
-        'ShowPageUtilities' => true
-    );
+	private static $defaults = array(
+		'ShowPageUtilities' => true
+	);
 
-    /**
-     * Modify the settings for a SiteTree
-     *
-     * {@inheritDoc}
-     *
-     * @param FieldList $fields
-     */
-    public function updateSettingsFields(FieldList $fields)
-    {
-        $helpText = _t(
-            __CLASS__ . '.SHOW_PAGE_UTILITIES_HELP',
-            'You can disable page utilities (print, share, etc) for this page'
-        );
+	/**
+	 * Modify the settings for a SiteTree
+	 *
+	 * {@inheritDoc}
+	 *
+	 * @param FieldList $fields
+	 */
+	public function updateSettingsFields(FieldList $fields)
+	{
+		$helpText = _t(
+			__CLASS__ . '.SHOW_PAGE_UTILITIES_HELP',
+			'You can disable page utilities (print, share, etc) for this page'
+		);
 
-        $fields->addFieldsToTab(
-            'Root.Settings',
-            array(
-                LiteralField::create('PageUtilitiesHelp', $helpText),
-                CheckboxField::create('ShowPageUtilities', $this->owner->fieldLabel('ShowPageUtilities'))
-            )
-        );
-    }
+		$fields->addFieldsToTab(
+			'Root.Settings',
+			array(
+				LiteralField::create('PageUtilitiesHelp', $helpText),
+				CheckboxField::create('ShowPageUtilities', $this->owner->fieldLabel('ShowPageUtilities'))
+			)
+		);
+	}
 
-    public function updateFieldLabels(&$labels)
-    {
-        $labels['ShowPageUtilities'] = _t(__CLASS__ . '.SHOW_PAGE_UTILITIES', 'Show page utilities?');
-    }
+	public function updateFieldLabels(&$labels)
+	{
+		$labels['ShowPageUtilities'] = _t(__CLASS__ . '.SHOW_PAGE_UTILITIES', 'Show page utilities?');
+	}
 }

src/Extensions/SynonymsSiteConfig.php

Indentation +42 added lines, -42 removed lines

@@ -16,52 +16,52 @@
 class SynonymsSiteConfig extends DataExtension
 {
 
-    private static $db = array(
-        'SearchSynonyms' => 'Text', // fulltextsearch synonyms.txt content
-    );
+	private static $db = array(
+		'SearchSynonyms' => 'Text', // fulltextsearch synonyms.txt content
+	);
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        // Don't show this field if you're not an admin
-        if (!Permission::check('ADMIN')) {
-            return;
-        }
+	public function updateCMSFields(FieldList $fields)
+	{
+		// Don't show this field if you're not an admin
+		if (!Permission::check('ADMIN')) {
+			return;
+		}
 
-        // Search synonyms
-        $fields->addFieldToTab(
-            'Root.FulltextSearch',
-            TextareaField::create('SearchSynonyms', _t(__CLASS__ . '.SearchSynonyms', 'Search Synonyms'))
-                ->setDescription(_t(
-                    __CLASS__ . '.SearchSynonyms_Description',
-                    'Enter as many comma separated synonyms as you wish, where '.
-                    'each line represents a group of synonyms.<br /> ' .
-                    'You will need to run <a rel="external" target="_blank" href="dev/tasks/Solr_Configure">'
-                    . 'Solr_Configure</a> if you make any changes'
-                ))
-        );
-    }
+		// Search synonyms
+		$fields->addFieldToTab(
+			'Root.FulltextSearch',
+			TextareaField::create('SearchSynonyms', _t(__CLASS__ . '.SearchSynonyms', 'Search Synonyms'))
+				->setDescription(_t(
+					__CLASS__ . '.SearchSynonyms_Description',
+					'Enter as many comma separated synonyms as you wish, where '.
+					'each line represents a group of synonyms.<br /> ' .
+					'You will need to run <a rel="external" target="_blank" href="dev/tasks/Solr_Configure">'
+					. 'Solr_Configure</a> if you make any changes'
+				))
+		);
+	}
 
-    /**
-     * @inheritdoc
-     *
-     * @param ValidationResult $validationResult
-     */
-    public function validate(ValidationResult $validationResult)
-    {
-        $validator = new SynonymValidator(array(
-            'SearchSynonyms',
-        ));
+	/**
+	 * @inheritdoc
+	 *
+	 * @param ValidationResult $validationResult
+	 */
+	public function validate(ValidationResult $validationResult)
+	{
+		$validator = new SynonymValidator(array(
+			'SearchSynonyms',
+		));
 
-        $validator->php(array(
-            'SearchSynonyms' => $this->owner->SearchSynonyms
-        ));
+		$validator->php(array(
+			'SearchSynonyms' => $this->owner->SearchSynonyms
+		));
 
-        $errors = $validator->getErrors();
+		$errors = $validator->getErrors();
 
-        if (is_array($errors) || $errors instanceof Traversable) {
-            foreach ($errors as $error) {
-                $validationResult->addError($error['message']);
-            }
-        }
-    }
+		if (is_array($errors) || $errors instanceof Traversable) {
+			foreach ($errors as $error) {
+				$validationResult->addError($error['message']);
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
             TextareaField::create('SearchSynonyms', _t(__CLASS__ . '.SearchSynonyms', 'Search Synonyms'))
                 ->setDescription(_t(
                     __CLASS__ . '.SearchSynonyms_Description',
-                    'Enter as many comma separated synonyms as you wish, where '.
+                    'Enter as many comma separated synonyms as you wish, where ' .
                     'each line represents a group of synonyms.<br /> ' .
                     'You will need to run <a rel="external" target="_blank" href="dev/tasks/Solr_Configure">'
                     . 'Solr_Configure</a> if you make any changes'

src/Search/CwpSearchPageController.php

Indentation +20 added lines, -20 removed lines

@@ -11,25 +11,25 @@
  */
 class CwpSearchPageController extends PageController
 {
-    /**
-     * Create the dummy search record for this page
-     *
-     * @return CwpSearchPage
-     */
-    protected function generateSearchRecord()
-    {
-        $searchPage = CwpSearchPage::create();
-        $searchPage->URLSegment = 'search';
-        $searchPage->Title = _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results');
-        $searchPage->ID = -1;
-        return $searchPage;
-    }
+	/**
+	 * Create the dummy search record for this page
+	 *
+	 * @return CwpSearchPage
+	 */
+	protected function generateSearchRecord()
+	{
+		$searchPage = CwpSearchPage::create();
+		$searchPage->URLSegment = 'search';
+		$searchPage->Title = _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results');
+		$searchPage->ID = -1;
+		return $searchPage;
+	}
 
-    public function __construct($dataRecord = null)
-    {
-        if (!$dataRecord) {
-            $dataRecord = $this->generateSearchRecord();
-        }
-        parent::__construct($dataRecord);
-    }
+	public function __construct($dataRecord = null)
+	{
+		if (!$dataRecord) {
+			$dataRecord = $this->generateSearchRecord();
+		}
+		parent::__construct($dataRecord);
+	}
 }

src/Tasks/PopulateThemeSampleDataTask.php

Indentation +129 added lines, -129 removed lines

@@ -17,133 +17,133 @@
  */
 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 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::class, $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([
-                'Title' => _t(
-                    'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
-                    'First Page'
-                )
-            ]),
-            EditableTextField::create([
-                'Title' => 'Name',
-                'Required' => true,
-                'RightTitle' => 'Please enter your first and last name'
-            ]),
-            EditableEmailField::create([
-                'Title' => Email::class,
-                'Required' => true,
-                'Placeholder' => 'example@example.com'
-            ]),
-            EditableTextField::create([
-                'Title' => 'Subject'
-            ]),
-            EditableTextField::create([
-                'Title' => 'Message',
-                'Required' => true,
-                'Rows' => 5
-            ])
-        );
-
-        foreach ($fields as $field) {
-            $field->write();
-            $form->Fields()->add($field);
-            $field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
-        }
-
-        $form->copyVersionToStage(Versioned::DRAFT, Versioned::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;
-    }
+	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 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::class, $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([
+				'Title' => _t(
+					'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
+					'First Page'
+				)
+			]),
+			EditableTextField::create([
+				'Title' => 'Name',
+				'Required' => true,
+				'RightTitle' => 'Please enter your first and last name'
+			]),
+			EditableEmailField::create([
+				'Title' => Email::class,
+				'Required' => true,
+				'Placeholder' => 'example@example.com'
+			]),
+			EditableTextField::create([
+				'Title' => 'Subject'
+			]),
+			EditableTextField::create([
+				'Title' => 'Message',
+				'Required' => true,
+				'Rows' => 5
+			])
+		);
+
+		foreach ($fields as $field) {
+			$field->write();
+			$form->Fields()->add($field);
+			$field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
+		}
+
+		$form->copyVersionToStage(Versioned::DRAFT, Versioned::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;
+	}
 }

src/PageTypes/BasePageController.php

Spacing +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
     {
         //if base url YML is defined in YML, use that
         if (Config::inst()->get(BasePage::class, 'pdf_base_url')) {
-            $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/';
+            $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url') . '/';
             //otherwise, if we are CWP use the secure domain
         } elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) {
             $pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/';
@@ -273,7 +273,7 @@ 
         if ($results) {
             $response = $response
                 ->customise($results)
-                ->customise(array( 'Results' => $results->getResults() ));
+                ->customise(array('Results' => $results->getResults()));
         }
 
         // Render

Indentation +283 added lines, -283 removed lines

@@ -21,293 +21,293 @@
 
 class BasePageController extends ContentController
 {
-    private static $allowed_actions = [
-        'downloadpdf',
-        'SearchForm',
-        'results',
-    ];
-
-    /**
-     * How many search results should be shown per-page?
-     *
-     * @config
-     * @var int
-     */
-    private static $results_per_page = 10;
-
-    /**
-     * If spelling suggestions for searches are given, enable
-     * suggested searches to be followed immediately
-     *
-     * @config
-     * @var bool
-     */
-    private static $search_follow_suggestions = true;
-
-    /**
-     * Which classes should be queried when searching?
-     *
-     * @config
-     * @var array
-     */
-    private static $classes_to_search = [
-        [
-            'class' => 'Page',
-            'includeSubclasses' => true,
-        ]
-    ];
-
-    /**
-     * Serve the page rendered as PDF.
-     */
-    public function downloadpdf()
-    {
-        if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
-            return false;
-        }
-
-        // We only allow producing live pdf. There is no way to secure the draft files.
-        Versioned::set_stage(Versioned::LIVE);
-
-        $path = $this->dataRecord->getPdfFilename();
-        if (!file_exists($path)) {
-            $this->generatePDF();
-        }
-
-        return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf');
-    }
-
-    /*
+	private static $allowed_actions = [
+		'downloadpdf',
+		'SearchForm',
+		'results',
+	];
+
+	/**
+	 * How many search results should be shown per-page?
+	 *
+	 * @config
+	 * @var int
+	 */
+	private static $results_per_page = 10;
+
+	/**
+	 * If spelling suggestions for searches are given, enable
+	 * suggested searches to be followed immediately
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $search_follow_suggestions = true;
+
+	/**
+	 * Which classes should be queried when searching?
+	 *
+	 * @config
+	 * @var array
+	 */
+	private static $classes_to_search = [
+		[
+			'class' => 'Page',
+			'includeSubclasses' => true,
+		]
+	];
+
+	/**
+	 * Serve the page rendered as PDF.
+	 */
+	public function downloadpdf()
+	{
+		if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
+			return false;
+		}
+
+		// We only allow producing live pdf. There is no way to secure the draft files.
+		Versioned::set_stage(Versioned::LIVE);
+
+		$path = $this->dataRecord->getPdfFilename();
+		if (!file_exists($path)) {
+			$this->generatePDF();
+		}
+
+		return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf');
+	}
+
+	/*
     * This will return either pdf_base_url from YML, CWP_SECURE_DOMAIN
     * from _ss_environment, or blank. In that order of importance.
     */
-    public function getPDFBaseURL()
-    {
-        //if base url YML is defined in YML, use that
-        if (Config::inst()->get(BasePage::class, 'pdf_base_url')) {
-            $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/';
-            //otherwise, if we are CWP use the secure domain
-        } elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) {
-            $pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/';
-            //or if neither, leave blank
-        } else {
-            $pdfBaseUrl = '';
-        }
-        return $pdfBaseUrl;
-    }
-
-    /*
+	public function getPDFBaseURL()
+	{
+		//if base url YML is defined in YML, use that
+		if (Config::inst()->get(BasePage::class, 'pdf_base_url')) {
+			$pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/';
+			//otherwise, if we are CWP use the secure domain
+		} elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) {
+			$pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/';
+			//or if neither, leave blank
+		} else {
+			$pdfBaseUrl = '';
+		}
+		return $pdfBaseUrl;
+	}
+
+	/*
     * Don't use the proxy if the pdf domain is the CWP secure domain
     * Or if we aren't on a CWP server
     */
-    public function getPDFProxy($pdfBaseUrl)
-    {
-        if (!Environment::getEnv('CWP_SECURE_DOMAIN')
-            || $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/'
-        ) {
-            $proxy = '';
-        } else {
-            $proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY')
-                . ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
-        }
-        return $proxy;
-    }
-
-    /**
-     * Render the page as PDF using wkhtmltopdf.
-     */
-    public function generatePDF()
-    {
-        if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
-            return false;
-        }
-
-        $binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary');
-        if (!$binaryPath || !is_executable($binaryPath)) {
-            if (Environment::getEnv('WKHTMLTOPDF_BINARY')
-                && is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY'))
-            ) {
-                $binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY');
-            }
-        }
-
-        if (!$binaryPath) {
-            user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR);
-        }
-
-        if (Versioned::get_reading_mode() == 'Stage.Stage') {
-            user_error('Generating PDFs on draft is not supported', E_USER_ERROR);
-        }
-
-        set_time_limit(60);
-
-        // prepare the paths
-        $pdfFile = $this->dataRecord->getPdfFilename();
-        $bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile);
-        $footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile);
-
-        // make sure the work directory exists
-        if (!file_exists(dirname($pdfFile))) {
-            Filesystem::makeFolder(dirname($pdfFile));
-        }
-
-        //decide the domain to use in generation
-        $pdfBaseUrl = $this->getPDFBaseURL();
-
-        // Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway.
-        if (Environment::getEnv('CWP_ENVIRONMENT')) {
-            Config::modify()->set(Director::class, 'alternate_protocol', 'http');
-            //only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is
-            if ($pdfBaseUrl) {
-                Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl);
-            }
-        }
-
-        $bodyViewer = $this->getViewer('pdf');
-
-        // write the output of this page to HTML, ready for conversion to PDF
-        file_put_contents($bodyFile, $bodyViewer->process($this));
-
-        // get the viewer for the current template with _pdffooter
-        $footerViewer = $this->getViewer('pdffooter');
-
-        // write the output of the footer template to HTML, ready for conversion to PDF
-        file_put_contents($footerFile, $footerViewer->process($this));
-
-        //decide what the proxy should look like
-        $proxy = $this->getPDFProxy($pdfBaseUrl);
-
-        // finally, generate the PDF
-        $command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 '
-            . '--orientation Portrait --disable-javascript --quiet --print-media-type ';
-        $retVal = 0;
-        $output = array();
-        exec(
-            $command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout",
-            $output,
-            $retVal
-        );
-
-        // remove temporary file
-        unlink($bodyFile);
-        unlink($footerFile);
-
-        // output any errors
-        if ($retVal != 0) {
-            user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR);
-        }
-
-        // serve the generated file
-        return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf');
-    }
-
-    /**
-     * Site search form
-     */
-    public function SearchForm()
-    {
-        $searchText = $this->getRequest()->getVar('Search');
-
-        $fields = FieldList::create(
-            TextField::create('Search', false, $searchText)
-        );
-        $actions = FieldList::create(
-            FormAction::create('results', _t('SilverStripe\\CMS\\Search\\SearchForm.GO', 'Go'))
-        );
-
-        $form = SearchForm::create($this, SearchForm::class, $fields, $actions);
-        $form->setFormAction('search/SearchForm');
-
-        return $form;
-    }
-
-    /**
-     * Get search form with _header suffix
-     *
-     * @return SearchForm
-     */
-    public function HeaderSearchForm()
-    {
-        return $this->SearchForm()->setTemplate('SearchForm_header');
-    }
-
-    /**
-     * Process and render search results.
-     *
-     * @param array $data The raw request data submitted by user
-     * @param SearchForm $form The form instance that was submitted
-     * @param HTTPRequest $request Request generated for this action
-     * @return DBHTMLText
-     */
-    public function results($data, $form, $request)
-    {
-        // Check parameters for terms, pagination, and if we should follow suggestions
-        $keywords = empty($data['Search']) ? '' : $data['Search'];
-        $start = isset($data['start']) ? $data['start'] : 0;
-        $suggestions = isset($data['suggestions'])
-            ? $data['suggestions']
-            : $this->config()->get('search_follow_suggestions');
-
-        $results = CwpSearchEngine::create()
-            ->search(
-                $keywords,
-                $this->config()->get('classes_to_search'),
-                Injector::inst()->get(CwpSearchEngine::class . '.search_index'),
-                $this->config()->get('results_per_page'),
-                $start,
-                $suggestions
-            );
-
-        // Customise content with these results
-        $properties = [
-            'MetaTitle' => _t(__CLASS__ . '.MetaTitle', 'Search {keywords}', ['keywords' => $keywords]),
-            'NoSearchResults' => _t(__CLASS__ . '.NoResult', 'Sorry, your search query did not return any results.'),
-            'EmptySearch' => _t(__CLASS__ . '.EmptySearch', 'Search field empty, please enter your search query.'),
-            'PdfLink' => '',
-            'Title' => _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results'),
-        ];
-        $this->extend('updateSearchResults', $results, $properties);
-
-        // Customise page
-        $response = $this->customise($properties);
-        if ($results) {
-            $response = $response
-                ->customise($results)
-                ->customise(array( 'Results' => $results->getResults() ));
-        }
-
-        // Render
-        $templates = $this->getResultsTemplate($request);
-        return $response->renderWith($templates);
-    }
-
-    /**
-     * Select the template to render search results with
-     *
-     * @param HTTPRequest $request
-     * @return array
-     */
-    protected function getResultsTemplate($request)
-    {
-        $templates = [Page::class . '_results', Page::class];
-        if ($request->getVar('format') == 'rss') {
-            array_unshift($templates, 'Page_results_rss');
-        }
-        if ($request->getVar('format') == 'atom') {
-            array_unshift($templates, 'Page_results_atom');
-        }
-        return $templates;
-    }
-
-    /**
-     * Provide current year.
-     */
-    public function CurrentDatetime()
-    {
-        return DBDatetime::now();
-    }
-
-    public function getRSSLink()
-    {
-    }
+	public function getPDFProxy($pdfBaseUrl)
+	{
+		if (!Environment::getEnv('CWP_SECURE_DOMAIN')
+			|| $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/'
+		) {
+			$proxy = '';
+		} else {
+			$proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY')
+				. ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
+		}
+		return $proxy;
+	}
+
+	/**
+	 * Render the page as PDF using wkhtmltopdf.
+	 */
+	public function generatePDF()
+	{
+		if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
+			return false;
+		}
+
+		$binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary');
+		if (!$binaryPath || !is_executable($binaryPath)) {
+			if (Environment::getEnv('WKHTMLTOPDF_BINARY')
+				&& is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY'))
+			) {
+				$binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY');
+			}
+		}
+
+		if (!$binaryPath) {
+			user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR);
+		}
+
+		if (Versioned::get_reading_mode() == 'Stage.Stage') {
+			user_error('Generating PDFs on draft is not supported', E_USER_ERROR);
+		}
+
+		set_time_limit(60);
+
+		// prepare the paths
+		$pdfFile = $this->dataRecord->getPdfFilename();
+		$bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile);
+		$footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile);
+
+		// make sure the work directory exists
+		if (!file_exists(dirname($pdfFile))) {
+			Filesystem::makeFolder(dirname($pdfFile));
+		}
+
+		//decide the domain to use in generation
+		$pdfBaseUrl = $this->getPDFBaseURL();
+
+		// Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway.
+		if (Environment::getEnv('CWP_ENVIRONMENT')) {
+			Config::modify()->set(Director::class, 'alternate_protocol', 'http');
+			//only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is
+			if ($pdfBaseUrl) {
+				Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl);
+			}
+		}
+
+		$bodyViewer = $this->getViewer('pdf');
+
+		// write the output of this page to HTML, ready for conversion to PDF
+		file_put_contents($bodyFile, $bodyViewer->process($this));
+
+		// get the viewer for the current template with _pdffooter
+		$footerViewer = $this->getViewer('pdffooter');
+
+		// write the output of the footer template to HTML, ready for conversion to PDF
+		file_put_contents($footerFile, $footerViewer->process($this));
+
+		//decide what the proxy should look like
+		$proxy = $this->getPDFProxy($pdfBaseUrl);
+
+		// finally, generate the PDF
+		$command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 '
+			. '--orientation Portrait --disable-javascript --quiet --print-media-type ';
+		$retVal = 0;
+		$output = array();
+		exec(
+			$command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout",
+			$output,
+			$retVal
+		);
+
+		// remove temporary file
+		unlink($bodyFile);
+		unlink($footerFile);
+
+		// output any errors
+		if ($retVal != 0) {
+			user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR);
+		}
+
+		// serve the generated file
+		return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf');
+	}
+
+	/**
+	 * Site search form
+	 */
+	public function SearchForm()
+	{
+		$searchText = $this->getRequest()->getVar('Search');
+
+		$fields = FieldList::create(
+			TextField::create('Search', false, $searchText)
+		);
+		$actions = FieldList::create(
+			FormAction::create('results', _t('SilverStripe\\CMS\\Search\\SearchForm.GO', 'Go'))
+		);
+
+		$form = SearchForm::create($this, SearchForm::class, $fields, $actions);
+		$form->setFormAction('search/SearchForm');
+
+		return $form;
+	}
+
+	/**
+	 * Get search form with _header suffix
+	 *
+	 * @return SearchForm
+	 */
+	public function HeaderSearchForm()
+	{
+		return $this->SearchForm()->setTemplate('SearchForm_header');
+	}
+
+	/**
+	 * Process and render search results.
+	 *
+	 * @param array $data The raw request data submitted by user
+	 * @param SearchForm $form The form instance that was submitted
+	 * @param HTTPRequest $request Request generated for this action
+	 * @return DBHTMLText
+	 */
+	public function results($data, $form, $request)
+	{
+		// Check parameters for terms, pagination, and if we should follow suggestions
+		$keywords = empty($data['Search']) ? '' : $data['Search'];
+		$start = isset($data['start']) ? $data['start'] : 0;
+		$suggestions = isset($data['suggestions'])
+			? $data['suggestions']
+			: $this->config()->get('search_follow_suggestions');
+
+		$results = CwpSearchEngine::create()
+			->search(
+				$keywords,
+				$this->config()->get('classes_to_search'),
+				Injector::inst()->get(CwpSearchEngine::class . '.search_index'),
+				$this->config()->get('results_per_page'),
+				$start,
+				$suggestions
+			);
+
+		// Customise content with these results
+		$properties = [
+			'MetaTitle' => _t(__CLASS__ . '.MetaTitle', 'Search {keywords}', ['keywords' => $keywords]),
+			'NoSearchResults' => _t(__CLASS__ . '.NoResult', 'Sorry, your search query did not return any results.'),
+			'EmptySearch' => _t(__CLASS__ . '.EmptySearch', 'Search field empty, please enter your search query.'),
+			'PdfLink' => '',
+			'Title' => _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results'),
+		];
+		$this->extend('updateSearchResults', $results, $properties);
+
+		// Customise page
+		$response = $this->customise($properties);
+		if ($results) {
+			$response = $response
+				->customise($results)
+				->customise(array( 'Results' => $results->getResults() ));
+		}
+
+		// Render
+		$templates = $this->getResultsTemplate($request);
+		return $response->renderWith($templates);
+	}
+
+	/**
+	 * Select the template to render search results with
+	 *
+	 * @param HTTPRequest $request
+	 * @return array
+	 */
+	protected function getResultsTemplate($request)
+	{
+		$templates = [Page::class . '_results', Page::class];
+		if ($request->getVar('format') == 'rss') {
+			array_unshift($templates, 'Page_results_rss');
+		}
+		if ($request->getVar('format') == 'atom') {
+			array_unshift($templates, 'Page_results_atom');
+		}
+		return $templates;
+	}
+
+	/**
+	 * Provide current year.
+	 */
+	public function CurrentDatetime()
+	{
+		return DBDatetime::now();
+	}
+
+	public function getRSSLink()
+	{
+	}
 }