silverstripe / silverstripe-tagfield

src/TagField.php

Indentation +486 added lines, -486 removed lines

@@ -26,491 +26,491 @@
  */
 class TagField extends DropdownField
 {
-    /**
-     * @var array
-     */
-    private 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 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 = null, $value = null, $titleField = 'Title')
-    {
-        $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.
-     * If empty use getSource() for array version
-     *
-     * @return DataList
-     */
-    public function getSourceList()
-    {
-        return $this->sourceList;
-    }
-
-    /**
-     * Set the model class name for tags
-     *
-     * @param DataList $sourceList
-     * @return self
-     */
-    public function setSourceList($sourceList)
-    {
-        $this->sourceList = $sourceList;
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function Field($properties = array())
-    {
-        Requirements::css('silverstripe/tagfield:css/select2.min.css');
-        Requirements::css('silverstripe/tagfield:css/TagField.css');
-
-        Requirements::javascript('silverstripe/tagfield:js/select2.js');
-        Requirements::javascript('silverstripe/tagfield: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()
-            ));
-        }
-
-        $this->setAttribute('data-can-create', (int) $this->getCanCreate());
-
-        return $this
-            ->customise($properties)
-            ->renderWith(self::class);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSuggestURL()
-    {
-        return Controller::join_links($this->Link(), 'suggest');
-    }
-
-    /**
-     * @return ArrayList
-     */
-    protected function getOptions()
-    {
-        $options = ArrayList::create();
-
-        $source = $this->getSourceList();
-
-        if (!$source) {
-            $source = ArrayList::create();
-        }
-
-        $dataClass = $source->dataClass();
-
-        $values = $this->Value();
-
-        if (!$values) {
-            return $options;
-        }
-
-        if (is_array($values)) {
-            $values = DataList::create($dataClass)->filter($this->getTitleField(), $values);
-        }
-
-        $ids = $values->column($this->getTitleField());
-
-        $titleField = $this->getTitleField();
+	/**
+	 * @var array
+	 */
+	private 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 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 = null, $value = null, $titleField = 'Title')
+	{
+		$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.
+	 * If empty use getSource() for array version
+	 *
+	 * @return DataList
+	 */
+	public function getSourceList()
+	{
+		return $this->sourceList;
+	}
+
+	/**
+	 * Set the model class name for tags
+	 *
+	 * @param DataList $sourceList
+	 * @return self
+	 */
+	public function setSourceList($sourceList)
+	{
+		$this->sourceList = $sourceList;
+		return $this;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function Field($properties = array())
+	{
+		Requirements::css('silverstripe/tagfield:css/select2.min.css');
+		Requirements::css('silverstripe/tagfield:css/TagField.css');
+
+		Requirements::javascript('silverstripe/tagfield:js/select2.js');
+		Requirements::javascript('silverstripe/tagfield: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()
+			));
+		}
+
+		$this->setAttribute('data-can-create', (int) $this->getCanCreate());
+
+		return $this
+			->customise($properties)
+			->renderWith(self::class);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSuggestURL()
+	{
+		return Controller::join_links($this->Link(), 'suggest');
+	}
+
+	/**
+	 * @return ArrayList
+	 */
+	protected function getOptions()
+	{
+		$options = ArrayList::create();
+
+		$source = $this->getSourceList();
+
+		if (!$source) {
+			$source = ArrayList::create();
+		}
+
+		$dataClass = $source->dataClass();
+
+		$values = $this->Value();
+
+		if (!$values) {
+			return $options;
+		}
+
+		if (is_array($values)) {
+			$values = DataList::create($dataClass)->filter($this->getTitleField(), $values);
+		}
+
+		$ids = $values->column($this->getTitleField());
+
+		$titleField = $this->getTitleField();
         
-        if ($this->shouldLazyLoad) {
-            // only render options that are selected as everything else should be lazy loaded, and or loaded by the form
-            foreach ($values as $value) {
-                $options->push(
-                    ArrayData::create(array(
-                        'Title' => $value->$titleField,
-                        'Value' => $value->Title,
-                        'Selected' => true, // only values are iterated.
-                    ))
-                );
-            }
-            return $options;
-        }
-
-        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($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));
-    }
-
-    /**
-     * Gets the source array if required
-     *
-     * Note: this is expensive for a SS_List
-     *
-     * @return array
-     */
-    public function getSource()
-    {
-        if (is_null($this->source)) {
-            $this->source = $this->getListMap($this->getSourceList());
-        }
-        return $this->source;
-    }
-
-    /**
-     * Intercept DataList source
-     *
-     * @param mixed $source
-     * @return $this
-     */
-    public function setSource($source)
-    {
-        // When setting a datalist force internal list to null
-        if ($source instanceof DataList) {
-            $this->source = null;
-            $this->setSourceList($source);
-        } else {
-            parent::setSource($source);
-        }
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAttributes()
-    {
-        return array_merge(
-            parent::getAttributes(),
-            [
-                'name' => $this->getName() . '[]',
-                'style'=> 'width: 100%'
-            ]
-        );
-    }
-
-    /**
-     * @param DataObject|DataObjectInterface $record DataObject to save data into
-     * @throws Exception
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        parent::saveInto($record);
-
-        $name = $this->getName();
-        $titleField = $this->getTitleField();
-        $values = $this->Value();
-
-        /** @var Relation $relation */
-        $relation = $record->$name();
-        $ids = array();
-
-        if (!$values) {
-            $values = array();
-        }
-        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|false
-     */
-    protected function getOrCreateTag($term)
-    {
-        // Check if existing record can be found
-        $source = $this->getSourceList();
-        if (!$source) {
-            return false;
-        }
-
-        $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  HTTPRequest $request
-     * @return HTTPResponse
-     */
-    public function suggest(HTTPRequest $request)
-    {
-        $tags = $this->getTags($request->getVar('term'));
-
-        $response = new 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)
-    {
-        $source = $this->getSourceList();
-        if (!$source) {
-            return [];
-        }
-
-        $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;
-    }
-
-    /**
-     * 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;
-    }
+		if ($this->shouldLazyLoad) {
+			// only render options that are selected as everything else should be lazy loaded, and or loaded by the form
+			foreach ($values as $value) {
+				$options->push(
+					ArrayData::create(array(
+						'Title' => $value->$titleField,
+						'Value' => $value->Title,
+						'Selected' => true, // only values are iterated.
+					))
+				);
+			}
+			return $options;
+		}
+
+		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($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));
+	}
+
+	/**
+	 * Gets the source array if required
+	 *
+	 * Note: this is expensive for a SS_List
+	 *
+	 * @return array
+	 */
+	public function getSource()
+	{
+		if (is_null($this->source)) {
+			$this->source = $this->getListMap($this->getSourceList());
+		}
+		return $this->source;
+	}
+
+	/**
+	 * Intercept DataList source
+	 *
+	 * @param mixed $source
+	 * @return $this
+	 */
+	public function setSource($source)
+	{
+		// When setting a datalist force internal list to null
+		if ($source instanceof DataList) {
+			$this->source = null;
+			$this->setSourceList($source);
+		} else {
+			parent::setSource($source);
+		}
+		return $this;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getAttributes()
+	{
+		return array_merge(
+			parent::getAttributes(),
+			[
+				'name' => $this->getName() . '[]',
+				'style'=> 'width: 100%'
+			]
+		);
+	}
+
+	/**
+	 * @param DataObject|DataObjectInterface $record DataObject to save data into
+	 * @throws Exception
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		parent::saveInto($record);
+
+		$name = $this->getName();
+		$titleField = $this->getTitleField();
+		$values = $this->Value();
+
+		/** @var Relation $relation */
+		$relation = $record->$name();
+		$ids = array();
+
+		if (!$values) {
+			$values = array();
+		}
+		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|false
+	 */
+	protected function getOrCreateTag($term)
+	{
+		// Check if existing record can be found
+		$source = $this->getSourceList();
+		if (!$source) {
+			return false;
+		}
+
+		$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  HTTPRequest $request
+	 * @return HTTPResponse
+	 */
+	public function suggest(HTTPRequest $request)
+	{
+		$tags = $this->getTags($request->getVar('term'));
+
+		$response = new 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)
+	{
+		$source = $this->getSourceList();
+		if (!$source) {
+			return [];
+		}
+
+		$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;
+	}
+
+	/**
+	 * 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;
+	}
 }