From fa348d66660931c1e9f80cb3442f72d6e1d8f713 Mon Sep 17 00:00:00 2001
From: Stig Lindqvist <stig@silverstripe.com>
Date: Tue, 30 Oct 2012 17:56:14 +1300
Subject: [PATCH] MINOR Code refactoring of CMSMain::SearchForm() extracted
 some methods.

---
 code/controllers/CMSMain.php           | 112 +++++++++++++++----------
 code/controllers/CMSSiteTreeFilter.php |  24 ++++++
 2 files changed, 92 insertions(+), 44 deletions(-)

diff --git a/code/controllers/CMSMain.php b/code/controllers/CMSMain.php
index ccafe2fc..c3477a90 100644
--- a/code/controllers/CMSMain.php
+++ b/code/controllers/CMSMain.php
@@ -245,74 +245,98 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
 		return $html;
 	}
 	
+	/**
+	 * Returns a Form for page searching for use in templates.
+	 * 
+	 * Can be modified from a decorator by a 'updateSearchForm' method
+	 *
+	 * @return Form
+	 */
 	public function SearchForm() {
-		// get all page types in a dropdown-compatible format
-		$pageTypeClasses = SiteTree::page_type_classes(); 
-		$pageTypes = array();
-		foreach ($pageTypeClasses as $pageTypeClass) {
-			$pageTypes[$pageTypeClass] = _t($pageTypeClass.'.SINGULARNAME', $pageTypeClass);
-		}
-		asort($pageTypes);
-		
-		// get all filter instances
-		$filters = ClassInfo::subclassesFor('CMSSiteTreeFilter');
-		$filterMap = array();
-		// remove base class
-		array_shift($filters);
-		// add filters to map
-		foreach($filters as $filter) {
-			$filterMap[$filter] = call_user_func(array($filter, 'title'));
-		}
-		// ensure that 'all pages' filter is on top position
-		uasort($filterMap, 
-			create_function('$a,$b', 'return ($a == "CMSSiteTreeFilter_Search") ? 1 : -1;')
+		// Create the fields
+		$content = new TextField('q[Term]', _t('CMSSearch.FILTERLABELTEXT', 'Content'));
+		$dateHeader = new HeaderField('q[Date]', _t('CMSSearch.FILTERDATEHEADING', 'Date'), 4);
+		$dateFrom = new DateField(
+			'q[LastEditedFrom]', 
+			_t('CMSSearch.FILTERDATEFROM', 'From')
 		);
+		$dateFrom->setConfig('showcalendar', true);
+		$dateTo = new DateField(
+			'q[LastEditedTo]',
+			_t('CMSSearch.FILTERDATETO', 'To')
+		);
+		$dateTo->setConfig('showcalendar', true);
+		$pageFilter = new DropdownField(
+			'q[FilterClass]', 
+			_t('CMSMain.PAGES', 'Pages'), 
+			CMSSiteTreeFilter::get_all_filters()
+		);
+		$pageClasses = new DropdownField(
+			'q[ClassName]', 
+			_t('CMSMain.PAGETYPEOPT', 'Page Type', 'Dropdown for limiting search to a page type'), 
+			$this->getPageTypes()
+		);
+		$pageClasses->setEmptyString(_t('CMSMain.PAGETYPEANYOPT','Any'));
 		
-		$fields = new FieldList(
-			new TextField('q[Term]', _t('CMSSearch.FILTERLABELTEXT', 'Content')),
-			$dateGroup = new FieldGroup(
-				new HeaderField('q[Date]', _t('CMSSearch.FILTERDATEHEADING', 'Date'), 4),
-				$dateFrom = new DateField('q[LastEditedFrom]', _t('CMSSearch.FILTERDATEFROM', 'From')),
-				$dateTo = new DateField('q[LastEditedTo]', _t('CMSSearch.FILTERDATETO', 'To'))
-			),
-			new DropdownField(
-				'q[FilterClass]',
-				_t('CMSMain.PAGES', 'Pages'),
-				$filterMap
-			),
-			$classDropdown = new DropdownField(
-				'q[ClassName]',
-				_t('CMSMain.PAGETYPEOPT','Page Type', 'Dropdown for limiting search to a page type'),
-				$pageTypes
-			)
-			// new TextField('MetaTags', _t('CMSMain.SearchMetaTags', 'Meta tags'))
+		// Group the Datefields
+		$dateGroup = new FieldGroup(
+			$dateHeader,
+			$dateFrom,
+			$dateTo
 		);
 		$dateGroup->setFieldHolderTemplate('FieldGroup_DefaultFieldHolder')->addExtraClass('stacked');
-		$dateFrom->setConfig('showcalendar', true);
-		$dateTo->setConfig('showcalendar', true);
-		$classDropdown->setEmptyString(_t('CMSMain.PAGETYPEANYOPT','Any'));
-
+		
+		// Create the Field list
+		$fields = new FieldList(
+			$content,
+			$dateGroup,
+			$pageFilter,
+			$pageClasses
+		);
+		
+		// Create the Search and Reset action
 		$actions = new FieldList(
 			FormAction::create('doSearch',  _t('CMSMain_left.ss.APPLY FILTER', 'Apply Filter'))
 			->addExtraClass('ss-ui-action-constructive'),
 			Object::create('ResetFormAction', 'clear', _t('CMSMain_left.ss.RESET', 'Reset'))
 		);
 
-		// Use <button> to allow full jQuery UI styling
-		foreach($actions->dataFields() as $action) $action->setUseButtonTag(true);
+		// Use <button> to allow full jQuery UI styling on the all of the Actions
+		foreach($actions->dataFields() as $action) {
+			$action->setUseButtonTag(true);
+		}
 		
+		// Create the form
 		$form = Form::create($this, 'SearchForm', $fields, $actions)
 			->addExtraClass('cms-search-form')
 			->setFormMethod('GET')
 			->setFormAction($this->Link())
 			->disableSecurityToken()
 			->unsetValidator();
+		
+		// Load the form with previously sent search data
 		$form->loadDataFrom($this->request->getVars());
 
+		// Allow decorators to modify the form
 		$this->extend('updateSearchForm', $form);
+		
 		return $form;
 	}
 	
+	/**
+	 * Returns a sorted array suitable for a dropdown with pagetypes and their translated name
+	 * 
+	 * @return array
+	 */
+	protected function getPageTypes() {
+		$pageTypes = array();
+		foreach(SiteTree::page_type_classes() as $pageTypeClass) {
+			$pageTypes[$pageTypeClass] = _t($pageTypeClass.'.SINGULARNAME', $pageTypeClass);
+		}
+		asort($pageTypes);
+		return $pageTypes;
+	}
+	
 	public function doSearch($data, $form) {
 		return $this->getsubtree($this->request);
 	}
diff --git a/code/controllers/CMSSiteTreeFilter.php b/code/controllers/CMSSiteTreeFilter.php
index eeab5657..e1a3f85e 100644
--- a/code/controllers/CMSSiteTreeFilter.php
+++ b/code/controllers/CMSSiteTreeFilter.php
@@ -35,6 +35,30 @@ abstract class CMSSiteTreeFilter extends Object {
 	 * @var String 
 	 */
 	protected $childrenMethod = null;
+	
+	/**
+	 * Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.
+	 * 
+	 * @return array
+	 */
+	public static function get_all_filters() {
+		// get all filter instances
+		$filters = ClassInfo::subclassesFor('CMSSiteTreeFilter');
+		// remove abstract CMSSiteTreeFilter class
+		array_shift($filters);
+		// add filters to map
+		$filterMap = array();
+		
+		foreach($filters as $filter) {
+			$filterMap[$filter] = call_user_func(array($filter, 'title'));
+		}
+		// ensure that 'all pages' filter is on top position
+		uasort($filterMap, 
+			create_function('$a,$b', 'return ($a == "CMSSiteTreeFilter_Search") ? 1 : -1;')
+		);
+		
+		return $filterMap;
+	}
 		
 	public function __construct($params = null) {
 		if($params) $this->params = $params;