silverstripe / silverstripe-tagfield

src/StringTagField.php

Indentation +320 added lines, -320 removed lines

@@ -26,324 +26,324 @@
  */
 class StringTagField extends DropdownField
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = [
-        'suggest',
-    ];
-
-    /**
-     * @var bool
-     */
-    protected $shouldLazyLoad = false;
-
-    /**
-     * @var int
-     */
-    protected $lazyLoadItemLimit = 10;
-
-    /**
-     * @var bool
-     */
-    protected $canCreate = true;
-
-    /**
-     * @var null|DataObject
-     */
-    protected $record;
-
-    /**
-     * @var bool
-     */
-    protected $isMultiple = true;
-
-    /**
-     * @return bool
-     */
-    public function getShouldLazyLoad()
-    {
-        return $this->shouldLazyLoad;
-    }
-
-    /**
-     * @param bool $shouldLazyLoad
-     * @return $this
-     */
-    public function setShouldLazyLoad($shouldLazyLoad)
-    {
-        $this->shouldLazyLoad = $shouldLazyLoad;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getLazyLoadItemLimit()
-    {
-        return $this->lazyLoadItemLimit;
-    }
-
-    /**
-     * @param int $lazyLoadItemLimit
-     * @return $this
-     */
-    public function setLazyLoadItemLimit($lazyLoadItemLimit)
-    {
-        $this->lazyLoadItemLimit = $lazyLoadItemLimit;
-
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getIsMultiple()
-    {
-        return $this->isMultiple;
-    }
-
-    /**
-     * @param bool $isMultiple
-     * @return $this
-     */
-    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;
-    }
-
-    public function Field($properties = [])
-    {
-        $this->addExtraClass('ss-tag-field');
-
-        return $this
-            ->customise($properties)
-            ->renderWith(TagField::class);
-    }
-
-    /**
-     * Provide TagField data to the JSON schema for the frontend component
-     *
-     * @return array
-     */
-    public function getSchemaDataDefaults()
-    {
-        $schema = array_merge(
-            parent::getSchemaDataDefaults(),
-            [
-                'name' => $this->getName() . '[]',
-                'lazyLoad' => $this->getShouldLazyLoad(),
-                'creatable' => $this->getCanCreate(),
-                'multi' => $this->getIsMultiple(),
-                'value' => $this->formatOptions($this->Value()),
-                'disabled' => $this->isDisabled() || $this->isReadonly(),
-            ]
-        );
-
-        if (!$this->getShouldLazyLoad()) {
-            $schema['options'] = $this->getOptions()->toNestedArray();
-        } else {
-            $schema['optionUrl'] = $this->getSuggestURL();
-        }
-
-        return $schema;
-    }
-
-    protected function formatOptions($fieldValue)
-    {
-        if (empty($fieldValue)) {
-            return [];
-        }
-
-        $formattedValue = [];
-        foreach ($fieldValue as $value) {
-            $formattedValue[] = [
-                'Title' => $value,
-                'Value' => $value,
-            ];
-        }
-        return $formattedValue;
-    }
-
-    /**
-     * When not used in a React form factory context, this adds the schema data to SilverStripe template
-     * rendered attributes lists
-     *
-     * @return array
-     */
-    public function getAttributes()
-    {
-        $attributes = parent::getAttributes();
-        $attributes['data-schema'] = json_encode($this->getSchemaData());
-        return $attributes;
-    }
-
-    /**
-     * @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);
-        }
-
-        foreach ($source as $value) {
-            $options->push(
-                ArrayData::create([
-                    'Title' => $value,
-                    'Value' => $value,
-                ])
-            );
-        }
-
-        return $options;
-    }
-
-    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 ($value === null) {
-            $value = [];
-        }
-
-        return parent::setValue(array_filter($value));
-    }
-
-    public function saveInto(DataObjectInterface $record)
-    {
-        parent::saveInto($record);
-
-        $name = $this->getName();
-
-        $record->$name = implode(',', $this->Value());
-        $record->write();
-    }
-
-    /**
-     * Returns a JSON string of tags, for lazy loading.
-     *
-     * @param  HTTPRequest $request
-     * @return HTTPResponse
-     */
-    public function suggest(HTTPRequest $request)
-    {
-        $responseBody = json_encode(
-            ['items' => $this->getTags($request->getVar('term'))]
-        );
-
-        $response = HTTPResponse::create();
-        $response->addHeader('Content-Type', 'application/json');
-        $response->setBody($responseBody);
-
-        return $response;
-    }
-
-    /**
-     * Returns array of arrays representing tags that partially match the given search term
-     *
-     * @param string $term
-     * @return array
-     */
-    protected function getTags($term)
-    {
-        $items = [];
-        foreach ($this->getOptions() as $i => $tag) {
-            /** @var ArrayData $tag */
-            $tagValue = $tag->Value;
-            // Map into a distinct list (prevent duplicates)
-            if (stripos($tagValue, $term) !== false && !array_key_exists($tagValue, $items)) {
-                $items[$tagValue] = [
-                    'id' => $tag->Title,
-                    'text' => $tag->Value,
-                ];
-            }
-        }
-        // @todo do we actually need lazy loading limits for StringTagField?
-        return array_slice(array_values($items), 0, $this->getLazyLoadItemLimit());
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getCanCreate()
-    {
-        return $this->canCreate;
-    }
-
-    /**
-     * @param bool $canCreate
-     * @return $this
-     */
-    public function setCanCreate($canCreate)
-    {
-        $this->canCreate = $canCreate;
-
-        return $this;
-    }
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = [
+		'suggest',
+	];
+
+	/**
+	 * @var bool
+	 */
+	protected $shouldLazyLoad = false;
+
+	/**
+	 * @var int
+	 */
+	protected $lazyLoadItemLimit = 10;
+
+	/**
+	 * @var bool
+	 */
+	protected $canCreate = true;
+
+	/**
+	 * @var null|DataObject
+	 */
+	protected $record;
+
+	/**
+	 * @var bool
+	 */
+	protected $isMultiple = true;
+
+	/**
+	 * @return bool
+	 */
+	public function getShouldLazyLoad()
+	{
+		return $this->shouldLazyLoad;
+	}
+
+	/**
+	 * @param bool $shouldLazyLoad
+	 * @return $this
+	 */
+	public function setShouldLazyLoad($shouldLazyLoad)
+	{
+		$this->shouldLazyLoad = $shouldLazyLoad;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLazyLoadItemLimit()
+	{
+		return $this->lazyLoadItemLimit;
+	}
+
+	/**
+	 * @param int $lazyLoadItemLimit
+	 * @return $this
+	 */
+	public function setLazyLoadItemLimit($lazyLoadItemLimit)
+	{
+		$this->lazyLoadItemLimit = $lazyLoadItemLimit;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getIsMultiple()
+	{
+		return $this->isMultiple;
+	}
+
+	/**
+	 * @param bool $isMultiple
+	 * @return $this
+	 */
+	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;
+	}
+
+	public function Field($properties = [])
+	{
+		$this->addExtraClass('ss-tag-field');
+
+		return $this
+			->customise($properties)
+			->renderWith(TagField::class);
+	}
+
+	/**
+	 * Provide TagField data to the JSON schema for the frontend component
+	 *
+	 * @return array
+	 */
+	public function getSchemaDataDefaults()
+	{
+		$schema = array_merge(
+			parent::getSchemaDataDefaults(),
+			[
+				'name' => $this->getName() . '[]',
+				'lazyLoad' => $this->getShouldLazyLoad(),
+				'creatable' => $this->getCanCreate(),
+				'multi' => $this->getIsMultiple(),
+				'value' => $this->formatOptions($this->Value()),
+				'disabled' => $this->isDisabled() || $this->isReadonly(),
+			]
+		);
+
+		if (!$this->getShouldLazyLoad()) {
+			$schema['options'] = $this->getOptions()->toNestedArray();
+		} else {
+			$schema['optionUrl'] = $this->getSuggestURL();
+		}
+
+		return $schema;
+	}
+
+	protected function formatOptions($fieldValue)
+	{
+		if (empty($fieldValue)) {
+			return [];
+		}
+
+		$formattedValue = [];
+		foreach ($fieldValue as $value) {
+			$formattedValue[] = [
+				'Title' => $value,
+				'Value' => $value,
+			];
+		}
+		return $formattedValue;
+	}
+
+	/**
+	 * When not used in a React form factory context, this adds the schema data to SilverStripe template
+	 * rendered attributes lists
+	 *
+	 * @return array
+	 */
+	public function getAttributes()
+	{
+		$attributes = parent::getAttributes();
+		$attributes['data-schema'] = json_encode($this->getSchemaData());
+		return $attributes;
+	}
+
+	/**
+	 * @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);
+		}
+
+		foreach ($source as $value) {
+			$options->push(
+				ArrayData::create([
+					'Title' => $value,
+					'Value' => $value,
+				])
+			);
+		}
+
+		return $options;
+	}
+
+	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 ($value === null) {
+			$value = [];
+		}
+
+		return parent::setValue(array_filter($value));
+	}
+
+	public function saveInto(DataObjectInterface $record)
+	{
+		parent::saveInto($record);
+
+		$name = $this->getName();
+
+		$record->$name = implode(',', $this->Value());
+		$record->write();
+	}
+
+	/**
+	 * Returns a JSON string of tags, for lazy loading.
+	 *
+	 * @param  HTTPRequest $request
+	 * @return HTTPResponse
+	 */
+	public function suggest(HTTPRequest $request)
+	{
+		$responseBody = json_encode(
+			['items' => $this->getTags($request->getVar('term'))]
+		);
+
+		$response = HTTPResponse::create();
+		$response->addHeader('Content-Type', 'application/json');
+		$response->setBody($responseBody);
+
+		return $response;
+	}
+
+	/**
+	 * Returns array of arrays representing tags that partially match the given search term
+	 *
+	 * @param string $term
+	 * @return array
+	 */
+	protected function getTags($term)
+	{
+		$items = [];
+		foreach ($this->getOptions() as $i => $tag) {
+			/** @var ArrayData $tag */
+			$tagValue = $tag->Value;
+			// Map into a distinct list (prevent duplicates)
+			if (stripos($tagValue, $term) !== false && !array_key_exists($tagValue, $items)) {
+				$items[$tagValue] = [
+					'id' => $tag->Title,
+					'text' => $tag->Value,
+				];
+			}
+		}
+		// @todo do we actually need lazy loading limits for StringTagField?
+		return array_slice(array_values($items), 0, $this->getLazyLoadItemLimit());
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getCanCreate()
+	{
+		return $this->canCreate;
+	}
+
+	/**
+	 * @param bool $canCreate
+	 * @return $this
+	 */
+	public function setCanCreate($canCreate)
+	{
+		$this->canCreate = $canCreate;
+
+		return $this;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
         $schema = array_merge(
             parent::getSchemaDataDefaults(),
             [
-                'name' => $this->getName() . '[]',
+                'name' => $this->getName().'[]',
                 'lazyLoad' => $this->getShouldLazyLoad(),
                 'creatable' => $this->getCanCreate(),
                 'multi' => $this->getIsMultiple(),

src/TagField.php

Indentation +453 added lines, -453 removed lines

@@ -24,457 +24,457 @@
  */
 class TagField extends DropdownField
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = [
-        'suggest',
-    ];
-
-    /**
-     * @var bool
-     */
-    protected $shouldLazyLoad = false;
-
-    /**
-     * @var int
-     */
-    protected $lazyLoadItemLimit = 10;
-
-    /**
-     * @var bool
-     */
-    protected $canCreate = true;
-
-    /**
-     * @var string
-     */
-    protected $titleField = 'Title';
-
-    /**
-     * @var DataList
-     */
-    protected $sourceList;
-
-    /**
-     * @var bool
-     */
-    protected $isMultiple = true;
-
-    /**
-     * @param string $name
-     * @param string $title
-     * @param null|DataList $source
-     * @param null|DataList $value
-     * @param string $titleField
-     */
-    public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
-    {
-        $this->setSourceList($source);
-        $this->setTitleField($titleField);
-        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;
-    }
-
-    /**
-     * Get the DataList source. The 4.x upgrade for SelectField::setSource starts to convert this to an array
-     * @return DataList
-     */
-    public function getSourceList()
-    {
-        return $this->sourceList;
-    }
-
-    /**
-     * Set the model class name for tags
-     * @param  DataList $className
-     * @return self
-     */
-    public function setSourceList($sourceList)
-    {
-        $this->sourceList = $sourceList;
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function Field($properties = [])
-    {
-        $this->addExtraClass('ss-tag-field');
-
-        return $this->customise($properties)->renderWith(self::class);
-    }
-
-    /**
-     * Provide TagField data to the JSON schema for the frontend component
-     *
-     * @return array
-     */
-    public function getSchemaDataDefaults()
-    {
-        $schema = array_merge(
-            parent::getSchemaDataDefaults(),
-            [
-                'name' => $this->getName() . '[]',
-                'lazyLoad' => $this->getShouldLazyLoad(),
-                'creatable' => $this->getCanCreate(),
-                'multi' => $this->getIsMultiple(),
-                'value' => $this->Value(),
-                'disabled' => $this->isDisabled() || $this->isReadonly(),
-            ]
-        );
-
-        if (!$this->getShouldLazyLoad()) {
-            $schema['options'] = array_values($this->getOptions()->toNestedArray());
-        } else {
-            if ($this->Value()) {
-                $schema['value'] = $this->getOptions(true)->toNestedArray();
-            }
-            $schema['optionUrl'] = $this->getSuggestURL();
-        }
-
-        return $schema;
-    }
-
-    /**
-     * When not used in a React form factory context, this adds the schema data to SilverStripe template
-     * rendered attributes lists
-     *
-     * @return array
-     */
-    public function getAttributes()
-    {
-        $attributes = parent::getAttributes();
-        $attributes['data-schema'] = json_encode($this->getSchemaData());
-        return $attributes;
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSuggestURL()
-    {
-        return Controller::join_links($this->Link(), 'suggest');
-    }
-
-    /**
-     * @param bool $onlySelected Only return options that are selected
-     * @return ArrayList
-     */
-    protected function getOptions($onlySelected = false)
-    {
-        $source = $this->getSourceList();
-
-        if (!$source) {
-            $source = ArrayList::create();
-        }
-
-        $dataClass = $source->dataClass();
-        $titleField = $this->getTitleField();
-        $values = $this->Value();
-
-        if ($values) {
-            if (is_array($values)) {
-                $values = DataList::create($dataClass)->filter($titleField, $values);
-            }
-        }
-        if ($onlySelected) {
-            $source = $values;
-        }
-
-        return $source instanceof DataList ? $this->formatOptions($source) : ArrayList::create();
-    }
-
-    /**
-     * @param DataList $source
-     * @return ArrayList
-     */
-    protected function formatOptions(DataList $source)
-    {
-        $options = ArrayList::create();
-        $titleField = $this->getTitleField();
-
-        foreach ($source as $object) {
-            $options->push(
-                ArrayData::create([
-                    'Title' => $object->$titleField,
-                    'Value' => $object->Title,
-                ])
-            );
-        }
-
-        return $options;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setValue($value, $source = null)
-    {
-        if ($source instanceof DataObject) {
-            $name = $this->getName();
-
-            if ($source->hasMethod($name)) {
-                $value = $source->$name()->column($this->getTitleField());
-            }
-        } elseif ($value instanceof SS_List) {
-            $value = $value->column($this->getTitleField());
-        }
-
-        if (!is_array($value)) {
-            return parent::setValue($value);
-        }
-
-        return parent::setValue(array_filter($value));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        parent::saveInto($record);
-
-        $name = $this->getName();
-        $titleField = $this->getTitleField();
-        $values = $this->Value();
-        $relation = $record->$name();
-        $ids = [];
-
-        if (!$values) {
-            $values = [];
-        }
-        if (empty($record) || 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|bool
-     */
-    protected function getOrCreateTag($term)
-    {
-        // Check if existing record can be found
-        $source = $this->getSourceList();
-        $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;
-        }
-
-        return false;
-    }
-
-    /**
-     * Returns a JSON string of tags, for lazy loading.
-     *
-     * @param  HTTPRequest $request
-     * @return HTTPResponse
-     */
-    public function suggest(HTTPRequest $request)
-    {
-        $tags = $this->getTags($request->getVar('term'));
-
-        $response = HTTPResponse::create();
-        $response->addHeader('Content-Type', 'application/json');
-        $response->setBody(json_encode(['items' => $tags]));
-
-        return $response;
-    }
-
-    /**
-     * Returns array of arrays representing tags.
-     *
-     * @param  string $term
-     * @return array
-     */
-    protected function getTags($term)
-    {
-        $source = $this->getSourceList();
-
-        $titleField = $this->getTitleField();
-
-        $query = $source
-            ->filter($titleField . ':PartialMatch:nocase', $term)
-            ->sort($titleField)
-            ->limit($this->getLazyLoadItemLimit());
-
-        // Map into a distinct list
-        $items = [];
-        $titleField = $this->getTitleField();
-        foreach ($query->map('ID', $titleField) as $id => $title) {
-            $items[$title] = [
-                '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;
-    }
-
-    /**
-     * Converts the field to a readonly variant.
-     *
-     * @return ReadonlyTagField
-     */
-    public function performReadonlyTransformation()
-    {
-        /** @var ReadonlyTagField $copy */
-        $copy = $this->castedCopy(ReadonlyTagField::class);
-        $copy->setSourceList($this->getSourceList());
-        return $copy;
-    }
-
-    /**
-     * Prevent the default, which would return "tag"
-     *
-     * @return string
-     */
-    public function Type()
-    {
-        return '';
-    }
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = [
+		'suggest',
+	];
+
+	/**
+	 * @var bool
+	 */
+	protected $shouldLazyLoad = false;
+
+	/**
+	 * @var int
+	 */
+	protected $lazyLoadItemLimit = 10;
+
+	/**
+	 * @var bool
+	 */
+	protected $canCreate = true;
+
+	/**
+	 * @var string
+	 */
+	protected $titleField = 'Title';
+
+	/**
+	 * @var DataList
+	 */
+	protected $sourceList;
+
+	/**
+	 * @var bool
+	 */
+	protected $isMultiple = true;
+
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param null|DataList $source
+	 * @param null|DataList $value
+	 * @param string $titleField
+	 */
+	public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
+	{
+		$this->setSourceList($source);
+		$this->setTitleField($titleField);
+		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;
+	}
+
+	/**
+	 * Get the DataList source. The 4.x upgrade for SelectField::setSource starts to convert this to an array
+	 * @return DataList
+	 */
+	public function getSourceList()
+	{
+		return $this->sourceList;
+	}
+
+	/**
+	 * Set the model class name for tags
+	 * @param  DataList $className
+	 * @return self
+	 */
+	public function setSourceList($sourceList)
+	{
+		$this->sourceList = $sourceList;
+		return $this;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function Field($properties = [])
+	{
+		$this->addExtraClass('ss-tag-field');
+
+		return $this->customise($properties)->renderWith(self::class);
+	}
+
+	/**
+	 * Provide TagField data to the JSON schema for the frontend component
+	 *
+	 * @return array
+	 */
+	public function getSchemaDataDefaults()
+	{
+		$schema = array_merge(
+			parent::getSchemaDataDefaults(),
+			[
+				'name' => $this->getName() . '[]',
+				'lazyLoad' => $this->getShouldLazyLoad(),
+				'creatable' => $this->getCanCreate(),
+				'multi' => $this->getIsMultiple(),
+				'value' => $this->Value(),
+				'disabled' => $this->isDisabled() || $this->isReadonly(),
+			]
+		);
+
+		if (!$this->getShouldLazyLoad()) {
+			$schema['options'] = array_values($this->getOptions()->toNestedArray());
+		} else {
+			if ($this->Value()) {
+				$schema['value'] = $this->getOptions(true)->toNestedArray();
+			}
+			$schema['optionUrl'] = $this->getSuggestURL();
+		}
+
+		return $schema;
+	}
+
+	/**
+	 * When not used in a React form factory context, this adds the schema data to SilverStripe template
+	 * rendered attributes lists
+	 *
+	 * @return array
+	 */
+	public function getAttributes()
+	{
+		$attributes = parent::getAttributes();
+		$attributes['data-schema'] = json_encode($this->getSchemaData());
+		return $attributes;
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSuggestURL()
+	{
+		return Controller::join_links($this->Link(), 'suggest');
+	}
+
+	/**
+	 * @param bool $onlySelected Only return options that are selected
+	 * @return ArrayList
+	 */
+	protected function getOptions($onlySelected = false)
+	{
+		$source = $this->getSourceList();
+
+		if (!$source) {
+			$source = ArrayList::create();
+		}
+
+		$dataClass = $source->dataClass();
+		$titleField = $this->getTitleField();
+		$values = $this->Value();
+
+		if ($values) {
+			if (is_array($values)) {
+				$values = DataList::create($dataClass)->filter($titleField, $values);
+			}
+		}
+		if ($onlySelected) {
+			$source = $values;
+		}
+
+		return $source instanceof DataList ? $this->formatOptions($source) : ArrayList::create();
+	}
+
+	/**
+	 * @param DataList $source
+	 * @return ArrayList
+	 */
+	protected function formatOptions(DataList $source)
+	{
+		$options = ArrayList::create();
+		$titleField = $this->getTitleField();
+
+		foreach ($source as $object) {
+			$options->push(
+				ArrayData::create([
+					'Title' => $object->$titleField,
+					'Value' => $object->Title,
+				])
+			);
+		}
+
+		return $options;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setValue($value, $source = null)
+	{
+		if ($source instanceof DataObject) {
+			$name = $this->getName();
+
+			if ($source->hasMethod($name)) {
+				$value = $source->$name()->column($this->getTitleField());
+			}
+		} elseif ($value instanceof SS_List) {
+			$value = $value->column($this->getTitleField());
+		}
+
+		if (!is_array($value)) {
+			return parent::setValue($value);
+		}
+
+		return parent::setValue(array_filter($value));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		parent::saveInto($record);
+
+		$name = $this->getName();
+		$titleField = $this->getTitleField();
+		$values = $this->Value();
+		$relation = $record->$name();
+		$ids = [];
+
+		if (!$values) {
+			$values = [];
+		}
+		if (empty($record) || 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|bool
+	 */
+	protected function getOrCreateTag($term)
+	{
+		// Check if existing record can be found
+		$source = $this->getSourceList();
+		$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;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Returns a JSON string of tags, for lazy loading.
+	 *
+	 * @param  HTTPRequest $request
+	 * @return HTTPResponse
+	 */
+	public function suggest(HTTPRequest $request)
+	{
+		$tags = $this->getTags($request->getVar('term'));
+
+		$response = HTTPResponse::create();
+		$response->addHeader('Content-Type', 'application/json');
+		$response->setBody(json_encode(['items' => $tags]));
+
+		return $response;
+	}
+
+	/**
+	 * Returns array of arrays representing tags.
+	 *
+	 * @param  string $term
+	 * @return array
+	 */
+	protected function getTags($term)
+	{
+		$source = $this->getSourceList();
+
+		$titleField = $this->getTitleField();
+
+		$query = $source
+			->filter($titleField . ':PartialMatch:nocase', $term)
+			->sort($titleField)
+			->limit($this->getLazyLoadItemLimit());
+
+		// Map into a distinct list
+		$items = [];
+		$titleField = $this->getTitleField();
+		foreach ($query->map('ID', $titleField) as $id => $title) {
+			$items[$title] = [
+				'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;
+	}
+
+	/**
+	 * Converts the field to a readonly variant.
+	 *
+	 * @return ReadonlyTagField
+	 */
+	public function performReadonlyTransformation()
+	{
+		/** @var ReadonlyTagField $copy */
+		$copy = $this->castedCopy(ReadonlyTagField::class);
+		$copy->setSourceList($this->getSourceList());
+		return $copy;
+	}
+
+	/**
+	 * Prevent the default, which would return "tag"
+	 *
+	 * @return string
+	 */
+	public function Type()
+	{
+		return '';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -215,7 +215,7 @@ 
         $schema = array_merge(
             parent::getSchemaDataDefaults(),
             [
-                'name' => $this->getName() . '[]',
+                'name' => $this->getName().'[]',
                 'lazyLoad' => $this->getShouldLazyLoad(),
                 'creatable' => $this->getCanCreate(),
                 'multi' => $this->getIsMultiple(),
@@ -426,7 +426,7 @@ 
         $titleField = $this->getTitleField();
 
         $query = $source
-            ->filter($titleField . ':PartialMatch:nocase', $term)
+            ->filter($titleField.':PartialMatch:nocase', $term)
             ->sort($titleField)
             ->limit($this->getLazyLoadItemLimit());
 

tests/StringTagFieldTest.php

Indentation +140 added lines, -140 removed lines

@@ -15,144 +15,144 @@
  */
 class StringTagFieldTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = 'StringTagFieldTest.yml';
-
-    /**
-     * @var array
-     */
-    protected static $extra_dataobjects = [
-        StringTagFieldTestBlogPost::class,
-    ];
-
-    public function testItSavesTagsOnNewRecords()
-    {
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
-
-        $field = new StringTagField('Tags');
-        $field->setValue(['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::class,
-            $name
-        );
-    }
-
-    public function testItSavesTagsOnExistingRecords()
-    {
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $field = new StringTagField('Tags');
-        $field->setValue(['Tag1', 'Tag2']);
-        $field->saveInto($record);
-
-        $this->assertEquals('Tag1,Tag2', $record->Tags);
-    }
-
-    public function testItSuggestsTags()
-    {
-        $field = new StringTagField('SomeField', 'Some field', ['Tag1', 'Tag2'], []);
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'Tag']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'Tag1']);
-
-        $this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
-
-        /**
-         * Case-insensitive tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'TAG1']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * No tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'unknown']);
-
-        $this->assertEquals(
-            '{"items":[]}',
-            $field->suggest($request)->getBody()
-        );
-    }
-
-    public function testGetSchemaDataDefaults()
-    {
-        $form = new Form(null, 'Form', new FieldList(), new FieldList());
-        $field = new StringTagField('TestField', 'Test Field', ['one', 'two']);
-        $field->setForm($form);
-
-        $field
-            ->setShouldLazyLoad(false)
-            ->setCanCreate(false);
-
-        $schema = $field->getSchemaDataDefaults();
-        $this->assertSame('TestField[]', $schema['name']);
-        $this->assertFalse($schema['lazyLoad']);
-        $this->assertFalse($schema['creatable']);
-        $this->assertEquals([
-            ['Title' => 'one', 'Value' => 'one'],
-            ['Title' => 'two', 'Value' => 'two'],
-        ], $schema['options']);
-
-        $field
-            ->setShouldLazyLoad(true)
-            ->setCanCreate(true);
-
-        $schema = $field->getSchemaDataDefaults();
-        $this->assertTrue($schema['lazyLoad']);
-        $this->assertTrue($schema['creatable']);
-        $this->assertContains('suggest', $schema['optionUrl']);
-    }
-
-    public function testSchemaIsAddedToAttributes()
-    {
-        $field = new StringTagField('TestField');
-        $attributes = $field->getAttributes();
-        $this->assertNotEmpty($attributes['data-schema']);
-    }
-
-    /**
-     * @param array $parameters
-     * @return HTTPRequest
-     */
-    protected function getNewRequest(array $parameters)
-    {
-        return new HTTPRequest(
-            'get',
-            'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
-            $parameters
-        );
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = 'StringTagFieldTest.yml';
+
+	/**
+	 * @var array
+	 */
+	protected static $extra_dataobjects = [
+		StringTagFieldTestBlogPost::class,
+	];
+
+	public function testItSavesTagsOnNewRecords()
+	{
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
+
+		$field = new StringTagField('Tags');
+		$field->setValue(['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::class,
+			$name
+		);
+	}
+
+	public function testItSavesTagsOnExistingRecords()
+	{
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$field = new StringTagField('Tags');
+		$field->setValue(['Tag1', 'Tag2']);
+		$field->saveInto($record);
+
+		$this->assertEquals('Tag1,Tag2', $record->Tags);
+	}
+
+	public function testItSuggestsTags()
+	{
+		$field = new StringTagField('SomeField', 'Some field', ['Tag1', 'Tag2'], []);
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag1']);
+
+		$this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
+
+		/**
+		 * Case-insensitive tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'TAG1']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * No tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'unknown']);
+
+		$this->assertEquals(
+			'{"items":[]}',
+			$field->suggest($request)->getBody()
+		);
+	}
+
+	public function testGetSchemaDataDefaults()
+	{
+		$form = new Form(null, 'Form', new FieldList(), new FieldList());
+		$field = new StringTagField('TestField', 'Test Field', ['one', 'two']);
+		$field->setForm($form);
+
+		$field
+			->setShouldLazyLoad(false)
+			->setCanCreate(false);
+
+		$schema = $field->getSchemaDataDefaults();
+		$this->assertSame('TestField[]', $schema['name']);
+		$this->assertFalse($schema['lazyLoad']);
+		$this->assertFalse($schema['creatable']);
+		$this->assertEquals([
+			['Title' => 'one', 'Value' => 'one'],
+			['Title' => 'two', 'Value' => 'two'],
+		], $schema['options']);
+
+		$field
+			->setShouldLazyLoad(true)
+			->setCanCreate(true);
+
+		$schema = $field->getSchemaDataDefaults();
+		$this->assertTrue($schema['lazyLoad']);
+		$this->assertTrue($schema['creatable']);
+		$this->assertContains('suggest', $schema['optionUrl']);
+	}
+
+	public function testSchemaIsAddedToAttributes()
+	{
+		$field = new StringTagField('TestField');
+		$attributes = $field->getAttributes();
+		$this->assertNotEmpty($attributes['data-schema']);
+	}
+
+	/**
+	 * @param array $parameters
+	 * @return HTTPRequest
+	 */
+	protected function getNewRequest(array $parameters)
+	{
+		return new HTTPRequest(
+			'get',
+			'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
+			$parameters
+		);
+	}
 }

tests/TagFieldTest.php

Indentation +369 added lines, -369 removed lines

@@ -20,373 +20,373 @@
  */
 class TagFieldTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = 'TagFieldTest.yml';
-
-    /**
-     * @var array
-     */
-    protected static $extra_dataobjects = [
-        TagFieldTestBlogTag::class,
-        TagFieldTestBlogPost::class,
-    ];
-
-    public function testItSavesLinksToNewTagsOnNewRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
-        $field->setValue(['Tag3', 'Tag4']);
-        $field->saveInto($record);
-        $record->write();
-        $this->compareExpectedAndActualTags(
-            ['Tag3', 'Tag4'],
-            $record
-        );
-    }
-
-    /**
-     * @param string $name
-     *
-     * @return TagFieldTestBlogPost
-     */
-    protected function getNewTagFieldTestBlogPost($name)
-    {
-        return $this->objFromFixture(
-            TagFieldTestBlogPost::class,
-            $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::class));
-        $field->setValue(['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::class));
-        $field->setValue(['Tag1', 'Tag2']);
-        $field->saveInto($record);
-
-        $record->write();
-
-        $this->compareExpectedAndActualTags(
-            ['Tag1', 'Tag2'],
-            $record
-        );
-    }
-
-    public function testItSavesLinksToExistingTagsOnExistingRecords()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
-        $field->setValue(['Tag1', 'Tag2']);
-        $field->saveInto($record);
-
-        $this->compareExpectedAndActualTags(
-            ['Tag1', 'Tag2'],
-            $record
-        );
-    }
-
-    /**
-     * Ensure that {@see TagField::saveInto} respects existing tags
-     */
-    public function testSaveDuplicateTags()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost2');
-        $record->write();
-        $tag2ID = $this->idFromFixture(TagFieldTestBlogTag::class, 'Tag2');
-
-        // Check tags before write
-        $this->compareExpectedAndActualTags(
-            ['Tag1', '222'],
-            $record
-        );
-        $this->compareTagLists(
-            ['Tag1', '222'],
-            TagFieldTestBlogTag::get()
-        );
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
-
-        // Write new tags
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
-        $field->setValue(['222', 'Tag3']);
-        $field->saveInto($record);
-
-        // Check only one new tag was added
-        $this->compareExpectedAndActualTags(
-            ['222', 'Tag3'],
-            $record
-        );
-
-        // Ensure that only one new dataobject was added and that tag2s id has not changed
-        $this->compareTagLists(
-            ['Tag1', '222', 'Tag3'],
-            TagFieldTestBlogTag::get()
-        );
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
-    }
-
-    public function testItSuggestsTags()
-    {
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'Tag']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(['term' => '222']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"222","text":"222"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Case-insensitive tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'TAG1']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * No tag title match.
-         */
-        $request = $this->getNewRequest(['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);
-
-        /**
-         * Partial tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'Tag']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Exact tag title match.
-         */
-        $request = $this->getNewRequest(['term' => 'Tag1']);
-
-        $this->assertEquals(
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
-            $field->suggest($request)->getBody()
-        );
-
-        /**
-         * Excluded item doesn't appear in matches
-         */
-        $request = $this->getNewRequest(['term' => 'Tag2']);
-
-        $this->assertEquals(
-            '{"items":[]}',
-            $field->suggest($request)->getBody()
-        );
-    }
-
-    /**
-     * @param array $parameters
-     *
-     * @return HTTPRequest
-     */
-    protected function getNewRequest(array $parameters)
-    {
-        return new HTTPRequest(
-            'get',
-            'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
-            $parameters
-        );
-    }
-
-    public function testItDisplaysValuesFromRelations()
-    {
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
-        $record->write();
-
-        $form = new Form(
-            new TagFieldTestController(),
-            'Form',
-            new FieldList(
-                $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class))
-            ),
-            new FieldList()
-        );
-
-        $form->loadDataFrom(
-            $this->objFromFixture(TagFieldTestBlogPost::class, 'BlogPost2')
-        );
-
-        $ids = TagFieldTestBlogTag::get()->column('Title');
-
-        $this->assertEquals($field->Value(), $ids);
-    }
-
-    public function testItIgnoresNewTagsIfCannotCreate()
-    {
-        $this->markTestSkipped(
-            'This test has not been updated yet.'
-        );
-
-        $record = new TagFieldTestBlogPost();
-        $record->write();
-
-        $tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
-
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class), [$tag->Title, 'Tag3']);
-        $field->setCanCreate(false);
-        $field->saveInto($record);
-
-        /**
-         * @var TagFieldTestBlogPost $record
-         */
-        $record = DataObject::get_by_id(TagFieldTestBlogPost::class, $record->ID);
-
-        $this->compareExpectedAndActualTags(
-            ['Tag1'],
-            $record
-        );
-    }
-
-    /**
-     * Test you can save without a source set
-     */
-    public function testSaveEmptySource()
-    {
-        $record = new TagFieldTestBlogPost();
-        $record->write();
-
-        // Clear database of tags
-        TagFieldTestBlogTag::get()->removeAll();
-
-        $field = new TagField('Tags', '', TagFieldTestBlogTag::get());
-        $field->setValue(['New Tag']);
-        $field->setCanCreate(true);
-        $field->saveInto($record);
-
-        $tag = TagFieldTestBlogTag::get()->first();
-        $this->assertNotEmpty($tag);
-        $this->assertEquals('New Tag', $tag->Title);
-        $record = TagFieldTestBlogPost::get()->byID($record->ID);
-        $this->assertEquals(
-            $tag->ID,
-            $record->Tags()->first()->ID
-        );
-    }
-
-    /**
-     * Test read only fields are returned
-     */
-    public function testReadonlyTransformation()
-    {
-        $field = new TagField('Tags', '', TagFieldTestBlogTag::get());
-        $readOnlyField = $field->performReadonlyTransformation();
-        $this->assertInstanceOf(ReadonlyTagField::class, $readOnlyField);
-    }
-
-    public function testGetSchemaDataDefaults()
-    {
-        $form = new Form(null, 'Form', new FieldList(), new FieldList());
-        $field = new TagField('TestField', 'Test Field', TagFieldTestBlogTag::get());
-        $field->setForm($form);
-
-        $field
-            ->setShouldLazyLoad(false)
-            ->setCanCreate(false);
-
-        $schema = $field->getSchemaDataDefaults();
-        $this->assertSame('TestField[]', $schema['name']);
-        $this->assertFalse($schema['lazyLoad']);
-        $this->assertFalse($schema['creatable']);
-        $this->assertEquals([
-            ['Title' => 'Tag1', 'Value' => 'Tag1'],
-            ['Title' => '222', 'Value' => '222'],
-        ], $schema['options']);
-
-        $field
-            ->setShouldLazyLoad(true)
-            ->setCanCreate(true);
-
-        $schema = $field->getSchemaDataDefaults();
-        $this->assertTrue($schema['lazyLoad']);
-        $this->assertTrue($schema['creatable']);
-        $this->assertContains('suggest', $schema['optionUrl']);
-    }
-
-    public function testSchemaIsAddedToAttributes()
-    {
-        $field = new TagField('TestField');
-        $attributes = $field->getAttributes();
-        $this->assertNotEmpty($attributes['data-schema']);
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = 'TagFieldTest.yml';
+
+	/**
+	 * @var array
+	 */
+	protected static $extra_dataobjects = [
+		TagFieldTestBlogTag::class,
+		TagFieldTestBlogPost::class,
+	];
+
+	public function testItSavesLinksToNewTagsOnNewRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
+		$field->setValue(['Tag3', 'Tag4']);
+		$field->saveInto($record);
+		$record->write();
+		$this->compareExpectedAndActualTags(
+			['Tag3', 'Tag4'],
+			$record
+		);
+	}
+
+	/**
+	 * @param string $name
+	 *
+	 * @return TagFieldTestBlogPost
+	 */
+	protected function getNewTagFieldTestBlogPost($name)
+	{
+		return $this->objFromFixture(
+			TagFieldTestBlogPost::class,
+			$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::class));
+		$field->setValue(['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::class));
+		$field->setValue(['Tag1', 'Tag2']);
+		$field->saveInto($record);
+
+		$record->write();
+
+		$this->compareExpectedAndActualTags(
+			['Tag1', 'Tag2'],
+			$record
+		);
+	}
+
+	public function testItSavesLinksToExistingTagsOnExistingRecords()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
+		$field->setValue(['Tag1', 'Tag2']);
+		$field->saveInto($record);
+
+		$this->compareExpectedAndActualTags(
+			['Tag1', 'Tag2'],
+			$record
+		);
+	}
+
+	/**
+	 * Ensure that {@see TagField::saveInto} respects existing tags
+	 */
+	public function testSaveDuplicateTags()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost2');
+		$record->write();
+		$tag2ID = $this->idFromFixture(TagFieldTestBlogTag::class, 'Tag2');
+
+		// Check tags before write
+		$this->compareExpectedAndActualTags(
+			['Tag1', '222'],
+			$record
+		);
+		$this->compareTagLists(
+			['Tag1', '222'],
+			TagFieldTestBlogTag::get()
+		);
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
+
+		// Write new tags
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
+		$field->setValue(['222', 'Tag3']);
+		$field->saveInto($record);
+
+		// Check only one new tag was added
+		$this->compareExpectedAndActualTags(
+			['222', 'Tag3'],
+			$record
+		);
+
+		// Ensure that only one new dataobject was added and that tag2s id has not changed
+		$this->compareTagLists(
+			['Tag1', '222', 'Tag3'],
+			TagFieldTestBlogTag::get()
+		);
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
+	}
+
+	public function testItSuggestsTags()
+	{
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => '222']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"222","text":"222"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Case-insensitive tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'TAG1']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * No tag title match.
+		 */
+		$request = $this->getNewRequest(['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);
+
+		/**
+		 * Partial tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Exact tag title match.
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag1']);
+
+		$this->assertEquals(
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
+			$field->suggest($request)->getBody()
+		);
+
+		/**
+		 * Excluded item doesn't appear in matches
+		 */
+		$request = $this->getNewRequest(['term' => 'Tag2']);
+
+		$this->assertEquals(
+			'{"items":[]}',
+			$field->suggest($request)->getBody()
+		);
+	}
+
+	/**
+	 * @param array $parameters
+	 *
+	 * @return HTTPRequest
+	 */
+	protected function getNewRequest(array $parameters)
+	{
+		return new HTTPRequest(
+			'get',
+			'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
+			$parameters
+		);
+	}
+
+	public function testItDisplaysValuesFromRelations()
+	{
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
+		$record->write();
+
+		$form = new Form(
+			new TagFieldTestController(),
+			'Form',
+			new FieldList(
+				$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class))
+			),
+			new FieldList()
+		);
+
+		$form->loadDataFrom(
+			$this->objFromFixture(TagFieldTestBlogPost::class, 'BlogPost2')
+		);
+
+		$ids = TagFieldTestBlogTag::get()->column('Title');
+
+		$this->assertEquals($field->Value(), $ids);
+	}
+
+	public function testItIgnoresNewTagsIfCannotCreate()
+	{
+		$this->markTestSkipped(
+			'This test has not been updated yet.'
+		);
+
+		$record = new TagFieldTestBlogPost();
+		$record->write();
+
+		$tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
+
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class), [$tag->Title, 'Tag3']);
+		$field->setCanCreate(false);
+		$field->saveInto($record);
+
+		/**
+		 * @var TagFieldTestBlogPost $record
+		 */
+		$record = DataObject::get_by_id(TagFieldTestBlogPost::class, $record->ID);
+
+		$this->compareExpectedAndActualTags(
+			['Tag1'],
+			$record
+		);
+	}
+
+	/**
+	 * Test you can save without a source set
+	 */
+	public function testSaveEmptySource()
+	{
+		$record = new TagFieldTestBlogPost();
+		$record->write();
+
+		// Clear database of tags
+		TagFieldTestBlogTag::get()->removeAll();
+
+		$field = new TagField('Tags', '', TagFieldTestBlogTag::get());
+		$field->setValue(['New Tag']);
+		$field->setCanCreate(true);
+		$field->saveInto($record);
+
+		$tag = TagFieldTestBlogTag::get()->first();
+		$this->assertNotEmpty($tag);
+		$this->assertEquals('New Tag', $tag->Title);
+		$record = TagFieldTestBlogPost::get()->byID($record->ID);
+		$this->assertEquals(
+			$tag->ID,
+			$record->Tags()->first()->ID
+		);
+	}
+
+	/**
+	 * Test read only fields are returned
+	 */
+	public function testReadonlyTransformation()
+	{
+		$field = new TagField('Tags', '', TagFieldTestBlogTag::get());
+		$readOnlyField = $field->performReadonlyTransformation();
+		$this->assertInstanceOf(ReadonlyTagField::class, $readOnlyField);
+	}
+
+	public function testGetSchemaDataDefaults()
+	{
+		$form = new Form(null, 'Form', new FieldList(), new FieldList());
+		$field = new TagField('TestField', 'Test Field', TagFieldTestBlogTag::get());
+		$field->setForm($form);
+
+		$field
+			->setShouldLazyLoad(false)
+			->setCanCreate(false);
+
+		$schema = $field->getSchemaDataDefaults();
+		$this->assertSame('TestField[]', $schema['name']);
+		$this->assertFalse($schema['lazyLoad']);
+		$this->assertFalse($schema['creatable']);
+		$this->assertEquals([
+			['Title' => 'Tag1', 'Value' => 'Tag1'],
+			['Title' => '222', 'Value' => '222'],
+		], $schema['options']);
+
+		$field
+			->setShouldLazyLoad(true)
+			->setCanCreate(true);
+
+		$schema = $field->getSchemaDataDefaults();
+		$this->assertTrue($schema['lazyLoad']);
+		$this->assertTrue($schema['creatable']);
+		$this->assertContains('suggest', $schema['optionUrl']);
+	}
+
+	public function testSchemaIsAddedToAttributes()
+	{
+		$field = new TagField('TestField');
+		$attributes = $field->getAttributes();
+		$this->assertNotEmpty($attributes['data-schema']);
+	}
 }