Passed
Pull Request — master (#142)
by
unknown
02:31
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.
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.
tests/TagFieldTest.php 1 patch
Indentation   +369 added lines, -369 removed lines patch added patch discarded remove patch
@@ -20,373 +20,373 @@
 block discarded – undo
20 20
  */
21 21
 class TagFieldTest extends SapphireTest
22 22
 {
23
-    /**
24
-     * @var string
25
-     */
26
-    protected static $fixture_file = 'TagFieldTest.yml';
27
-
28
-    /**
29
-     * @var array
30
-     */
31
-    protected static $extra_dataobjects = [
32
-        TagFieldTestBlogTag::class,
33
-        TagFieldTestBlogPost::class,
34
-    ];
35
-
36
-    public function testItSavesLinksToNewTagsOnNewRecords()
37
-    {
38
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
39
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
40
-        $field->setValue(['Tag3', 'Tag4']);
41
-        $field->saveInto($record);
42
-        $record->write();
43
-        $this->compareExpectedAndActualTags(
44
-            ['Tag3', 'Tag4'],
45
-            $record
46
-        );
47
-    }
48
-
49
-    /**
50
-     * @param string $name
51
-     *
52
-     * @return TagFieldTestBlogPost
53
-     */
54
-    protected function getNewTagFieldTestBlogPost($name)
55
-    {
56
-        return $this->objFromFixture(
57
-            TagFieldTestBlogPost::class,
58
-            $name
59
-        );
60
-    }
61
-
62
-    /**
63
-     * @param array $expected
64
-     * @param TagFieldTestBlogPost $record
65
-     */
66
-    protected function compareExpectedAndActualTags(array $expected, TagFieldTestBlogPost $record)
67
-    {
68
-        $this->compareTagLists($expected, $record->Tags());
69
-    }
70
-
71
-    /**
72
-     * Ensure a source of tags matches the given string tag names
73
-     *
74
-     * @param array $expected
75
-     * @param DataList $actualSource
76
-     */
77
-    protected function compareTagLists(array $expected, DataList $actualSource)
78
-    {
79
-        $actual = array_values($actualSource->map('ID', 'Title')->toArray());
80
-        sort($expected);
81
-        sort($actual);
82
-
83
-        $this->assertEquals(
84
-            $expected,
85
-            $actual
86
-        );
87
-    }
88
-
89
-    public function testItSavesLinksToNewTagsOnExistingRecords()
90
-    {
91
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
92
-        $record->write();
93
-
94
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
95
-        $field->setValue(['Tag3', 'Tag4']);
96
-        $field->saveInto($record);
97
-
98
-        $this->compareExpectedAndActualTags(
99
-            array('Tag3', 'Tag4'),
100
-            $record
101
-        );
102
-    }
103
-
104
-    public function testItSavesLinksToExistingTagsOnNewRecords()
105
-    {
106
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
107
-
108
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
109
-        $field->setValue(['Tag1', 'Tag2']);
110
-        $field->saveInto($record);
111
-
112
-        $record->write();
113
-
114
-        $this->compareExpectedAndActualTags(
115
-            ['Tag1', 'Tag2'],
116
-            $record
117
-        );
118
-    }
119
-
120
-    public function testItSavesLinksToExistingTagsOnExistingRecords()
121
-    {
122
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
123
-        $record->write();
124
-
125
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
126
-        $field->setValue(['Tag1', 'Tag2']);
127
-        $field->saveInto($record);
128
-
129
-        $this->compareExpectedAndActualTags(
130
-            ['Tag1', 'Tag2'],
131
-            $record
132
-        );
133
-    }
134
-
135
-    /**
136
-     * Ensure that {@see TagField::saveInto} respects existing tags
137
-     */
138
-    public function testSaveDuplicateTags()
139
-    {
140
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost2');
141
-        $record->write();
142
-        $tag2ID = $this->idFromFixture(TagFieldTestBlogTag::class, 'Tag2');
143
-
144
-        // Check tags before write
145
-        $this->compareExpectedAndActualTags(
146
-            ['Tag1', '222'],
147
-            $record
148
-        );
149
-        $this->compareTagLists(
150
-            ['Tag1', '222'],
151
-            TagFieldTestBlogTag::get()
152
-        );
153
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
154
-
155
-        // Write new tags
156
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
157
-        $field->setValue(['222', 'Tag3']);
158
-        $field->saveInto($record);
159
-
160
-        // Check only one new tag was added
161
-        $this->compareExpectedAndActualTags(
162
-            ['222', 'Tag3'],
163
-            $record
164
-        );
165
-
166
-        // Ensure that only one new dataobject was added and that tag2s id has not changed
167
-        $this->compareTagLists(
168
-            ['Tag1', '222', 'Tag3'],
169
-            TagFieldTestBlogTag::get()
170
-        );
171
-        $this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
172
-    }
173
-
174
-    public function testItSuggestsTags()
175
-    {
176
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
177
-
178
-        /**
179
-         * Partial tag title match.
180
-         */
181
-        $request = $this->getNewRequest(['term' => 'Tag']);
182
-
183
-        $this->assertEquals(
184
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
185
-            $field->suggest($request)->getBody()
186
-        );
187
-
188
-        /**
189
-         * Exact tag title match.
190
-         */
191
-        $request = $this->getNewRequest(['term' => '222']);
192
-
193
-        $this->assertEquals(
194
-            '{"items":[{"id":"222","text":"222"}]}',
195
-            $field->suggest($request)->getBody()
196
-        );
197
-
198
-        /**
199
-         * Case-insensitive tag title match.
200
-         */
201
-        $request = $this->getNewRequest(['term' => 'TAG1']);
202
-
203
-        $this->assertEquals(
204
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
205
-            $field->suggest($request)->getBody()
206
-        );
207
-
208
-        /**
209
-         * No tag title match.
210
-         */
211
-        $request = $this->getNewRequest(['term' => 'unknown']);
212
-
213
-        $this->assertEquals(
214
-            '{"items":[]}',
215
-            $field->suggest($request)->getBody()
216
-        );
217
-    }
218
-
219
-    /**
220
-     * Tests that TagField supports pre-filtered data sources
221
-     */
222
-    public function testRestrictedSuggestions()
223
-    {
224
-        $source = TagFieldTestBlogTag::get()->exclude('Title', 'Tag2');
225
-        $field = new TagField('Tags', '', $source);
226
-
227
-        /**
228
-         * Partial tag title match.
229
-         */
230
-        $request = $this->getNewRequest(['term' => 'Tag']);
231
-
232
-        $this->assertEquals(
233
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
234
-            $field->suggest($request)->getBody()
235
-        );
236
-
237
-        /**
238
-         * Exact tag title match.
239
-         */
240
-        $request = $this->getNewRequest(['term' => 'Tag1']);
241
-
242
-        $this->assertEquals(
243
-            '{"items":[{"id":"Tag1","text":"Tag1"}]}',
244
-            $field->suggest($request)->getBody()
245
-        );
246
-
247
-        /**
248
-         * Excluded item doesn't appear in matches
249
-         */
250
-        $request = $this->getNewRequest(['term' => 'Tag2']);
251
-
252
-        $this->assertEquals(
253
-            '{"items":[]}',
254
-            $field->suggest($request)->getBody()
255
-        );
256
-    }
257
-
258
-    /**
259
-     * @param array $parameters
260
-     *
261
-     * @return HTTPRequest
262
-     */
263
-    protected function getNewRequest(array $parameters)
264
-    {
265
-        return new HTTPRequest(
266
-            'get',
267
-            'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
268
-            $parameters
269
-        );
270
-    }
271
-
272
-    public function testItDisplaysValuesFromRelations()
273
-    {
274
-        $record = $this->getNewTagFieldTestBlogPost('BlogPost1');
275
-        $record->write();
276
-
277
-        $form = new Form(
278
-            new TagFieldTestController(),
279
-            'Form',
280
-            new FieldList(
281
-                $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class))
282
-            ),
283
-            new FieldList()
284
-        );
285
-
286
-        $form->loadDataFrom(
287
-            $this->objFromFixture(TagFieldTestBlogPost::class, 'BlogPost2')
288
-        );
289
-
290
-        $ids = TagFieldTestBlogTag::get()->column('Title');
291
-
292
-        $this->assertEquals($field->Value(), $ids);
293
-    }
294
-
295
-    public function testItIgnoresNewTagsIfCannotCreate()
296
-    {
297
-        $this->markTestSkipped(
298
-            'This test has not been updated yet.'
299
-        );
300
-
301
-        $record = new TagFieldTestBlogPost();
302
-        $record->write();
303
-
304
-        $tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
305
-
306
-        $field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class), [$tag->Title, 'Tag3']);
307
-        $field->setCanCreate(false);
308
-        $field->saveInto($record);
309
-
310
-        /**
311
-         * @var TagFieldTestBlogPost $record
312
-         */
313
-        $record = DataObject::get_by_id(TagFieldTestBlogPost::class, $record->ID);
314
-
315
-        $this->compareExpectedAndActualTags(
316
-            ['Tag1'],
317
-            $record
318
-        );
319
-    }
320
-
321
-    /**
322
-     * Test you can save without a source set
323
-     */
324
-    public function testSaveEmptySource()
325
-    {
326
-        $record = new TagFieldTestBlogPost();
327
-        $record->write();
328
-
329
-        // Clear database of tags
330
-        TagFieldTestBlogTag::get()->removeAll();
331
-
332
-        $field = new TagField('Tags', '', TagFieldTestBlogTag::get());
333
-        $field->setValue(['New Tag']);
334
-        $field->setCanCreate(true);
335
-        $field->saveInto($record);
336
-
337
-        $tag = TagFieldTestBlogTag::get()->first();
338
-        $this->assertNotEmpty($tag);
339
-        $this->assertEquals('New Tag', $tag->Title);
340
-        $record = TagFieldTestBlogPost::get()->byID($record->ID);
341
-        $this->assertEquals(
342
-            $tag->ID,
343
-            $record->Tags()->first()->ID
344
-        );
345
-    }
346
-
347
-    /**
348
-     * Test read only fields are returned
349
-     */
350
-    public function testReadonlyTransformation()
351
-    {
352
-        $field = new TagField('Tags', '', TagFieldTestBlogTag::get());
353
-        $readOnlyField = $field->performReadonlyTransformation();
354
-        $this->assertInstanceOf(ReadonlyTagField::class, $readOnlyField);
355
-    }
356
-
357
-    public function testGetSchemaDataDefaults()
358
-    {
359
-        $form = new Form(null, 'Form', new FieldList(), new FieldList());
360
-        $field = new TagField('TestField', 'Test Field', TagFieldTestBlogTag::get());
361
-        $field->setForm($form);
362
-
363
-        $field
364
-            ->setShouldLazyLoad(false)
365
-            ->setCanCreate(false);
366
-
367
-        $schema = $field->getSchemaDataDefaults();
368
-        $this->assertSame('TestField[]', $schema['name']);
369
-        $this->assertFalse($schema['lazyLoad']);
370
-        $this->assertFalse($schema['creatable']);
371
-        $this->assertEquals([
372
-            ['Title' => 'Tag1', 'Value' => 'Tag1'],
373
-            ['Title' => '222', 'Value' => '222'],
374
-        ], $schema['options']);
375
-
376
-        $field
377
-            ->setShouldLazyLoad(true)
378
-            ->setCanCreate(true);
379
-
380
-        $schema = $field->getSchemaDataDefaults();
381
-        $this->assertTrue($schema['lazyLoad']);
382
-        $this->assertTrue($schema['creatable']);
383
-        $this->assertContains('suggest', $schema['optionUrl']);
384
-    }
385
-
386
-    public function testSchemaIsAddedToAttributes()
387
-    {
388
-        $field = new TagField('TestField');
389
-        $attributes = $field->getAttributes();
390
-        $this->assertNotEmpty($attributes['data-schema']);
391
-    }
23
+	/**
24
+	 * @var string
25
+	 */
26
+	protected static $fixture_file = 'TagFieldTest.yml';
27
+
28
+	/**
29
+	 * @var array
30
+	 */
31
+	protected static $extra_dataobjects = [
32
+		TagFieldTestBlogTag::class,
33
+		TagFieldTestBlogPost::class,
34
+	];
35
+
36
+	public function testItSavesLinksToNewTagsOnNewRecords()
37
+	{
38
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
39
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
40
+		$field->setValue(['Tag3', 'Tag4']);
41
+		$field->saveInto($record);
42
+		$record->write();
43
+		$this->compareExpectedAndActualTags(
44
+			['Tag3', 'Tag4'],
45
+			$record
46
+		);
47
+	}
48
+
49
+	/**
50
+	 * @param string $name
51
+	 *
52
+	 * @return TagFieldTestBlogPost
53
+	 */
54
+	protected function getNewTagFieldTestBlogPost($name)
55
+	{
56
+		return $this->objFromFixture(
57
+			TagFieldTestBlogPost::class,
58
+			$name
59
+		);
60
+	}
61
+
62
+	/**
63
+	 * @param array $expected
64
+	 * @param TagFieldTestBlogPost $record
65
+	 */
66
+	protected function compareExpectedAndActualTags(array $expected, TagFieldTestBlogPost $record)
67
+	{
68
+		$this->compareTagLists($expected, $record->Tags());
69
+	}
70
+
71
+	/**
72
+	 * Ensure a source of tags matches the given string tag names
73
+	 *
74
+	 * @param array $expected
75
+	 * @param DataList $actualSource
76
+	 */
77
+	protected function compareTagLists(array $expected, DataList $actualSource)
78
+	{
79
+		$actual = array_values($actualSource->map('ID', 'Title')->toArray());
80
+		sort($expected);
81
+		sort($actual);
82
+
83
+		$this->assertEquals(
84
+			$expected,
85
+			$actual
86
+		);
87
+	}
88
+
89
+	public function testItSavesLinksToNewTagsOnExistingRecords()
90
+	{
91
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
92
+		$record->write();
93
+
94
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
95
+		$field->setValue(['Tag3', 'Tag4']);
96
+		$field->saveInto($record);
97
+
98
+		$this->compareExpectedAndActualTags(
99
+			array('Tag3', 'Tag4'),
100
+			$record
101
+		);
102
+	}
103
+
104
+	public function testItSavesLinksToExistingTagsOnNewRecords()
105
+	{
106
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
107
+
108
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
109
+		$field->setValue(['Tag1', 'Tag2']);
110
+		$field->saveInto($record);
111
+
112
+		$record->write();
113
+
114
+		$this->compareExpectedAndActualTags(
115
+			['Tag1', 'Tag2'],
116
+			$record
117
+		);
118
+	}
119
+
120
+	public function testItSavesLinksToExistingTagsOnExistingRecords()
121
+	{
122
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
123
+		$record->write();
124
+
125
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
126
+		$field->setValue(['Tag1', 'Tag2']);
127
+		$field->saveInto($record);
128
+
129
+		$this->compareExpectedAndActualTags(
130
+			['Tag1', 'Tag2'],
131
+			$record
132
+		);
133
+	}
134
+
135
+	/**
136
+	 * Ensure that {@see TagField::saveInto} respects existing tags
137
+	 */
138
+	public function testSaveDuplicateTags()
139
+	{
140
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost2');
141
+		$record->write();
142
+		$tag2ID = $this->idFromFixture(TagFieldTestBlogTag::class, 'Tag2');
143
+
144
+		// Check tags before write
145
+		$this->compareExpectedAndActualTags(
146
+			['Tag1', '222'],
147
+			$record
148
+		);
149
+		$this->compareTagLists(
150
+			['Tag1', '222'],
151
+			TagFieldTestBlogTag::get()
152
+		);
153
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
154
+
155
+		// Write new tags
156
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
157
+		$field->setValue(['222', 'Tag3']);
158
+		$field->saveInto($record);
159
+
160
+		// Check only one new tag was added
161
+		$this->compareExpectedAndActualTags(
162
+			['222', 'Tag3'],
163
+			$record
164
+		);
165
+
166
+		// Ensure that only one new dataobject was added and that tag2s id has not changed
167
+		$this->compareTagLists(
168
+			['Tag1', '222', 'Tag3'],
169
+			TagFieldTestBlogTag::get()
170
+		);
171
+		$this->assertContains($tag2ID, TagFieldTestBlogTag::get()->column('ID'));
172
+	}
173
+
174
+	public function testItSuggestsTags()
175
+	{
176
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class));
177
+
178
+		/**
179
+		 * Partial tag title match.
180
+		 */
181
+		$request = $this->getNewRequest(['term' => 'Tag']);
182
+
183
+		$this->assertEquals(
184
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
185
+			$field->suggest($request)->getBody()
186
+		);
187
+
188
+		/**
189
+		 * Exact tag title match.
190
+		 */
191
+		$request = $this->getNewRequest(['term' => '222']);
192
+
193
+		$this->assertEquals(
194
+			'{"items":[{"id":"222","text":"222"}]}',
195
+			$field->suggest($request)->getBody()
196
+		);
197
+
198
+		/**
199
+		 * Case-insensitive tag title match.
200
+		 */
201
+		$request = $this->getNewRequest(['term' => 'TAG1']);
202
+
203
+		$this->assertEquals(
204
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
205
+			$field->suggest($request)->getBody()
206
+		);
207
+
208
+		/**
209
+		 * No tag title match.
210
+		 */
211
+		$request = $this->getNewRequest(['term' => 'unknown']);
212
+
213
+		$this->assertEquals(
214
+			'{"items":[]}',
215
+			$field->suggest($request)->getBody()
216
+		);
217
+	}
218
+
219
+	/**
220
+	 * Tests that TagField supports pre-filtered data sources
221
+	 */
222
+	public function testRestrictedSuggestions()
223
+	{
224
+		$source = TagFieldTestBlogTag::get()->exclude('Title', 'Tag2');
225
+		$field = new TagField('Tags', '', $source);
226
+
227
+		/**
228
+		 * Partial tag title match.
229
+		 */
230
+		$request = $this->getNewRequest(['term' => 'Tag']);
231
+
232
+		$this->assertEquals(
233
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
234
+			$field->suggest($request)->getBody()
235
+		);
236
+
237
+		/**
238
+		 * Exact tag title match.
239
+		 */
240
+		$request = $this->getNewRequest(['term' => 'Tag1']);
241
+
242
+		$this->assertEquals(
243
+			'{"items":[{"id":"Tag1","text":"Tag1"}]}',
244
+			$field->suggest($request)->getBody()
245
+		);
246
+
247
+		/**
248
+		 * Excluded item doesn't appear in matches
249
+		 */
250
+		$request = $this->getNewRequest(['term' => 'Tag2']);
251
+
252
+		$this->assertEquals(
253
+			'{"items":[]}',
254
+			$field->suggest($request)->getBody()
255
+		);
256
+	}
257
+
258
+	/**
259
+	 * @param array $parameters
260
+	 *
261
+	 * @return HTTPRequest
262
+	 */
263
+	protected function getNewRequest(array $parameters)
264
+	{
265
+		return new HTTPRequest(
266
+			'get',
267
+			'TagFieldTestController/TagFieldTestForm/fields/Tags/suggest',
268
+			$parameters
269
+		);
270
+	}
271
+
272
+	public function testItDisplaysValuesFromRelations()
273
+	{
274
+		$record = $this->getNewTagFieldTestBlogPost('BlogPost1');
275
+		$record->write();
276
+
277
+		$form = new Form(
278
+			new TagFieldTestController(),
279
+			'Form',
280
+			new FieldList(
281
+				$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class))
282
+			),
283
+			new FieldList()
284
+		);
285
+
286
+		$form->loadDataFrom(
287
+			$this->objFromFixture(TagFieldTestBlogPost::class, 'BlogPost2')
288
+		);
289
+
290
+		$ids = TagFieldTestBlogTag::get()->column('Title');
291
+
292
+		$this->assertEquals($field->Value(), $ids);
293
+	}
294
+
295
+	public function testItIgnoresNewTagsIfCannotCreate()
296
+	{
297
+		$this->markTestSkipped(
298
+			'This test has not been updated yet.'
299
+		);
300
+
301
+		$record = new TagFieldTestBlogPost();
302
+		$record->write();
303
+
304
+		$tag = TagFieldTestBlogTag::get()->filter('Title', 'Tag1')->first();
305
+
306
+		$field = new TagField('Tags', '', new DataList(TagFieldTestBlogTag::class), [$tag->Title, 'Tag3']);
307
+		$field->setCanCreate(false);
308
+		$field->saveInto($record);
309
+
310
+		/**
311
+		 * @var TagFieldTestBlogPost $record
312
+		 */
313
+		$record = DataObject::get_by_id(TagFieldTestBlogPost::class, $record->ID);
314
+
315
+		$this->compareExpectedAndActualTags(
316
+			['Tag1'],
317
+			$record
318
+		);
319
+	}
320
+
321
+	/**
322
+	 * Test you can save without a source set
323
+	 */
324
+	public function testSaveEmptySource()
325
+	{
326
+		$record = new TagFieldTestBlogPost();
327
+		$record->write();
328
+
329
+		// Clear database of tags
330
+		TagFieldTestBlogTag::get()->removeAll();
331
+
332
+		$field = new TagField('Tags', '', TagFieldTestBlogTag::get());
333
+		$field->setValue(['New Tag']);
334
+		$field->setCanCreate(true);
335
+		$field->saveInto($record);
336
+
337
+		$tag = TagFieldTestBlogTag::get()->first();
338
+		$this->assertNotEmpty($tag);
339
+		$this->assertEquals('New Tag', $tag->Title);
340
+		$record = TagFieldTestBlogPost::get()->byID($record->ID);
341
+		$this->assertEquals(
342
+			$tag->ID,
343
+			$record->Tags()->first()->ID
344
+		);
345
+	}
346
+
347
+	/**
348
+	 * Test read only fields are returned
349
+	 */
350
+	public function testReadonlyTransformation()
351
+	{
352
+		$field = new TagField('Tags', '', TagFieldTestBlogTag::get());
353
+		$readOnlyField = $field->performReadonlyTransformation();
354
+		$this->assertInstanceOf(ReadonlyTagField::class, $readOnlyField);
355
+	}
356
+
357
+	public function testGetSchemaDataDefaults()
358
+	{
359
+		$form = new Form(null, 'Form', new FieldList(), new FieldList());
360
+		$field = new TagField('TestField', 'Test Field', TagFieldTestBlogTag::get());
361
+		$field->setForm($form);
362
+
363
+		$field
364
+			->setShouldLazyLoad(false)
365
+			->setCanCreate(false);
366
+
367
+		$schema = $field->getSchemaDataDefaults();
368
+		$this->assertSame('TestField[]', $schema['name']);
369
+		$this->assertFalse($schema['lazyLoad']);
370
+		$this->assertFalse($schema['creatable']);
371
+		$this->assertEquals([
372
+			['Title' => 'Tag1', 'Value' => 'Tag1'],
373
+			['Title' => '222', 'Value' => '222'],
374
+		], $schema['options']);
375
+
376
+		$field
377
+			->setShouldLazyLoad(true)
378
+			->setCanCreate(true);
379
+
380
+		$schema = $field->getSchemaDataDefaults();
381
+		$this->assertTrue($schema['lazyLoad']);
382
+		$this->assertTrue($schema['creatable']);
383
+		$this->assertContains('suggest', $schema['optionUrl']);
384
+	}
385
+
386
+	public function testSchemaIsAddedToAttributes()
387
+	{
388
+		$field = new TagField('TestField');
389
+		$attributes = $field->getAttributes();
390
+		$this->assertNotEmpty($attributes['data-schema']);
391
+	}
392 392
 }
Please login to merge, or discard this patch.