Standard::compare()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 2
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 3
1
<?php
2
3
/**
4
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5
 * @copyright Aimeos (aimeos.org), 2018-2025
6
 * @package Controller
7
 * @subpackage Frontend
8
 */
9
10
11
namespace Aimeos\Controller\Frontend\Supplier;
12
13
14
/**
15
 * Default implementation of the supplier frontend controller
16
 *
17
 * @package Controller
18
 * @subpackage Frontend
19
 */
20
class Standard
21
	extends \Aimeos\Controller\Frontend\Base
22
	implements Iface, \Aimeos\Controller\Frontend\Common\Iface
23
{
24
	/** controller/frontend/supplier/name
25
	 * Class name of the used supplier frontend controller implementation
26
	 *
27
	 * Each default frontend controller can be replace by an alternative imlementation.
28
	 * To use this implementation, you have to set the last part of the class
29
	 * name as configuration value so the controller factory knows which class it
30
	 * has to instantiate.
31
	 *
32
	 * For example, if the name of the default class is
33
	 *
34
	 *  \Aimeos\Controller\Frontend\Supplier\Standard
35
	 *
36
	 * and you want to replace it with your own version named
37
	 *
38
	 *  \Aimeos\Controller\Frontend\Supplier\Mysupplier
39
	 *
40
	 * then you have to set the this configuration option:
41
	 *
42
	 *  controller/jobs/frontend/supplier/name = Mysupplier
43
	 *
44
	 * The value is the last part of your own class name and it's case sensitive,
45
	 * so take care that the configuration value is exactly named like the last
46
	 * part of the class name.
47
	 *
48
	 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
49
	 * characters are possible! You should always start the last part of the class
50
	 * name with an upper case character and continue only with lower case characters
51
	 * or numbers. Avoid chamel case names like "MySupplier"!
52
	 *
53
	 * @param string Last part of the class name
54
	 * @since 2018.07
55
	 * @category Developer
56
	 */
57
58
	/** controller/frontend/supplier/decorators/excludes
59
	 * Excludes decorators added by the "common" option from the supplier frontend controllers
60
	 *
61
	 * Decorators extend the functionality of a class by adding new aspects
62
	 * (e.g. log what is currently done), executing the methods of the underlying
63
	 * class only in certain conditions (e.g. only for logged in users) or
64
	 * modify what is returned to the caller.
65
	 *
66
	 * This option allows you to remove a decorator added via
67
	 * "controller/frontend/common/decorators/default" before they are wrapped
68
	 * around the frontend controller.
69
	 *
70
	 *  controller/frontend/supplier/decorators/excludes = array( 'decorator1' )
71
	 *
72
	 * This would remove the decorator named "decorator1" from the list of
73
	 * common decorators ("\Aimeos\Controller\Frontend\Common\Decorator\*") added via
74
	 * "controller/frontend/common/decorators/default" for the supplier frontend controller.
75
	 *
76
	 * @param array List of decorator names
77
	 * @since 2018.07
78
	 * @category Developer
79
	 * @see controller/frontend/common/decorators/default
80
	 * @see controller/frontend/supplier/decorators/global
81
	 * @see controller/frontend/supplier/decorators/local
82
	 */
83
84
	/** controller/frontend/supplier/decorators/global
85
	 * Adds a list of globally available decorators only to the supplier frontend controllers
86
	 *
87
	 * Decorators extend the functionality of a class by adding new aspects
88
	 * (e.g. log what is currently done), executing the methods of the underlying
89
	 * class only in certain conditions (e.g. only for logged in users) or
90
	 * modify what is returned to the caller.
91
	 *
92
	 * This option allows you to wrap global decorators
93
	 * ("\Aimeos\Controller\Frontend\Common\Decorator\*") around the frontend controller.
94
	 *
95
	 *  controller/frontend/supplier/decorators/global = array( 'decorator1' )
96
	 *
97
	 * This would add the decorator named "decorator1" defined by
98
	 * "\Aimeos\Controller\Frontend\Common\Decorator\Decorator1" only to the frontend controller.
99
	 *
100
	 * @param array List of decorator names
101
	 * @since 2018.07
102
	 * @category Developer
103
	 * @see controller/frontend/common/decorators/default
104
	 * @see controller/frontend/supplier/decorators/excludes
105
	 * @see controller/frontend/supplier/decorators/local
106
	 */
107
108
	/** controller/frontend/supplier/decorators/local
109
	 * Adds a list of local decorators only to the supplier frontend controllers
110
	 *
111
	 * Decorators extend the functionality of a class by adding new aspects
112
	 * (e.g. log what is currently done), executing the methods of the underlying
113
	 * class only in certain conditions (e.g. only for logged in users) or
114
	 * modify what is returned to the caller.
115
	 *
116
	 * This option allows you to wrap local decorators
117
	 * ("\Aimeos\Controller\Frontend\Supplier\Decorator\*") around the frontend controller.
118
	 *
119
	 *  controller/frontend/supplier/decorators/local = array( 'decorator2' )
120
	 *
121
	 * This would add the decorator named "decorator2" defined by
122
	 * "\Aimeos\Controller\Frontend\Supplier\Decorator\Decorator2" only to the frontend
123
	 * controller.
124
	 *
125
	 * @param array List of decorator names
126
	 * @since 2018.07
127
	 * @category Developer
128
	 * @see controller/frontend/common/decorators/default
129
	 * @see controller/frontend/supplier/decorators/excludes
130
	 * @see controller/frontend/supplier/decorators/global
131
	 */
132
133
134
	private array $domains = [];
135
	private \Aimeos\Base\Criteria\Iface $filter;
136
	private \Aimeos\MShop\Common\Manager\Iface $manager;
137
138
139
	/**
140
	 * Common initialization for controller classes
141
	 *
142
	 * @param \Aimeos\MShop\ContextIface $context Common MShop context object
143
	 */
144
	public function __construct( \Aimeos\MShop\ContextIface $context )
145
	{
146
		parent::__construct( $context );
147
148
		$this->manager = \Aimeos\MShop::create( $context, 'supplier' );
149
		$this->filter = $this->manager->filter( true );
150
	}
151
152
153
	/**
154
	 * Clones objects in controller
155
	 */
156
	public function __clone()
157
	{
158
		$this->filter = clone $this->filter;
159
		parent::__clone();
160
	}
161
162
163
	/**
164
	 * Adds generic condition for filtering
165
	 *
166
	 * @param string $operator Comparison operator, e.g. "==", "!=", "<", "<=", ">=", ">", "=~", "~="
167
	 * @param string $key Search key defined by the supplier manager, e.g. "supplier.status"
168
	 * @param array|string $value Value or list of values to compare to
169
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
170
	 * @since 2019.04
171
	 */
172
	public function compare( string $operator, string $key, $value ) : Iface
173
	{
174
		$this->addExpression( $this->filter->compare( $operator, $key, $value ) );
175
		return $this;
176
	}
177
178
179
	/**
180
	 * Returns the supplier for the given supplier code
181
	 *
182
	 * @param string $code Unique supplier code
183
	 * @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
184
	 * @since 2019.04
185
	 */
186
	public function find( string $code ) : \Aimeos\MShop\Supplier\Item\Iface
187
	{
188
		return $this->manager->find( $code, $this->domains, null, null, null );
189
	}
190
191
192
	/**
193
	 * Creates a search function string for the given name and parameters
194
	 *
195
	 * @param string $name Name of the search function without parenthesis, e.g. "supplier:has"
196
	 * @param array $params List of parameters for the search function with numeric keys starting at 0
197
	 * @return string Search function string that can be used in compare()
198
	 */
199
	public function function( string $name, array $params ) : string
200
	{
201
		return $this->filter->make( $name, $params );
202
	}
203
204
205
	/**
206
	 * Returns the supplier for the given supplier ID
207
	 *
208
	 * @param string $id Unique supplier ID
209
	 * @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
210
	 * @since 2019.04
211
	 */
212
	public function get( string $id ) : \Aimeos\MShop\Supplier\Item\Iface
213
	{
214
		return $this->manager->get( $id, $this->domains, null );
215
	}
216
217
218
	/**
219
	 * Adds a filter to return only items containing a reference to the given ID
220
	 *
221
	 * @param string $domain Domain name of the referenced item, e.g. "media"
222
	 * @param string|null $type Type code of the reference, e.g. "default" or null for all types
223
	 * @param string|null $refId ID of the referenced item of the given domain or null for all references
224
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
225
	 * @since 2019.10
226
	 */
227
	public function has( string $domain, ?string $type = null, ?string $refId = null ) : Iface
228
	{
229
		$params = [$domain];
230
		!$type ?: $params[] = $type;
231
		!$refId ?: $params[] = $refId;
232
233
		$func = $this->filter->make( 'supplier:has', $params );
234
		$this->addExpression( $this->filter->compare( '!=', $func, null ) );
235
		return $this;
236
	}
237
238
239
	/**
240
	 * Parses the given array and adds the conditions to the list of conditions
241
	 *
242
	 * @param array $conditions List of conditions, e.g. ['=~' => ['supplier.label' => 'test']]
243
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
244
	 * @since 2019.04
245
	 */
246
	public function parse( array $conditions ) : Iface
247
	{
248
		if( ( $cond = $this->filter->parse( $conditions ) ) !== null ) {
249
			$this->addExpression( $cond );
250
		}
251
252
		return $this;
253
	}
254
255
256
	/**
257
	 * Returns the supplier for the given supplier URL name
258
	 *
259
	 * @param string $name Supplier URL name
260
	 * @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
261
	 * @since 2023.10
262
	 */
263
	public function resolve( string $name ) : \Aimeos\MShop\Supplier\Item\Iface
264
	{
265
		$search = $this->manager->filter( null )->add( 'supplier.code', '==', $name )->slice( 0, 1 );
266
267
		if( ( $item = $this->manager->search( $search, $this->domains )->first() ) === null )
268
		{
269
			$msg = $this->context()->translate( 'controller/frontend', 'Unable to find supplier "%1$s"' );
270
			throw new \Aimeos\Controller\Frontend\Supplier\Exception( sprintf( $msg, $name ), 404 );
271
		}
272
273
		return $item;
274
	}
275
276
277
	/**
278
	 * Returns the suppliers filtered by the previously assigned conditions
279
	 *
280
	 * @param int &$total Parameter where the total number of found suppliers will be stored in
281
	 * @return \Aimeos\Map Ordered list of supplier items implementing \Aimeos\MShop\Supplier\Item\Iface
282
	 * @since 2019.04
283
	 */
284
	public function search( ?int &$total = null ) : \Aimeos\Map
285
	{
286
		$filter = clone $this->filter;
287
288
		$this->addExpression( $filter->getConditions() );
289
290
		$filter->setSortations( $this->getSortations() );
291
		$filter->add( $filter->and( $this->getConditions() ) );
292
293
		return $this->manager->search( $filter, $this->domains, $total );
294
	}
295
296
297
	/**
298
	 * Sets the start value and the number of returned supplier items for slicing the list of found supplier items
299
	 *
300
	 * @param int $start Start value of the first supplier item in the list
301
	 * @param int $limit Number of returned supplier items
302
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
303
	 * @since 2019.04
304
	 */
305
	public function slice( int $start, int $limit ) : Iface
306
	{
307
		$maxsize = $this->context()->config()->get( 'controller/frontend/common/max-size', 500 );
308
		$this->filter->slice( $start, min( $limit, $maxsize ) );
309
		return $this;
310
	}
311
312
313
	/**
314
	 * Sets the sorting of the result list
315
	 *
316
	 * @param string|null $key Sorting key of the result list like "supplier.label", null for no sorting
317
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
318
	 * @since 2019.04
319
	 */
320
	public function sort( ?string $key = null ) : Iface
321
	{
322
		$list = $this->splitKeys( $key );
323
324
		foreach( $list as $sortkey )
325
		{
326
			$direction = ( $sortkey[0] === '-' ? '-' : '+' );
327
			$this->addExpression( $this->filter->sort( $direction, ltrim( $sortkey, '+-' ) ) );
328
		}
329
330
		return $this;
331
	}
332
333
334
	/**
335
	 * Sets the referenced domains that will be fetched too when retrieving items
336
	 *
337
	 * @param array $domains Domain names of the referenced items that should be fetched too
338
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
339
	 * @since 2019.04
340
	 */
341
	public function uses( array $domains ) : Iface
342
	{
343
		$this->domains = $domains;
344
		return $this;
345
	}
346
347
348
	/**
349
	 * Returns the manager used by the controller
350
	 *
351
	 * @return \Aimeos\MShop\Common\Manager\Iface Manager object
352
	 */
353
	protected function getManager() : \Aimeos\MShop\Common\Manager\Iface
354
	{
355
		return $this->manager;
356
	}
357
}
358