Completed
Push — master ( 5bf4b2...b5ca87 )
by Robbie
28s queued 25s
created
src/ReadonlyTagField.php 2 patches
Indentation   +21 added lines, -21 removed lines patch added patch discarded remove patch
@@ -12,29 +12,29 @@
 block discarded – undo
12 12
  */
13 13
 class ReadonlyTagField extends TagField
14 14
 {
15
-    /**
16
-     * {@inheritDoc}
17
-     */
18
-    protected $readonly = true;
15
+	/**
16
+	 * {@inheritDoc}
17
+	 */
18
+	protected $readonly = true;
19 19
 
20
-    /**
21
-     * Render the readonly field as HTML.
22
-     *
23
-     * @param array $properties
24
-     * @return HTMLText
25
-     */
26
-    public function Field($properties = array())
27
-    {
28
-        $options = array();
20
+	/**
21
+	 * Render the readonly field as HTML.
22
+	 *
23
+	 * @param array $properties
24
+	 * @return HTMLText
25
+	 */
26
+	public function Field($properties = array())
27
+	{
28
+		$options = array();
29 29
 
30
-        foreach ($this->getOptions()->filter('Selected', true) as $option) {
31
-            $options[] = $option->Title;
32
-        }
30
+		foreach ($this->getOptions()->filter('Selected', true) as $option) {
31
+			$options[] = $option->Title;
32
+		}
33 33
 
34
-        $field = ReadonlyField::create($this->name . '_Readonly', $this->title);
34
+		$field = ReadonlyField::create($this->name . '_Readonly', $this->title);
35 35
 
36
-        $field->setForm($this->form);
37
-        $field->setValue(implode(', ', $options));
38
-        return $field->Field();
39
-    }
36
+		$field->setForm($this->form);
37
+		$field->setValue(implode(', ', $options));
38
+		return $field->Field();
39
+	}
40 40
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -31,7 +31,7 @@
 block discarded – undo
31 31
             $options[] = $option->Title;
32 32
         }
33 33
 
34
-        $field = ReadonlyField::create($this->name . '_Readonly', $this->title);
34
+        $field = ReadonlyField::create($this->name.'_Readonly', $this->title);
35 35
 
36 36
         $field->setForm($this->form);
37 37
         $field->setValue(implode(', ', $options));
Please login to merge, or discard this patch.
tests/Stub/StringTagFieldTestController.php 1 patch
Indentation   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -12,21 +12,21 @@
 block discarded – undo
12 12
 
13 13
 class StringTagFieldTestController extends Controller implements TestOnly
14 14
 {
15
-    public function StringTagFieldTestForm()
16
-    {
17
-        $fields = new FieldList(
18
-            $tagField = new StringTagField('Tags')
19
-        );
15
+	public function StringTagFieldTestForm()
16
+	{
17
+		$fields = new FieldList(
18
+			$tagField = new StringTagField('Tags')
19
+		);
20 20
 
21
-        $actions = new FieldList(
22
-            new FormAction('StringTagFieldTestFormSubmit')
23
-        );
21
+		$actions = new FieldList(
22
+			new FormAction('StringTagFieldTestFormSubmit')
23
+		);
24 24
 
25
-        return new Form($this, 'StringTagFieldTestForm', $fields, $actions);
26
-    }
25
+		return new Form($this, 'StringTagFieldTestForm', $fields, $actions);
26
+	}
27 27
 
28
-    public function StringTagFieldTestFormSubmit(DataObject $dataObject, Form $form)
29
-    {
30
-        $form->saveInto($dataObject);
31
-    }
28
+	public function StringTagFieldTestFormSubmit(DataObject $dataObject, Form $form)
29
+	{
30
+		$form->saveInto($dataObject);
31
+	}
32 32
 }
Please login to merge, or discard this patch.
tests/Stub/TagFieldTestBlogPost.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -8,14 +8,14 @@
 block discarded – undo
8 8
 
9 9
 class TagFieldTestBlogPost extends DataObject implements TestOnly
10 10
 {
11
-    private static $table_name = 'TagFieldTestBlogPost';
11
+	private static $table_name = 'TagFieldTestBlogPost';
12 12
 
13
-    private static $db = [
14
-        'Title'   => 'Text',
15
-        'Content' => 'Text'
16
-    ];
13
+	private static $db = [
14
+		'Title'   => 'Text',
15
+		'Content' => 'Text'
16
+	];
17 17
 
18
-    private static $many_many = [
19
-        'Tags' => TagFieldTestBlogTag::class
20
-    ];
18
+	private static $many_many = [
19
+		'Tags' => TagFieldTestBlogTag::class
20
+	];
21 21
 }
Please login to merge, or discard this patch.
tests/Stub/TagFieldTestController.php 1 patch
Indentation   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -13,21 +13,21 @@
 block discarded – undo
13 13
 
14 14
 class TagFieldTestController extends Controller implements TestOnly
15 15
 {
16
-    public function TagFieldTestForm()
17
-    {
18
-        $fields = new FieldList(
19
-            $tagField = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
20
-        );
16
+	public function TagFieldTestForm()
17
+	{
18
+		$fields = new FieldList(
19
+			$tagField = new TagField('Tags', '', new DataList('TagFieldTestBlogTag'))
20
+		);
21 21
 
22
-        $actions = new FieldList(
23
-            new FormAction('TagFieldTestFormSubmit')
24
-        );
22
+		$actions = new FieldList(
23
+			new FormAction('TagFieldTestFormSubmit')
24
+		);
25 25
 
26
-        return new Form($this, 'TagFieldTestForm', $fields, $actions);
27
-    }
26
+		return new Form($this, 'TagFieldTestForm', $fields, $actions);
27
+	}
28 28
 
29
-    public function TagFieldTestFormSubmit(DataObject $dataObject, Form $form)
30
-    {
31
-        $form->saveInto($dataObject);
32
-    }
29
+	public function TagFieldTestFormSubmit(DataObject $dataObject, Form $form)
30
+	{
31
+		$form->saveInto($dataObject);
32
+	}
33 33
 }
Please login to merge, or discard this patch.
tests/Stub/TagFieldTestBlogTag.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -8,15 +8,15 @@
 block discarded – undo
8 8
 
9 9
 class TagFieldTestBlogTag extends DataObject implements TestOnly
10 10
 {
11
-    private static $table_name = 'TagFieldTestBlogTag';
11
+	private static $table_name = 'TagFieldTestBlogTag';
12 12
 
13
-    private static $default_sort = '"TagFieldTestBlogTag"."ID" ASC';
13
+	private static $default_sort = '"TagFieldTestBlogTag"."ID" ASC';
14 14
 
15
-    private static $db = [
16
-        'Title' => 'Varchar(200)'
17
-    ];
15
+	private static $db = [
16
+		'Title' => 'Varchar(200)'
17
+	];
18 18
 
19
-    private static $belongs_many_many = [
20
-        'BlogPosts' => TagFieldTestBlogPost::class
21
-    ];
19
+	private static $belongs_many_many = [
20
+		'BlogPosts' => TagFieldTestBlogPost::class
21
+	];
22 22
 }
Please login to merge, or discard this patch.
tests/Stub/StringTagFieldTestBlogPost.php 1 patch
Indentation   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -7,11 +7,11 @@
 block discarded – undo
7 7
 
8 8
 class StringTagFieldTestBlogPost extends DataObject implements TestOnly
9 9
 {
10
-    private static $table_name = 'StringTagFieldTestBlogPost';
10
+	private static $table_name = 'StringTagFieldTestBlogPost';
11 11
 
12
-    private static $db = [
13
-        'Title' => 'Text',
14
-        'Content' => 'Text',
15
-        'Tags' => 'Text',
16
-    ];
12
+	private static $db = [
13
+		'Title' => 'Text',
14
+		'Content' => 'Text',
15
+		'Tags' => 'Text',
16
+	];
17 17
 }
Please login to merge, or discard this patch.
src/StringTagField.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -161,7 +161,7 @@
 block discarded – undo
161 161
         $schema = array_merge(
162 162
             parent::getSchemaDataDefaults(),
163 163
             [
164
-                'name' => $this->getName() . '[]',
164
+                'name' => $this->getName().'[]',
165 165
                 'lazyLoad' => $this->getShouldLazyLoad(),
166 166
                 'creatable' => $this->getCanCreate(),
167 167
                 'multi' => $this->getIsMultiple(),
Please login to merge, or discard this patch.
Indentation   +330 added lines, -330 removed lines patch added patch discarded remove patch
@@ -26,334 +26,334 @@
 block discarded – undo
26 26
  */
27 27
 class StringTagField extends DropdownField
28 28
 {
29
-    /**
30
-     * @var array
31
-     */
32
-    private static $allowed_actions = [
33
-        'suggest',
34
-    ];
35
-
36
-    /**
37
-     * @var bool
38
-     */
39
-    protected $shouldLazyLoad = false;
40
-
41
-    /**
42
-     * @var int
43
-     */
44
-    protected $lazyLoadItemLimit = 10;
45
-
46
-    /**
47
-     * @var bool
48
-     */
49
-    protected $canCreate = true;
50
-
51
-    /**
52
-     * @var null|DataObject
53
-     */
54
-    protected $record;
55
-
56
-    /**
57
-     * @var bool
58
-     */
59
-    protected $isMultiple = true;
60
-
61
-    /**
62
-     * @return bool
63
-     */
64
-    public function getShouldLazyLoad()
65
-    {
66
-        return $this->shouldLazyLoad;
67
-    }
68
-
69
-    /**
70
-     * @param bool $shouldLazyLoad
71
-     * @return $this
72
-     */
73
-    public function setShouldLazyLoad($shouldLazyLoad)
74
-    {
75
-        $this->shouldLazyLoad = $shouldLazyLoad;
76
-
77
-        return $this;
78
-    }
79
-
80
-    /**
81
-     * @return int
82
-     */
83
-    public function getLazyLoadItemLimit()
84
-    {
85
-        return $this->lazyLoadItemLimit;
86
-    }
87
-
88
-    /**
89
-     * @param int $lazyLoadItemLimit
90
-     * @return $this
91
-     */
92
-    public function setLazyLoadItemLimit($lazyLoadItemLimit)
93
-    {
94
-        $this->lazyLoadItemLimit = $lazyLoadItemLimit;
95
-
96
-        return $this;
97
-    }
98
-
99
-    /**
100
-     * @return bool
101
-     */
102
-    public function getIsMultiple()
103
-    {
104
-        return $this->isMultiple;
105
-    }
106
-
107
-    /**
108
-     * @param bool $isMultiple
109
-     * @return $this
110
-     */
111
-    public function setIsMultiple($isMultiple)
112
-    {
113
-        $this->isMultiple = $isMultiple;
114
-
115
-        return $this;
116
-    }
117
-
118
-    /**
119
-     * @return null|DataObject
120
-     */
121
-    public function getRecord()
122
-    {
123
-        if ($this->record) {
124
-            return $this->record;
125
-        }
126
-
127
-        if ($form = $this->getForm()) {
128
-            return $form->getRecord();
129
-        }
130
-
131
-        return null;
132
-    }
133
-
134
-    /**
135
-     * @param DataObject $record
136
-     * @return $this
137
-     */
138
-    public function setRecord(DataObject $record)
139
-    {
140
-        $this->record = $record;
141
-
142
-        return $this;
143
-    }
144
-
145
-    public function Field($properties = [])
146
-    {
147
-        $this->addExtraClass('ss-tag-field');
148
-
149
-        return $this
150
-            ->customise($properties)
151
-            ->renderWith(TagField::class);
152
-    }
153
-
154
-    /**
155
-     * Provide TagField data to the JSON schema for the frontend component
156
-     *
157
-     * @return array
158
-     */
159
-    public function getSchemaDataDefaults()
160
-    {
161
-        $schema = array_merge(
162
-            parent::getSchemaDataDefaults(),
163
-            [
164
-                'name' => $this->getName() . '[]',
165
-                'lazyLoad' => $this->getShouldLazyLoad(),
166
-                'creatable' => $this->getCanCreate(),
167
-                'multi' => $this->getIsMultiple(),
168
-                'value' => $this->formatOptions($this->Value()),
169
-                'disabled' => $this->isDisabled() || $this->isReadonly(),
170
-            ]
171
-        );
172
-
173
-        if (!$this->getShouldLazyLoad()) {
174
-            $schema['options'] = $this->getOptions()->toNestedArray();
175
-        } else {
176
-            $schema['optionUrl'] = $this->getSuggestURL();
177
-        }
178
-
179
-        return $schema;
180
-    }
181
-
182
-    protected function formatOptions($fieldValue)
183
-    {
184
-        if (empty($fieldValue)) {
185
-            return [];
186
-        }
187
-
188
-        $formattedValue = [];
189
-        foreach ($fieldValue as $value) {
190
-            $formattedValue[] = [
191
-                'Title' => $value,
192
-                'Value' => $value,
193
-            ];
194
-        }
195
-        return $formattedValue;
196
-    }
197
-
198
-    /**
199
-     * When not used in a React form factory context, this adds the schema data to SilverStripe template
200
-     * rendered attributes lists
201
-     *
202
-     * @return array
203
-     */
204
-    public function getAttributes()
205
-    {
206
-        $attributes = parent::getAttributes();
207
-        $attributes['data-schema'] = json_encode($this->getSchemaData());
208
-        return $attributes;
209
-    }
210
-
211
-    /**
212
-     * @return string
213
-     */
214
-    protected function getSuggestURL()
215
-    {
216
-        return Controller::join_links($this->Link(), 'suggest');
217
-    }
218
-
219
-    /**
220
-     * @return ArrayList
221
-     */
222
-    protected function getOptions()
223
-    {
224
-        $options = ArrayList::create();
225
-
226
-        $source = $this->getSource();
227
-
228
-        if ($source instanceof Iterator) {
229
-            $source = iterator_to_array($source);
230
-        }
231
-
232
-        foreach ($source as $value) {
233
-            $options->push(
234
-                ArrayData::create([
235
-                    'Title' => $value,
236
-                    'Value' => $value,
237
-                ])
238
-            );
239
-        }
240
-
241
-        return $options;
242
-    }
243
-
244
-    public function setValue($value, $source = null)
245
-    {
246
-        if (is_string($value)) {
247
-            $value = explode(',', $value);
248
-        }
249
-
250
-        if ($source instanceof DataObject) {
251
-            $name = $this->getName();
252
-            $value = explode(',', $source->$name);
253
-        }
254
-
255
-        if ($source instanceof SS_List) {
256
-            $value = $source->column('ID');
257
-        }
258
-
259
-        if ($value === null) {
260
-            $value = [];
261
-        }
262
-
263
-        return parent::setValue(array_filter($value));
264
-    }
265
-
266
-    public function saveInto(DataObjectInterface $record)
267
-    {
268
-        parent::saveInto($record);
269
-
270
-        $name = $this->getName();
271
-
272
-        $record->$name = $this->dataValue();
273
-        $record->write();
274
-    }
275
-
276
-    /**
277
-     * Ensure that arrays are imploded before being saved
278
-     *
279
-     * @return mixed|string
280
-     */
281
-    public function dataValue()
282
-    {
283
-        return implode(',', $this->value);
284
-    }
285
-
286
-    /**
287
-     * Returns a JSON string of tags, for lazy loading.
288
-     *
289
-     * @param  HTTPRequest $request
290
-     * @return HTTPResponse
291
-     */
292
-    public function suggest(HTTPRequest $request)
293
-    {
294
-        $responseBody = json_encode(
295
-            ['items' => $this->getTags($request->getVar('term'))]
296
-        );
297
-
298
-        $response = HTTPResponse::create();
299
-        $response->addHeader('Content-Type', 'application/json');
300
-        $response->setBody($responseBody);
301
-
302
-        return $response;
303
-    }
304
-
305
-    /**
306
-     * Returns array of arrays representing tags that partially match the given search term
307
-     *
308
-     * @param string $term
309
-     * @return array
310
-     */
311
-    protected function getTags($term)
312
-    {
313
-        $items = [];
314
-        foreach ($this->getOptions() as $i => $tag) {
315
-            /** @var ArrayData $tag */
316
-            $tagValue = $tag->Value;
317
-            // Map into a distinct list (prevent duplicates)
318
-            if (stripos($tagValue, $term) !== false && !array_key_exists($tagValue, $items)) {
319
-                $items[$tagValue] = [
320
-                    'id' => $tag->Title,
321
-                    'text' => $tag->Value,
322
-                ];
323
-            }
324
-        }
325
-        // @todo do we actually need lazy loading limits for StringTagField?
326
-        return array_slice(array_values($items), 0, $this->getLazyLoadItemLimit());
327
-    }
328
-
329
-    /**
330
-     * DropdownField assumes value will be a scalar so we must
331
-     * override validate. This only applies to Silverstripe 3.2+
332
-     *
333
-     * @param Validator $validator
334
-     * @return bool
335
-     */
336
-    public function validate($validator)
337
-    {
338
-        return true;
339
-    }
340
-
341
-    /**
342
-     * @return bool
343
-     */
344
-    public function getCanCreate()
345
-    {
346
-        return $this->canCreate;
347
-    }
348
-
349
-    /**
350
-     * @param bool $canCreate
351
-     * @return $this
352
-     */
353
-    public function setCanCreate($canCreate)
354
-    {
355
-        $this->canCreate = $canCreate;
356
-
357
-        return $this;
358
-    }
29
+	/**
30
+	 * @var array
31
+	 */
32
+	private static $allowed_actions = [
33
+		'suggest',
34
+	];
35
+
36
+	/**
37
+	 * @var bool
38
+	 */
39
+	protected $shouldLazyLoad = false;
40
+
41
+	/**
42
+	 * @var int
43
+	 */
44
+	protected $lazyLoadItemLimit = 10;
45
+
46
+	/**
47
+	 * @var bool
48
+	 */
49
+	protected $canCreate = true;
50
+
51
+	/**
52
+	 * @var null|DataObject
53
+	 */
54
+	protected $record;
55
+
56
+	/**
57
+	 * @var bool
58
+	 */
59
+	protected $isMultiple = true;
60
+
61
+	/**
62
+	 * @return bool
63
+	 */
64
+	public function getShouldLazyLoad()
65
+	{
66
+		return $this->shouldLazyLoad;
67
+	}
68
+
69
+	/**
70
+	 * @param bool $shouldLazyLoad
71
+	 * @return $this
72
+	 */
73
+	public function setShouldLazyLoad($shouldLazyLoad)
74
+	{
75
+		$this->shouldLazyLoad = $shouldLazyLoad;
76
+
77
+		return $this;
78
+	}
79
+
80
+	/**
81
+	 * @return int
82
+	 */
83
+	public function getLazyLoadItemLimit()
84
+	{
85
+		return $this->lazyLoadItemLimit;
86
+	}
87
+
88
+	/**
89
+	 * @param int $lazyLoadItemLimit
90
+	 * @return $this
91
+	 */
92
+	public function setLazyLoadItemLimit($lazyLoadItemLimit)
93
+	{
94
+		$this->lazyLoadItemLimit = $lazyLoadItemLimit;
95
+
96
+		return $this;
97
+	}
98
+
99
+	/**
100
+	 * @return bool
101
+	 */
102
+	public function getIsMultiple()
103
+	{
104
+		return $this->isMultiple;
105
+	}
106
+
107
+	/**
108
+	 * @param bool $isMultiple
109
+	 * @return $this
110
+	 */
111
+	public function setIsMultiple($isMultiple)
112
+	{
113
+		$this->isMultiple = $isMultiple;
114
+
115
+		return $this;
116
+	}
117
+
118
+	/**
119
+	 * @return null|DataObject
120
+	 */
121
+	public function getRecord()
122
+	{
123
+		if ($this->record) {
124
+			return $this->record;
125
+		}
126
+
127
+		if ($form = $this->getForm()) {
128
+			return $form->getRecord();
129
+		}
130
+
131
+		return null;
132
+	}
133
+
134
+	/**
135
+	 * @param DataObject $record
136
+	 * @return $this
137
+	 */
138
+	public function setRecord(DataObject $record)
139
+	{
140
+		$this->record = $record;
141
+
142
+		return $this;
143
+	}
144
+
145
+	public function Field($properties = [])
146
+	{
147
+		$this->addExtraClass('ss-tag-field');
148
+
149
+		return $this
150
+			->customise($properties)
151
+			->renderWith(TagField::class);
152
+	}
153
+
154
+	/**
155
+	 * Provide TagField data to the JSON schema for the frontend component
156
+	 *
157
+	 * @return array
158
+	 */
159
+	public function getSchemaDataDefaults()
160
+	{
161
+		$schema = array_merge(
162
+			parent::getSchemaDataDefaults(),
163
+			[
164
+				'name' => $this->getName() . '[]',
165
+				'lazyLoad' => $this->getShouldLazyLoad(),
166
+				'creatable' => $this->getCanCreate(),
167
+				'multi' => $this->getIsMultiple(),
168
+				'value' => $this->formatOptions($this->Value()),
169
+				'disabled' => $this->isDisabled() || $this->isReadonly(),
170
+			]
171
+		);
172
+
173
+		if (!$this->getShouldLazyLoad()) {
174
+			$schema['options'] = $this->getOptions()->toNestedArray();
175
+		} else {
176
+			$schema['optionUrl'] = $this->getSuggestURL();
177
+		}
178
+
179
+		return $schema;
180
+	}
181
+
182
+	protected function formatOptions($fieldValue)
183
+	{
184
+		if (empty($fieldValue)) {
185
+			return [];
186
+		}
187
+
188
+		$formattedValue = [];
189
+		foreach ($fieldValue as $value) {
190
+			$formattedValue[] = [
191
+				'Title' => $value,
192
+				'Value' => $value,
193
+			];
194
+		}
195
+		return $formattedValue;
196
+	}
197
+
198
+	/**
199
+	 * When not used in a React form factory context, this adds the schema data to SilverStripe template
200
+	 * rendered attributes lists
201
+	 *
202
+	 * @return array
203
+	 */
204
+	public function getAttributes()
205
+	{
206
+		$attributes = parent::getAttributes();
207
+		$attributes['data-schema'] = json_encode($this->getSchemaData());
208
+		return $attributes;
209
+	}
210
+
211
+	/**
212
+	 * @return string
213
+	 */
214
+	protected function getSuggestURL()
215
+	{
216
+		return Controller::join_links($this->Link(), 'suggest');
217
+	}
218
+
219
+	/**
220
+	 * @return ArrayList
221
+	 */
222
+	protected function getOptions()
223
+	{
224
+		$options = ArrayList::create();
225
+
226
+		$source = $this->getSource();
227
+
228
+		if ($source instanceof Iterator) {
229
+			$source = iterator_to_array($source);
230
+		}
231
+
232
+		foreach ($source as $value) {
233
+			$options->push(
234
+				ArrayData::create([
235
+					'Title' => $value,
236
+					'Value' => $value,
237
+				])
238
+			);
239
+		}
240
+
241
+		return $options;
242
+	}
243
+
244
+	public function setValue($value, $source = null)
245
+	{
246
+		if (is_string($value)) {
247
+			$value = explode(',', $value);
248
+		}
249
+
250
+		if ($source instanceof DataObject) {
251
+			$name = $this->getName();
252
+			$value = explode(',', $source->$name);
253
+		}
254
+
255
+		if ($source instanceof SS_List) {
256
+			$value = $source->column('ID');
257
+		}
258
+
259
+		if ($value === null) {
260
+			$value = [];
261
+		}
262
+
263
+		return parent::setValue(array_filter($value));
264
+	}
265
+
266
+	public function saveInto(DataObjectInterface $record)
267
+	{
268
+		parent::saveInto($record);
269
+
270
+		$name = $this->getName();
271
+
272
+		$record->$name = $this->dataValue();
273
+		$record->write();
274
+	}
275
+
276
+	/**
277
+	 * Ensure that arrays are imploded before being saved
278
+	 *
279
+	 * @return mixed|string
280
+	 */
281
+	public function dataValue()
282
+	{
283
+		return implode(',', $this->value);
284
+	}
285
+
286
+	/**
287
+	 * Returns a JSON string of tags, for lazy loading.
288
+	 *
289
+	 * @param  HTTPRequest $request
290
+	 * @return HTTPResponse
291
+	 */
292
+	public function suggest(HTTPRequest $request)
293
+	{
294
+		$responseBody = json_encode(
295
+			['items' => $this->getTags($request->getVar('term'))]
296
+		);
297
+
298
+		$response = HTTPResponse::create();
299
+		$response->addHeader('Content-Type', 'application/json');
300
+		$response->setBody($responseBody);
301
+
302
+		return $response;
303
+	}
304
+
305
+	/**
306
+	 * Returns array of arrays representing tags that partially match the given search term
307
+	 *
308
+	 * @param string $term
309
+	 * @return array
310
+	 */
311
+	protected function getTags($term)
312
+	{
313
+		$items = [];
314
+		foreach ($this->getOptions() as $i => $tag) {
315
+			/** @var ArrayData $tag */
316
+			$tagValue = $tag->Value;
317
+			// Map into a distinct list (prevent duplicates)
318
+			if (stripos($tagValue, $term) !== false && !array_key_exists($tagValue, $items)) {
319
+				$items[$tagValue] = [
320
+					'id' => $tag->Title,
321
+					'text' => $tag->Value,
322
+				];
323
+			}
324
+		}
325
+		// @todo do we actually need lazy loading limits for StringTagField?
326
+		return array_slice(array_values($items), 0, $this->getLazyLoadItemLimit());
327
+	}
328
+
329
+	/**
330
+	 * DropdownField assumes value will be a scalar so we must
331
+	 * override validate. This only applies to Silverstripe 3.2+
332
+	 *
333
+	 * @param Validator $validator
334
+	 * @return bool
335
+	 */
336
+	public function validate($validator)
337
+	{
338
+		return true;
339
+	}
340
+
341
+	/**
342
+	 * @return bool
343
+	 */
344
+	public function getCanCreate()
345
+	{
346
+		return $this->canCreate;
347
+	}
348
+
349
+	/**
350
+	 * @param bool $canCreate
351
+	 * @return $this
352
+	 */
353
+	public function setCanCreate($canCreate)
354
+	{
355
+		$this->canCreate = $canCreate;
356
+
357
+		return $this;
358
+	}
359 359
 }
Please login to merge, or discard this patch.
src/TagField.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -215,7 +215,7 @@  discard block
 block discarded – undo
215 215
         $schema = array_merge(
216 216
             parent::getSchemaDataDefaults(),
217 217
             [
218
-                'name' => $this->getName() . '[]',
218
+                'name' => $this->getName().'[]',
219 219
                 'lazyLoad' => $this->getShouldLazyLoad(),
220 220
                 'creatable' => $this->getCanCreate(),
221 221
                 'multi' => $this->getIsMultiple(),
@@ -426,7 +426,7 @@  discard block
 block discarded – undo
426 426
         $titleField = $this->getTitleField();
427 427
 
428 428
         $query = $source
429
-            ->filter($titleField . ':PartialMatch:nocase', $term)
429
+            ->filter($titleField.':PartialMatch:nocase', $term)
430 430
             ->sort($titleField)
431 431
             ->limit($this->getLazyLoadItemLimit());
432 432
 
Please login to merge, or discard this patch.
Indentation   +456 added lines, -456 removed lines patch added patch discarded remove patch
@@ -24,460 +24,460 @@
 block discarded – undo
24 24
  */
25 25
 class TagField extends DropdownField
26 26
 {
27
-    /**
28
-     * @var array
29
-     */
30
-    private static $allowed_actions = [
31
-        'suggest',
32
-    ];
33
-
34
-    /**
35
-     * @var bool
36
-     */
37
-    protected $shouldLazyLoad = false;
38
-
39
-    /**
40
-     * @var int
41
-     */
42
-    protected $lazyLoadItemLimit = 10;
43
-
44
-    /**
45
-     * @var bool
46
-     */
47
-    protected $canCreate = true;
48
-
49
-    /**
50
-     * @var string
51
-     */
52
-    protected $titleField = 'Title';
53
-
54
-    /**
55
-     * @var DataList
56
-     */
57
-    protected $sourceList;
58
-
59
-    /**
60
-     * @var bool
61
-     */
62
-    protected $isMultiple = true;
63
-
64
-    /**
65
-     * @param string $name
66
-     * @param string $title
67
-     * @param null|DataList $source
68
-     * @param null|DataList $value
69
-     * @param string $titleField
70
-     */
71
-    public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
72
-    {
73
-        $this->setSourceList($source);
74
-        $this->setTitleField($titleField);
75
-        parent::__construct($name, $title, $source, $value);
76
-    }
77
-
78
-    /**
79
-     * @return bool
80
-     */
81
-    public function getShouldLazyLoad()
82
-    {
83
-        return $this->shouldLazyLoad;
84
-    }
85
-
86
-    /**
87
-     * @param bool $shouldLazyLoad
88
-     *
89
-     * @return static
90
-     */
91
-    public function setShouldLazyLoad($shouldLazyLoad)
92
-    {
93
-        $this->shouldLazyLoad = $shouldLazyLoad;
94
-
95
-        return $this;
96
-    }
97
-
98
-    /**
99
-     * @return int
100
-     */
101
-    public function getLazyLoadItemLimit()
102
-    {
103
-        return $this->lazyLoadItemLimit;
104
-    }
105
-
106
-    /**
107
-     * @param int $lazyLoadItemLimit
108
-     *
109
-     * @return static
110
-     */
111
-    public function setLazyLoadItemLimit($lazyLoadItemLimit)
112
-    {
113
-        $this->lazyLoadItemLimit = $lazyLoadItemLimit;
114
-
115
-        return $this;
116
-    }
117
-
118
-    /**
119
-     * @return bool
120
-     */
121
-    public function getIsMultiple()
122
-    {
123
-        return $this->isMultiple;
124
-    }
125
-
126
-    /**
127
-     * @param bool $isMultiple
128
-     *
129
-     * @return static
130
-     */
131
-    public function setIsMultiple($isMultiple)
132
-    {
133
-        $this->isMultiple = $isMultiple;
134
-
135
-        return $this;
136
-    }
137
-
138
-    /**
139
-     * @return bool
140
-     */
141
-    public function getCanCreate()
142
-    {
143
-        return $this->canCreate;
144
-    }
145
-
146
-    /**
147
-     * @param bool $canCreate
148
-     *
149
-     * @return static
150
-     */
151
-    public function setCanCreate($canCreate)
152
-    {
153
-        $this->canCreate = $canCreate;
154
-
155
-        return $this;
156
-    }
157
-
158
-    /**
159
-     * @return string
160
-     */
161
-    public function getTitleField()
162
-    {
163
-        return $this->titleField;
164
-    }
165
-
166
-    /**
167
-     * @param string $titleField
168
-     *
169
-     * @return $this
170
-     */
171
-    public function setTitleField($titleField)
172
-    {
173
-        $this->titleField = $titleField;
174
-
175
-        return $this;
176
-    }
177
-
178
-    /**
179
-     * Get the DataList source. The 4.x upgrade for SelectField::setSource starts to convert this to an array
180
-     * @return DataList
181
-     */
182
-    public function getSourceList()
183
-    {
184
-        return $this->sourceList;
185
-    }
186
-
187
-    /**
188
-     * Set the model class name for tags
189
-     * @param  DataList $className
190
-     * @return self
191
-     */
192
-    public function setSourceList($sourceList)
193
-    {
194
-        $this->sourceList = $sourceList;
195
-        return $this;
196
-    }
197
-
198
-    /**
199
-     * {@inheritdoc}
200
-     */
201
-    public function Field($properties = [])
202
-    {
203
-        $this->addExtraClass('ss-tag-field');
204
-
205
-        return $this->customise($properties)->renderWith(self::class);
206
-    }
207
-
208
-    /**
209
-     * Provide TagField data to the JSON schema for the frontend component
210
-     *
211
-     * @return array
212
-     */
213
-    public function getSchemaDataDefaults()
214
-    {
215
-        $schema = array_merge(
216
-            parent::getSchemaDataDefaults(),
217
-            [
218
-                'name' => $this->getName() . '[]',
219
-                'lazyLoad' => $this->getShouldLazyLoad(),
220
-                'creatable' => $this->getCanCreate(),
221
-                'multi' => $this->getIsMultiple(),
222
-                'value' => $this->Value(),
223
-                'disabled' => $this->isDisabled() || $this->isReadonly(),
224
-            ]
225
-        );
226
-
227
-        if (!$this->getShouldLazyLoad()) {
228
-            $schema['options'] = array_values($this->getOptions()->toNestedArray());
229
-        } else {
230
-            if ($this->Value()) {
231
-                $schema['value'] = $this->getOptions(true)->toNestedArray();
232
-            }
233
-            $schema['optionUrl'] = $this->getSuggestURL();
234
-        }
235
-
236
-        return $schema;
237
-    }
238
-
239
-    /**
240
-     * When not used in a React form factory context, this adds the schema data to SilverStripe template
241
-     * rendered attributes lists
242
-     *
243
-     * @return array
244
-     */
245
-    public function getAttributes()
246
-    {
247
-        $attributes = parent::getAttributes();
248
-        $attributes['data-schema'] = json_encode($this->getSchemaData());
249
-        return $attributes;
250
-    }
251
-
252
-    /**
253
-     * @return string
254
-     */
255
-    protected function getSuggestURL()
256
-    {
257
-        return Controller::join_links($this->Link(), 'suggest');
258
-    }
259
-
260
-    /**
261
-     * @param bool $onlySelected Only return options that are selected
262
-     * @return ArrayList
263
-     */
264
-    protected function getOptions($onlySelected = false)
265
-    {
266
-        $source = $this->getSourceList();
267
-
268
-        if (!$source) {
269
-            $source = ArrayList::create();
270
-        }
271
-
272
-        $dataClass = $source->dataClass();
273
-        $titleField = $this->getTitleField();
274
-        $values = $this->Value();
275
-
276
-        if ($values) {
277
-            if (is_array($values)) {
278
-                $values = $source->filter($titleField, $values);
279
-            }
280
-        }
281
-        if ($onlySelected) {
282
-            $source = $values;
283
-        }
284
-
285
-        return $source instanceof DataList ? $this->formatOptions($source) : ArrayList::create();
286
-    }
287
-
288
-    /**
289
-     * @param DataList $source
290
-     * @return ArrayList
291
-     */
292
-    protected function formatOptions(DataList $source)
293
-    {
294
-        $options = ArrayList::create();
295
-        $titleField = $this->getTitleField();
296
-
297
-        foreach ($source as $object) {
298
-            $options->push(
299
-                ArrayData::create([
300
-                    'Title' => $object->$titleField,
301
-                    'Value' => $object->Title,
302
-                ])
303
-            );
304
-        }
305
-
306
-        return $options;
307
-    }
308
-
309
-    /**
310
-     * {@inheritdoc}
311
-     */
312
-    public function setValue($value, $source = null)
313
-    {
314
-        if ($source instanceof DataObject) {
315
-            $name = $this->getName();
316
-
317
-            if ($source->hasMethod($name)) {
318
-                $value = $source->$name()->column($this->getTitleField());
319
-            }
320
-        } elseif ($value instanceof SS_List) {
321
-            $value = $value->column($this->getTitleField());
322
-        }
323
-
324
-        if (!is_array($value)) {
325
-            return parent::setValue($value);
326
-        }
327
-
328
-        return parent::setValue(array_filter($value));
329
-    }
330
-
331
-    /**
332
-     * {@inheritdoc}
333
-     */
334
-    public function saveInto(DataObjectInterface $record)
335
-    {
336
-        parent::saveInto($record);
337
-
338
-        $name = $this->getName();
339
-        $titleField = $this->getTitleField();
340
-        $values = $this->Value();
341
-        $relation = $record->$name();
342
-        $ids = [];
343
-
344
-        if (!$values) {
345
-            $values = [];
346
-        }
347
-        if (empty($record) || empty($titleField)) {
348
-            return;
349
-        }
350
-
351
-        if (!$record->hasMethod($name)) {
352
-            throw new Exception(
353
-                sprintf("%s does not have a %s method", get_class($record), $name)
354
-            );
355
-        }
356
-
357
-        foreach ($values as $key => $value) {
358
-            // Get or create record
359
-            $record = $this->getOrCreateTag($value);
360
-            if ($record) {
361
-                $ids[] = $record->ID;
362
-                $values[$key] = $record->Title;
363
-            }
364
-        }
365
-
366
-        $relation->setByIDList(array_filter($ids));
367
-    }
368
-
369
-    /**
370
-     * Get or create tag with the given value
371
-     *
372
-     * @param  string $term
373
-     * @return DataObject|bool
374
-     */
375
-    protected function getOrCreateTag($term)
376
-    {
377
-        // Check if existing record can be found
378
-        $source = $this->getSourceList();
379
-        $titleField = $this->getTitleField();
380
-        $record = $source
381
-            ->filter($titleField, $term)
382
-            ->first();
383
-        if ($record) {
384
-            return $record;
385
-        }
386
-
387
-        // Create new instance if not yet saved
388
-        if ($this->getCanCreate()) {
389
-            $dataClass = $source->dataClass();
390
-            $record = Injector::inst()->create($dataClass);
391
-            $record->{$titleField} = $term;
392
-            $record->write();
393
-            if ($source instanceof SS_List) {
394
-                $source->add($record);
395
-            }
396
-            return $record;
397
-        }
398
-
399
-        return false;
400
-    }
401
-
402
-    /**
403
-     * Returns a JSON string of tags, for lazy loading.
404
-     *
405
-     * @param  HTTPRequest $request
406
-     * @return HTTPResponse
407
-     */
408
-    public function suggest(HTTPRequest $request)
409
-    {
410
-        $tags = $this->getTags($request->getVar('term'));
411
-
412
-        $response = HTTPResponse::create();
413
-        $response->addHeader('Content-Type', 'application/json');
414
-        $response->setBody(json_encode(['items' => $tags]));
415
-
416
-        return $response;
417
-    }
418
-
419
-    /**
420
-     * Returns array of arrays representing tags.
421
-     *
422
-     * @param  string $term
423
-     * @return array
424
-     */
425
-    protected function getTags($term)
426
-    {
427
-        $source = $this->getSourceList();
428
-
429
-        $titleField = $this->getTitleField();
430
-
431
-        $query = $source
432
-            ->filter($titleField . ':PartialMatch:nocase', $term)
433
-            ->sort($titleField)
434
-            ->limit($this->getLazyLoadItemLimit());
435
-
436
-        // Map into a distinct list
437
-        $items = [];
438
-        $titleField = $this->getTitleField();
439
-        foreach ($query->map('ID', $titleField) as $id => $title) {
440
-            $items[$title] = [
441
-                'id' => $title,
442
-                'text' => $title,
443
-            ];
444
-        }
445
-
446
-        return array_values($items);
447
-    }
448
-
449
-    /**
450
-     * DropdownField assumes value will be a scalar so we must
451
-     * override validate. This only applies to Silverstripe 3.2+
452
-     *
453
-     * @param Validator $validator
454
-     * @return bool
455
-     */
456
-    public function validate($validator)
457
-    {
458
-        return true;
459
-    }
460
-
461
-    /**
462
-     * Converts the field to a readonly variant.
463
-     *
464
-     * @return ReadonlyTagField
465
-     */
466
-    public function performReadonlyTransformation()
467
-    {
468
-        /** @var ReadonlyTagField $copy */
469
-        $copy = $this->castedCopy(ReadonlyTagField::class);
470
-        $copy->setSourceList($this->getSourceList());
471
-        return $copy;
472
-    }
473
-
474
-    /**
475
-     * Prevent the default, which would return "tag"
476
-     *
477
-     * @return string
478
-     */
479
-    public function Type()
480
-    {
481
-        return '';
482
-    }
27
+	/**
28
+	 * @var array
29
+	 */
30
+	private static $allowed_actions = [
31
+		'suggest',
32
+	];
33
+
34
+	/**
35
+	 * @var bool
36
+	 */
37
+	protected $shouldLazyLoad = false;
38
+
39
+	/**
40
+	 * @var int
41
+	 */
42
+	protected $lazyLoadItemLimit = 10;
43
+
44
+	/**
45
+	 * @var bool
46
+	 */
47
+	protected $canCreate = true;
48
+
49
+	/**
50
+	 * @var string
51
+	 */
52
+	protected $titleField = 'Title';
53
+
54
+	/**
55
+	 * @var DataList
56
+	 */
57
+	protected $sourceList;
58
+
59
+	/**
60
+	 * @var bool
61
+	 */
62
+	protected $isMultiple = true;
63
+
64
+	/**
65
+	 * @param string $name
66
+	 * @param string $title
67
+	 * @param null|DataList $source
68
+	 * @param null|DataList $value
69
+	 * @param string $titleField
70
+	 */
71
+	public function __construct($name, $title = '', $source = [], $value = null, $titleField = 'Title')
72
+	{
73
+		$this->setSourceList($source);
74
+		$this->setTitleField($titleField);
75
+		parent::__construct($name, $title, $source, $value);
76
+	}
77
+
78
+	/**
79
+	 * @return bool
80
+	 */
81
+	public function getShouldLazyLoad()
82
+	{
83
+		return $this->shouldLazyLoad;
84
+	}
85
+
86
+	/**
87
+	 * @param bool $shouldLazyLoad
88
+	 *
89
+	 * @return static
90
+	 */
91
+	public function setShouldLazyLoad($shouldLazyLoad)
92
+	{
93
+		$this->shouldLazyLoad = $shouldLazyLoad;
94
+
95
+		return $this;
96
+	}
97
+
98
+	/**
99
+	 * @return int
100
+	 */
101
+	public function getLazyLoadItemLimit()
102
+	{
103
+		return $this->lazyLoadItemLimit;
104
+	}
105
+
106
+	/**
107
+	 * @param int $lazyLoadItemLimit
108
+	 *
109
+	 * @return static
110
+	 */
111
+	public function setLazyLoadItemLimit($lazyLoadItemLimit)
112
+	{
113
+		$this->lazyLoadItemLimit = $lazyLoadItemLimit;
114
+
115
+		return $this;
116
+	}
117
+
118
+	/**
119
+	 * @return bool
120
+	 */
121
+	public function getIsMultiple()
122
+	{
123
+		return $this->isMultiple;
124
+	}
125
+
126
+	/**
127
+	 * @param bool $isMultiple
128
+	 *
129
+	 * @return static
130
+	 */
131
+	public function setIsMultiple($isMultiple)
132
+	{
133
+		$this->isMultiple = $isMultiple;
134
+
135
+		return $this;
136
+	}
137
+
138
+	/**
139
+	 * @return bool
140
+	 */
141
+	public function getCanCreate()
142
+	{
143
+		return $this->canCreate;
144
+	}
145
+
146
+	/**
147
+	 * @param bool $canCreate
148
+	 *
149
+	 * @return static
150
+	 */
151
+	public function setCanCreate($canCreate)
152
+	{
153
+		$this->canCreate = $canCreate;
154
+
155
+		return $this;
156
+	}
157
+
158
+	/**
159
+	 * @return string
160
+	 */
161
+	public function getTitleField()
162
+	{
163
+		return $this->titleField;
164
+	}
165
+
166
+	/**
167
+	 * @param string $titleField
168
+	 *
169
+	 * @return $this
170
+	 */
171
+	public function setTitleField($titleField)
172
+	{
173
+		$this->titleField = $titleField;
174
+
175
+		return $this;
176
+	}
177
+
178
+	/**
179
+	 * Get the DataList source. The 4.x upgrade for SelectField::setSource starts to convert this to an array
180
+	 * @return DataList
181
+	 */
182
+	public function getSourceList()
183
+	{
184
+		return $this->sourceList;
185
+	}
186
+
187
+	/**
188
+	 * Set the model class name for tags
189
+	 * @param  DataList $className
190
+	 * @return self
191
+	 */
192
+	public function setSourceList($sourceList)
193
+	{
194
+		$this->sourceList = $sourceList;
195
+		return $this;
196
+	}
197
+
198
+	/**
199
+	 * {@inheritdoc}
200
+	 */
201
+	public function Field($properties = [])
202
+	{
203
+		$this->addExtraClass('ss-tag-field');
204
+
205
+		return $this->customise($properties)->renderWith(self::class);
206
+	}
207
+
208
+	/**
209
+	 * Provide TagField data to the JSON schema for the frontend component
210
+	 *
211
+	 * @return array
212
+	 */
213
+	public function getSchemaDataDefaults()
214
+	{
215
+		$schema = array_merge(
216
+			parent::getSchemaDataDefaults(),
217
+			[
218
+				'name' => $this->getName() . '[]',
219
+				'lazyLoad' => $this->getShouldLazyLoad(),
220
+				'creatable' => $this->getCanCreate(),
221
+				'multi' => $this->getIsMultiple(),
222
+				'value' => $this->Value(),
223
+				'disabled' => $this->isDisabled() || $this->isReadonly(),
224
+			]
225
+		);
226
+
227
+		if (!$this->getShouldLazyLoad()) {
228
+			$schema['options'] = array_values($this->getOptions()->toNestedArray());
229
+		} else {
230
+			if ($this->Value()) {
231
+				$schema['value'] = $this->getOptions(true)->toNestedArray();
232
+			}
233
+			$schema['optionUrl'] = $this->getSuggestURL();
234
+		}
235
+
236
+		return $schema;
237
+	}
238
+
239
+	/**
240
+	 * When not used in a React form factory context, this adds the schema data to SilverStripe template
241
+	 * rendered attributes lists
242
+	 *
243
+	 * @return array
244
+	 */
245
+	public function getAttributes()
246
+	{
247
+		$attributes = parent::getAttributes();
248
+		$attributes['data-schema'] = json_encode($this->getSchemaData());
249
+		return $attributes;
250
+	}
251
+
252
+	/**
253
+	 * @return string
254
+	 */
255
+	protected function getSuggestURL()
256
+	{
257
+		return Controller::join_links($this->Link(), 'suggest');
258
+	}
259
+
260
+	/**
261
+	 * @param bool $onlySelected Only return options that are selected
262
+	 * @return ArrayList
263
+	 */
264
+	protected function getOptions($onlySelected = false)
265
+	{
266
+		$source = $this->getSourceList();
267
+
268
+		if (!$source) {
269
+			$source = ArrayList::create();
270
+		}
271
+
272
+		$dataClass = $source->dataClass();
273
+		$titleField = $this->getTitleField();
274
+		$values = $this->Value();
275
+
276
+		if ($values) {
277
+			if (is_array($values)) {
278
+				$values = $source->filter($titleField, $values);
279
+			}
280
+		}
281
+		if ($onlySelected) {
282
+			$source = $values;
283
+		}
284
+
285
+		return $source instanceof DataList ? $this->formatOptions($source) : ArrayList::create();
286
+	}
287
+
288
+	/**
289
+	 * @param DataList $source
290
+	 * @return ArrayList
291
+	 */
292
+	protected function formatOptions(DataList $source)
293
+	{
294
+		$options = ArrayList::create();
295
+		$titleField = $this->getTitleField();
296
+
297
+		foreach ($source as $object) {
298
+			$options->push(
299
+				ArrayData::create([
300
+					'Title' => $object->$titleField,
301
+					'Value' => $object->Title,
302
+				])
303
+			);
304
+		}
305
+
306
+		return $options;
307
+	}
308
+
309
+	/**
310
+	 * {@inheritdoc}
311
+	 */
312
+	public function setValue($value, $source = null)
313
+	{
314
+		if ($source instanceof DataObject) {
315
+			$name = $this->getName();
316
+
317
+			if ($source->hasMethod($name)) {
318
+				$value = $source->$name()->column($this->getTitleField());
319
+			}
320
+		} elseif ($value instanceof SS_List) {
321
+			$value = $value->column($this->getTitleField());
322
+		}
323
+
324
+		if (!is_array($value)) {
325
+			return parent::setValue($value);
326
+		}
327
+
328
+		return parent::setValue(array_filter($value));
329
+	}
330
+
331
+	/**
332
+	 * {@inheritdoc}
333
+	 */
334
+	public function saveInto(DataObjectInterface $record)
335
+	{
336
+		parent::saveInto($record);
337
+
338
+		$name = $this->getName();
339
+		$titleField = $this->getTitleField();
340
+		$values = $this->Value();
341
+		$relation = $record->$name();
342
+		$ids = [];
343
+
344
+		if (!$values) {
345
+			$values = [];
346
+		}
347
+		if (empty($record) || empty($titleField)) {
348
+			return;
349
+		}
350
+
351
+		if (!$record->hasMethod($name)) {
352
+			throw new Exception(
353
+				sprintf("%s does not have a %s method", get_class($record), $name)
354
+			);
355
+		}
356
+
357
+		foreach ($values as $key => $value) {
358
+			// Get or create record
359
+			$record = $this->getOrCreateTag($value);
360
+			if ($record) {
361
+				$ids[] = $record->ID;
362
+				$values[$key] = $record->Title;
363
+			}
364
+		}
365
+
366
+		$relation->setByIDList(array_filter($ids));
367
+	}
368
+
369
+	/**
370
+	 * Get or create tag with the given value
371
+	 *
372
+	 * @param  string $term
373
+	 * @return DataObject|bool
374
+	 */
375
+	protected function getOrCreateTag($term)
376
+	{
377
+		// Check if existing record can be found
378
+		$source = $this->getSourceList();
379
+		$titleField = $this->getTitleField();
380
+		$record = $source
381
+			->filter($titleField, $term)
382
+			->first();
383
+		if ($record) {
384
+			return $record;
385
+		}
386
+
387
+		// Create new instance if not yet saved
388
+		if ($this->getCanCreate()) {
389
+			$dataClass = $source->dataClass();
390
+			$record = Injector::inst()->create($dataClass);
391
+			$record->{$titleField} = $term;
392
+			$record->write();
393
+			if ($source instanceof SS_List) {
394
+				$source->add($record);
395
+			}
396
+			return $record;
397
+		}
398
+
399
+		return false;
400
+	}
401
+
402
+	/**
403
+	 * Returns a JSON string of tags, for lazy loading.
404
+	 *
405
+	 * @param  HTTPRequest $request
406
+	 * @return HTTPResponse
407
+	 */
408
+	public function suggest(HTTPRequest $request)
409
+	{
410
+		$tags = $this->getTags($request->getVar('term'));
411
+
412
+		$response = HTTPResponse::create();
413
+		$response->addHeader('Content-Type', 'application/json');
414
+		$response->setBody(json_encode(['items' => $tags]));
415
+
416
+		return $response;
417
+	}
418
+
419
+	/**
420
+	 * Returns array of arrays representing tags.
421
+	 *
422
+	 * @param  string $term
423
+	 * @return array
424
+	 */
425
+	protected function getTags($term)
426
+	{
427
+		$source = $this->getSourceList();
428
+
429
+		$titleField = $this->getTitleField();
430
+
431
+		$query = $source
432
+			->filter($titleField . ':PartialMatch:nocase', $term)
433
+			->sort($titleField)
434
+			->limit($this->getLazyLoadItemLimit());
435
+
436
+		// Map into a distinct list
437
+		$items = [];
438
+		$titleField = $this->getTitleField();
439
+		foreach ($query->map('ID', $titleField) as $id => $title) {
440
+			$items[$title] = [
441
+				'id' => $title,
442
+				'text' => $title,
443
+			];
444
+		}
445
+
446
+		return array_values($items);
447
+	}
448
+
449
+	/**
450
+	 * DropdownField assumes value will be a scalar so we must
451
+	 * override validate. This only applies to Silverstripe 3.2+
452
+	 *
453
+	 * @param Validator $validator
454
+	 * @return bool
455
+	 */
456
+	public function validate($validator)
457
+	{
458
+		return true;
459
+	}
460
+
461
+	/**
462
+	 * Converts the field to a readonly variant.
463
+	 *
464
+	 * @return ReadonlyTagField
465
+	 */
466
+	public function performReadonlyTransformation()
467
+	{
468
+		/** @var ReadonlyTagField $copy */
469
+		$copy = $this->castedCopy(ReadonlyTagField::class);
470
+		$copy->setSourceList($this->getSourceList());
471
+		return $copy;
472
+	}
473
+
474
+	/**
475
+	 * Prevent the default, which would return "tag"
476
+	 *
477
+	 * @return string
478
+	 */
479
+	public function Type()
480
+	{
481
+		return '';
482
+	}
483 483
 }
Please login to merge, or discard this patch.
tests/StringTagFieldTest.php 1 patch
Indentation   +140 added lines, -140 removed lines patch added patch discarded remove patch
@@ -15,144 +15,144 @@
 block discarded – undo
15 15
  */
16 16
 class StringTagFieldTest extends SapphireTest
17 17
 {
18
-    /**
19
-     * @var string
20
-     */
21
-    protected static $fixture_file = 'StringTagFieldTest.yml';
22
-
23
-    /**
24
-     * @var array
25
-     */
26
-    protected static $extra_dataobjects = [
27
-        StringTagFieldTestBlogPost::class,
28
-    ];
29
-
30
-    public function testItSavesTagsOnNewRecords()
31
-    {
32
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
33
-
34
-        $field = new StringTagField('Tags');
35
-        $field->setValue(['Tag1', 'Tag2']);
36
-        $field->saveInto($record);
37
-
38
-        $record->write();
39
-
40
-        $this->assertEquals('Tag1,Tag2', $record->Tags);
41
-    }
42
-
43
-    /**
44
-     * @param string $name
45
-     *
46
-     * @return StringTagFieldTestBlogPost
47
-     */
48
-    protected function getNewStringTagFieldTestBlogPost($name)
49
-    {
50
-        return $this->objFromFixture(
51
-            StringTagFieldTestBlogPost::class,
52
-            $name
53
-        );
54
-    }
55
-
56
-    public function testItSavesTagsOnExistingRecords()
57
-    {
58
-        $record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
59
-        $record->write();
60
-
61
-        $field = new StringTagField('Tags');
62
-        $field->setValue(['Tag1', 'Tag2']);
63
-        $field->saveInto($record);
64
-
65
-        $this->assertEquals('Tag1,Tag2', $record->Tags);
66
-    }
67
-
68
-    public function testItSuggestsTags()
69
-    {
70
-        $field = new StringTagField('SomeField', 'Some field', ['Tag1', 'Tag2'], []);
71
-
72
-        /**
73
-         * Partial tag title match.
74
-         */
75
-        $request = $this->getNewRequest(['term' => 'Tag']);
76
-
77
-        $this->assertEquals(
78
-            '{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
79
-            $field->suggest($request)->getBody()
80
-        );
81
-
82
-        /**
83
-         * Exact tag title match.
84
-         */
85
-        $request = $this->getNewRequest(['term' => 'Tag1']);
86
-
87
-        $this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
88
-
89
-        /**
90
-         * Case-insensitive tag title match.
91
-         */
92
-        $request = $this->getNewRequest(['term' => 'TAG1']);
93
-
94
-        $this->assertEquals(
95
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
96
-            $field->suggest($request)->getBody()
97
-        );
98
-
99
-        /**
100
-         * No tag title match.
101
-         */
102
-        $request = $this->getNewRequest(['term' => 'unknown']);
103
-
104
-        $this->assertEquals(
105
-            '{"items":[]}',
106
-            $field->suggest($request)->getBody()
107
-        );
108
-    }
109
-
110
-    public function testGetSchemaDataDefaults()
111
-    {
112
-        $form = new Form(null, 'Form', new FieldList(), new FieldList());
113
-        $field = new StringTagField('TestField', 'Test Field', ['one', 'two']);
114
-        $field->setForm($form);
115
-
116
-        $field
117
-            ->setShouldLazyLoad(false)
118
-            ->setCanCreate(false);
119
-
120
-        $schema = $field->getSchemaDataDefaults();
121
-        $this->assertSame('TestField[]', $schema['name']);
122
-        $this->assertFalse($schema['lazyLoad']);
123
-        $this->assertFalse($schema['creatable']);
124
-        $this->assertEquals([
125
-            ['Title' => 'one', 'Value' => 'one'],
126
-            ['Title' => 'two', 'Value' => 'two'],
127
-        ], $schema['options']);
128
-
129
-        $field
130
-            ->setShouldLazyLoad(true)
131
-            ->setCanCreate(true);
132
-
133
-        $schema = $field->getSchemaDataDefaults();
134
-        $this->assertTrue($schema['lazyLoad']);
135
-        $this->assertTrue($schema['creatable']);
136
-        $this->assertContains('suggest', $schema['optionUrl']);
137
-    }
138
-
139
-    public function testSchemaIsAddedToAttributes()
140
-    {
141
-        $field = new StringTagField('TestField');
142
-        $attributes = $field->getAttributes();
143
-        $this->assertNotEmpty($attributes['data-schema']);
144
-    }
145
-
146
-    /**
147
-     * @param array $parameters
148
-     * @return HTTPRequest
149
-     */
150
-    protected function getNewRequest(array $parameters)
151
-    {
152
-        return new HTTPRequest(
153
-            'get',
154
-            'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
155
-            $parameters
156
-        );
157
-    }
18
+	/**
19
+	 * @var string
20
+	 */
21
+	protected static $fixture_file = 'StringTagFieldTest.yml';
22
+
23
+	/**
24
+	 * @var array
25
+	 */
26
+	protected static $extra_dataobjects = [
27
+		StringTagFieldTestBlogPost::class,
28
+	];
29
+
30
+	public function testItSavesTagsOnNewRecords()
31
+	{
32
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
33
+
34
+		$field = new StringTagField('Tags');
35
+		$field->setValue(['Tag1', 'Tag2']);
36
+		$field->saveInto($record);
37
+
38
+		$record->write();
39
+
40
+		$this->assertEquals('Tag1,Tag2', $record->Tags);
41
+	}
42
+
43
+	/**
44
+	 * @param string $name
45
+	 *
46
+	 * @return StringTagFieldTestBlogPost
47
+	 */
48
+	protected function getNewStringTagFieldTestBlogPost($name)
49
+	{
50
+		return $this->objFromFixture(
51
+			StringTagFieldTestBlogPost::class,
52
+			$name
53
+		);
54
+	}
55
+
56
+	public function testItSavesTagsOnExistingRecords()
57
+	{
58
+		$record = $this->getNewStringTagFieldTestBlogPost('BlogPost1');
59
+		$record->write();
60
+
61
+		$field = new StringTagField('Tags');
62
+		$field->setValue(['Tag1', 'Tag2']);
63
+		$field->saveInto($record);
64
+
65
+		$this->assertEquals('Tag1,Tag2', $record->Tags);
66
+	}
67
+
68
+	public function testItSuggestsTags()
69
+	{
70
+		$field = new StringTagField('SomeField', 'Some field', ['Tag1', 'Tag2'], []);
71
+
72
+		/**
73
+		 * Partial tag title match.
74
+		 */
75
+		$request = $this->getNewRequest(['term' => 'Tag']);
76
+
77
+		$this->assertEquals(
78
+			'{"items":[{"id":"Tag1","text":"Tag1"},{"id":"Tag2","text":"Tag2"}]}',
79
+			$field->suggest($request)->getBody()
80
+		);
81
+
82
+		/**
83
+		 * Exact tag title match.
84
+		 */
85
+		$request = $this->getNewRequest(['term' => 'Tag1']);
86
+
87
+		$this->assertEquals($field->suggest($request)->getBody(), '{"items":[{"id":"Tag1","text":"Tag1"}]}');
88
+
89
+		/**
90
+		 * Case-insensitive tag title match.
91
+		 */
92
+		$request = $this->getNewRequest(['term' => 'TAG1']);
93
+
94
+		$this->assertEquals(
95
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
96
+			$field->suggest($request)->getBody()
97
+		);
98
+
99
+		/**
100
+		 * No tag title match.
101
+		 */
102
+		$request = $this->getNewRequest(['term' => 'unknown']);
103
+
104
+		$this->assertEquals(
105
+			'{"items":[]}',
106
+			$field->suggest($request)->getBody()
107
+		);
108
+	}
109
+
110
+	public function testGetSchemaDataDefaults()
111
+	{
112
+		$form = new Form(null, 'Form', new FieldList(), new FieldList());
113
+		$field = new StringTagField('TestField', 'Test Field', ['one', 'two']);
114
+		$field->setForm($form);
115
+
116
+		$field
117
+			->setShouldLazyLoad(false)
118
+			->setCanCreate(false);
119
+
120
+		$schema = $field->getSchemaDataDefaults();
121
+		$this->assertSame('TestField[]', $schema['name']);
122
+		$this->assertFalse($schema['lazyLoad']);
123
+		$this->assertFalse($schema['creatable']);
124
+		$this->assertEquals([
125
+			['Title' => 'one', 'Value' => 'one'],
126
+			['Title' => 'two', 'Value' => 'two'],
127
+		], $schema['options']);
128
+
129
+		$field
130
+			->setShouldLazyLoad(true)
131
+			->setCanCreate(true);
132
+
133
+		$schema = $field->getSchemaDataDefaults();
134
+		$this->assertTrue($schema['lazyLoad']);
135
+		$this->assertTrue($schema['creatable']);
136
+		$this->assertContains('suggest', $schema['optionUrl']);
137
+	}
138
+
139
+	public function testSchemaIsAddedToAttributes()
140
+	{
141
+		$field = new StringTagField('TestField');
142
+		$attributes = $field->getAttributes();
143
+		$this->assertNotEmpty($attributes['data-schema']);
144
+	}
145
+
146
+	/**
147
+	 * @param array $parameters
148
+	 * @return HTTPRequest
149
+	 */
150
+	protected function getNewRequest(array $parameters)
151
+	{
152
+		return new HTTPRequest(
153
+			'get',
154
+			'StringTagFieldTestController/StringTagFieldTestForm/fields/Tags/suggest',
155
+			$parameters
156
+		);
157
+	}
158 158
 }
Please login to merge, or discard this patch.