Passed
Push — master ( c2fd32...089040 )
by Aimeos
02:28
created

Standard::initCriteriaConditions()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 12
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 3
eloc 6
c 1
b 0
f 0
nc 2
nop 2
dl 0
loc 12
rs 10
1
<?php
2
3
/**
4
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5
 * @copyright Aimeos (aimeos.org), 2015-2020
6
 * @package Admin
7
 * @subpackage JsonAdm
8
 */
9
10
11
namespace Aimeos\Admin\JsonAdm\Order\Base;
12
13
use \Psr\Http\Message\ServerRequestInterface;
14
use \Psr\Http\Message\ResponseInterface;
15
16
17
/**
18
 * JSON API order client
19
 *
20
 * @package Admin
21
 * @subpackage JsonAdm
22
 */
23
class Standard
24
	extends \Aimeos\Admin\JsonAdm\Standard
25
	implements \Aimeos\Admin\JsonAdm\Common\Iface
26
{
27
	/** admin/jsonadm/order/base/decorators/excludes
28
	 * Excludes decorators added by the "common" option from the JSON API clients
29
	 *
30
	 * Decorators extend the functionality of a class by adding new aspects
31
	 * (e.g. log what is currently done), executing the methods of the underlying
32
	 * class only in certain conditions (e.g. only for logged in users) or
33
	 * modify what is returned to the caller.
34
	 *
35
	 * This option allows you to remove a decorator added via
36
	 * "admin/jsonadm/common/decorators/default" before they are wrapped
37
	 * around the Jsonadm client.
38
	 *
39
	 *  admin/jsonadm/decorators/excludes = array( 'decorator1' )
40
	 *
41
	 * This would remove the decorator named "decorator1" from the list of
42
	 * common decorators ("\Aimeos\Admin\JsonAdm\Common\Decorator\*") added via
43
	 * "admin/jsonadm/common/decorators/default" for the JSON API client.
44
	 *
45
	 * @param array List of decorator names
46
	 * @since 2016.01
47
	 * @category Developer
48
	 * @see admin/jsonadm/common/decorators/default
49
	 * @see admin/jsonadm/order/base/decorators/global
50
	 * @see admin/jsonadm/order/base/decorators/local
51
	 */
52
53
	/** admin/jsonadm/order/base/decorators/global
54
	 * Adds a list of globally available decorators only to the Jsonadm client
55
	 *
56
	 * Decorators extend the functionality of a class by adding new aspects
57
	 * (e.g. log what is currently done), executing the methods of the underlying
58
	 * class only in certain conditions (e.g. only for logged in users) or
59
	 * modify what is returned to the caller.
60
	 *
61
	 * This option allows you to wrap global decorators
62
	 * ("\Aimeos\Admin\Jsonadm\Common\Decorator\*") around the Jsonadm
63
	 * client.
64
	 *
65
	 *  admin/jsonadm/order/base/decorators/global = array( 'decorator1' )
66
	 *
67
	 * This would add the decorator named "decorator1" defined by
68
	 * "\Aimeos\Admin\Jsonadm\Common\Decorator\Decorator1" only to the
69
	 * "order/base" Jsonadm client.
70
	 *
71
	 * @param array List of decorator names
72
	 * @since 2016.01
73
	 * @category Developer
74
	 * @see admin/jsonadm/common/decorators/default
75
	 * @see admin/jsonadm/order/base/decorators/excludes
76
	 * @see admin/jsonadm/order/base/decorators/local
77
	 */
78
79
	/** admin/jsonadm/order/base/decorators/local
80
	 * Adds a list of local decorators only to the Jsonadm client
81
	 *
82
	 * Decorators extend the functionality of a class by adding new aspects
83
	 * (e.g. log what is currently done), executing the methods of the underlying
84
	 * class only in certain conditions (e.g. only for logged in users) or
85
	 * modify what is returned to the caller.
86
	 *
87
	 * This option allows you to wrap local decorators
88
	 * ("\Aimeos\Admin\Jsonadm\Order\Base\Decorator\*") around the Jsonadm
89
	 * client.
90
	 *
91
	 *  admin/jsonadm/order/base/decorators/local = array( 'decorator2' )
92
	 *
93
	 * This would add the decorator named "decorator2" defined by
94
	 * "\Aimeos\Admin\Jsonadm\Order\Base\Decorator\Decorator2" only to the
95
	 * "order/base" Jsonadm client.
96
	 *
97
	 * @param array List of decorator names
98
	 * @since 2016.01
99
	 * @category Developer
100
	 * @see admin/jsonadm/common/decorators/default
101
	 * @see admin/jsonadm/order/base/decorators/excludes
102
	 * @see admin/jsonadm/order/base/decorators/global
103
	 */
104
105
106
	/**
107
	 * Returns the requested resource or the resource list
108
	 *
109
	 * @param \Psr\Http\Message\ServerRequestInterface $request Request object
110
	 * @param \Psr\Http\Message\ResponseInterface $response Response object
111
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
112
	 */
113
	public function get( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
114
	{
115
		/** admin/jsonadm/partials/order/base/template-data
116
		 * Relative path to the data partial template file for the order base client
117
		 *
118
		 * Partials are templates which are reused in other templates and generate
119
		 * reoccuring blocks filled with data from the assigned values. The data
120
		 * partial creates the "data" part for the JSON API response.
121
		 *
122
		 * The partial template files are usually stored in the templates/partials/ folder
123
		 * of the core or the extensions. The configured path to the partial file must
124
		 * be relative to the templates/ folder, e.g. "partials/data-standard".
125
		 *
126
		 * @param string Relative path to the template file
127
		 * @since 2016.01
128
		 * @category Developer
129
		 */
130
		$this->getView()->assign( array( 'partial-data' => 'admin/jsonadm/partials/order/base/template-data' ) );
131
132
		return parent::get( $request, $response );
133
	}
134
135
136
	/**
137
	 * Returns the items with parent/child relationships
138
	 *
139
	 * @param \Aimeos\Map $items List of items implementing \Aimeos\MShop\Common\Item\Iface
140
	 * @param array $include List of resource types that should be fetched
141
	 * @return \Aimeos\Map List of items implementing \Aimeos\MShop\Common\Item\Iface
142
	 */
143
	protected function getChildItems( \Aimeos\Map $items, array $include ) : \Aimeos\Map
144
	{
145
		$list = map();
146
		$context = $this->getContext();
147
		$ids = $items->keys()->toArray();
148
		$domains = ['order/base/address', 'order/base/coupon', 'order/base/product', 'order/base/service'];
149
		$include = map( $domains )->intersect( $include );
150
151
		if( ( $key = $include->search( 'order/base/product' ) ) !== null )
152
		{
153
			$manager = \Aimeos\MShop::create( $context, 'order/base/product' );
154
155
			$search = $manager->createSearch();
156
			$search->setConditions( $search->combine( '&&', [
157
				$search->compare( '==', 'order.base.product.baseid', $ids ),
158
				$search->compare( '=~', 'order.base.product.siteid', $context->getLocale()->getSiteId() )
159
			] ) );
160
161
			$list = $list->merge( $manager->searchItems( $search ) );
162
			$include->remove( $key );
163
		}
164
165
		foreach( $include as $type )
166
		{
167
			$manager = \Aimeos\MShop::create( $context, $type );
168
169
			$search = $manager->createSearch();
170
			$search->setConditions( $search->compare( '==', str_replace( '/', '.', $type ) . '.baseid', $ids ) );
171
172
			$list = $list->merge( $manager->searchItems( $search ) );
173
		}
174
175
		return $list;
176
	}
177
178
179
	/**
180
	 * Initializes the criteria object with conditions based on the given parameter
181
	 *
182
	 * @param \Aimeos\MW\Criteria\Iface $criteria Criteria object
183
	 * @param array $params List of criteria data with condition, sorting and paging
184
	 * @return \Aimeos\MW\Criteria\Iface Initialized criteria object
185
	 */
186
	protected function initCriteriaConditions( \Aimeos\MW\Criteria\Iface $criteria, array $params ) : \Aimeos\MW\Criteria\Iface
187
	{
188
		if( isset( $params['filter'] ) && ( $cond = $criteria->toConditions( (array) $params['filter'] ) ) !== null ) {
189
			$criteria = $criteria->setConditions( $criteria->combine( '&&', [$cond, $criteria->getConditions()] ) );
190
		}
191
192
		$criteria->setConditions( $criteria->combine( '&&', [
193
			$criteria->compare( '=~', 'order.base.product.siteid', $this->getContext()->getLocale()->getSiteId() ),
194
			$criteria->getConditions()
195
		] ) );
196
197
		return $criteria;
198
	}
199
}
200