silverstripe / silverstripe-tagfield

src/TagField.php

Indentation +525 added lines, -525 removed lines

@@ -26,529 +26,529 @@
  */
 class TagField extends MultiSelectField
 {
-    /**
-     * @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;
-
-    /** @skipUpgrade */
-    protected $schemaComponent = 'TagField';
-
-    /**
-     * @param string $name
-     * @param string $title
-     * @param null|DataList|array $source
-     * @param null|DataList $value
-     * @param string $titleField
-     */
-    public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
-    {
-        $this->setTitleField($titleField);
-        parent::__construct($name, $title, $source, $value);
-
-        $this->addExtraClass('ss-tag-field');
-    }
-
-    /**
-     * @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 = [])
-    {
-        $this->addExtraClass('entwine');
-
-        return $this->customise($properties)->renderWith(self::class);
-    }
-
-    /**
-     * Provide TagField data to the JSON schema for the frontend component
-     *
-     * @return array
-     */
-    public function getSchemaDataDefaults()
-    {
-        $options = $this->getOptions(true);
-        $schema = array_merge(
-            parent::getSchemaDataDefaults(),
-            [
-                'name' => $this->getName() . '[]',
-                'lazyLoad' => $this->getShouldLazyLoad(),
-                'creatable' => $this->getCanCreate(),
-                'multi' => $this->getIsMultiple(),
-                'value' => $options->count() ? $options->toNestedArray() : null,
-                'disabled' => $this->isDisabled() || $this->isReadonly(),
-            ]
-        );
-
-        if (!$this->getShouldLazyLoad()) {
-            $schema['options'] = array_values($this->getOptions()->toNestedArray());
-        } else {
-            $schema['optionUrl'] = $this->getSuggestURL();
-        }
-
-        return $schema;
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSuggestURL()
-    {
-        return Controller::join_links($this->Link(), 'suggest');
-    }
-
-    /**
-     * @return ArrayList
-     */
-    protected function getOptions($onlySelected = false)
-    {
-        $options = ArrayList::create();
-        $source = $this->getSourceList();
-
-        // No source means we have no options
-        if (!$source) {
-            return ArrayList::create();
-        }
-
-        $dataClass = $source->dataClass();
-
-        $values = $this->Value();
-
-        // If we have no values and we only want selected options we can bail here
-        if (empty($values) && $onlySelected) {
-            return ArrayList::create();
-        }
-
-        // Convert an array of values into a datalist of options
-        if (is_array($values) && !empty($values)) {
-            $values = DataList::create($dataClass)
-                ->filter($this->getTitleField(), $values);
-        } else {
-            $values = ArrayList::create();
-        }
-
-        // Prep a function to parse a dataobject into an option
-        $addOption = function (DataObject $item) use ($options, $values) {
-            $titleField = $this->getTitleField();
-            $option = $item->$titleField;
-            $options->push(ArrayData::create([
-                'Title' => $option,
-                'Value' => $option,
-                'Selected' => (bool) $values->find('ID', $item->ID)
-            ]));
-        };
-
-        // Only parse the values if we only want the selected items in the values list (this is for lazy-loading)
-        if ($onlySelected) {
-            $values->each($addOption);
-            return $options;
-        }
-
-        $source->each($addOption);
-        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());
-            }
-        }
-
-        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;
-    }
-
-    /**
-     * @param DataObject|DataObjectInterface $record DataObject to save data into
-     * @throws Exception
-     */
-    public function getAttributes()
-    {
-        return array_merge(
-            parent::getAttributes(),
-            [
-                'name' => $this->getName() . '[]',
-                'style' => 'width: 100%',
-                'data-schema' => json_encode($this->getSchemaData()),
-            ]
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        $name = $this->getName();
-        $titleField = $this->getTitleField();
-        $values = $this->Value();
-
-        /** @var Relation $relation */
-        $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();
-        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);
-
-            if (is_array($term)) {
-                $term = $term['Value'];
-            }
-
-            $record->{$titleField} = $term;
-            $record->write();
-            if ($source instanceof SS_List) {
-                $source->add($record);
-            }
-            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();
-        if (!$source) {
-            return [];
-        }
-
-        $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] = [
-                'Title' => $title,
-                'Value' => $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 '';
-    }
-
-    public function getSchemaStateDefaults()
-    {
-        $data = parent::getSchemaStateDefaults();
-
-        // Add options to 'data'
-        $data['lazyLoad'] = $this->getShouldLazyLoad();
-        $data['multi'] = $this->getIsMultiple();
-        $data['optionUrl'] = $this->getSuggestURL();
-        $data['creatable'] = $this->getCanCreate();
-        $options = $this->getOptions(true);
-        $data['value'] = $options->count() ? $options->toNestedArray() : null;
-
-        return $data;
-    }
+	/**
+	 * @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;
+
+	/** @skipUpgrade */
+	protected $schemaComponent = 'TagField';
+
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param null|DataList|array $source
+	 * @param null|DataList $value
+	 * @param string $titleField
+	 */
+	public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
+	{
+		$this->setTitleField($titleField);
+		parent::__construct($name, $title, $source, $value);
+
+		$this->addExtraClass('ss-tag-field');
+	}
+
+	/**
+	 * @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 = [])
+	{
+		$this->addExtraClass('entwine');
+
+		return $this->customise($properties)->renderWith(self::class);
+	}
+
+	/**
+	 * Provide TagField data to the JSON schema for the frontend component
+	 *
+	 * @return array
+	 */
+	public function getSchemaDataDefaults()
+	{
+		$options = $this->getOptions(true);
+		$schema = array_merge(
+			parent::getSchemaDataDefaults(),
+			[
+				'name' => $this->getName() . '[]',
+				'lazyLoad' => $this->getShouldLazyLoad(),
+				'creatable' => $this->getCanCreate(),
+				'multi' => $this->getIsMultiple(),
+				'value' => $options->count() ? $options->toNestedArray() : null,
+				'disabled' => $this->isDisabled() || $this->isReadonly(),
+			]
+		);
+
+		if (!$this->getShouldLazyLoad()) {
+			$schema['options'] = array_values($this->getOptions()->toNestedArray());
+		} else {
+			$schema['optionUrl'] = $this->getSuggestURL();
+		}
+
+		return $schema;
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSuggestURL()
+	{
+		return Controller::join_links($this->Link(), 'suggest');
+	}
+
+	/**
+	 * @return ArrayList
+	 */
+	protected function getOptions($onlySelected = false)
+	{
+		$options = ArrayList::create();
+		$source = $this->getSourceList();
+
+		// No source means we have no options
+		if (!$source) {
+			return ArrayList::create();
+		}
+
+		$dataClass = $source->dataClass();
+
+		$values = $this->Value();
+
+		// If we have no values and we only want selected options we can bail here
+		if (empty($values) && $onlySelected) {
+			return ArrayList::create();
+		}
+
+		// Convert an array of values into a datalist of options
+		if (is_array($values) && !empty($values)) {
+			$values = DataList::create($dataClass)
+				->filter($this->getTitleField(), $values);
+		} else {
+			$values = ArrayList::create();
+		}
+
+		// Prep a function to parse a dataobject into an option
+		$addOption = function (DataObject $item) use ($options, $values) {
+			$titleField = $this->getTitleField();
+			$option = $item->$titleField;
+			$options->push(ArrayData::create([
+				'Title' => $option,
+				'Value' => $option,
+				'Selected' => (bool) $values->find('ID', $item->ID)
+			]));
+		};
+
+		// Only parse the values if we only want the selected items in the values list (this is for lazy-loading)
+		if ($onlySelected) {
+			$values->each($addOption);
+			return $options;
+		}
+
+		$source->each($addOption);
+		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());
+			}
+		}
+
+		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;
+	}
+
+	/**
+	 * @param DataObject|DataObjectInterface $record DataObject to save data into
+	 * @throws Exception
+	 */
+	public function getAttributes()
+	{
+		return array_merge(
+			parent::getAttributes(),
+			[
+				'name' => $this->getName() . '[]',
+				'style' => 'width: 100%',
+				'data-schema' => json_encode($this->getSchemaData()),
+			]
+		);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		$name = $this->getName();
+		$titleField = $this->getTitleField();
+		$values = $this->Value();
+
+		/** @var Relation $relation */
+		$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();
+		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);
+
+			if (is_array($term)) {
+				$term = $term['Value'];
+			}
+
+			$record->{$titleField} = $term;
+			$record->write();
+			if ($source instanceof SS_List) {
+				$source->add($record);
+			}
+			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();
+		if (!$source) {
+			return [];
+		}
+
+		$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] = [
+				'Title' => $title,
+				'Value' => $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 '';
+	}
+
+	public function getSchemaStateDefaults()
+	{
+		$data = parent::getSchemaStateDefaults();
+
+		// Add options to 'data'
+		$data['lazyLoad'] = $this->getShouldLazyLoad();
+		$data['multi'] = $this->getIsMultiple();
+		$data['optionUrl'] = $this->getSuggestURL();
+		$data['creatable'] = $this->getCanCreate();
+		$options = $this->getOptions(true);
+		$data['value'] = $options->count() ? $options->toNestedArray() : null;
+
+		return $data;
+	}
 }