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