Passed
Push — master ( 85cd01...c58492 )
by Aimeos
03:18
created

Standard::render()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 25
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 1
dl 0
loc 25
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5
 * @copyright Aimeos (aimeos.org), 2017-2021
6
 * @package Admin
7
 * @subpackage JQAdm
8
 */
9
10
11
namespace Aimeos\Admin\JQAdm\Attribute\Text;
12
13
sprintf( 'text' ); // for translation
14
15
16
/**
17
 * Default implementation of attribute text JQAdm client.
18
 *
19
 * @package Admin
20
 * @subpackage JQAdm
21
 */
22
class Standard
23
	extends \Aimeos\Admin\JQAdm\Common\Admin\Factory\Base
24
	implements \Aimeos\Admin\JQAdm\Common\Admin\Factory\Iface
25
{
26
	/** admin/jqadm/attribute/text/name
27
	 * Name of the text subpart used by the JQAdm attribute implementation
28
	 *
29
	 * Use "Myname" if your class is named "\Aimeos\Admin\Jqadm\Attribute\Text\Myname".
30
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
31
	 *
32
	 * @param string Last part of the JQAdm class name
33
	 * @since 2017.07
34
	 * @category Developer
35
	 */
36
37
38
	/**
39
	 * Copies a resource
40
	 *
41
	 * @return string|null HTML output
42
	 */
43
	public function copy() : ?string
44
	{
45
		$view = $this->getObject()->data( $this->view() );
46
		$view->textData = $this->toArray( $view->item, true );
47
		$view->textBody = parent::copy();
48
49
		return $this->render( $view );
50
	}
51
52
53
	/**
54
	 * Creates a new resource
55
	 *
56
	 * @return string|null HTML output
57
	 */
58
	public function create() : ?string
59
	{
60
		$view = $this->getObject()->data( $this->view() );
61
		$siteid = $this->getContext()->getLocale()->getSiteId();
62
		$data = $view->param( 'text', [] );
63
64
		foreach( $data as $idx => $entry )
65
		{
66
			$data[$idx]['attribute.lists.siteid'] = $siteid;
67
			$data[$idx]['text.siteid'] = $siteid;
68
		}
69
70
		$view->textData = $data;
71
		$view->textBody = parent::create();
72
73
		return $this->render( $view );
74
	}
75
76
77
	/**
78
	 * Deletes a resource
79
	 *
80
	 * @return string|null HTML output
81
	 */
82
	public function delete() : ?string
83
	{
84
		parent::delete();
85
86
		$item = $this->view()->item;
87
		$item->deleteListItems( $item->getListItems( 'text', null, null, false )->toArray(), true );
88
89
		return null;
90
	}
91
92
93
	/**
94
	 * Returns a single resource
95
	 *
96
	 * @return string|null HTML output
97
	 */
98
	public function get() : ?string
99
	{
100
		$view = $this->getObject()->data( $this->view() );
101
		$view->textData = $this->toArray( $view->item );
102
		$view->textBody = parent::get();
103
104
		return $this->render( $view );
105
	}
106
107
108
	/**
109
	 * Saves the data
110
	 *
111
	 * @return string|null HTML output
112
	 */
113
	public function save() : ?string
114
	{
115
		$view = $this->view();
116
117
		$view->item = $this->fromArray( $view->item, $view->param( 'text', [] ) );
118
		$view->textBody = parent::save();
119
120
		return null;
121
	}
122
123
124
	/**
125
	 * Returns the sub-client given by its name.
126
	 *
127
	 * @param string $type Name of the client type
128
	 * @param string|null $name Name of the sub-client (Default if null)
129
	 * @return \Aimeos\Admin\JQAdm\Iface Sub-client object
130
	 */
131
	public function getSubClient( string $type, string $name = null ) : \Aimeos\Admin\JQAdm\Iface
132
	{
133
		/** admin/jqadm/attribute/text/decorators/excludes
134
		 * Excludes decorators added by the "common" option from the attribute JQAdm client
135
		 *
136
		 * Decorators extend the functionality of a class by adding new aspects
137
		 * (e.g. log what is currently done), executing the methods of the underlying
138
		 * class only in certain conditions (e.g. only for logged in users) or
139
		 * modify what is returned to the caller.
140
		 *
141
		 * This option allows you to remove a decorator added via
142
		 * "admin/jqadm/common/decorators/default" before they are wrapped
143
		 * around the JQAdm client.
144
		 *
145
		 *  admin/jqadm/attribute/text/decorators/excludes = array( 'decorator1' )
146
		 *
147
		 * This would remove the decorator named "decorator1" from the list of
148
		 * common decorators ("\Aimeos\Admin\JQAdm\Common\Decorator\*") added via
149
		 * "admin/jqadm/common/decorators/default" to the JQAdm client.
150
		 *
151
		 * @param array List of decorator names
152
		 * @since 2017.07
153
		 * @category Developer
154
		 * @see admin/jqadm/common/decorators/default
155
		 * @see admin/jqadm/attribute/text/decorators/global
156
		 * @see admin/jqadm/attribute/text/decorators/local
157
		 */
158
159
		/** admin/jqadm/attribute/text/decorators/global
160
		 * Adds a list of globally available decorators only to the attribute JQAdm client
161
		 *
162
		 * Decorators extend the functionality of a class by adding new aspects
163
		 * (e.g. log what is currently done), executing the methods of the underlying
164
		 * class only in certain conditions (e.g. only for logged in users) or
165
		 * modify what is returned to the caller.
166
		 *
167
		 * This option allows you to wrap global decorators
168
		 * ("\Aimeos\Admin\JQAdm\Common\Decorator\*") around the JQAdm client.
169
		 *
170
		 *  admin/jqadm/attribute/text/decorators/global = array( 'decorator1' )
171
		 *
172
		 * This would add the decorator named "decorator1" defined by
173
		 * "\Aimeos\Admin\JQAdm\Common\Decorator\Decorator1" only to the JQAdm client.
174
		 *
175
		 * @param array List of decorator names
176
		 * @since 2017.07
177
		 * @category Developer
178
		 * @see admin/jqadm/common/decorators/default
179
		 * @see admin/jqadm/attribute/text/decorators/excludes
180
		 * @see admin/jqadm/attribute/text/decorators/local
181
		 */
182
183
		/** admin/jqadm/attribute/text/decorators/local
184
		 * Adds a list of local decorators only to the attribute JQAdm client
185
		 *
186
		 * Decorators extend the functionality of a class by adding new aspects
187
		 * (e.g. log what is currently done), executing the methods of the underlying
188
		 * class only in certain conditions (e.g. only for logged in users) or
189
		 * modify what is returned to the caller.
190
		 *
191
		 * This option allows you to wrap local decorators
192
		 * ("\Aimeos\Admin\JQAdm\Attribute\Decorator\*") around the JQAdm client.
193
		 *
194
		 *  admin/jqadm/attribute/text/decorators/local = array( 'decorator2' )
195
		 *
196
		 * This would add the decorator named "decorator2" defined by
197
		 * "\Aimeos\Admin\JQAdm\Attribute\Decorator\Decorator2" only to the JQAdm client.
198
		 *
199
		 * @param array List of decorator names
200
		 * @since 2017.07
201
		 * @category Developer
202
		 * @see admin/jqadm/common/decorators/default
203
		 * @see admin/jqadm/attribute/text/decorators/excludes
204
		 * @see admin/jqadm/attribute/text/decorators/global
205
		 */
206
		return $this->createSubClient( 'attribute/text/' . $type, $name );
207
	}
208
209
210
	/**
211
	 * Returns the list of sub-client names configured for the client.
212
	 *
213
	 * @return array List of JQAdm client names
214
	 */
215
	protected function getSubClientNames() : array
216
	{
217
		/** admin/jqadm/attribute/text/subparts
218
		 * List of JQAdm sub-clients rendered within the attribute text section
219
		 *
220
		 * The output of the frontend is composed of the code generated by the JQAdm
221
		 * clients. Each JQAdm client can consist of serveral (or none) sub-clients
222
		 * that are responsible for rendering certain sub-parts of the output. The
223
		 * sub-clients can contain JQAdm clients themselves and therefore a
224
		 * hierarchical tree of JQAdm clients is composed. Each JQAdm client creates
225
		 * the output that is placed inside the container of its parent.
226
		 *
227
		 * At first, always the JQAdm code generated by the parent is printed, then
228
		 * the JQAdm code of its sub-clients. The order of the JQAdm sub-clients
229
		 * determines the order of the output of these sub-clients inside the parent
230
		 * container. If the configured list of clients is
231
		 *
232
		 *  array( "subclient1", "subclient2" )
233
		 *
234
		 * you can easily change the order of the output by reordering the subparts:
235
		 *
236
		 *  admin/jqadm/<clients>/subparts = array( "subclient1", "subclient2" )
237
		 *
238
		 * You can also remove one or more parts if they shouldn't be rendered:
239
		 *
240
		 *  admin/jqadm/<clients>/subparts = array( "subclient1" )
241
		 *
242
		 * As the clients only generates structural JQAdm, the layout defined via CSS
243
		 * should support adding, removing or reordering content by a fluid like
244
		 * design.
245
		 *
246
		 * @param array List of sub-client names
247
		 * @since 2017.07
248
		 * @category Developer
249
		 */
250
		return $this->getContext()->getConfig()->get( 'admin/jqadm/attribute/text/subparts', [] );
251
	}
252
253
254
	/**
255
	 * Adds the required data used in the text template
256
	 *
257
	 * @param \Aimeos\MW\View\Iface $view View object
258
	 * @return \Aimeos\MW\View\Iface View object with assigned parameters
259
	 */
260
	public function data( \Aimeos\MW\View\Iface $view ) : \Aimeos\MW\View\Iface
261
	{
262
		$context = $this->getContext();
263
264
		$textTypeManager = \Aimeos\MShop::create( $context, 'text/type' );
265
		$listTypeManager = \Aimeos\MShop::create( $context, 'attribute/lists/type' );
266
267
		$search = $textTypeManager->filter( true )->slice( 0, 10000 );
268
		$search->setConditions( $search->compare( '==', 'text.type.domain', 'attribute' ) );
269
		$search->setSortations( [$search->sort( '+', 'text.type.position' )] );
270
271
		$listSearch = $listTypeManager->filter( true )->slice( 0, 10000 );
272
		$listSearch->setConditions( $listSearch->compare( '==', 'attribute.lists.type.domain', 'text' ) );
273
		$listSearch->setSortations( [$listSearch->sort( '+', 'attribute.lists.type.position' )] );
274
275
		$view->textTypes = $textTypeManager->search( $search );
276
		$view->textListTypes = $listTypeManager->search( $listSearch );
277
278
		return $view;
279
	}
280
281
282
	/**
283
	 * Creates new and updates existing items using the data array
284
	 *
285
	 * @param \Aimeos\MShop\Attribute\Item\Iface $item Attribute item object without referenced domain items
286
	 * @param array $data Data array
287
	 * @return \Aimeos\MShop\Attribute\Item\Iface Modified attribute item
288
	 */
289
	protected function fromArray( \Aimeos\MShop\Attribute\Item\Iface $item, array $data ) : \Aimeos\MShop\Attribute\Item\Iface
290
	{
291
		$context = $this->getContext();
292
293
		$textManager = \Aimeos\MShop::create( $context, 'text' );
294
		$listManager = \Aimeos\MShop::create( $context, 'attribute/lists' );
295
296
		$listItems = $item->getListItems( 'text', null, null, false );
297
298
299
		foreach( $data as $idx => $entry )
300
		{
301
			if( trim( $this->getValue( $entry, 'text.content', '' ) ) === '' ) {
302
				continue;
303
			}
304
305
			if( ( $listItem = $item->getListItem( 'text', $entry['attribute.lists.type'], $entry['text.id'], false ) ) === null ) {
306
				$listItem = $listManager->create();
307
			}
308
309
			if( ( $refItem = $listItem->getRefItem() ) === null ) {
310
				$refItem = $textManager->create();
311
			}
312
313
			$refItem->fromArray( $entry, true );
314
			$listItem->fromArray( $entry, true )->setPosition( $idx )->setConfig( [] );
315
316
			foreach( (array) $this->getValue( $entry, 'config', [] ) as $cfg )
317
			{
318
				if( ( $key = trim( $cfg['key'] ?? '' ) ) !== '' ) {
319
					$listItem->setConfigValue( $key, trim( $cfg['val'] ?? '' ) );
320
				}
321
			}
322
323
			$item->addListItem( 'text', $listItem, $refItem );
324
			unset( $listItems[$listItem->getId()] );
325
		}
326
327
		return $item->deleteListItems( $listItems->toArray(), true );
328
	}
329
330
331
	/**
332
	 * Constructs the data array for the view from the given item
333
	 *
334
	 * @param \Aimeos\MShop\Attribute\Item\Iface $item Attribute item object including referenced domain items
335
	 * @param bool $copy True if items should be copied, false if not
336
	 * @return string[] Multi-dimensional associative list of item data
337
	 */
338
	protected function toArray( \Aimeos\MShop\Attribute\Item\Iface $item, bool $copy = false ) : array
339
	{
340
		$data = [];
341
		$siteId = $this->getContext()->getLocale()->getSiteId();
342
343
		foreach( $item->getListItems( 'text', null, null, false ) as $listItem )
344
		{
345
			if( ( $refItem = $listItem->getRefItem() ) === null ) {
346
				continue;
347
			}
348
349
			$list = $listItem->toArray( true ) + $refItem->toArray( true );
350
351
			if( $copy === true )
352
			{
353
				$list['attribute.lists.siteid'] = $siteId;
354
				$list['attribute.lists.id'] = '';
355
				$list['text.siteid'] = $siteId;
356
				$list['text.id'] = null;
357
			}
358
359
			$list['attribute.lists.datestart'] = str_replace( ' ', 'T', $list['attribute.lists.datestart'] );
360
			$list['attribute.lists.dateend'] = str_replace( ' ', 'T', $list['attribute.lists.dateend'] );
361
			$list['config'] = [];
362
363
			foreach( $listItem->getConfig() as $key => $value ) {
364
				$list['config'][] = ['key' => $key, 'val' => $value];
365
			}
366
367
			$data[] = $list;
368
		}
369
370
		return $data;
371
	}
372
373
374
	/**
375
	 * Returns the rendered template including the view data
376
	 *
377
	 * @param \Aimeos\MW\View\Iface $view View object with data assigned
378
	 * @return string HTML output
379
	 */
380
	protected function render( \Aimeos\MW\View\Iface $view ) : string
381
	{
382
		/** admin/jqadm/attribute/text/template-item
383
		 * Relative path to the HTML body template of the text subpart for attributes.
384
		 *
385
		 * The template file contains the HTML code and processing instructions
386
		 * to generate the result shown in the body of the frontend. The
387
		 * configuration string is the path to the template file relative
388
		 * to the templates directory (usually in admin/jqadm/templates).
389
		 *
390
		 * You can overwrite the template file configuration in extensions and
391
		 * provide alternative templates. These alternative templates should be
392
		 * named like the default one but with the string "default" replaced by
393
		 * an unique name. You may use the name of your project for this. If
394
		 * you've implemented an alternative client class as well, "default"
395
		 * should be replaced by the name of the new class.
396
		 *
397
		 * @param string Relative path to the template creating the HTML code
398
		 * @since 2016.04
399
		 * @category Developer
400
		 */
401
		$tplconf = 'admin/jqadm/attribute/text/template-item';
402
		$default = 'attribute/item-text-standard';
403
404
		return $view->render( $view->config( $tplconf, $default ) );
405
	}
406
}
407