silverstripe / silverstripe-tagfield

code/TagField.php

Doc Comments +1 added lines

@@ -235,6 +235,7 @@
 
     /**
      * {@inheritdoc}
+     * @param string[] $value
      */
     public function setValue($value, $source = null)
     {

Indentation +397 added lines, -397 removed lines

@@ -8,401 +8,401 @@
  */
 class TagField extends DropdownField
 {
-    /**
-     * @var array
-     */
-    public static $allowed_actions = array(
-        'suggest',
-    );
-
-    /**
-     * @var bool
-     */
-    protected $shouldLazyLoad = false;
-
-    /**
-     * @var int
-     */
-    protected $lazyLoadItemLimit = 10;
-
-    /**
-     * @var bool
-     */
-    protected $canCreate = true;
-
-    /**
-     * @var string
-     */
-    protected $titleField = 'Title';
-
-    /**
-     * @var bool
-     */
-    protected $isMultiple = true;
-
-    /**
-     * @param string $name
-     * @param string $title
-     * @param null|DataList $source
-     * @param null|DataList $value
-     */
-    public function __construct($name, $title = '', $source = null, $value = null)
-    {
-        parent::__construct($name, $title, $source, $value);
-    }
-
-    /**
-     * @return bool
-     */
-    public function getShouldLazyLoad()
-    {
-        return $this->shouldLazyLoad;
-    }
-
-    /**
-     * @param bool $shouldLazyLoad
-     *
-     * @return static
-     */
-    public function setShouldLazyLoad($shouldLazyLoad)
-    {
-        $this->shouldLazyLoad = $shouldLazyLoad;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getLazyLoadItemLimit()
-    {
-        return $this->lazyLoadItemLimit;
-    }
-
-    /**
-     * @param int $lazyLoadItemLimit
-     *
-     * @return static
-     */
-    public function setLazyLoadItemLimit($lazyLoadItemLimit)
-    {
-        $this->lazyLoadItemLimit = $lazyLoadItemLimit;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getIsMultiple()
-    {
-        return $this->isMultiple;
-    }
-
-    /**
-     * @param bool $isMultiple
-     *
-     * @return static
-     */
-    public function setIsMultiple($isMultiple)
-    {
-        $this->isMultiple = $isMultiple;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getCanCreate()
-    {
-        return $this->canCreate;
-    }
-
-    /**
-     * @param bool $canCreate
-     *
-     * @return static
-     */
-    public function setCanCreate($canCreate)
-    {
-        $this->canCreate = $canCreate;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getTitleField()
-    {
-        return $this->titleField;
-    }
-
-    /**
-     * @param string $titleField
-     *
-     * @return $this
-     */
-    public function setTitleField($titleField)
-    {
-        $this->titleField = $titleField;
-
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function Field($properties = array())
-    {
-        Requirements::css(TAG_FIELD_DIR . '/css/select2.min.css');
-        Requirements::css(TAG_FIELD_DIR . '/css/TagField.css');
-
-        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
-        Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
-        Requirements::javascript(TAG_FIELD_DIR . '/js/select2.js');
-        Requirements::javascript(TAG_FIELD_DIR . '/js/TagField.js');
-
-        $this->addExtraClass('ss-tag-field');
-
-        if ($this->getIsMultiple()) {
-            $this->setAttribute('multiple', 'multiple');
-        }
-
-        if ($this->shouldLazyLoad) {
-            $this->setAttribute('data-ss-tag-field-suggest-url', $this->getSuggestURL());
-        } else {
-            $properties = array_merge($properties, array(
-                'Options' => $this->getOptions()
-            ));
-        }
-
-        return $this
-            ->customise($properties)
-            ->renderWith(array("templates/TagField"));
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSuggestURL()
-    {
-        return Controller::join_links($this->Link(), 'suggest');
-    }
-
-    /**
-     * @return ArrayList
-     */
-    protected function getOptions()
-    {
-        $options = ArrayList::create();
-
-        $source = $this->getSource();
-
-        if(!$source) {
-            $source = new ArrayList();
-        }
-
-        $dataClass = $source->dataClass();
-
-        $values = $this->Value();
-
-        if(!$values) {
-            return $options;
-        }
-
-        if(is_array($values)) {
-            $values = DataList::create($dataClass)->filter('Title', $values);
-        }
-
-        $ids = $values->column('Title');
-
-        $titleField = $this->getTitleField();
-
-        foreach($source as $object) {
-            $options->push(
-            ArrayData::create(array(
-                'Title' => $object->$titleField,
-                'Value' => $object->Title,
-                'Selected' => in_array($object->Title, $ids),
-                ))
-            );
-        }
-
-        return $options;
-     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setValue($value, $source = null)
-    {
-        if ($source instanceof DataObject) {
-            $name = $this->getName();
-
-            if ($source->hasMethod($name)) {
-                $value = $source->$name()->column('Title');
-            }
-        } elseif ($value instanceof SS_List) {
-            $value = $value->column('Title');
-        }
-
-        if (!is_array($value)) {
-            return parent::setValue($value);
-        }
-
-        return parent::setValue(array_filter($value));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAttributes()
-    {
-        return array_merge(
-            parent::getAttributes(),
-            array('name' => $this->getName() . '[]')
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        parent::saveInto($record);
-
-        $name = $this->getName();
-
-        $titleField = $this->getTitleField();
-
-        $source = $this->getSource();
-
-        $values = $this->Value();
-
-        $relation = $record->$name();
-
-        $ids = array();
-
-        if(!$values) {
-            $values = array();
-        }
-
-        if(empty($record) || empty($source) || empty($titleField)) {
-            return;
-        }
-
-        if(!$record->hasMethod($name)) {
-            throw new Exception(
-                sprintf("%s does not have a %s method", get_class($record), $name)
-            );
-        }
-
-        foreach ($values as $key => $value) {
-            // Get or create record
-            $record = $this->getOrCreateTag($value);
-            if($record) {
-                $ids[] = $record->ID;
-                $values[$key] = $record->Title;
-            }
-        }
-
-        $relation->setByIDList(array_filter($ids));
-
-     }
-
-    /**
-     * Get or create tag with the given value
-     *
-     * @param string $term
-     * @return DataObject
-     */
-    protected function getOrCreateTag($term)
-    {
-        // Check if existing record can be found
-        $source = $this->getSource();
-        $titleField = $this->getTitleField();
-        $record = $source
-            ->filter($titleField, $term)
-            ->first();
-        if($record) {
-            return $record;
-        }
-
-        // Create new instance if not yet saved
-        if ($this->getCanCreate()) {
-            $dataClass = $source->dataClass();
-            $record = Injector::inst()->create($dataClass);
-            $record->{$titleField} = $term;
-            $record->write();
-            return $record;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Returns a JSON string of tags, for lazy loading.
-     *
-     * @param SS_HTTPRequest $request
-     *
-     * @return SS_HTTPResponse
-     */
-    public function suggest(SS_HTTPRequest $request)
-    {
-        $tags = $this->getTags($request->getVar('term'));
-
-        $response = new SS_HTTPResponse();
-        $response->addHeader('Content-Type', 'application/json');
-        $response->setBody(json_encode(array('items' => $tags)));
-
-        return $response;
-    }
-
-    /**
-     * Returns array of arrays representing tags.
-     *
-     * @param string $term
-     *
-     * @return array
-     */
-    protected function getTags($term)
-    {
-        /**
-         * @var DataList $source
-         */
-        $source = $this->getSource();
-
-        $titleField = $this->getTitleField();
-
-        $query = $source
-            ->filter($titleField . ':PartialMatch:nocase', $term)
-            ->sort($titleField)
-            ->limit($this->getLazyLoadItemLimit());
-
-        // Map into a distinct list
-        $items = array();
-        $titleField = $this->getTitleField();
-        foreach ($query->map('ID', $titleField) as $id => $title) {
-            $items[$title] = array(
-                'id' => $title,
-                'text' => $title
-            );
-        }
-
-        return array_values($items);
-    }
-
-    /**
-     * DropdownField assumes value will be a scalar so we must
-     * override validate. This only applies to Silverstripe 3.2+
-     *
-     * @param Validator $validator
-     * @return bool
-     */
-    public function validate($validator)
-    {
-        return true;
-    }
+	/**
+	 * @var array
+	 */
+	public static $allowed_actions = array(
+		'suggest',
+	);
+
+	/**
+	 * @var bool
+	 */
+	protected $shouldLazyLoad = false;
+
+	/**
+	 * @var int
+	 */
+	protected $lazyLoadItemLimit = 10;
+
+	/**
+	 * @var bool
+	 */
+	protected $canCreate = true;
+
+	/**
+	 * @var string
+	 */
+	protected $titleField = 'Title';
+
+	/**
+	 * @var bool
+	 */
+	protected $isMultiple = true;
+
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param null|DataList $source
+	 * @param null|DataList $value
+	 */
+	public function __construct($name, $title = '', $source = null, $value = null)
+	{
+		parent::__construct($name, $title, $source, $value);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getShouldLazyLoad()
+	{
+		return $this->shouldLazyLoad;
+	}
+
+	/**
+	 * @param bool $shouldLazyLoad
+	 *
+	 * @return static
+	 */
+	public function setShouldLazyLoad($shouldLazyLoad)
+	{
+		$this->shouldLazyLoad = $shouldLazyLoad;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLazyLoadItemLimit()
+	{
+		return $this->lazyLoadItemLimit;
+	}
+
+	/**
+	 * @param int $lazyLoadItemLimit
+	 *
+	 * @return static
+	 */
+	public function setLazyLoadItemLimit($lazyLoadItemLimit)
+	{
+		$this->lazyLoadItemLimit = $lazyLoadItemLimit;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getIsMultiple()
+	{
+		return $this->isMultiple;
+	}
+
+	/**
+	 * @param bool $isMultiple
+	 *
+	 * @return static
+	 */
+	public function setIsMultiple($isMultiple)
+	{
+		$this->isMultiple = $isMultiple;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getCanCreate()
+	{
+		return $this->canCreate;
+	}
+
+	/**
+	 * @param bool $canCreate
+	 *
+	 * @return static
+	 */
+	public function setCanCreate($canCreate)
+	{
+		$this->canCreate = $canCreate;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getTitleField()
+	{
+		return $this->titleField;
+	}
+
+	/**
+	 * @param string $titleField
+	 *
+	 * @return $this
+	 */
+	public function setTitleField($titleField)
+	{
+		$this->titleField = $titleField;
+
+		return $this;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function Field($properties = array())
+	{
+		Requirements::css(TAG_FIELD_DIR . '/css/select2.min.css');
+		Requirements::css(TAG_FIELD_DIR . '/css/TagField.css');
+
+		Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
+		Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
+		Requirements::javascript(TAG_FIELD_DIR . '/js/select2.js');
+		Requirements::javascript(TAG_FIELD_DIR . '/js/TagField.js');
+
+		$this->addExtraClass('ss-tag-field');
+
+		if ($this->getIsMultiple()) {
+			$this->setAttribute('multiple', 'multiple');
+		}
+
+		if ($this->shouldLazyLoad) {
+			$this->setAttribute('data-ss-tag-field-suggest-url', $this->getSuggestURL());
+		} else {
+			$properties = array_merge($properties, array(
+				'Options' => $this->getOptions()
+			));
+		}
+
+		return $this
+			->customise($properties)
+			->renderWith(array("templates/TagField"));
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSuggestURL()
+	{
+		return Controller::join_links($this->Link(), 'suggest');
+	}
+
+	/**
+	 * @return ArrayList
+	 */
+	protected function getOptions()
+	{
+		$options = ArrayList::create();
+
+		$source = $this->getSource();
+
+		if(!$source) {
+			$source = new ArrayList();
+		}
+
+		$dataClass = $source->dataClass();
+
+		$values = $this->Value();
+
+		if(!$values) {
+			return $options;
+		}
+
+		if(is_array($values)) {
+			$values = DataList::create($dataClass)->filter('Title', $values);
+		}
+
+		$ids = $values->column('Title');
+
+		$titleField = $this->getTitleField();
+
+		foreach($source as $object) {
+			$options->push(
+			ArrayData::create(array(
+				'Title' => $object->$titleField,
+				'Value' => $object->Title,
+				'Selected' => in_array($object->Title, $ids),
+				))
+			);
+		}
+
+		return $options;
+	 }
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setValue($value, $source = null)
+	{
+		if ($source instanceof DataObject) {
+			$name = $this->getName();
+
+			if ($source->hasMethod($name)) {
+				$value = $source->$name()->column('Title');
+			}
+		} elseif ($value instanceof SS_List) {
+			$value = $value->column('Title');
+		}
+
+		if (!is_array($value)) {
+			return parent::setValue($value);
+		}
+
+		return parent::setValue(array_filter($value));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getAttributes()
+	{
+		return array_merge(
+			parent::getAttributes(),
+			array('name' => $this->getName() . '[]')
+		);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		parent::saveInto($record);
+
+		$name = $this->getName();
+
+		$titleField = $this->getTitleField();
+
+		$source = $this->getSource();
+
+		$values = $this->Value();
+
+		$relation = $record->$name();
+
+		$ids = array();
+
+		if(!$values) {
+			$values = array();
+		}
+
+		if(empty($record) || empty($source) || empty($titleField)) {
+			return;
+		}
+
+		if(!$record->hasMethod($name)) {
+			throw new Exception(
+				sprintf("%s does not have a %s method", get_class($record), $name)
+			);
+		}
+
+		foreach ($values as $key => $value) {
+			// Get or create record
+			$record = $this->getOrCreateTag($value);
+			if($record) {
+				$ids[] = $record->ID;
+				$values[$key] = $record->Title;
+			}
+		}
+
+		$relation->setByIDList(array_filter($ids));
+
+	 }
+
+	/**
+	 * Get or create tag with the given value
+	 *
+	 * @param string $term
+	 * @return DataObject
+	 */
+	protected function getOrCreateTag($term)
+	{
+		// Check if existing record can be found
+		$source = $this->getSource();
+		$titleField = $this->getTitleField();
+		$record = $source
+			->filter($titleField, $term)
+			->first();
+		if($record) {
+			return $record;
+		}
+
+		// Create new instance if not yet saved
+		if ($this->getCanCreate()) {
+			$dataClass = $source->dataClass();
+			$record = Injector::inst()->create($dataClass);
+			$record->{$titleField} = $term;
+			$record->write();
+			return $record;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Returns a JSON string of tags, for lazy loading.
+	 *
+	 * @param SS_HTTPRequest $request
+	 *
+	 * @return SS_HTTPResponse
+	 */
+	public function suggest(SS_HTTPRequest $request)
+	{
+		$tags = $this->getTags($request->getVar('term'));
+
+		$response = new SS_HTTPResponse();
+		$response->addHeader('Content-Type', 'application/json');
+		$response->setBody(json_encode(array('items' => $tags)));
+
+		return $response;
+	}
+
+	/**
+	 * Returns array of arrays representing tags.
+	 *
+	 * @param string $term
+	 *
+	 * @return array
+	 */
+	protected function getTags($term)
+	{
+		/**
+		 * @var DataList $source
+		 */
+		$source = $this->getSource();
+
+		$titleField = $this->getTitleField();
+
+		$query = $source
+			->filter($titleField . ':PartialMatch:nocase', $term)
+			->sort($titleField)
+			->limit($this->getLazyLoadItemLimit());
+
+		// Map into a distinct list
+		$items = array();
+		$titleField = $this->getTitleField();
+		foreach ($query->map('ID', $titleField) as $id => $title) {
+			$items[$title] = array(
+				'id' => $title,
+				'text' => $title
+			);
+		}
+
+		return array_values($items);
+	}
+
+	/**
+	 * DropdownField assumes value will be a scalar so we must
+	 * override validate. This only applies to Silverstripe 3.2+
+	 *
+	 * @param Validator $validator
+	 * @return bool
+	 */
+	public function validate($validator)
+	{
+		return true;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -200,7 +200,7 @@ 
 
         $source = $this->getSource();
 
-        if(!$source) {
+        if (!$source) {
             $source = new ArrayList();
         }
 
@@ -208,11 +208,11 @@ 
 
         $values = $this->Value();
 
-        if(!$values) {
+        if (!$values) {
             return $options;
         }
 
-        if(is_array($values)) {
+        if (is_array($values)) {
             $values = DataList::create($dataClass)->filter('Title', $values);
         }
 
@@ -220,7 +220,7 @@ 
 
         $titleField = $this->getTitleField();
 
-        foreach($source as $object) {
+        foreach ($source as $object) {
             $options->push(
             ArrayData::create(array(
                 'Title' => $object->$titleField,
@@ -285,15 +285,15 @@ 
 
         $ids = array();
 
-        if(!$values) {
+        if (!$values) {
             $values = array();
         }
 
-        if(empty($record) || empty($source) || empty($titleField)) {
+        if (empty($record) || empty($source) || empty($titleField)) {
             return;
         }
 
-        if(!$record->hasMethod($name)) {
+        if (!$record->hasMethod($name)) {
             throw new Exception(
                 sprintf("%s does not have a %s method", get_class($record), $name)
             );
@@ -302,7 +302,7 @@ 
         foreach ($values as $key => $value) {
             // Get or create record
             $record = $this->getOrCreateTag($value);
-            if($record) {
+            if ($record) {
                 $ids[] = $record->ID;
                 $values[$key] = $record->Title;
             }
@@ -326,7 +326,7 @@ 
         $record = $source
             ->filter($titleField, $term)
             ->first();
-        if($record) {
+        if ($record) {
             return $record;
         }
 

tests/TagFieldTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     }
 
     /**
-     * @param array $expected
+     * @param string[] $expected
      * @param TagFieldTestBlogPost $record
      */
     protected function compareExpectedAndActualTags(array $expected, TagFieldTestBlogPost $record)

Indentation +357 added lines, -357 removed lines

@@ -5,329 +5,329 @@ 
  */
 class TagFieldTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    public static $fixture_file = 'tagfield/tests/TagFieldTest.yml';
-
-    /**
-     * @var array
-     */
-    protected $extraDataObjects = array(
-        'TagFieldTestBlogTag',
-        'TagFieldTestBlogPost',
-    );
-
-    public function testItSavesLinksToNewTagsOnNewRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-        $field->setValue(array('Tag3', 'Tag4'));
-        $field->saveInto($record);
-
-        $record->write();
-
-        $this->compareExpectedAndActualTags(
-            array('Tag3', 'Tag4'),
-            $record
-        );
-    }
-
-    /**
-     * @param string $name
-     *
-     * @return TagFieldTestBlogPost
-     */
-    protected function getNewTagFieldTestBlogPost($name)
-    {
-        return $this->objFromFixture(
-            'TagFieldTestBlogPost',
-            $name
-        );
-    }
-
-    /**
-     * @param array $expected
-     * @param TagFieldTestBlogPost $record
-     */
-    protected function compareExpectedAndActualTags(array $expected, TagFieldTestBlogPost $record)
-    {
-        $this->compareTagLists($expected, $record->Tags());
-    }
-
-    /**
-     * Ensure a source of tags matches the given string tag names
-     *
-     * @param array $expected
-     * @param DataList $actualSource
-     */
-    protected function compareTagLists(array $expected, DataList $actualSource)
-    {
-        $actual = array_values($actualSource->map('ID', 'Title')->toArray());
-
-        sort($expected);
-        sort($actual);
-
-        $this->assertEquals(
-            $expected,
-            $actual
-        );
-    }
-
-    public function testItSavesLinksToNewTagsOnExistingRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-        $field->setValue(array('Tag3', 'Tag4'));
-        $field->saveInto($record);
-
-        $this->compareExpectedAndActualTags(
-            array('Tag3', 'Tag4'),
-            $record
-        );
-    }
-
-    public function testItSavesLinksToExistingTagsOnNewRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-        $field->setValue(array('Tag1', 'Tag2'));
-        $field->saveInto($record);
-
-        $record->write();
-
-        $this->compareExpectedAndActualTags(
-            array('Tag1', 'Tag2'),
-            $record
-        );
-    }
-
-    public function testItSavesLinksToExistingTagsOnExistingRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-        $field->setValue(array('Tag1', 'Tag2'));
-        $field->saveInto($record);
-
-        $this->compareExpectedAndActualTags(
-            array('Tag1', 'Tag2'),
-            $record
-        );
-    }
-
-    /**
-     * Ensure that {@see TagField::saveInto} respects existing tags
-     */
-    public function testSaveDuplicateTags()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost2');
-        $record->write();
-        $tag2ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag2');
-
-        // Check tags before write
-        $this->compareExpectedAndActualTags(
-            array('Tag1', 'Tag2'),
-            $record
-        );
-        $this->compareTagLists(
-            array('Tag1', 'Tag2'),
-            TagFieldTestBlogTag::get()
-        );
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
-
-        // Write new tags
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-        $field->setValue(array('Tag2', 'Tag3'));
-        $field->saveInto($record);
-
-        // Check only one new tag was added
-        $this->compareExpectedAndActualTags(
-            array('Tag2', 'Tag3'),
-            $record
-        );
-
-        // Ensure that only one new dataobject was added and that tag2s id has not changed
-        $this->compareTagLists(
-            array('Tag1', 'Tag2', 'Tag3'),
-            TagFieldTestBlogTag::get()
-        );
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
-    }
-
-    public function testItSuggestsTags()
-    {
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag'));
-
-        $tag1ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag1');
-        $tag2ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag2');
-
-        $this->assertEquals(
-            sprintf('{"items":[{"id":%d,"text":"Tag1"},{"id":%d,"text":"Tag2"}]}', $tag1ID, $tag2ID),
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag1'));
-
-        $this->assertEquals(
-            sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Case-insensitive tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'TAG1'));
-
-        $this->assertEquals(
-            sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * No tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'unknown'));
-
-        $this->assertEquals(
-            '{"items":[]}',
-            $field->suggest($request)->getBody()
-        );
-    }
-
-    /**
-     * Tests that TagField supports pre-filtered data sources
-     */
-    public function testRestrictedSuggestions()
-    {
-        $source = TagFieldTestBlogTag::get()->exclude('Title', 'Tag2');
-        $field = new TagField('Tags', '', $source);
-        $tag1ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag1');
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag'));
-
-        $this->assertEquals(
-            sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag1'));
-
-        $this->assertEquals(
-            sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Excluded item doesn't appear in matches
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag2'));
-
-        $this->assertEquals(
-            '{"items":[]}',
-            $field->suggest($request)->getBody()
-        );
-    }
-
-    /**
-     * @param array $parameters
-     *
-     * @return SS_HTTPRequest
-     */
-    protected function getNewRequest(array $parameters)
-    {
-        return new SS_HTTPRequest(
-            'get',
-            'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
-            $parameters
-        );
-    }
-
-    public function testItDisplaysValuesFromRelations()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $form = new Form(
-            new TagFieldTestController($record),
-            'Form',
-            new FieldList(
-                $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
-            ),
-            new FieldList()
-        );
-
-        $form->loadDataFrom(
-            $this->objFromFixture('TagFieldTestBlogPost', 'BlogPost2')
-        );
-
-        $ids = TagFieldTestBlogTag::get()->map('ID', 'ID')->toArray();
-
-        $this->assertEquals($field->Value(), $ids);
-    }
-
-    public function testItIgnoresNewTagsIfCannotCreate()
-    {
-        $record = new TagFieldTestBlogPost();
-        $record->write();
-
-        $tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
-
-        $field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'), array($tag->ID, 'Tag3'));
-        $field->setCanCreate(false);
-        $field->saveInto($record);
-
-        /**
-         * @var TagFieldTestBlogPost $record
-         */
-        $record = DataObject::get_by_id('TagFieldTestBlogPost', $record->ID);
-
-        $this->compareExpectedAndActualTags(
-            array('Tag1'),
-            $record
-        );
-    }
+	/**
+	 * @var string
+	 */
+	public static $fixture_file = 'tagfield/tests/TagFieldTest.yml';
+
+	/**
+	 * @var array
+	 */
+	protected $extraDataObjects = array(
+		'TagFieldTestBlogTag',
+		'TagFieldTestBlogPost',
+	);
+
+	public function testItSavesLinksToNewTagsOnNewRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+		$field->setValue(array('Tag3', 'Tag4'));
+		$field->saveInto($record);
+
+		$record->write();
+
+		$this->compareExpectedAndActualTags(
+			array('Tag3', 'Tag4'),
+			$record
+		);
+	}
+
+	/**
+	 * @param string $name
+	 *
+	 * @return TagFieldTestBlogPost
+	 */
+	protected function getNewTagFieldTestBlogPost($name)
+	{
+		return $this->objFromFixture(
+			'TagFieldTestBlogPost',
+			$name
+		);
+	}
+
+	/**
+	 * @param array $expected
+	 * @param TagFieldTestBlogPost $record
+	 */
+	protected function compareExpectedAndActualTags(array $expected, TagFieldTestBlogPost $record)
+	{
+		$this->compareTagLists($expected, $record->Tags());
+	}
+
+	/**
+	 * Ensure a source of tags matches the given string tag names
+	 *
+	 * @param array $expected
+	 * @param DataList $actualSource
+	 */
+	protected function compareTagLists(array $expected, DataList $actualSource)
+	{
+		$actual = array_values($actualSource->map('ID', 'Title')->toArray());
+
+		sort($expected);
+		sort($actual);
+
+		$this->assertEquals(
+			$expected,
+			$actual
+		);
+	}
+
+	public function testItSavesLinksToNewTagsOnExistingRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+		$field->setValue(array('Tag3', 'Tag4'));
+		$field->saveInto($record);
+
+		$this->compareExpectedAndActualTags(
+			array('Tag3', 'Tag4'),
+			$record
+		);
+	}
+
+	public function testItSavesLinksToExistingTagsOnNewRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+		$field->setValue(array('Tag1', 'Tag2'));
+		$field->saveInto($record);
+
+		$record->write();
+
+		$this->compareExpectedAndActualTags(
+			array('Tag1', 'Tag2'),
+			$record
+		);
+	}
+
+	public function testItSavesLinksToExistingTagsOnExistingRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+		$field->setValue(array('Tag1', 'Tag2'));
+		$field->saveInto($record);
+
+		$this->compareExpectedAndActualTags(
+			array('Tag1', 'Tag2'),
+			$record
+		);
+	}
+
+	/**
+	 * Ensure that {@see TagField::saveInto} respects existing tags
+	 */
+	public function testSaveDuplicateTags()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost2');
+		$record->write();
+		$tag2ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag2');
+
+		// Check tags before write
+		$this->compareExpectedAndActualTags(
+			array('Tag1', 'Tag2'),
+			$record
+		);
+		$this->compareTagLists(
+			array('Tag1', 'Tag2'),
+			TagFieldTestBlogTag::get()
+		);
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
+
+		// Write new tags
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+		$field->setValue(array('Tag2', 'Tag3'));
+		$field->saveInto($record);
+
+		// Check only one new tag was added
+		$this->compareExpectedAndActualTags(
+			array('Tag2', 'Tag3'),
+			$record
+		);
+
+		// Ensure that only one new dataobject was added and that tag2s id has not changed
+		$this->compareTagLists(
+			array('Tag1', 'Tag2', 'Tag3'),
+			TagFieldTestBlogTag::get()
+		);
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
+	}
+
+	public function testItSuggestsTags()
+	{
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'));
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag'));
+
+		$tag1ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag1');
+		$tag2ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag2');
+
+		$this->assertEquals(
+			sprintf('{"items":[{"id":%d,"text":"Tag1"},{"id":%d,"text":"Tag2"}]}', $tag1ID, $tag2ID),
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag1'));
+
+		$this->assertEquals(
+			sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Case-insensitive tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'TAG1'));
+
+		$this->assertEquals(
+			sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * No tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'unknown'));
+
+		$this->assertEquals(
+			'{"items":[]}',
+			$field->suggest($request)->getBody()
+		);
+	}
+
+	/**
+	 * Tests that TagField supports pre-filtered data sources
+	 */
+	public function testRestrictedSuggestions()
+	{
+		$source = TagFieldTestBlogTag::get()->exclude('Title', 'Tag2');
+		$field = new TagField('Tags', '', $source);
+		$tag1ID = $this->idFromFixture('TagFieldTestBlogTag', 'Tag1');
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag'));
+
+		$this->assertEquals(
+			sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag1'));
+
+		$this->assertEquals(
+			sprintf('{"items":[{"id":%d,"text":"Tag1"}]}', $tag1ID),
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Excluded item doesn't appear in matches
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag2'));
+
+		$this->assertEquals(
+			'{"items":[]}',
+			$field->suggest($request)->getBody()
+		);
+	}
+
+	/**
+	 * @param array $parameters
+	 *
+	 * @return SS_HTTPRequest
+	 */
+	protected function getNewRequest(array $parameters)
+	{
+		return new SS_HTTPRequest(
+			'get',
+			'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
+			$parameters
+		);
+	}
+
+	public function testItDisplaysValuesFromRelations()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$form = new Form(
+			new TagFieldTestController($record),
+			'Form',
+			new FieldList(
+				$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
+			),
+			new FieldList()
+		);
+
+		$form->loadDataFrom(
+			$this->objFromFixture('TagFieldTestBlogPost', 'BlogPost2')
+		);
+
+		$ids = TagFieldTestBlogTag::get()->map('ID', 'ID')->toArray();
+
+		$this->assertEquals($field->Value(), $ids);
+	}
+
+	public function testItIgnoresNewTagsIfCannotCreate()
+	{
+		$record = new TagFieldTestBlogPost();
+		$record->write();
+
+		$tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
+
+		$field = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'), array($tag->ID, 'Tag3'));
+		$field->setCanCreate(false);
+		$field->saveInto($record);
+
+		/**
+		 * @var TagFieldTestBlogPost $record
+		 */
+		$record = DataObject::get_by_id('TagFieldTestBlogPost', $record->ID);
+
+		$this->compareExpectedAndActualTags(
+			array('Tag1'),
+			$record
+		);
+	}
 }
 
 class TagFieldTestBlogTag extends DataObject implements TestOnly
 {
-    /**
-     * @var string
-     */
-    private static $default_sort = '"TagFieldTestBlogTag"."ID" ASC';
-
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Title' => 'Varchar(200)',
-    );
-
-    /**
-     * @var array
-     */
-    private static $belongs_many_many = array(
-        'BlogPosts' => 'TagFieldTestBlogPost',
-    );
+	/**
+	 * @var string
+	 */
+	private static $default_sort = '"TagFieldTestBlogTag"."ID" ASC';
+
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Title' => 'Varchar(200)',
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $belongs_many_many = array(
+		'BlogPosts' => 'TagFieldTestBlogPost',
+	);
 }
 
 /**
@@ -335,46 +335,46 @@ 
  */
 class TagFieldTestBlogPost extends DataObject implements TestOnly
 {
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Title' => 'Text',
-        'Content' => 'Text',
-    );
-
-    /**
-     * @var array
-     */
-    private static $many_many = array(
-        'Tags' => 'TagFieldTestBlogTag',
-    );
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Title' => 'Text',
+		'Content' => 'Text',
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $many_many = array(
+		'Tags' => 'TagFieldTestBlogTag',
+	);
 }
 
 class TagFieldTestController extends Controller implements TestOnly
 {
-    /**
-     * @return Form
-     */
-    public function TagFieldTestForm()
-    {
-        $fields = new FieldList(
-            $tagField = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
-        );
-
-        $actions = new FieldList(
-            new FormAction('TagFieldTestFormSubmit')
-        );
-
-        return new Form($this, 'TagFieldTestForm', $fields, $actions);
-    }
-
-    /**
-     * @param DataObject $dataObject
-     * @param Form $form
-     */
-    public function TagFieldTestFormSubmit(DataObject $dataObject, Form $form)
-    {
-        $form->saveInto($dataObject);
-    }
+	/**
+	 * @return Form
+	 */
+	public function TagFieldTestForm()
+	{
+		$fields = new FieldList(
+			$tagField = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
+		);
+
+		$actions = new FieldList(
+			new FormAction('TagFieldTestFormSubmit')
+		);
+
+		return new Form($this, 'TagFieldTestForm', $fields, $actions);
+	}
+
+	/**
+	 * @param DataObject $dataObject
+	 * @param Form $form
+	 */
+	public function TagFieldTestFormSubmit(DataObject $dataObject, Form $form)
+	{
+		$form->saveInto($dataObject);
+	}
 }

tests/StringTagFieldTest.php

Indentation +140 added lines, -140 removed lines

@@ -5,114 +5,114 @@ 
  */
 class StringTagFieldTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    public static $fixture_file = 'tagfield/tests/StringTagFieldTest.yml';
-
-    /**
-     * @var array
-     */
-    protected $extraDataObjects = array(
-        'StringTagFieldTestBlogPost',
-    );
-
-    public function testItSavesTagsOnNewRecords()
-    {
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
-
-        $field = new StringTagField('Tags');
-        $field->setValue(array('Tag1', 'Tag2'));
-        $field->saveInto($record);
-
-        $record->write();
-
-        $this->assertEquals('Tag1,Tag2', $record->Tags);
-    }
-
-    /**
-     * @param string $name
-     *
-     * @return StringTagFieldTestBlogPost
-     */
-    protected function getNewStringTagFieldTestBlogPost($name)
-    {
-        return $this->objFromFixture(
-            'StringTagFieldTestBlogPost',
-            $name
-        );
-    }
-
-    public function testItSavesTagsOnExistingRecords()
-    {
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $field = new StringTagField('Tags');
-        $field->setValue(array('Tag1', 'Tag2'));
-        $field->saveInto($record);
-
-        $this->assertEquals('Tag1,Tag2', $record->Tags);
-    }
-
-    public function testItSuggestsTags()
-    {
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost2');
-
-        $field = new StringTagField('Tags');
-        $field->setRecord($record);
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag'));
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'Tag1'));
-
-        $this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
-
-        /**
-         * Case-insensitive tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'TAG1'));
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * No tag title match.
-         */
-        $request = $this->getNewRequest(array('term' => 'unknown'));
-
-        $this->assertEquals(
-            '{"items":[]}',
-            $field->suggest($request)->getBody()
-        );
-    }
-
-    /**
-     * @param array $parameters
-     *
-     * @return SS_HTTPRequest
-     */
-    protected function getNewRequest(array $parameters)
-    {
-        return new SS_HTTPRequest(
-            'get',
-            'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
-            $parameters
-        );
-    }
+	/**
+	 * @var string
+	 */
+	public static $fixture_file = 'tagfield/tests/StringTagFieldTest.yml';
+
+	/**
+	 * @var array
+	 */
+	protected $extraDataObjects = array(
+		'StringTagFieldTestBlogPost',
+	);
+
+	public function testItSavesTagsOnNewRecords()
+	{
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
+
+		$field = new StringTagField('Tags');
+		$field->setValue(array('Tag1', 'Tag2'));
+		$field->saveInto($record);
+
+		$record->write();
+
+		$this->assertEquals('Tag1,Tag2', $record->Tags);
+	}
+
+	/**
+	 * @param string $name
+	 *
+	 * @return StringTagFieldTestBlogPost
+	 */
+	protected function getNewStringTagFieldTestBlogPost($name)
+	{
+		return $this->objFromFixture(
+			'StringTagFieldTestBlogPost',
+			$name
+		);
+	}
+
+	public function testItSavesTagsOnExistingRecords()
+	{
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$field = new StringTagField('Tags');
+		$field->setValue(array('Tag1', 'Tag2'));
+		$field->saveInto($record);
+
+		$this->assertEquals('Tag1,Tag2', $record->Tags);
+	}
+
+	public function testItSuggestsTags()
+	{
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost2');
+
+		$field = new StringTagField('Tags');
+		$field->setRecord($record);
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag'));
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'Tag1'));
+
+		$this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
+
+		/**
+		 * Case-insensitive tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'TAG1'));
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * No tag title match.
+		 */
+		$request = $this->getNewRequest(array('term' => 'unknown'));
+
+		$this->assertEquals(
+			'{"items":[]}',
+			$field->suggest($request)->getBody()
+		);
+	}
+
+	/**
+	 * @param array $parameters
+	 *
+	 * @return SS_HTTPRequest
+	 */
+	protected function getNewRequest(array $parameters)
+	{
+		return new SS_HTTPRequest(
+			'get',
+			'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
+			$parameters
+		);
+	}
 }
 
 /**
@@ -120,40 +120,40 @@ 
  */
 class StringTagFieldTestBlogPost extends DataObject implements TestOnly
 {
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Title' => 'Text',
-        'Content' => 'Text',
-        'Tags' => 'Text',
-    );
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Title' => 'Text',
+		'Content' => 'Text',
+		'Tags' => 'Text',
+	);
 }
 
 class StringTagFieldTestController extends Controller implements TestOnly
 {
-    /**
-     * @return Form
-     */
-    public function StringTagFieldTestForm()
-    {
-        $fields = new FieldList(
-            $tagField = new StringTagField('Tags')
-        );
-
-        $actions = new FieldList(
-            new FormAction('StringTagFieldTestFormSubmit')
-        );
-
-        return new Form($this, 'StringTagFieldTestForm', $fields, $actions);
-    }
-
-    /**
-     * @param DataObject $dataObject
-     * @param Form $form
-     */
-    public function StringTagFieldTestFormSubmit(DataObject $dataObject, Form $form)
-    {
-        $form->saveInto($dataObject);
-    }
+	/**
+	 * @return Form
+	 */
+	public function StringTagFieldTestForm()
+	{
+		$fields = new FieldList(
+			$tagField = new StringTagField('Tags')
+		);
+
+		$actions = new FieldList(
+			new FormAction('StringTagFieldTestFormSubmit')
+		);
+
+		return new Form($this, 'StringTagFieldTestForm', $fields, $actions);
+	}
+
+	/**
+	 * @param DataObject $dataObject
+	 * @param Form $form
+	 */
+	public function StringTagFieldTestFormSubmit(DataObject $dataObject, Form $form)
+	{
+		$form->saveInto($dataObject);
+	}
 }

code/StringTagField.php

Doc Comments +1 added lines

@@ -235,6 +235,7 @@
 
     /**
      * {@inheritdoc}
+     * @param string[] $value
      */
     public function setValue($value, $source = null)
     {

Indentation +330 added lines, -330 removed lines

@@ -11,334 +11,334 @@
  */
 class StringTagField extends DropdownField
 {
-    /**
-     * @var array
-     */
-    public static $allowed_actions = array(
-        'suggest',
-    );
-
-    /**
-     * @var bool
-     */
-    protected $shouldLazyLoad = false;
-
-    /**
-     * @var int
-     */
-    protected $lazyLoadItemLimit = 10;
-
-    /**
-     * @var null|DataObject
-     */
-    protected $record;
-
-    /**
-     * @var bool
-     */
-    protected $isMultiple = true;
-
-    /**
-     * @param string $name
-     * @param string $title
-     * @param array|SS_List $source
-     * @param array|SS_List $value
-     */
-    public function __construct($name, $title = '', $source = array(), $value = array())
-    {
-        parent::__construct($name, $title, $source, $value);
-    }
-
-    /**
-     * @return bool
-     */
-    public function getShouldLazyLoad()
-    {
-        return $this->shouldLazyLoad;
-    }
-
-    /**
-     * @param bool $shouldLazyLoad
-     *
-     * @return static
-     */
-    public function setShouldLazyLoad($shouldLazyLoad)
-    {
-        $this->shouldLazyLoad = $shouldLazyLoad;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getLazyLoadItemLimit()
-    {
-        return $this->lazyLoadItemLimit;
-    }
-
-    /**
-     * @param int $lazyLoadItemLimit
-     *
-     * @return static
-     */
-    public function setLazyLoadItemLimit($lazyLoadItemLimit)
-    {
-        $this->lazyLoadItemLimit = $lazyLoadItemLimit;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getIsMultiple()
-    {
-        return $this->isMultiple;
-    }
-
-    /**
-     * @param bool $isMultiple
-     *
-     * @return static
-     */
-    public function setIsMultiple($isMultiple)
-    {
-        $this->isMultiple = $isMultiple;
-
-        return $this;
-    }
-
-    /**
-     * @return null|DataObject
-     */
-    public function getRecord()
-    {
-        if ($this->record) {
-            return $this->record;
-        }
-
-        if ($form = $this->getForm()) {
-            return $form->getRecord();
-        }
-
-        return null;
-    }
-
-    /**
-     * @param DataObject $record
-     *
-     * @return $this
-     */
-    public function setRecord(DataObject $record)
-    {
-        $this->record = $record;
-
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function Field($properties = array())
-    {
-        Requirements::css(TAG_FIELD_DIR . '/css/select2.min.css');
-        Requirements::css(TAG_FIELD_DIR . '/css/TagField.css');
-
-        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
-        Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
-        Requirements::javascript(TAG_FIELD_DIR . '/js/select2.js');
-        Requirements::javascript(TAG_FIELD_DIR . '/js/TagField.js');
-
-        $this->addExtraClass('ss-tag-field');
-
-        if ($this->getIsMultiple()) {
-            $this->setAttribute('multiple', 'multiple');
-        }
-
-        if ($this->getShouldLazyLoad()) {
-            $this->setAttribute('data-ss-tag-field-suggest-url', $this->getSuggestURL());
-        } else {
-            $properties = array_merge($properties, array(
-                'Options' => $this->getOptions()
-            ));
-        }
-
-        return $this
-            ->customise($properties)
-            ->renderWith(array("templates/TagField"));
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSuggestURL()
-    {
-        return Controller::join_links($this->Link(), 'suggest');
-    }
-
-    /**
-     * @return ArrayList
-     */
-    protected function getOptions()
-    {
-        $options = ArrayList::create();
-
-        $source = $this->getSource();
-
-        if ($source instanceof Iterator) {
-            $source = iterator_to_array($source);
-        }
-
-        $values = $this->Value();
-
-        foreach ($source as $value) {
-            $options->push(
-                ArrayData::create(array(
-                    'Title' => $value,
-                    'Value' => $value,
-                    'Selected' => in_array($value, $values),
-                ))
-            );
-        }
-
-        return $options;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setValue($value, $source = null)
-    {
-        if (is_string($value)) {
-            $value = explode(',', $value);
-        }
-
-        if ($source instanceof DataObject) {
-            $name = $this->getName();
-            $value = explode(',', $source->$name);
-        }
-
-        if ($source instanceof SS_List) {
-            $value = $source->column('ID');
-        }
-
-        if (is_null($value)) {
-            $value = array();
-        }
-
-        return parent::setValue(array_filter($value));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAttributes()
-    {
-        return array_merge(
-            parent::getAttributes(),
-            array('name' => $this->getName() . '[]')
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        parent::saveInto($record);
-
-        $name = $this->getName();
-
-        $record->$name = join(',', $this->Value());
-        $record->write();
-    }
-
-    /**
-     * Returns a JSON string of tags, for lazy loading.
-     *
-     * @param SS_HTTPRequest $request
-     *
-     * @return SS_HTTPResponse
-     */
-    public function suggest(SS_HTTPRequest $request)
-    {
-        $responseBody = Convert::raw2json(
-            array('items' => array())
-        );
-
-        $response = new SS_HTTPResponse();
-        $response->addHeader('Content-Type', 'application/json');
-
-        if ($record = $this->getRecord()) {
-            $tags = array();
-            $term = $request->getVar('term');
-
-            if ($record->hasField($this->getName())) {
-                $tags = $this->getTags($term);
-            }
-
-            $responseBody = Convert::raw2json(
-                array('items' => $tags)
-            );
-        }
-
-        $response->setBody($responseBody);
-
-        return $response;
-    }
-
-    /**
-     * Returns array of arrays representing tags.
-     *
-     * @param string $term
-     *
-     * @return array
-     */
-    protected function getTags($term)
-    {
-        $record = $this->getRecord();
-
-        if (!$record) {
-            return array();
-        }
-
-        $fieldName = $this->getName();
-        $className = $record->getClassName();
-
-        $term = Convert::raw2sql($term);
-
-        $query = $className::get()
-            ->filter($fieldName . ':PartialMatch:nocase', $term)
-            ->limit($this->getLazyLoadItemLimit());
-
-        $items = array();
-
-        foreach ($query->column($fieldName) as $tags) {
-            $tags = explode(',', $tags);
-
-            foreach ($tags as $i => $tag) {
-                if (stripos($tag, $term) !== false && !in_array($tag, $items)) {
-                    $items[] = array(
-                        'id' => $tag,
-                        'text' => $tag
-                    );
-                }
-            }
-        }
-
-        return $items;
-    }
-
-    /**
-     * DropdownField assumes value will be a scalar so we must
-     * override validate. This only applies to Silverstripe 3.2+
-     *
-     * @param Validator $validator
-     * @return bool
-     */
-    public function validate($validator)
-    {
-        return true;
-    }
+	/**
+	 * @var array
+	 */
+	public static $allowed_actions = array(
+		'suggest',
+	);
+
+	/**
+	 * @var bool
+	 */
+	protected $shouldLazyLoad = false;
+
+	/**
+	 * @var int
+	 */
+	protected $lazyLoadItemLimit = 10;
+
+	/**
+	 * @var null|DataObject
+	 */
+	protected $record;
+
+	/**
+	 * @var bool
+	 */
+	protected $isMultiple = true;
+
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param array|SS_List $source
+	 * @param array|SS_List $value
+	 */
+	public function __construct($name, $title = '', $source = array(), $value = array())
+	{
+		parent::__construct($name, $title, $source, $value);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getShouldLazyLoad()
+	{
+		return $this->shouldLazyLoad;
+	}
+
+	/**
+	 * @param bool $shouldLazyLoad
+	 *
+	 * @return static
+	 */
+	public function setShouldLazyLoad($shouldLazyLoad)
+	{
+		$this->shouldLazyLoad = $shouldLazyLoad;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLazyLoadItemLimit()
+	{
+		return $this->lazyLoadItemLimit;
+	}
+
+	/**
+	 * @param int $lazyLoadItemLimit
+	 *
+	 * @return static
+	 */
+	public function setLazyLoadItemLimit($lazyLoadItemLimit)
+	{
+		$this->lazyLoadItemLimit = $lazyLoadItemLimit;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getIsMultiple()
+	{
+		return $this->isMultiple;
+	}
+
+	/**
+	 * @param bool $isMultiple
+	 *
+	 * @return static
+	 */
+	public function setIsMultiple($isMultiple)
+	{
+		$this->isMultiple = $isMultiple;
+
+		return $this;
+	}
+
+	/**
+	 * @return null|DataObject
+	 */
+	public function getRecord()
+	{
+		if ($this->record) {
+			return $this->record;
+		}
+
+		if ($form = $this->getForm()) {
+			return $form->getRecord();
+		}
+
+		return null;
+	}
+
+	/**
+	 * @param DataObject $record
+	 *
+	 * @return $this
+	 */
+	public function setRecord(DataObject $record)
+	{
+		$this->record = $record;
+
+		return $this;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function Field($properties = array())
+	{
+		Requirements::css(TAG_FIELD_DIR . '/css/select2.min.css');
+		Requirements::css(TAG_FIELD_DIR . '/css/TagField.css');
+
+		Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
+		Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
+		Requirements::javascript(TAG_FIELD_DIR . '/js/select2.js');
+		Requirements::javascript(TAG_FIELD_DIR . '/js/TagField.js');
+
+		$this->addExtraClass('ss-tag-field');
+
+		if ($this->getIsMultiple()) {
+			$this->setAttribute('multiple', 'multiple');
+		}
+
+		if ($this->getShouldLazyLoad()) {
+			$this->setAttribute('data-ss-tag-field-suggest-url', $this->getSuggestURL());
+		} else {
+			$properties = array_merge($properties, array(
+				'Options' => $this->getOptions()
+			));
+		}
+
+		return $this
+			->customise($properties)
+			->renderWith(array("templates/TagField"));
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSuggestURL()
+	{
+		return Controller::join_links($this->Link(), 'suggest');
+	}
+
+	/**
+	 * @return ArrayList
+	 */
+	protected function getOptions()
+	{
+		$options = ArrayList::create();
+
+		$source = $this->getSource();
+
+		if ($source instanceof Iterator) {
+			$source = iterator_to_array($source);
+		}
+
+		$values = $this->Value();
+
+		foreach ($source as $value) {
+			$options->push(
+				ArrayData::create(array(
+					'Title' => $value,
+					'Value' => $value,
+					'Selected' => in_array($value, $values),
+				))
+			);
+		}
+
+		return $options;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setValue($value, $source = null)
+	{
+		if (is_string($value)) {
+			$value = explode(',', $value);
+		}
+
+		if ($source instanceof DataObject) {
+			$name = $this->getName();
+			$value = explode(',', $source->$name);
+		}
+
+		if ($source instanceof SS_List) {
+			$value = $source->column('ID');
+		}
+
+		if (is_null($value)) {
+			$value = array();
+		}
+
+		return parent::setValue(array_filter($value));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getAttributes()
+	{
+		return array_merge(
+			parent::getAttributes(),
+			array('name' => $this->getName() . '[]')
+		);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		parent::saveInto($record);
+
+		$name = $this->getName();
+
+		$record->$name = join(',', $this->Value());
+		$record->write();
+	}
+
+	/**
+	 * Returns a JSON string of tags, for lazy loading.
+	 *
+	 * @param SS_HTTPRequest $request
+	 *
+	 * @return SS_HTTPResponse
+	 */
+	public function suggest(SS_HTTPRequest $request)
+	{
+		$responseBody = Convert::raw2json(
+			array('items' => array())
+		);
+
+		$response = new SS_HTTPResponse();
+		$response->addHeader('Content-Type', 'application/json');
+
+		if ($record = $this->getRecord()) {
+			$tags = array();
+			$term = $request->getVar('term');
+
+			if ($record->hasField($this->getName())) {
+				$tags = $this->getTags($term);
+			}
+
+			$responseBody = Convert::raw2json(
+				array('items' => $tags)
+			);
+		}
+
+		$response->setBody($responseBody);
+
+		return $response;
+	}
+
+	/**
+	 * Returns array of arrays representing tags.
+	 *
+	 * @param string $term
+	 *
+	 * @return array
+	 */
+	protected function getTags($term)
+	{
+		$record = $this->getRecord();
+
+		if (!$record) {
+			return array();
+		}
+
+		$fieldName = $this->getName();
+		$className = $record->getClassName();
+
+		$term = Convert::raw2sql($term);
+
+		$query = $className::get()
+			->filter($fieldName . ':PartialMatch:nocase', $term)
+			->limit($this->getLazyLoadItemLimit());
+
+		$items = array();
+
+		foreach ($query->column($fieldName) as $tags) {
+			$tags = explode(',', $tags);
+
+			foreach ($tags as $i => $tag) {
+				if (stripos($tag, $term) !== false && !in_array($tag, $items)) {
+					$items[] = array(
+						'id' => $tag,
+						'text' => $tag
+					);
+				}
+			}
+		}
+
+		return $items;
+	}
+
+	/**
+	 * DropdownField assumes value will be a scalar so we must
+	 * override validate. This only applies to Silverstripe 3.2+
+	 *
+	 * @param Validator $validator
+	 * @return bool
+	 */
+	public function validate($validator)
+	{
+		return true;
+	}
 }