silverstripe / cwp

src/Search/CwpSearchEngine.php

Indentation +134 added lines, -134 removed lines

@@ -16,138 +16,138 @@
  */
 class CwpSearchEngine
 {
-    use Configurable;
-    use Extensible;
-    use Injectable;
-
-    /**
-     * Default search options
-     *
-     * @var array
-     * @config
-     */
-    private static $search_options = [
-        'hl' => 'true',
-    ];
-
-    /**
-     * Additional search options to send to search when spellcheck
-     * is included
-     *
-     * @var array
-     * @config
-     */
-    private static $spellcheck_options = [
-        'spellcheck' => 'true',
-        'spellcheck.collate' => 'true',
-        // spellcheck.dictionary can also be configured to use '_spellcheck'
-        // dictionary when indexing fields under the _spellcheckText column
-        'spellcheck.dictionary' => 'default',
-    ];
-
-    /**
-     * Build a SearchQuery for a new search
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @return SearchQuery
-     */
-    protected function getSearchQuery($keywords, $classes)
-    {
-        $query = new SearchQuery();
-        $query->classes = $classes;
-        $query->search($keywords);
-        $query->exclude('SiteTree_ShowInSearch', 0);
-        $query->exclude('File_ShowInSearch', 0);
-
-        // Artificially lower the amount of results to prevent too high resource usage.
-        // on subsequent canView check loop.
-        $query->limit(100);
-        return $query;
-    }
-
-    /**
-     * Get solr search options for this query
-     *
-     * @param bool $spellcheck True if we should include spellcheck support
-     * @return array
-     */
-    protected function getSearchOptions($spellcheck)
-    {
-        $options = $this->config()->search_options;
-        if ($spellcheck) {
-            $options = array_merge($options, $this->config()->spellcheck_options);
-        }
-        return $options;
-    }
-
-    /**
-     * Get results for a search term
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @param SolrIndex $searchIndex
-     * @param int $limit Max number of results for this page
-     * @param int $start Skip this number of records
-     * @param bool $spellcheck True to enable spellcheck
-     * @return CwpSearchResult
-     */
-    protected function getResult($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $spellcheck = false)
-    {
-        // Prepare options
-        $query = $this->getSearchQuery($keywords, $classes);
-        $options = $this->getSearchOptions($spellcheck);
-
-        // Get results
-        $solrResult = $searchIndex->search(
-            $query,
-            $start,
-            $limit,
-            $options
-        );
-
-        return CwpSearchResult::create($keywords, $solrResult);
-    }
-
-    /**
-     * Get a CwpSearchResult for a given criterea
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @param SolrIndex $searchIndex
-     * @param int $limit Max number of results for this page
-     * @param int $start Skip this number of records
-     * @param bool $followSuggestions True to enable suggested searches to be returned immediately
-     * @return CwpSearchResult|null
-     */
-    public function search($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $followSuggestions = false)
-    {
-        if (empty($keywords)) {
-            return null;
-        }
-
-        try {
-            // Begin search
-            $result = $this->getResult($keywords, $classes, $searchIndex, $limit, $start, true);
-
-            // Return results if we don't need to refine this any further
-            if (!$followSuggestions || $result->hasResults() || !$result->getSuggestion()) {
-                return $result;
-            }
-
-            // Perform new search with the suggested terms
-            $suggested = $result->getSuggestion();
-            $newResult = $this->getResult($suggested, $classes, $searchIndex, $limit, $start, false);
-            $newResult->setOriginal($keywords);
-
-            // Compare new results to the original query
-            if ($newResult->hasResults()) {
-                return $newResult;
-            } else {
-                return $result;
-            }
-        } catch (Exception $e) {
-            Injector::inst()->get(LoggerInterface::class)->warning($e);
-        }
-    }
+	use Configurable;
+	use Extensible;
+	use Injectable;
+
+	/**
+	 * Default search options
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $search_options = [
+		'hl' => 'true',
+	];
+
+	/**
+	 * Additional search options to send to search when spellcheck
+	 * is included
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $spellcheck_options = [
+		'spellcheck' => 'true',
+		'spellcheck.collate' => 'true',
+		// spellcheck.dictionary can also be configured to use '_spellcheck'
+		// dictionary when indexing fields under the _spellcheckText column
+		'spellcheck.dictionary' => 'default',
+	];
+
+	/**
+	 * Build a SearchQuery for a new search
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @return SearchQuery
+	 */
+	protected function getSearchQuery($keywords, $classes)
+	{
+		$query = new SearchQuery();
+		$query->classes = $classes;
+		$query->search($keywords);
+		$query->exclude('SiteTree_ShowInSearch', 0);
+		$query->exclude('File_ShowInSearch', 0);
+
+		// Artificially lower the amount of results to prevent too high resource usage.
+		// on subsequent canView check loop.
+		$query->limit(100);
+		return $query;
+	}
+
+	/**
+	 * Get solr search options for this query
+	 *
+	 * @param bool $spellcheck True if we should include spellcheck support
+	 * @return array
+	 */
+	protected function getSearchOptions($spellcheck)
+	{
+		$options = $this->config()->search_options;
+		if ($spellcheck) {
+			$options = array_merge($options, $this->config()->spellcheck_options);
+		}
+		return $options;
+	}
+
+	/**
+	 * Get results for a search term
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @param SolrIndex $searchIndex
+	 * @param int $limit Max number of results for this page
+	 * @param int $start Skip this number of records
+	 * @param bool $spellcheck True to enable spellcheck
+	 * @return CwpSearchResult
+	 */
+	protected function getResult($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $spellcheck = false)
+	{
+		// Prepare options
+		$query = $this->getSearchQuery($keywords, $classes);
+		$options = $this->getSearchOptions($spellcheck);
+
+		// Get results
+		$solrResult = $searchIndex->search(
+			$query,
+			$start,
+			$limit,
+			$options
+		);
+
+		return CwpSearchResult::create($keywords, $solrResult);
+	}
+
+	/**
+	 * Get a CwpSearchResult for a given criterea
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @param SolrIndex $searchIndex
+	 * @param int $limit Max number of results for this page
+	 * @param int $start Skip this number of records
+	 * @param bool $followSuggestions True to enable suggested searches to be returned immediately
+	 * @return CwpSearchResult|null
+	 */
+	public function search($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $followSuggestions = false)
+	{
+		if (empty($keywords)) {
+			return null;
+		}
+
+		try {
+			// Begin search
+			$result = $this->getResult($keywords, $classes, $searchIndex, $limit, $start, true);
+
+			// Return results if we don't need to refine this any further
+			if (!$followSuggestions || $result->hasResults() || !$result->getSuggestion()) {
+				return $result;
+			}
+
+			// Perform new search with the suggested terms
+			$suggested = $result->getSuggestion();
+			$newResult = $this->getResult($suggested, $classes, $searchIndex, $limit, $start, false);
+			$newResult->setOriginal($keywords);
+
+			// Compare new results to the original query
+			if ($newResult->hasResults()) {
+				return $newResult;
+			} else {
+				return $result;
+			}
+		} catch (Exception $e) {
+			Injector::inst()->get(LoggerInterface::class)->warning($e);
+		}
+	}
 }

src/Search/CwpSearchResult.php

Indentation +200 added lines, -200 removed lines

@@ -11,204 +11,204 @@
  */
 class CwpSearchResult extends ViewableData
 {
-    private static $casting = [
-        'Original' => 'Text',
-        'OriginalLink' => 'Text',
-        'Suggestion' => 'Text',
-        'SuggestionLink' => 'Text',
-        'Query' => 'Text',
-        'SearchLink' => 'Text',
-        'RSSLink' => 'Text',
-        'AtomLink' => 'Text',
-    ];
-
-    /**
-     * List of results
-     *
-     * @var PaginatedList
-     */
-    protected $matches;
-
-    /**
-     * Search terms for these results
-     *
-     * @var string
-     */
-    protected $query;
-
-    /**
-     * Suggested search keywords
-     * Used when this search has suggested terms, but following suggestions isn't enabled
-     *
-     * @var string
-     */
-    protected $suggestion;
-
-    /**
-     * Original terms superceded by these result.
-     * Used when a prior search had suggested terms, and follow suggestions is enabled.
-     *
-     * @var PaginatedList
-     */
-    protected $original;
-
-    /**
-     * Create a new CwpSearchResult
-     *
-     * @param string $terms
-     * @param ArrayData $results Result from SolrIndex
-     */
-    public function __construct($terms = '', ArrayData $results = null)
-    {
-        $this->query = $terms;
-        if ($results) {
-            // Clean up the results.
-            $matches = $results->Matches;
-            foreach ($matches as $result) {
-                if (!$result->canView()) {
-                    $matches->remove($result);
-                }
-            }
-
-            $this->matches = $matches;
-            $this->suggestion = $results->SuggestionNice;
-        }
-    }
-
-    /**
-     * Get search results
-     *
-     * @return PaginatedList
-     */
-    public function getResults()
-    {
-        return $this->matches;
-    }
-
-    /**
-     * Check if there are found results
-     *
-     * @return bool
-     */
-    public function hasResults()
-    {
-        return $this->matches && $this->matches->exists();
-    }
-
-    /**
-     * Get search keywords matching these results
-     *
-     * @return string
-     */
-    public function getQuery()
-    {
-        return $this->query;
-    }
-
-    /**
-     * Get suggested search keywords
-     *
-     * @return string
-     */
-    public function getSuggestion()
-    {
-        return $this->suggestion;
-    }
-
-    /**
-     * Get original search keywords superceded by these results
-     *
-     * @return string
-     */
-    public function getOriginal()
-    {
-        return $this->original;
-    }
-
-    /**
-     * Set original keywords
-     *
-     * @param string $original
-     */
-    public function setOriginal($original)
-    {
-        $this->original = $original;
-    }
-
-    /**
-     * Get the link to the suggested search
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getSuggestionLink($format = null)
-    {
-        return $this->getLink($this->suggestion, $format);
-    }
-
-    /**
-     * Gets the link to the given search
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getSearchLink($format = null)
-    {
-        return $this->getLink($this->query, $format);
-    }
-
-    /**
-     * Gets the link to the original search, with suggestions disabled
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getOriginalLink($format = null)
-    {
-        return $this->getLink($this->original, $format) . "&suggestions=0";
-    }
-
-    /**
-     * Get link to these results in RSS format
-     *
-     * @return string
-     */
-    public function getRSSLink()
-    {
-        return $this->getLink($this->query, 'rss');
-    }
-
-    /**
-     * Get link to these results in atom format
-     *
-     * @return string
-     */
-    public function getAtomLink()
-    {
-        return $this->getLink($this->query, 'atom');
-    }
-
-    /**
-     * Get a search link for given terms
-     *
-     * @param string $terms
-     * @return string|null
-     */
-    protected function getLink($terms, $format = null)
-    {
-        if (!$terms) {
-            return null;
-        }
-        $link = 'search/SearchForm?Search='.rawurlencode($terms);
-        if ($format) {
-            $link .= '&format='.rawurlencode($format);
-        }
-        return $link;
-    }
-
-    public function hasField($field)
-    {
-        // Fix customise not detecting custom field getters
-        return array_key_exists($field, $this->config()->casting);
-    }
+	private static $casting = [
+		'Original' => 'Text',
+		'OriginalLink' => 'Text',
+		'Suggestion' => 'Text',
+		'SuggestionLink' => 'Text',
+		'Query' => 'Text',
+		'SearchLink' => 'Text',
+		'RSSLink' => 'Text',
+		'AtomLink' => 'Text',
+	];
+
+	/**
+	 * List of results
+	 *
+	 * @var PaginatedList
+	 */
+	protected $matches;
+
+	/**
+	 * Search terms for these results
+	 *
+	 * @var string
+	 */
+	protected $query;
+
+	/**
+	 * Suggested search keywords
+	 * Used when this search has suggested terms, but following suggestions isn't enabled
+	 *
+	 * @var string
+	 */
+	protected $suggestion;
+
+	/**
+	 * Original terms superceded by these result.
+	 * Used when a prior search had suggested terms, and follow suggestions is enabled.
+	 *
+	 * @var PaginatedList
+	 */
+	protected $original;
+
+	/**
+	 * Create a new CwpSearchResult
+	 *
+	 * @param string $terms
+	 * @param ArrayData $results Result from SolrIndex
+	 */
+	public function __construct($terms = '', ArrayData $results = null)
+	{
+		$this->query = $terms;
+		if ($results) {
+			// Clean up the results.
+			$matches = $results->Matches;
+			foreach ($matches as $result) {
+				if (!$result->canView()) {
+					$matches->remove($result);
+				}
+			}
+
+			$this->matches = $matches;
+			$this->suggestion = $results->SuggestionNice;
+		}
+	}
+
+	/**
+	 * Get search results
+	 *
+	 * @return PaginatedList
+	 */
+	public function getResults()
+	{
+		return $this->matches;
+	}
+
+	/**
+	 * Check if there are found results
+	 *
+	 * @return bool
+	 */
+	public function hasResults()
+	{
+		return $this->matches && $this->matches->exists();
+	}
+
+	/**
+	 * Get search keywords matching these results
+	 *
+	 * @return string
+	 */
+	public function getQuery()
+	{
+		return $this->query;
+	}
+
+	/**
+	 * Get suggested search keywords
+	 *
+	 * @return string
+	 */
+	public function getSuggestion()
+	{
+		return $this->suggestion;
+	}
+
+	/**
+	 * Get original search keywords superceded by these results
+	 *
+	 * @return string
+	 */
+	public function getOriginal()
+	{
+		return $this->original;
+	}
+
+	/**
+	 * Set original keywords
+	 *
+	 * @param string $original
+	 */
+	public function setOriginal($original)
+	{
+		$this->original = $original;
+	}
+
+	/**
+	 * Get the link to the suggested search
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getSuggestionLink($format = null)
+	{
+		return $this->getLink($this->suggestion, $format);
+	}
+
+	/**
+	 * Gets the link to the given search
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getSearchLink($format = null)
+	{
+		return $this->getLink($this->query, $format);
+	}
+
+	/**
+	 * Gets the link to the original search, with suggestions disabled
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getOriginalLink($format = null)
+	{
+		return $this->getLink($this->original, $format) . "&suggestions=0";
+	}
+
+	/**
+	 * Get link to these results in RSS format
+	 *
+	 * @return string
+	 */
+	public function getRSSLink()
+	{
+		return $this->getLink($this->query, 'rss');
+	}
+
+	/**
+	 * Get link to these results in atom format
+	 *
+	 * @return string
+	 */
+	public function getAtomLink()
+	{
+		return $this->getLink($this->query, 'atom');
+	}
+
+	/**
+	 * Get a search link for given terms
+	 *
+	 * @param string $terms
+	 * @return string|null
+	 */
+	protected function getLink($terms, $format = null)
+	{
+		if (!$terms) {
+			return null;
+		}
+		$link = 'search/SearchForm?Search='.rawurlencode($terms);
+		if ($format) {
+			$link .= '&format='.rawurlencode($format);
+		}
+		return $link;
+	}
+
+	public function hasField($field)
+	{
+		// Fix customise not detecting custom field getters
+		return array_key_exists($field, $this->config()->casting);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -199,9 +199,9 @@
         if (!$terms) {
             return null;
         }
-        $link = 'search/SearchForm?Search='.rawurlencode($terms);
+        $link = 'search/SearchForm?Search=' . rawurlencode($terms);
         if ($format) {
-            $link .= '&format='.rawurlencode($format);
+            $link .= '&format=' . rawurlencode($format);
         }
         return $link;
     }

src/Search/CwpSearchPage.php

Indentation +8 added lines, -8 removed lines

@@ -11,14 +11,14 @@
  */
 class CwpSearchPage extends Page
 {
-    private static $hide_ancestor = CwpSearchPage::class;
+	private static $hide_ancestor = CwpSearchPage::class;
 
-    public function canViewStage($stage = Versioned::LIVE, $member = null)
-    {
-        if (Permission::checkMember($member, 'VIEW_DRAFT_CONTENT')) {
-            return true;
-        }
+	public function canViewStage($stage = Versioned::LIVE, $member = null)
+	{
+		if (Permission::checkMember($member, 'VIEW_DRAFT_CONTENT')) {
+			return true;
+		}
 
-        return parent::canViewStage($stage, $member);
-    }
+		return parent::canViewStage($stage, $member);
+	}
 }

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('CwpConfig.SearchSynonyms', 'Search Synonyms'))
-                ->setDescription(_t(
-                    'CwpConfig.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('CwpConfig.SearchSynonyms', 'Search Synonyms'))
+				->setDescription(_t(
+					'CwpConfig.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->error($error['message']);
-            }
-        }
-    }
+		if (is_array($errors) || $errors instanceof Traversable) {
+			foreach ($errors as $error) {
+				$validationResult->error($error['message']);
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
             TextareaField::create('SearchSynonyms', _t('CwpConfig.SearchSynonyms', 'Search Synonyms'))
                 ->setDescription(_t(
                     'CwpConfig.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/Extensions/CwpSiteTreeFileExtension.php

Indentation +46 added lines, -46 removed lines

@@ -11,50 +11,50 @@
 class CwpSiteTreeFileExtension extends DataExtension
 {
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        Requirements::css('cwp/css/fieldDescriptionToggle.css');
-        Requirements::javascript('cwp/javascript/fieldDescriptionToggle.js');
-
-        $fields->insertAfter(
-            ReadonlyField::create(
-                'BackLinkCount',
-                _t('AssetTableField.BACKLINKCOUNT', 'Used on:'),
-                $this->owner->BackLinkTracking()->Count() . ' ' . _t('AssetTableField.PAGES', 'page(s)')
-            )
-            ->addExtraClass('cms-description-toggle')
-            ->setDescription($this->BackLinkHTMLList()),
-            'LastEdited'
-        );
-    }
-
-    /**
-     * Generate an HTML list which provides links to where a file is used.
-     *
-     * @return String
-     */
-    public function BackLinkHTMLList()
-    {
-        $html = '<em>' . _t(
-            'SiteTreeFileExtension.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('SiteTreeFileExtension.EDIT', 'Edit') . '</a>';
-
-            $html .= $listItem . '</li>';
-        }
-
-        return $html .= '</ul>';
-    }
+	public function updateCMSFields(FieldList $fields)
+	{
+		Requirements::css('cwp/css/fieldDescriptionToggle.css');
+		Requirements::javascript('cwp/javascript/fieldDescriptionToggle.js');
+
+		$fields->insertAfter(
+			ReadonlyField::create(
+				'BackLinkCount',
+				_t('AssetTableField.BACKLINKCOUNT', 'Used on:'),
+				$this->owner->BackLinkTracking()->Count() . ' ' . _t('AssetTableField.PAGES', 'page(s)')
+			)
+			->addExtraClass('cms-description-toggle')
+			->setDescription($this->BackLinkHTMLList()),
+			'LastEdited'
+		);
+	}
+
+	/**
+	 * Generate an HTML list which provides links to where a file is used.
+	 *
+	 * @return String
+	 */
+	public function BackLinkHTMLList()
+	{
+		$html = '<em>' . _t(
+			'SiteTreeFileExtension.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('SiteTreeFileExtension.EDIT', 'Edit') . '</a>';
+
+			$html .= $listItem . '</li>';
+		}
+
+		return $html .= '</ul>';
+	}
 }

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
-     *
-     * @var config
-     * @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('CwpSearchBoostExtension.PAGEINFO', 'Page info and SEO'));
-
-        $boostTitle = _t('CwpSiteTreeSearchBoost.SearchBoost', 'Boost Keywords');
-        $boostNote = _t(
-            'CwpSiteTreeSearchBoost.SearchBoostNote',
-            '(Only applies to the search results on this site e.g. not on Google search)'
-        );
-        $boostDescription = _t(
-            'CwpSiteTreeSearchBoost.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($boostField, 'MetaDescription');
-    }
+	/**
+	 * Quality to boost the 'SearchBoost' field by.
+	 * Default boost is 2x
+	 *
+	 * @var config
+	 * @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('CwpSearchBoostExtension.PAGEINFO', 'Page info and SEO'));
+
+		$boostTitle = _t('CwpSiteTreeSearchBoost.SearchBoost', 'Boost Keywords');
+		$boostNote = _t(
+			'CwpSiteTreeSearchBoost.SearchBoostNote',
+			'(Only applies to the search results on this site e.g. not on Google search)'
+		);
+		$boostDescription = _t(
+			'CwpSiteTreeSearchBoost.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($boostField, 'MetaDescription');
+	}
 }

src/Extensions/CwpWorkflowDefinitionExtension.php

Indentation +29 added lines, -29 removed lines

@@ -12,37 +12,37 @@
  */
 class CwpWorkflowDefinitionExtension extends DataExtension
 {
-    /**
-     * Create the default 'Two-step Workflow' when this extension is loaded
-     *
-     * @config
-     * @var boolean
-     */
-    private static $create_default_workflow = true;
+	/**
+	 * Create the default 'Two-step Workflow' when this extension is loaded
+	 *
+	 * @config
+	 * @var boolean
+	 */
+	private static $create_default_workflow = true;
 
-    public function requireDefaultRecords()
-    {
-        if (Config::inst()->get(CwpWorkflowDefinitionExtension::class, 'create_default_workflow')) {
-            // Only proceed if a definition using this template has not been created yet
-            $definition = WorkflowDefinition::get()->filter("Template", "Review and Approve")->First();
-            if ($definition && $definition->exists()) {
-                return;
-            }
+	public function requireDefaultRecords()
+	{
+		if (Config::inst()->get(CwpWorkflowDefinitionExtension::class, 'create_default_workflow')) {
+			// Only proceed if a definition using this template has not been created yet
+			$definition = WorkflowDefinition::get()->filter("Template", "Review and Approve")->First();
+			if ($definition && $definition->exists()) {
+				return;
+			}
 
-            //generate from the template, which happens after we write the definition
-            $definition = WorkflowDefinition::create();
-            $definition->Template = "Review and Approve";
-            $definition->write();
+			//generate from the template, which happens after we write the definition
+			$definition = WorkflowDefinition::create();
+			$definition->Template = "Review and Approve";
+			$definition->write();
 
-            //change the title, description, and reminder days
-            $definition->update(array(
-                'Title' => "Two-step Workflow",
-                'Description' => "Content Authors can write content and Content Publishers can approve/reject.",
-                'RemindDays' => 3,
-            ));
-            $definition->write();
+			//change the title, description, and reminder days
+			$definition->update(array(
+				'Title' => "Two-step Workflow",
+				'Description' => "Content Authors can write content and Content Publishers can approve/reject.",
+				'RemindDays' => 3,
+			));
+			$definition->write();
 
-            DB::alteration_message("Added default workflow definition to WorkflowDefinition table", "created");
-        }
-    }
+			DB::alteration_message("Added default workflow definition to WorkflowDefinition table", "created");
+		}
+	}
 }

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('CwpConfig.GaField', 'Google Analytics account')
-            )
-        );
+	public function updateCMSFields(FieldList $fields)
+	{
+		$fields->addFieldToTab(
+			'Root.Main',
+			$gaCode = TextField::create(
+				'GACode',
+				_t('CwpConfig.GaField', 'Google Analytics account')
+			)
+		);
 
-        $gaCode->setRightTitle(
-            _t(
-                'CwpConfig.GaFieldDesc',
-                'Account number to be used all across the site (in the format <strong>UA-XXXXX-X</strong>)'
-            )
-        );
+		$gaCode->setRightTitle(
+			_t(
+				'CwpConfig.GaFieldDesc',
+				'Account number to be used all across the site (in the format <strong>UA-XXXXX-X</strong>)'
+			)
+		);
 
-        $fields->findOrMakeTab('Root.SocialMedia', _t('CustomSiteConfig.SocialMediaTab', 'Social Media'));
+		$fields->findOrMakeTab('Root.SocialMedia', _t('CustomSiteConfig.SocialMediaTab', 'Social Media'));
 
-        $fields->addFieldToTab(
-            'Root.SocialMedia',
-            $facebookURL = TextField::create(
-                'FacebookURL',
-                _t('CwpConfig.FbField', 'Facebook UID or username')
-            )
-        );
-        $facebookURL->setRightTitle(
-            _t(
-                'CwpConfig.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('CwpConfig.FbField', 'Facebook UID or username')
+			)
+		);
+		$facebookURL->setRightTitle(
+			_t(
+				'CwpConfig.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('CwpConfig.TwitterField', 'Twitter username')
-            )
-        );
-        $twitterUsername->setRightTitle(
-            _t('CwpConfig.TwitterFieldDesc', 'Twitter username (eg, http://twitter.com/<strong>username</strong>)')
-        );
-    }
+		$fields->addFieldToTab(
+			'Root.SocialMedia',
+			$twitterUsername = TextField::create(
+				'TwitterUsername',
+				_t('CwpConfig.TwitterField', 'Twitter username')
+			)
+		);
+		$twitterUsername->setRightTitle(
+			_t('CwpConfig.TwitterFieldDesc', 'Twitter username (eg, http://twitter.com/<strong>username</strong>)')
+		);
+	}
 }

tests/PageTypes/BasePageTest.php

Indentation +38 added lines, -38 removed lines

@@ -8,42 +8,42 @@
 
 class BasePageTest extends SapphireTest
 {
-    protected static $fixture_file = 'BasePageTest.yml';
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        Config::modify()->set(BasePage::class, 'pdf_export', true);
-        Config::modify()->set(BasePage::class, 'generated_pdf_path', 'assets/_generated_pdfs');
-    }
-
-    public function testPdfFilename()
-    {
-        $page = $this->objFromFixture(BasePage::class, 'test-page-one');
-        $this->assertContains(
-            'assets/_generated_pdfs/test-page-one-1.pdf',
-            $page->getPdfFilename(),
-            'Generated filename for PDF'
-        );
-    }
-
-    public function testPdfLink()
-    {
-        $page = $this->objFromFixture(BasePage::class, 'test-page-one');
-        $this->assertContains('test-page-one/downloadpdf', $page->PdfLink(), 'Link to download PDF');
-    }
-
-    public function testHomePagePdfLink()
-    {
-        $page = $this->objFromFixture(BasePage::class, 'home-page');
-        $this->assertContains('home/downloadpdf', $page->PdfLink(), 'Link to download PDF');
-    }
-
-    public function testPdfLinkDisabled()
-    {
-        Config::modify()->set(BasePage::class, 'pdf_export', false);
-        $page = $this->objFromFixture(BasePage::class, 'test-page-one');
-        $this->assertFalse($page->PdfLink(), 'No PDF link as the functionality is disabled');
-    }
+	protected static $fixture_file = 'BasePageTest.yml';
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		Config::modify()->set(BasePage::class, 'pdf_export', true);
+		Config::modify()->set(BasePage::class, 'generated_pdf_path', 'assets/_generated_pdfs');
+	}
+
+	public function testPdfFilename()
+	{
+		$page = $this->objFromFixture(BasePage::class, 'test-page-one');
+		$this->assertContains(
+			'assets/_generated_pdfs/test-page-one-1.pdf',
+			$page->getPdfFilename(),
+			'Generated filename for PDF'
+		);
+	}
+
+	public function testPdfLink()
+	{
+		$page = $this->objFromFixture(BasePage::class, 'test-page-one');
+		$this->assertContains('test-page-one/downloadpdf', $page->PdfLink(), 'Link to download PDF');
+	}
+
+	public function testHomePagePdfLink()
+	{
+		$page = $this->objFromFixture(BasePage::class, 'home-page');
+		$this->assertContains('home/downloadpdf', $page->PdfLink(), 'Link to download PDF');
+	}
+
+	public function testPdfLinkDisabled()
+	{
+		Config::modify()->set(BasePage::class, 'pdf_export', false);
+		$page = $this->objFromFixture(BasePage::class, 'test-page-one');
+		$this->assertFalse($page->PdfLink(), 'No PDF link as the functionality is disabled');
+	}
 }