silverstripe / cwp

src/Tasks/CleanupGeneratedPdfBuildTask.php

Indentation +16 added lines, -16 removed lines

@@ -7,24 +7,24 @@
 
 class CleanupGeneratedPdfBuildTask extends BuildTask
 {
-    protected $title = 'Cleanup generated PDFs';
+	protected $title = 'Cleanup generated PDFs';
 
-    protected $description = 'Removes generated PDFs on the site, forcing a regeneration of all exports to PDF '
-        . 'when users go to download them. This is most useful when templates have been changed so users should '
-        . 'receive a new copy';
+	protected $description = 'Removes generated PDFs on the site, forcing a regeneration of all exports to PDF '
+		. 'when users go to download them. This is most useful when templates have been changed so users should '
+		. 'receive a new copy';
 
-    public function run($request)
-    {
-        $path = sprintf('%s/%s', BASE_PATH, BasePage::config()->generated_pdf_path);
-        if (!file_exists($path)) {
-            return false;
-        }
+	public function run($request)
+	{
+		$path = sprintf('%s/%s', BASE_PATH, BasePage::config()->generated_pdf_path);
+		if (!file_exists($path)) {
+			return false;
+		}
 
-        exec(sprintf('if [ "$(ls -A %s 2> /dev/null)" != "" ]; then rm %s/*; fi', $path, $path), $output, $return_val);
+		exec(sprintf('if [ "$(ls -A %s 2> /dev/null)" != "" ]; then rm %s/*; fi', $path, $path), $output, $return_val);
 
-        // output any errors
-        if ($return_val != 0) {
-            user_error(sprintf('%s failed: ', get_class($this)) . implode("\n", $output), E_USER_ERROR);
-        }
-    }
+		// output any errors
+		if ($return_val != 0) {
+			user_error(sprintf('%s failed: ', get_class($this)) . implode("\n", $output), E_USER_ERROR);
+		}
+	}
 }

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/TaxonomyTermExtension.php

Indentation +4 added lines, -4 removed lines

@@ -8,9 +8,9 @@
 class TaxonomyTermExtension extends DataExtension
 {
 
-    private static $api_access = true;
+	private static $api_access = true;
 
-    private static $belongs_many_many = array(
-        'Pages' => BasePage::class
-    );
+	private static $belongs_many_many = array(
+		'Pages' => BasePage::class
+	);
 }

src/Extensions/SynonymValidator.php

Spacing +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
         );
 
         // strip comments (lines beginning with "#")
-        $lines = array_filter($lines, function ($line) {
+        $lines = array_filter($lines, function($line) {
             $line = trim($line);
 
             return !empty($line) && $line[0] !== '#';

Indentation +150 added lines, -150 removed lines

@@ -6,154 +6,154 @@
 
 class SynonymValidator extends Validator
 {
-    /**
-     * @var array
-     */
-    protected $fieldNames;
-
-    /**
-     * @inheritdoc
-     *
-     * @param array $fieldNames
-     */
-    public function __construct(array $fieldNames)
-    {
-        $this->fieldNames = $fieldNames;
-
-        parent::__construct();
-    }
-
-    /**
-     * @inheritdoc
-     *
-     * @param array $data
-     *
-     * @return mixed
-     */
-    public function php($data)
-    {
-        foreach ($this->fieldNames as $fieldName) {
-            if (empty($data[$fieldName])) {
-                return;
-            }
-
-            $this->validateField($fieldName, $data[$fieldName]);
-        }
-    }
-
-    /**
-     * Validate field values, raising errors if the values are invalid.
-     *
-     * @param string $fieldName
-     * @param mixed $value
-     */
-    protected function validateField($fieldName, $value)
-    {
-        if (!$this->validateValue($value)) {
-            $this->validationError(
-                $fieldName,
-                _t(
-                    __CLASS__ . '.InvalidValue',
-                    'Synonyms cannot contain words separated by spaces'
-                )
-            );
-        }
-    }
-
-    /**
-     * Check field values to see that they doesn't contain spaces between words.
-     *
-     * @param mixed $value
-     *
-     * @return bool
-     */
-    protected function validateValue($value)
-    {
-        // strip empty lines
-        $lines = array_filter(
-            explode("\n", $value)
-        );
-
-        // strip comments (lines beginning with "#")
-        $lines = array_filter($lines, function ($line) {
-            $line = trim($line);
-
-            return !empty($line) && $line[0] !== '#';
-        });
-
-        // validate each line
-        foreach ($lines as $line) {
-            if (!$this->validateLine($line)) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Check each line to see that it doesn't contain spaces between words.
-     *
-     * @param string $line
-     *
-     * @return bool
-     */
-    protected function validateLine($line)
-    {
-        $line = trim($line);
-
-        $parts = explode(',', $line);
-        $parts = array_filter($parts);
-
-        foreach ($parts as $part) {
-            if (!$this->validatePart($part)) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Check each part of the line doesn't contain spaces between words.
-     *
-     * @param string $part
-     *
-     * @return bool
-     */
-    protected function validatePart($part)
-    {
-        if (strpos($part, '=>') !== false) {
-            $subs = explode('=>', $part);
-            $subs = array_filter($subs);
-
-            foreach ($subs as $sub) {
-                if (!$this->validateNoSpaces($sub)) {
-                    return false;
-                }
-            }
-
-            return true;
-        }
-
-        return $this->validateNoSpaces($part);
-    }
-
-    /**
-     * @param string $value
-     *
-     * @return bool
-     */
-    protected function validateNoSpaces($value)
-    {
-        // allow spaces at the beginning and end of the value
-        $value = trim($value);
-
-        // does the value contain 1 or more whitespace characters?
-        if (preg_match('/\s+/', $value)) {
-            return false;
-        }
-
-        return true;
-    }
+	/**
+	 * @var array
+	 */
+	protected $fieldNames;
+
+	/**
+	 * @inheritdoc
+	 *
+	 * @param array $fieldNames
+	 */
+	public function __construct(array $fieldNames)
+	{
+		$this->fieldNames = $fieldNames;
+
+		parent::__construct();
+	}
+
+	/**
+	 * @inheritdoc
+	 *
+	 * @param array $data
+	 *
+	 * @return mixed
+	 */
+	public function php($data)
+	{
+		foreach ($this->fieldNames as $fieldName) {
+			if (empty($data[$fieldName])) {
+				return;
+			}
+
+			$this->validateField($fieldName, $data[$fieldName]);
+		}
+	}
+
+	/**
+	 * Validate field values, raising errors if the values are invalid.
+	 *
+	 * @param string $fieldName
+	 * @param mixed $value
+	 */
+	protected function validateField($fieldName, $value)
+	{
+		if (!$this->validateValue($value)) {
+			$this->validationError(
+				$fieldName,
+				_t(
+					__CLASS__ . '.InvalidValue',
+					'Synonyms cannot contain words separated by spaces'
+				)
+			);
+		}
+	}
+
+	/**
+	 * Check field values to see that they doesn't contain spaces between words.
+	 *
+	 * @param mixed $value
+	 *
+	 * @return bool
+	 */
+	protected function validateValue($value)
+	{
+		// strip empty lines
+		$lines = array_filter(
+			explode("\n", $value)
+		);
+
+		// strip comments (lines beginning with "#")
+		$lines = array_filter($lines, function ($line) {
+			$line = trim($line);
+
+			return !empty($line) && $line[0] !== '#';
+		});
+
+		// validate each line
+		foreach ($lines as $line) {
+			if (!$this->validateLine($line)) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Check each line to see that it doesn't contain spaces between words.
+	 *
+	 * @param string $line
+	 *
+	 * @return bool
+	 */
+	protected function validateLine($line)
+	{
+		$line = trim($line);
+
+		$parts = explode(',', $line);
+		$parts = array_filter($parts);
+
+		foreach ($parts as $part) {
+			if (!$this->validatePart($part)) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Check each part of the line doesn't contain spaces between words.
+	 *
+	 * @param string $part
+	 *
+	 * @return bool
+	 */
+	protected function validatePart($part)
+	{
+		if (strpos($part, '=>') !== false) {
+			$subs = explode('=>', $part);
+			$subs = array_filter($subs);
+
+			foreach ($subs as $sub) {
+				if (!$this->validateNoSpaces($sub)) {
+					return false;
+				}
+			}
+
+			return true;
+		}
+
+		return $this->validateNoSpaces($part);
+	}
+
+	/**
+	 * @param string $value
+	 *
+	 * @return bool
+	 */
+	protected function validateNoSpaces($value)
+	{
+		// allow spaces at the beginning and end of the value
+		$value = trim($value);
+
+		// does the value contain 1 or more whitespace characters?
+		if (preg_match('/\s+/', $value)) {
+			return false;
+		}
+
+		return true;
+	}
 }

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");
+		}
+	}
 }

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');
+	}
 }

tests/PageTypes/EventHolderTest.php

Indentation +68 added lines, -68 removed lines

@@ -8,94 +8,94 @@
 
 class EventHolderTest extends SapphireTest
 {
-    protected static $fixture_file = 'EventHolderTest.yml';
+	protected static $fixture_file = 'EventHolderTest.yml';
 
-    public function testEventTags()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testEventTags()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $tags = $holder->UpdateTags();
-        $this->assertNotNull($tags->find('Name', 'Future'), 'Finds present terms.');
-        $this->assertNull($tags->find('Name', 'Event types', 'Does not find top level taxonomy.'));
-        $this->assertNull($tags->find('Name', 'Carrot'), 'Does not find terms that are not applied.');
-    }
+		$tags = $holder->UpdateTags();
+		$this->assertNotNull($tags->find('Name', 'Future'), 'Finds present terms.');
+		$this->assertNull($tags->find('Name', 'Event types', 'Does not find top level taxonomy.'));
+		$this->assertNull($tags->find('Name', 'Carrot'), 'Does not find terms that are not applied.');
+	}
 
-    public function testEventWithParentFilter()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder2');
+	public function testEventWithParentFilter()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder2');
 
-        $items = $holder->Updates();
+		$items = $holder->Updates();
 
-        $this->assertNotNull($items->find('URLSegment', 'other-holder'), 'Event from the holder is shown.');
-        $this->assertNull($items->find('URLSegment', 'future-event-1'), 'Events from other holders are not shown.');
-    }
+		$this->assertNotNull($items->find('URLSegment', 'other-holder'), 'Event from the holder is shown.');
+		$this->assertNull($items->find('URLSegment', 'future-event-1'), 'Events from other holders are not shown.');
+	}
 
-    public function testEventsWithTagFilter()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testEventsWithTagFilter()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        //Get the "Future" tag.
-        $tag = $this->objFromFixture(TaxonomyTerm::class, 'TaxonomyTerm1');
+		//Get the "Future" tag.
+		$tag = $this->objFromFixture(TaxonomyTerm::class, 'TaxonomyTerm1');
 
-        $items = $holder->Updates($tag->ID);
+		$items = $holder->Updates($tag->ID);
 
-        $this->assertNotNull($items->find('URLSegment', 'future-event-1'), 'Finds the tagged page.');
-        $this->assertNull($items->find('URLSegment', 'past-event-1'), 'Does not find pages that are not tagged.');
-    }
+		$this->assertNotNull($items->find('URLSegment', 'future-event-1'), 'Finds the tagged page.');
+		$this->assertNull($items->find('URLSegment', 'past-event-1'), 'Does not find pages that are not tagged.');
+	}
 
-    public function testEventsWithMonthFilter()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testEventsWithMonthFilter()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $items = $holder->Updates(null, null, null, 2013, 7);
+		$items = $holder->Updates(null, null, null, 2013, 7);
 
-        $this->assertNotNull($items->find('URLSegment', 'future-event-1'), 'Finds the event in 2013-07.');
-        $this->assertNull($items->find('URLSegment', 'past-event-1'), 'Does not find events at other dates.');
-    }
+		$this->assertNotNull($items->find('URLSegment', 'future-event-1'), 'Finds the event in 2013-07.');
+		$this->assertNull($items->find('URLSegment', 'past-event-1'), 'Does not find events at other dates.');
+	}
 
-    public function testEventsWithDateRangeFilter()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testEventsWithDateRangeFilter()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $items = $holder->Updates(null, '2013-01-19', null);
-        $this->assertNotNull($items->find('URLSegment', 'past-event-2'), 'Finds the event at the date');
-        $this->assertNull($items->find('URLSegment', 'future-event-1'), 'Does not find the event at another date');
+		$items = $holder->Updates(null, '2013-01-19', null);
+		$this->assertNotNull($items->find('URLSegment', 'past-event-2'), 'Finds the event at the date');
+		$this->assertNull($items->find('URLSegment', 'future-event-1'), 'Does not find the event at another date');
 
-        $items = $holder->Updates(null, '2013-01-01', '2013-01-19');
-        $this->assertNotNull($items->find('URLSegment', 'past-event-2'), 'Finds events in the date range');
-        $this->assertNull($items->find('URLSegment', 'future-event-1'), 'Does not find event out of range');
-    }
+		$items = $holder->Updates(null, '2013-01-01', '2013-01-19');
+		$this->assertNotNull($items->find('URLSegment', 'past-event-2'), 'Finds events in the date range');
+		$this->assertNull($items->find('URLSegment', 'future-event-1'), 'Does not find event out of range');
+	}
 
-    public function testExtractMonths()
-    {
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testExtractMonths()
+	{
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $months = EventHolder::ExtractMonths(
-            $holder->Updates(),
-            'http://mybase.org/?tag=12&start=10&from=2010-10-10&to=2010-10-11', // Used for link generation
-            2013, // Currently selected
-            1 // Currently selected
-        );
+		$months = EventHolder::ExtractMonths(
+			$holder->Updates(),
+			'http://mybase.org/?tag=12&start=10&from=2010-10-10&to=2010-10-11', // Used for link generation
+			2013, // Currently selected
+			1 // Currently selected
+		);
 
-        // Check which years are generated.
-        $this->assertNotNull($months->find('YearName', 2013), 'Generates existing year');
-        $this->assertNull($months->find('YearName', 1990), 'Does not generate non-present year');
+		// Check which years are generated.
+		$this->assertNotNull($months->find('YearName', 2013), 'Generates existing year');
+		$this->assertNull($months->find('YearName', 1990), 'Does not generate non-present year');
 
-        $year = $months->find('YearName', 2013);
+		$year = $months->find('YearName', 2013);
 
-        // Check which months come up in 2013
-        $this->assertNotNull($year['Months']->find('MonthNumber', 7), 'Generates existing month');
-        $this->assertNull($year['Months']->find('MonthNumber', 12), 'Does not generate non-present month');
+		// Check which months come up in 2013
+		$this->assertNotNull($year['Months']->find('MonthNumber', 7), 'Generates existing month');
+		$this->assertNull($year['Months']->find('MonthNumber', 12), 'Does not generate non-present month');
 
-        $month = $year['Months']->find('MonthNumber', 7);
-        $this->assertEquals(
-            $month['MonthLink'],
-            'http://mybase.org/?tag=12&from=2010-10-10&to=2010-10-11&month=7&year=2013',
-            'Selection link is built properly - start is removed, and tag, from and to retained.'
-        );
+		$month = $year['Months']->find('MonthNumber', 7);
+		$this->assertEquals(
+			$month['MonthLink'],
+			'http://mybase.org/?tag=12&from=2010-10-10&to=2010-10-11&month=7&year=2013',
+			'Selection link is built properly - start is removed, and tag, from and to retained.'
+		);
 
-        // Check if these months are marked properly.
-        $month = $year['Months']->find('MonthNumber', 1);
-        $this->assertEquals($month['Active'], true, 'Correctly marks active link');
-    }
+		// Check if these months are marked properly.
+		$month = $year['Months']->find('MonthNumber', 1);
+		$this->assertEquals($month['Active'], true, 'Correctly marks active link');
+	}
 }