Completed
Push — master ( 55dc5c...4aebe4 )
by Aimeos
06:03
created
client/html/src/Client/Html/Locale/Select/Standard.php 3 patches
Indentation   +355 added lines, -355 removed lines patch added patch discarded remove patch
@@ -19,360 +19,360 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/locale/select/standard/subparts
26
-	 * List of HTML sub-clients rendered within the locale select section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.09
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/locale/select/standard/subparts';
59
-
60
-	/** client/html/locale/select/language/name
61
-	 * Name of the language part used by the locale selector client implementation
62
-	 *
63
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Locale\Select\Language\Myname".
64
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
65
-	 *
66
-	 * @param string Last part of the client class name
67
-	 * @since 2014.09
68
-	 * @category Developer
69
-	 */
70
-
71
-	/** client/html/locale/select/currency/name
72
-	 * Name of the currency part used by the locale selector client implementation
73
-	 *
74
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Locale\Select\Currency\Myname".
75
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
76
-	 *
77
-	 * @param string Last part of the client class name
78
-	 * @since 2014.09
79
-	 * @category Developer
80
-	 */
81
-	private $subPartNames = array( 'language', 'currency' );
82
-	private $cache;
83
-
84
-
85
-	/**
86
-	 * Returns the HTML code for insertion into the body.
87
-	 *
88
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
89
-	 * @param array &$tags Result array for the list of tags that are associated to the output
90
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91
-	 * @return string HTML code
92
-	 */
93
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
94
-	{
95
-		$context = $this->getContext();
96
-		$view = $this->getView();
97
-
98
-		try
99
-		{
100
-			$view = $this->setViewParams( $view, $tags, $expire );
101
-
102
-			$html = '';
103
-			foreach( $this->getSubClients() as $subclient ) {
104
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
105
-			}
106
-			$view->selectBody = $html;
107
-		}
108
-		catch( \Aimeos\Client\Html\Exception $e )
109
-		{
110
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
112
-		}
113
-		catch( \Aimeos\Controller\Frontend\Exception $e )
114
-		{
115
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
117
-		}
118
-		catch( \Aimeos\MShop\Exception $e )
119
-		{
120
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
122
-		}
123
-		catch( \Exception $e )
124
-		{
125
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
126
-
127
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
129
-		}
130
-
131
-		/** client/html/locale/select/standard/template-body
132
-		 * Relative path to the HTML body template of the locale select client.
133
-		 *
134
-		 * The template file contains the HTML code and processing instructions
135
-		 * to generate the result shown in the body of the frontend. The
136
-		 * configuration string is the path to the template file relative
137
-		 * to the templates directory (usually in client/html/templates).
138
-		 *
139
-		 * You can overwrite the template file configuration in extensions and
140
-		 * provide alternative templates. These alternative templates should be
141
-		 * named like the default one but with the string "standard" replaced by
142
-		 * an unique name. You may use the name of your project for this. If
143
-		 * you've implemented an alternative client class as well, "standard"
144
-		 * should be replaced by the name of the new class.
145
-		 *
146
-		 * @param string Relative path to the template creating code for the HTML page body
147
-		 * @since 2014.09
148
-		 * @category Developer
149
-		 * @see client/html/locale/select/standard/template-header
150
-		 */
151
-		$tplconf = 'client/html/locale/select/standard/template-body';
152
-		$default = 'locale/select/body-default.php';
153
-
154
-		return $view->render( $view->config( $tplconf, $default ) );
155
-	}
156
-
157
-
158
-	/**
159
-	 * Returns the HTML string for insertion into the header.
160
-	 *
161
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
162
-	 * @param array &$tags Result array for the list of tags that are associated to the output
163
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164
-	 * @return string|null String including HTML tags for the header on error
165
-	 */
166
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
167
-	{
168
-		try
169
-		{
170
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
171
-
172
-			$html = '';
173
-			foreach( $this->getSubClients() as $subclient ) {
174
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
175
-			}
176
-			$view->selectHeader = $html;
177
-
178
-			/** client/html/locale/select/standard/template-header
179
-			 * Relative path to the HTML header template of the locale select client.
180
-			 *
181
-			 * The template file contains the HTML code and processing instructions
182
-			 * to generate the HTML code that is inserted into the HTML page header
183
-			 * of the rendered page in the frontend. The configuration string is the
184
-			 * path to the template file relative to the templates directory (usually
185
-			 * in client/html/templates).
186
-			 *
187
-			 * You can overwrite the template file configuration in extensions and
188
-			 * provide alternative templates. These alternative templates should be
189
-			 * named like the default one but with the string "standard" replaced by
190
-			 * an unique name. You may use the name of your project for this. If
191
-			 * you've implemented an alternative client class as well, "standard"
192
-			 * should be replaced by the name of the new class.
193
-			 *
194
-			 * @param string Relative path to the template creating code for the HTML page head
195
-			 * @since 2014.09
196
-			 * @category Developer
197
-			 * @see client/html/locale/select/standard/template-body
198
-			 */
199
-			$tplconf = 'client/html/locale/select/standard/template-header';
200
-			$default = 'locale/select/header-default.php';
201
-
202
-			return $view->render( $view->config( $tplconf, $default ) );
203
-		}
204
-		catch( \Exception $e )
205
-		{
206
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
207
-		}
208
-	}
209
-
210
-
211
-	/**
212
-	 * Returns the sub-client given by its name.
213
-	 *
214
-	 * @param string $type Name of the client type
215
-	 * @param string|null $name Name of the sub-client (Default if null)
216
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
217
-	 */
218
-	public function getSubClient( $type, $name = null )
219
-	{
220
-		/** client/html/locale/select/decorators/excludes
221
-		 * Excludes decorators added by the "common" option from the locale select html client
222
-		 *
223
-		 * Decorators extend the functionality of a class by adding new aspects
224
-		 * (e.g. log what is currently done), executing the methods of the underlying
225
-		 * class only in certain conditions (e.g. only for logged in users) or
226
-		 * modify what is returned to the caller.
227
-		 *
228
-		 * This option allows you to remove a decorator added via
229
-		 * "client/html/common/decorators/default" before they are wrapped
230
-		 * around the html client.
231
-		 *
232
-		 *  client/html/locale/select/decorators/excludes = array( 'decorator1' )
233
-		 *
234
-		 * This would remove the decorator named "decorator1" from the list of
235
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
236
-		 * "client/html/common/decorators/default" to the html client.
237
-		 *
238
-		 * @param array List of decorator names
239
-		 * @since 2014.05
240
-		 * @category Developer
241
-		 * @see client/html/common/decorators/default
242
-		 * @see client/html/locale/select/decorators/global
243
-		 * @see client/html/locale/select/decorators/local
244
-		 */
245
-
246
-		/** client/html/locale/select/decorators/global
247
-		 * Adds a list of globally available decorators only to the locale select html client
248
-		 *
249
-		 * Decorators extend the functionality of a class by adding new aspects
250
-		 * (e.g. log what is currently done), executing the methods of the underlying
251
-		 * class only in certain conditions (e.g. only for logged in users) or
252
-		 * modify what is returned to the caller.
253
-		 *
254
-		 * This option allows you to wrap global decorators
255
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
256
-		 *
257
-		 *  client/html/locale/select/decorators/global = array( 'decorator1' )
258
-		 *
259
-		 * This would add the decorator named "decorator1" defined by
260
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
261
-		 *
262
-		 * @param array List of decorator names
263
-		 * @since 2014.05
264
-		 * @category Developer
265
-		 * @see client/html/common/decorators/default
266
-		 * @see client/html/locale/select/decorators/excludes
267
-		 * @see client/html/locale/select/decorators/local
268
-		 */
269
-
270
-		/** client/html/locale/select/decorators/local
271
-		 * Adds a list of local decorators only to the locale select html client
272
-		 *
273
-		 * Decorators extend the functionality of a class by adding new aspects
274
-		 * (e.g. log what is currently done), executing the methods of the underlying
275
-		 * class only in certain conditions (e.g. only for logged in users) or
276
-		 * modify what is returned to the caller.
277
-		 *
278
-		 * This option allows you to wrap local decorators
279
-		 * ("\Aimeos\Client\Html\Locale\Decorator\*") around the html client.
280
-		 *
281
-		 *  client/html/locale/select/decorators/local = array( 'decorator2' )
282
-		 *
283
-		 * This would add the decorator named "decorator2" defined by
284
-		 * "\Aimeos\Client\Html\Locale\Decorator\Decorator2" only to the html client.
285
-		 *
286
-		 * @param array List of decorator names
287
-		 * @since 2014.05
288
-		 * @category Developer
289
-		 * @see client/html/common/decorators/default
290
-		 * @see client/html/locale/select/decorators/excludes
291
-		 * @see client/html/locale/select/decorators/global
292
-		 */
293
-		return $this->createSubClient( 'locale/select/' . $type, $name );
294
-	}
295
-
296
-
297
-	/**
298
-	 * Returns the list of sub-client names configured for the client.
299
-	 *
300
-	 * @return array List of HTML client names
301
-	 */
302
-	protected function getSubClientNames()
303
-	{
304
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
305
-	}
306
-
307
-
308
-	/**
309
-	 * Sets the necessary parameter values in the view.
310
-	 *
311
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
312
-	 * @param array &$tags Result array for the list of tags that are associated to the output
313
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
314
-	 * @return \Aimeos\MW\View\Iface Modified view object
315
-	 */
316
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
317
-	{
318
-		if( !isset( $this->cache ) )
319
-		{
320
-			$map = array();
321
-			$context = $this->getContext();
322
-			$config = $context->getConfig();
323
-			$locale = $context->getLocale();
324
-
325
-			/** client/html/locale/select/language/param-name
326
-			 * Name of the parameter that contains the language ID value
327
-			 *
328
-			 * Frameworks and applications normally use its own predefined parameter
329
-			 * that contains the current language ID if they are multi-language
330
-			 * capable. To adapt the Aimeos parameter name to the already used name,
331
-			 * you are able to configure it by using this setting.
332
-			 *
333
-			 * @param string Parameter name for language ID
334
-			 * @since 2015.06
335
-			 * @see client/html/locale/select/currency/param-name
336
-			 */
337
-			$langname = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
338
-
339
-			/** client/html/locale/select/currency/param-name
340
-			 * Name of the parameter that contains the currency ID value
341
-			 *
342
-			 * Frameworks and applications normally use its own predefined parameter
343
-			 * that contains the current currency ID if they already support multiple
344
-			 * currencies. To adapt the Aimeos parameter name to the already used name,
345
-			 * you are able to configure it by using this setting.
346
-			 *
347
-			 * @param string Parameter name for currency ID
348
-			 * @since 2015.06
349
-			 * @see client/html/locale/select/language/param-name
350
-			 */
351
-			$curname = $config->get( 'client/html/locale/select/currency/param-name', 'loc_currencyid' );
352
-
353
-
354
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
355
-
356
-			$search = $manager->createSearch( true );
357
-			$search->setSortations( array( $search->sort( '+', 'locale.position' ) ) );
358
-
359
-			foreach( $manager->searchItems( $search ) as $item )
360
-			{
361
-				$curId = $item->getCurrencyId();
362
-				$langId = $item->getLanguageId();
363
-				$map[$langId][$curId] = array( $langname => $langId, $curname => $curId );
364
-			}
365
-
366
-			$params = $view->param();
367
-
368
-			$view->selectMap = $map;
369
-			$view->selectParams = $params;
370
-			$view->selectLanguageId = $locale->getLanguageId();
371
-			$view->selectCurrencyId = $locale->getCurrencyId();
372
-
373
-			$this->cache = $view;
374
-		}
375
-
376
-		return $this->cache;
377
-	}
25
+    /** client/html/locale/select/standard/subparts
26
+     * List of HTML sub-clients rendered within the locale select section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.09
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/locale/select/standard/subparts';
59
+
60
+    /** client/html/locale/select/language/name
61
+     * Name of the language part used by the locale selector client implementation
62
+     *
63
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Locale\Select\Language\Myname".
64
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
65
+     *
66
+     * @param string Last part of the client class name
67
+     * @since 2014.09
68
+     * @category Developer
69
+     */
70
+
71
+    /** client/html/locale/select/currency/name
72
+     * Name of the currency part used by the locale selector client implementation
73
+     *
74
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Locale\Select\Currency\Myname".
75
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
76
+     *
77
+     * @param string Last part of the client class name
78
+     * @since 2014.09
79
+     * @category Developer
80
+     */
81
+    private $subPartNames = array( 'language', 'currency' );
82
+    private $cache;
83
+
84
+
85
+    /**
86
+     * Returns the HTML code for insertion into the body.
87
+     *
88
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
89
+     * @param array &$tags Result array for the list of tags that are associated to the output
90
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91
+     * @return string HTML code
92
+     */
93
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
94
+    {
95
+        $context = $this->getContext();
96
+        $view = $this->getView();
97
+
98
+        try
99
+        {
100
+            $view = $this->setViewParams( $view, $tags, $expire );
101
+
102
+            $html = '';
103
+            foreach( $this->getSubClients() as $subclient ) {
104
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
105
+            }
106
+            $view->selectBody = $html;
107
+        }
108
+        catch( \Aimeos\Client\Html\Exception $e )
109
+        {
110
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
+            $view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
112
+        }
113
+        catch( \Aimeos\Controller\Frontend\Exception $e )
114
+        {
115
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
+            $view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
117
+        }
118
+        catch( \Aimeos\MShop\Exception $e )
119
+        {
120
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
+            $view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
122
+        }
123
+        catch( \Exception $e )
124
+        {
125
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
126
+
127
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
+            $view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
129
+        }
130
+
131
+        /** client/html/locale/select/standard/template-body
132
+         * Relative path to the HTML body template of the locale select client.
133
+         *
134
+         * The template file contains the HTML code and processing instructions
135
+         * to generate the result shown in the body of the frontend. The
136
+         * configuration string is the path to the template file relative
137
+         * to the templates directory (usually in client/html/templates).
138
+         *
139
+         * You can overwrite the template file configuration in extensions and
140
+         * provide alternative templates. These alternative templates should be
141
+         * named like the default one but with the string "standard" replaced by
142
+         * an unique name. You may use the name of your project for this. If
143
+         * you've implemented an alternative client class as well, "standard"
144
+         * should be replaced by the name of the new class.
145
+         *
146
+         * @param string Relative path to the template creating code for the HTML page body
147
+         * @since 2014.09
148
+         * @category Developer
149
+         * @see client/html/locale/select/standard/template-header
150
+         */
151
+        $tplconf = 'client/html/locale/select/standard/template-body';
152
+        $default = 'locale/select/body-default.php';
153
+
154
+        return $view->render( $view->config( $tplconf, $default ) );
155
+    }
156
+
157
+
158
+    /**
159
+     * Returns the HTML string for insertion into the header.
160
+     *
161
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
162
+     * @param array &$tags Result array for the list of tags that are associated to the output
163
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164
+     * @return string|null String including HTML tags for the header on error
165
+     */
166
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
167
+    {
168
+        try
169
+        {
170
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
171
+
172
+            $html = '';
173
+            foreach( $this->getSubClients() as $subclient ) {
174
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
175
+            }
176
+            $view->selectHeader = $html;
177
+
178
+            /** client/html/locale/select/standard/template-header
179
+             * Relative path to the HTML header template of the locale select client.
180
+             *
181
+             * The template file contains the HTML code and processing instructions
182
+             * to generate the HTML code that is inserted into the HTML page header
183
+             * of the rendered page in the frontend. The configuration string is the
184
+             * path to the template file relative to the templates directory (usually
185
+             * in client/html/templates).
186
+             *
187
+             * You can overwrite the template file configuration in extensions and
188
+             * provide alternative templates. These alternative templates should be
189
+             * named like the default one but with the string "standard" replaced by
190
+             * an unique name. You may use the name of your project for this. If
191
+             * you've implemented an alternative client class as well, "standard"
192
+             * should be replaced by the name of the new class.
193
+             *
194
+             * @param string Relative path to the template creating code for the HTML page head
195
+             * @since 2014.09
196
+             * @category Developer
197
+             * @see client/html/locale/select/standard/template-body
198
+             */
199
+            $tplconf = 'client/html/locale/select/standard/template-header';
200
+            $default = 'locale/select/header-default.php';
201
+
202
+            return $view->render( $view->config( $tplconf, $default ) );
203
+        }
204
+        catch( \Exception $e )
205
+        {
206
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
207
+        }
208
+    }
209
+
210
+
211
+    /**
212
+     * Returns the sub-client given by its name.
213
+     *
214
+     * @param string $type Name of the client type
215
+     * @param string|null $name Name of the sub-client (Default if null)
216
+     * @return \Aimeos\Client\Html\Iface Sub-client object
217
+     */
218
+    public function getSubClient( $type, $name = null )
219
+    {
220
+        /** client/html/locale/select/decorators/excludes
221
+         * Excludes decorators added by the "common" option from the locale select html client
222
+         *
223
+         * Decorators extend the functionality of a class by adding new aspects
224
+         * (e.g. log what is currently done), executing the methods of the underlying
225
+         * class only in certain conditions (e.g. only for logged in users) or
226
+         * modify what is returned to the caller.
227
+         *
228
+         * This option allows you to remove a decorator added via
229
+         * "client/html/common/decorators/default" before they are wrapped
230
+         * around the html client.
231
+         *
232
+         *  client/html/locale/select/decorators/excludes = array( 'decorator1' )
233
+         *
234
+         * This would remove the decorator named "decorator1" from the list of
235
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
236
+         * "client/html/common/decorators/default" to the html client.
237
+         *
238
+         * @param array List of decorator names
239
+         * @since 2014.05
240
+         * @category Developer
241
+         * @see client/html/common/decorators/default
242
+         * @see client/html/locale/select/decorators/global
243
+         * @see client/html/locale/select/decorators/local
244
+         */
245
+
246
+        /** client/html/locale/select/decorators/global
247
+         * Adds a list of globally available decorators only to the locale select html client
248
+         *
249
+         * Decorators extend the functionality of a class by adding new aspects
250
+         * (e.g. log what is currently done), executing the methods of the underlying
251
+         * class only in certain conditions (e.g. only for logged in users) or
252
+         * modify what is returned to the caller.
253
+         *
254
+         * This option allows you to wrap global decorators
255
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
256
+         *
257
+         *  client/html/locale/select/decorators/global = array( 'decorator1' )
258
+         *
259
+         * This would add the decorator named "decorator1" defined by
260
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
261
+         *
262
+         * @param array List of decorator names
263
+         * @since 2014.05
264
+         * @category Developer
265
+         * @see client/html/common/decorators/default
266
+         * @see client/html/locale/select/decorators/excludes
267
+         * @see client/html/locale/select/decorators/local
268
+         */
269
+
270
+        /** client/html/locale/select/decorators/local
271
+         * Adds a list of local decorators only to the locale select html client
272
+         *
273
+         * Decorators extend the functionality of a class by adding new aspects
274
+         * (e.g. log what is currently done), executing the methods of the underlying
275
+         * class only in certain conditions (e.g. only for logged in users) or
276
+         * modify what is returned to the caller.
277
+         *
278
+         * This option allows you to wrap local decorators
279
+         * ("\Aimeos\Client\Html\Locale\Decorator\*") around the html client.
280
+         *
281
+         *  client/html/locale/select/decorators/local = array( 'decorator2' )
282
+         *
283
+         * This would add the decorator named "decorator2" defined by
284
+         * "\Aimeos\Client\Html\Locale\Decorator\Decorator2" only to the html client.
285
+         *
286
+         * @param array List of decorator names
287
+         * @since 2014.05
288
+         * @category Developer
289
+         * @see client/html/common/decorators/default
290
+         * @see client/html/locale/select/decorators/excludes
291
+         * @see client/html/locale/select/decorators/global
292
+         */
293
+        return $this->createSubClient( 'locale/select/' . $type, $name );
294
+    }
295
+
296
+
297
+    /**
298
+     * Returns the list of sub-client names configured for the client.
299
+     *
300
+     * @return array List of HTML client names
301
+     */
302
+    protected function getSubClientNames()
303
+    {
304
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
305
+    }
306
+
307
+
308
+    /**
309
+     * Sets the necessary parameter values in the view.
310
+     *
311
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
312
+     * @param array &$tags Result array for the list of tags that are associated to the output
313
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
314
+     * @return \Aimeos\MW\View\Iface Modified view object
315
+     */
316
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
317
+    {
318
+        if( !isset( $this->cache ) )
319
+        {
320
+            $map = array();
321
+            $context = $this->getContext();
322
+            $config = $context->getConfig();
323
+            $locale = $context->getLocale();
324
+
325
+            /** client/html/locale/select/language/param-name
326
+             * Name of the parameter that contains the language ID value
327
+             *
328
+             * Frameworks and applications normally use its own predefined parameter
329
+             * that contains the current language ID if they are multi-language
330
+             * capable. To adapt the Aimeos parameter name to the already used name,
331
+             * you are able to configure it by using this setting.
332
+             *
333
+             * @param string Parameter name for language ID
334
+             * @since 2015.06
335
+             * @see client/html/locale/select/currency/param-name
336
+             */
337
+            $langname = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
338
+
339
+            /** client/html/locale/select/currency/param-name
340
+             * Name of the parameter that contains the currency ID value
341
+             *
342
+             * Frameworks and applications normally use its own predefined parameter
343
+             * that contains the current currency ID if they already support multiple
344
+             * currencies. To adapt the Aimeos parameter name to the already used name,
345
+             * you are able to configure it by using this setting.
346
+             *
347
+             * @param string Parameter name for currency ID
348
+             * @since 2015.06
349
+             * @see client/html/locale/select/language/param-name
350
+             */
351
+            $curname = $config->get( 'client/html/locale/select/currency/param-name', 'loc_currencyid' );
352
+
353
+
354
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
355
+
356
+            $search = $manager->createSearch( true );
357
+            $search->setSortations( array( $search->sort( '+', 'locale.position' ) ) );
358
+
359
+            foreach( $manager->searchItems( $search ) as $item )
360
+            {
361
+                $curId = $item->getCurrencyId();
362
+                $langId = $item->getLanguageId();
363
+                $map[$langId][$curId] = array( $langname => $langId, $curname => $curId );
364
+            }
365
+
366
+            $params = $view->param();
367
+
368
+            $view->selectMap = $map;
369
+            $view->selectParams = $params;
370
+            $view->selectLanguageId = $locale->getLanguageId();
371
+            $view->selectCurrencyId = $locale->getCurrencyId();
372
+
373
+            $this->cache = $view;
374
+        }
375
+
376
+        return $this->cache;
377
+    }
378 378
 }
379 379
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +38 added lines, -38 removed lines patch added patch discarded remove patch
@@ -78,7 +78,7 @@  discard block
 block discarded – undo
78 78
 	 * @since 2014.09
79 79
 	 * @category Developer
80 80
 	 */
81
-	private $subPartNames = array( 'language', 'currency' );
81
+	private $subPartNames = array('language', 'currency');
82 82
 	private $cache;
83 83
 
84 84
 
@@ -90,42 +90,42 @@  discard block
 block discarded – undo
90 90
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91 91
 	 * @return string HTML code
92 92
 	 */
93
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
93
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
94 94
 	{
95 95
 		$context = $this->getContext();
96 96
 		$view = $this->getView();
97 97
 
98 98
 		try
99 99
 		{
100
-			$view = $this->setViewParams( $view, $tags, $expire );
100
+			$view = $this->setViewParams($view, $tags, $expire);
101 101
 
102 102
 			$html = '';
103
-			foreach( $this->getSubClients() as $subclient ) {
104
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
103
+			foreach ($this->getSubClients() as $subclient) {
104
+				$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
105 105
 			}
106 106
 			$view->selectBody = $html;
107 107
 		}
108
-		catch( \Aimeos\Client\Html\Exception $e )
108
+		catch (\Aimeos\Client\Html\Exception $e)
109 109
 		{
110
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
110
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
111
+			$view->selectErrorList = $view->get('selectErrorList', array()) + $error;
112 112
 		}
113
-		catch( \Aimeos\Controller\Frontend\Exception $e )
113
+		catch (\Aimeos\Controller\Frontend\Exception $e)
114 114
 		{
115
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
115
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
116
+			$view->selectErrorList = $view->get('selectErrorList', array()) + $error;
117 117
 		}
118
-		catch( \Aimeos\MShop\Exception $e )
118
+		catch (\Aimeos\MShop\Exception $e)
119 119
 		{
120
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
120
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
121
+			$view->selectErrorList = $view->get('selectErrorList', array()) + $error;
122 122
 		}
123
-		catch( \Exception $e )
123
+		catch (\Exception $e)
124 124
 		{
125
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
125
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
126 126
 
127
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
-			$view->selectErrorList = $view->get( 'selectErrorList', array() ) + $error;
127
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
128
+			$view->selectErrorList = $view->get('selectErrorList', array()) + $error;
129 129
 		}
130 130
 
131 131
 		/** client/html/locale/select/standard/template-body
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
 		$tplconf = 'client/html/locale/select/standard/template-body';
152 152
 		$default = 'locale/select/body-default.php';
153 153
 
154
-		return $view->render( $view->config( $tplconf, $default ) );
154
+		return $view->render($view->config($tplconf, $default));
155 155
 	}
156 156
 
157 157
 
@@ -163,15 +163,15 @@  discard block
 block discarded – undo
163 163
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164 164
 	 * @return string|null String including HTML tags for the header on error
165 165
 	 */
166
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
166
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
167 167
 	{
168 168
 		try
169 169
 		{
170
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
170
+			$view = $this->setViewParams($this->getView(), $tags, $expire);
171 171
 
172 172
 			$html = '';
173
-			foreach( $this->getSubClients() as $subclient ) {
174
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
173
+			foreach ($this->getSubClients() as $subclient) {
174
+				$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
175 175
 			}
176 176
 			$view->selectHeader = $html;
177 177
 
@@ -199,11 +199,11 @@  discard block
 block discarded – undo
199 199
 			$tplconf = 'client/html/locale/select/standard/template-header';
200 200
 			$default = 'locale/select/header-default.php';
201 201
 
202
-			return $view->render( $view->config( $tplconf, $default ) );
202
+			return $view->render($view->config($tplconf, $default));
203 203
 		}
204
-		catch( \Exception $e )
204
+		catch (\Exception $e)
205 205
 		{
206
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
206
+			$this->getContext()->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
207 207
 		}
208 208
 	}
209 209
 
@@ -215,7 +215,7 @@  discard block
 block discarded – undo
215 215
 	 * @param string|null $name Name of the sub-client (Default if null)
216 216
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
217 217
 	 */
218
-	public function getSubClient( $type, $name = null )
218
+	public function getSubClient($type, $name = null)
219 219
 	{
220 220
 		/** client/html/locale/select/decorators/excludes
221 221
 		 * Excludes decorators added by the "common" option from the locale select html client
@@ -290,7 +290,7 @@  discard block
 block discarded – undo
290 290
 		 * @see client/html/locale/select/decorators/excludes
291 291
 		 * @see client/html/locale/select/decorators/global
292 292
 		 */
293
-		return $this->createSubClient( 'locale/select/' . $type, $name );
293
+		return $this->createSubClient('locale/select/'.$type, $name);
294 294
 	}
295 295
 
296 296
 
@@ -301,7 +301,7 @@  discard block
 block discarded – undo
301 301
 	 */
302 302
 	protected function getSubClientNames()
303 303
 	{
304
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
304
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
305 305
 	}
306 306
 
307 307
 
@@ -313,9 +313,9 @@  discard block
 block discarded – undo
313 313
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
314 314
 	 * @return \Aimeos\MW\View\Iface Modified view object
315 315
 	 */
316
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
316
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
317 317
 	{
318
-		if( !isset( $this->cache ) )
318
+		if (!isset($this->cache))
319 319
 		{
320 320
 			$map = array();
321 321
 			$context = $this->getContext();
@@ -334,7 +334,7 @@  discard block
 block discarded – undo
334 334
 			 * @since 2015.06
335 335
 			 * @see client/html/locale/select/currency/param-name
336 336
 			 */
337
-			$langname = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
337
+			$langname = $config->get('client/html/locale/select/language/param-name', 'loc_languageid');
338 338
 
339 339
 			/** client/html/locale/select/currency/param-name
340 340
 			 * Name of the parameter that contains the currency ID value
@@ -348,19 +348,19 @@  discard block
 block discarded – undo
348 348
 			 * @since 2015.06
349 349
 			 * @see client/html/locale/select/language/param-name
350 350
 			 */
351
-			$curname = $config->get( 'client/html/locale/select/currency/param-name', 'loc_currencyid' );
351
+			$curname = $config->get('client/html/locale/select/currency/param-name', 'loc_currencyid');
352 352
 
353 353
 
354
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
354
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'locale');
355 355
 
356
-			$search = $manager->createSearch( true );
357
-			$search->setSortations( array( $search->sort( '+', 'locale.position' ) ) );
356
+			$search = $manager->createSearch(true);
357
+			$search->setSortations(array($search->sort('+', 'locale.position')));
358 358
 
359
-			foreach( $manager->searchItems( $search ) as $item )
359
+			foreach ($manager->searchItems($search) as $item)
360 360
 			{
361 361
 				$curId = $item->getCurrencyId();
362 362
 				$langId = $item->getLanguageId();
363
-				$map[$langId][$curId] = array( $langname => $langId, $curname => $curId );
363
+				$map[$langId][$curId] = array($langname => $langId, $curname => $curId);
364 364
 			}
365 365
 
366 366
 			$params = $view->param();
Please login to merge, or discard this patch.
Braces   +5 added lines, -10 removed lines patch added patch discarded remove patch
@@ -82,23 +82,19 @@  discard block
 block discarded – undo
82 82
 				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
83 83
 			}
84 84
 			$view->watchBody = $html;
85
-		}
86
-		catch( \Aimeos\Client\Html\Exception $e )
85
+		} catch( \Aimeos\Client\Html\Exception $e )
87 86
 		{
88 87
 			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
89 88
 			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
90
-		}
91
-		catch( \Aimeos\Controller\Frontend\Exception $e )
89
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
92 90
 		{
93 91
 			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
94 92
 			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
95
-		}
96
-		catch( \Aimeos\MShop\Exception $e )
93
+		} catch( \Aimeos\MShop\Exception $e )
97 94
 		{
98 95
 			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
99 96
 			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
100
-		}
101
-		catch( \Exception $e )
97
+		} catch( \Exception $e )
102 98
 		{
103 99
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
104 100
 
@@ -178,8 +174,7 @@  discard block
 block discarded – undo
178 174
 			$default = 'account/watch/header-default.php';
179 175
 
180 176
 			return $view->render( $view->config( $tplconf, $default ) );
181
-		}
182
-		catch( \Exception $e )
177
+		} catch( \Exception $e )
183 178
 		{
184 179
 			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
185 180
 		}
Please login to merge, or discard this patch.
client/html/src/Client/Html/Locale/Select/Language/Standard.php 2 patches
Spacing   +16 added lines, -16 removed lines patch added patch discarded remove patch
@@ -67,13 +67,13 @@  discard block
 block discarded – undo
67 67
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68 68
 	 * @return string HTML code
69 69
 	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
71 71
 	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
72
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
73 73
 
74 74
 		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
75
+		foreach ($this->getSubClients() as $subclient) {
76
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
77 77
 		}
78 78
 		$view->languageBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/locale/select/language/standard/template-body';
101 101
 		$default = 'locale/select/language-body-default.php';
102 102
 
103
-		return $view->render( $view->config( $tplconf, $default ) );
103
+		return $view->render($view->config($tplconf, $default));
104 104
 	}
105 105
 
106 106
 
@@ -112,13 +112,13 @@  discard block
 block discarded – undo
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113 113
 	 * @return string|null String including HTML tags for the header on error
114 114
 	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
115
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
116 116
 	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
117
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
118 118
 
119 119
 		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
120
+		foreach ($this->getSubClients() as $subclient) {
121
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
122 122
 		}
123 123
 		$view->languageHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/locale/select/language/standard/template-header';
147 147
 		$default = 'locale/select/language-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/locale/select/language/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the locale select language html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/locale/select/language/decorators/global
234 234
 		 */
235 235
 
236
-		return $this->createSubClient( 'locale/select/language/' . $type, $name );
236
+		return $this->createSubClient('locale/select/language/'.$type, $name);
237 237
 	}
238 238
 
239 239
 
@@ -249,10 +249,10 @@  discard block
 block discarded – undo
249 249
 		$config = $context->getConfig();
250 250
 		$session = $context->getSession();
251 251
 
252
-		$name = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
252
+		$name = $config->get('client/html/locale/select/language/param-name', 'loc_languageid');
253 253
 
254
-		if( ( $languageId = $view->param( $name ) ) !== null ) {
255
-			$session->set( 'aimeos/locale/languageid', $languageId );
254
+		if (($languageId = $view->param($name)) !== null) {
255
+			$session->set('aimeos/locale/languageid', $languageId);
256 256
 		}
257 257
 
258 258
 		parent::process();
@@ -266,6 +266,6 @@  discard block
 block discarded – undo
266 266
 	 */
267 267
 	protected function getSubClientNames()
268 268
 	{
269
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
269
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
270 270
 	}
271 271
 }
Please login to merge, or discard this patch.
Indentation   +226 added lines, -226 removed lines patch added patch discarded remove patch
@@ -19,253 +19,253 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/locale/select/language/standard/subparts
26
-	 * List of HTML sub-clients rendered within the locale select language section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.09
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/locale/select/language/standard/subparts';
59
-	private $subPartNames = array();
25
+    /** client/html/locale/select/language/standard/subparts
26
+     * List of HTML sub-clients rendered within the locale select language section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.09
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/locale/select/language/standard/subparts';
59
+    private $subPartNames = array();
60 60
 
61 61
 
62
-	/**
63
-	 * Returns the HTML code for insertion into the body.
64
-	 *
65
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
-	 * @param array &$tags Result array for the list of tags that are associated to the output
67
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
-	 * @return string HTML code
69
-	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
-	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
62
+    /**
63
+     * Returns the HTML code for insertion into the body.
64
+     *
65
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
+     * @param array &$tags Result array for the list of tags that are associated to the output
67
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
+     * @return string HTML code
69
+     */
70
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
+    {
72
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
73 73
 
74
-		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
-		}
78
-		$view->languageBody = $html;
74
+        $html = '';
75
+        foreach( $this->getSubClients() as $subclient ) {
76
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+        }
78
+        $view->languageBody = $html;
79 79
 
80
-		/** client/html/locale/select/language/standard/template-body
81
-		 * Relative path to the HTML body template of the locale select language client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.09
97
-		 * @category Developer
98
-		 * @see client/html/locale/select/language/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/locale/select/language/standard/template-body';
101
-		$default = 'locale/select/language-body-default.php';
80
+        /** client/html/locale/select/language/standard/template-body
81
+         * Relative path to the HTML body template of the locale select language client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.09
97
+         * @category Developer
98
+         * @see client/html/locale/select/language/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/locale/select/language/standard/template-body';
101
+        $default = 'locale/select/language-body-default.php';
102 102
 
103
-		return $view->render( $view->config( $tplconf, $default ) );
104
-	}
103
+        return $view->render( $view->config( $tplconf, $default ) );
104
+    }
105 105
 
106 106
 
107
-	/**
108
-	 * Returns the HTML string for insertion into the header.
109
-	 *
110
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
-	 * @param array &$tags Result array for the list of tags that are associated to the output
112
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string String including HTML tags for the header on error
114
-	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
-	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
107
+    /**
108
+     * Returns the HTML string for insertion into the header.
109
+     *
110
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
+     * @param array &$tags Result array for the list of tags that are associated to the output
112
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
+     * @return string String including HTML tags for the header on error
114
+     */
115
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
+    {
117
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
118 118
 
119
-		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
-		}
123
-		$view->languageHeader = $html;
119
+        $html = '';
120
+        foreach( $this->getSubClients() as $subclient ) {
121
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+        }
123
+        $view->languageHeader = $html;
124 124
 
125
-		/** client/html/locale/select/language/standard/template-header
126
-		 * Relative path to the HTML header template of the locale select language client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.09
143
-		 * @category Developer
144
-		 * @see client/html/locale/select/language/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/locale/select/language/standard/template-header';
147
-		$default = 'locale/select/language-header-default.php';
125
+        /** client/html/locale/select/language/standard/template-header
126
+         * Relative path to the HTML header template of the locale select language client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.09
143
+         * @category Developer
144
+         * @see client/html/locale/select/language/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/locale/select/language/standard/template-header';
147
+        $default = 'locale/select/language-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151 151
 
152 152
 
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/locale/select/language/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the locale select language html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/locale/select/language/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/locale/select/language/decorators/global
185
-		 * @see client/html/locale/select/language/decorators/local
186
-		 */
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/locale/select/language/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the locale select language html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/locale/select/language/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/locale/select/language/decorators/global
185
+         * @see client/html/locale/select/language/decorators/local
186
+         */
187 187
 
188
-		/** client/html/locale/select/language/decorators/global
189
-		 * Adds a list of globally available decorators only to the locale select language html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/locale/select/language/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/locale/select/language/decorators/excludes
209
-		 * @see client/html/locale/select/language/decorators/local
210
-		 */
188
+        /** client/html/locale/select/language/decorators/global
189
+         * Adds a list of globally available decorators only to the locale select language html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/locale/select/language/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/locale/select/language/decorators/excludes
209
+         * @see client/html/locale/select/language/decorators/local
210
+         */
211 211
 
212
-		/** client/html/locale/select/language/decorators/local
213
-		 * Adds a list of local decorators only to the locale select language html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/locale/select/language/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/locale/select/language/decorators/excludes
233
-		 * @see client/html/locale/select/language/decorators/global
234
-		 */
212
+        /** client/html/locale/select/language/decorators/local
213
+         * Adds a list of local decorators only to the locale select language html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/locale/select/language/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/locale/select/language/decorators/excludes
233
+         * @see client/html/locale/select/language/decorators/global
234
+         */
235 235
 
236
-		return $this->createSubClient( 'locale/select/language/' . $type, $name );
237
-	}
236
+        return $this->createSubClient( 'locale/select/language/' . $type, $name );
237
+    }
238 238
 
239 239
 
240
-	/**
241
-	 * Processes the input, e.g. store given values.
242
-	 * A view must be available and this method doesn't generate any output
243
-	 * besides setting view variables.
244
-	 */
245
-	public function process()
246
-	{
247
-		$view = $this->getView();
248
-		$context = $this->getContext();
249
-		$config = $context->getConfig();
250
-		$session = $context->getSession();
240
+    /**
241
+     * Processes the input, e.g. store given values.
242
+     * A view must be available and this method doesn't generate any output
243
+     * besides setting view variables.
244
+     */
245
+    public function process()
246
+    {
247
+        $view = $this->getView();
248
+        $context = $this->getContext();
249
+        $config = $context->getConfig();
250
+        $session = $context->getSession();
251 251
 
252
-		$name = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
252
+        $name = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
253 253
 
254
-		if( ( $languageId = $view->param( $name ) ) !== null ) {
255
-			$session->set( 'aimeos/locale/languageid', $languageId );
256
-		}
254
+        if( ( $languageId = $view->param( $name ) ) !== null ) {
255
+            $session->set( 'aimeos/locale/languageid', $languageId );
256
+        }
257 257
 
258
-		parent::process();
259
-	}
258
+        parent::process();
259
+    }
260 260
 
261 261
 
262
-	/**
263
-	 * Returns the list of sub-client names configured for the client.
264
-	 *
265
-	 * @return array List of HTML client names
266
-	 */
267
-	protected function getSubClientNames()
268
-	{
269
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
270
-	}
262
+    /**
263
+     * Returns the list of sub-client names configured for the client.
264
+     *
265
+     * @return array List of HTML client names
266
+     */
267
+    protected function getSubClientNames()
268
+    {
269
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
270
+    }
271 271
 }
Please login to merge, or discard this patch.
client/html/src/Client/Html/Factory.php 2 patches
Indentation   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -19,48 +19,48 @@
 block discarded – undo
19 19
  */
20 20
 class Factory
21 21
 {
22
-	/**
23
-	 * Creates a new client object.
24
-	 *
25
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
26
-	 * @param array List of file system paths where the templates are stored
27
-	 * @param string $type Type of the client, e.g 'account/favorite' for \Aimeos\Client\Html\Account\Favorite\Standard
28
-	 * @param string|null $name Client name (default: "Standard")
29
-	 * @return \Aimeos\Client\Html\Iface HTML client implementing \Aimeos\Client\Html\Iface
30
-	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
31
-	 */
32
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $type, $name = null )
33
-	{
34
-		if( empty( $type ) ) {
35
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client HTML type is empty' ) );
36
-		}
22
+    /**
23
+     * Creates a new client object.
24
+     *
25
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
26
+     * @param array List of file system paths where the templates are stored
27
+     * @param string $type Type of the client, e.g 'account/favorite' for \Aimeos\Client\Html\Account\Favorite\Standard
28
+     * @param string|null $name Client name (default: "Standard")
29
+     * @return \Aimeos\Client\Html\Iface HTML client implementing \Aimeos\Client\Html\Iface
30
+     * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
31
+     */
32
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $type, $name = null )
33
+    {
34
+        if( empty( $type ) ) {
35
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Client HTML type is empty' ) );
36
+        }
37 37
 
38
-		$parts = explode( '/', $type );
38
+        $parts = explode( '/', $type );
39 39
 
40
-		if( count( $parts ) !== 2 ) {
41
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client type "%1$s" must consist of two parts separated by "/"', $type ) );
42
-		}
40
+        if( count( $parts ) !== 2 ) {
41
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Client type "%1$s" must consist of two parts separated by "/"', $type ) );
42
+        }
43 43
 
44
-		foreach( $parts as $part )
45
-		{
46
-			if( ctype_alnum( $part ) === false ) {
47
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s" in "%2$s"', $part, $type ) );
48
-			}
49
-		}
44
+        foreach( $parts as $part )
45
+        {
46
+            if( ctype_alnum( $part ) === false ) {
47
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s" in "%2$s"', $part, $type ) );
48
+            }
49
+        }
50 50
 
51
-		$factory = '\\Aimeos\\Client\\Html\\' . ucwords( $parts[0] ) . '\\' . ucwords( $parts[1] ) . '\\Factory';
51
+        $factory = '\\Aimeos\\Client\\Html\\' . ucwords( $parts[0] ) . '\\' . ucwords( $parts[1] ) . '\\Factory';
52 52
 
53
-		if( class_exists( $factory ) === false ) {
54
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $factory ) );
55
-		}
53
+        if( class_exists( $factory ) === false ) {
54
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $factory ) );
55
+        }
56 56
 
57
-		$client = @call_user_func_array( array( $factory, 'createClient' ), array( $context, $templatePaths, $name ) );
57
+        $client = @call_user_func_array( array( $factory, 'createClient' ), array( $context, $templatePaths, $name ) );
58 58
 
59
-		if( $client === false ) {
60
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid factory "%1$s"', $factory ) );
61
-		}
59
+        if( $client === false ) {
60
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid factory "%1$s"', $factory ) );
61
+        }
62 62
 
63
-		return $client;
64
-	}
63
+        return $client;
64
+    }
65 65
 
66 66
 }
67 67
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -29,35 +29,35 @@
 block discarded – undo
29 29
 	 * @return \Aimeos\Client\Html\Iface HTML client implementing \Aimeos\Client\Html\Iface
30 30
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
31 31
 	 */
32
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $type, $name = null )
32
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $type, $name = null)
33 33
 	{
34
-		if( empty( $type ) ) {
35
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client HTML type is empty' ) );
34
+		if (empty($type)) {
35
+			throw new \Aimeos\Client\Html\Exception(sprintf('Client HTML type is empty'));
36 36
 		}
37 37
 
38
-		$parts = explode( '/', $type );
38
+		$parts = explode('/', $type);
39 39
 
40
-		if( count( $parts ) !== 2 ) {
41
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client type "%1$s" must consist of two parts separated by "/"', $type ) );
40
+		if (count($parts) !== 2) {
41
+			throw new \Aimeos\Client\Html\Exception(sprintf('Client type "%1$s" must consist of two parts separated by "/"', $type));
42 42
 		}
43 43
 
44
-		foreach( $parts as $part )
44
+		foreach ($parts as $part)
45 45
 		{
46
-			if( ctype_alnum( $part ) === false ) {
47
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s" in "%2$s"', $part, $type ) );
46
+			if (ctype_alnum($part) === false) {
47
+				throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in client name "%1$s" in "%2$s"', $part, $type));
48 48
 			}
49 49
 		}
50 50
 
51
-		$factory = '\\Aimeos\\Client\\Html\\' . ucwords( $parts[0] ) . '\\' . ucwords( $parts[1] ) . '\\Factory';
51
+		$factory = '\\Aimeos\\Client\\Html\\'.ucwords($parts[0]).'\\'.ucwords($parts[1]).'\\Factory';
52 52
 
53
-		if( class_exists( $factory ) === false ) {
54
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $factory ) );
53
+		if (class_exists($factory) === false) {
54
+			throw new \Aimeos\Client\Html\Exception(sprintf('Class "%1$s" not available', $factory));
55 55
 		}
56 56
 
57
-		$client = @call_user_func_array( array( $factory, 'createClient' ), array( $context, $templatePaths, $name ) );
57
+		$client = @call_user_func_array(array($factory, 'createClient'), array($context, $templatePaths, $name));
58 58
 
59
-		if( $client === false ) {
60
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid factory "%1$s"', $factory ) );
59
+		if ($client === false) {
60
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid factory "%1$s"', $factory));
61 61
 		}
62 62
 
63 63
 		return $client;
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Base.php 2 patches
Indentation   +54 added lines, -54 removed lines patch added patch discarded remove patch
@@ -19,66 +19,66 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 abstract class Base
22
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
22
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
23 23
 {
24
-	/**
25
-	 * Removes all cached basket parts from the cache.
26
-	 */
27
-	protected function clearCached()
28
-	{
29
-		$session = $this->getContext()->getSession();
24
+    /**
25
+     * Removes all cached basket parts from the cache.
26
+     */
27
+    protected function clearCached()
28
+    {
29
+        $session = $this->getContext()->getSession();
30 30
 
31
-		foreach( $session->get( 'aimeos/basket/cache', array() ) as $key => $value ) {
32
-			$session->set( $key, null );
33
-		}
34
-	}
31
+        foreach( $session->get( 'aimeos/basket/cache', array() ) as $key => $value ) {
32
+            $session->set( $key, null );
33
+        }
34
+    }
35 35
 
36 36
 
37
-	/**
38
-	 * Returns the basket cache entry from the cache if available.
39
-	 *
40
-	 * @param string $key Path to the requested cache entry
41
-	 * @param mixed $default Value returned if requested key isn't found
42
-	 * @return mixed Value associated to the requested key. If no value for the
43
-	 *	key is found in the cache, the given default value is returned
44
-	 */
45
-	protected function getBasketCached( $key, $default = null )
46
-	{
47
-		return $this->getContext()->getSession()->get( $key, $default );
48
-	}
37
+    /**
38
+     * Returns the basket cache entry from the cache if available.
39
+     *
40
+     * @param string $key Path to the requested cache entry
41
+     * @param mixed $default Value returned if requested key isn't found
42
+     * @return mixed Value associated to the requested key. If no value for the
43
+     *	key is found in the cache, the given default value is returned
44
+     */
45
+    protected function getBasketCached( $key, $default = null )
46
+    {
47
+        return $this->getContext()->getSession()->get( $key, $default );
48
+    }
49 49
 
50 50
 
51
-	/**
52
-	 * Adds or overwrite a cache entry for the given key and value.
53
-	 *
54
-	 * @param string $key Path the cache entry should be stored in
55
-	 * @param mixed $value Value stored in the cache for the path
56
-	 */
57
-	protected function setBasketCached( $key, $value )
58
-	{
59
-		$context = $this->getContext();
51
+    /**
52
+     * Adds or overwrite a cache entry for the given key and value.
53
+     *
54
+     * @param string $key Path the cache entry should be stored in
55
+     * @param mixed $value Value stored in the cache for the path
56
+     */
57
+    protected function setBasketCached( $key, $value )
58
+    {
59
+        $context = $this->getContext();
60 60
 
61
-		/** client/html/basket/cache/enable
62
-		 * Enables or disables caching of the basket content
63
-		 *
64
-		 * For performance reasons, the content of the small baskets is cached
65
-		 * in the session of the customer. The cache is updated each time the
66
-		 * basket content changes either by adding, deleting or editing products.
67
-		 *
68
-		 * To ease development, the caching can be disabled but you shouldn't
69
-		 * disable it in your production environment!
70
-		 *
71
-		 * @param boolean True to enable, false to disable basket content caching
72
-		 * @category Developer
73
-		 * @since 2014.11
74
-		 */
75
-		if( $context->getConfig()->get( 'client/html/basket/cache/enable', true ) != false )
76
-		{
77
-			$session = $context->getSession();
61
+        /** client/html/basket/cache/enable
62
+         * Enables or disables caching of the basket content
63
+         *
64
+         * For performance reasons, the content of the small baskets is cached
65
+         * in the session of the customer. The cache is updated each time the
66
+         * basket content changes either by adding, deleting or editing products.
67
+         *
68
+         * To ease development, the caching can be disabled but you shouldn't
69
+         * disable it in your production environment!
70
+         *
71
+         * @param boolean True to enable, false to disable basket content caching
72
+         * @category Developer
73
+         * @since 2014.11
74
+         */
75
+        if( $context->getConfig()->get( 'client/html/basket/cache/enable', true ) != false )
76
+        {
77
+            $session = $context->getSession();
78 78
 
79
-			$cached = $session->get( 'aimeos/basket/cache', array() ) + array( $key => true );
80
-			$session->set( 'aimeos/basket/cache', $cached );
81
-			$session->set( $key, $value );
82
-		}
83
-	}
79
+            $cached = $session->get( 'aimeos/basket/cache', array() ) + array( $key => true );
80
+            $session->set( 'aimeos/basket/cache', $cached );
81
+            $session->set( $key, $value );
82
+        }
83
+    }
84 84
 }
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -28,8 +28,8 @@  discard block
 block discarded – undo
28 28
 	{
29 29
 		$session = $this->getContext()->getSession();
30 30
 
31
-		foreach( $session->get( 'aimeos/basket/cache', array() ) as $key => $value ) {
32
-			$session->set( $key, null );
31
+		foreach ($session->get('aimeos/basket/cache', array()) as $key => $value) {
32
+			$session->set($key, null);
33 33
 		}
34 34
 	}
35 35
 
@@ -42,9 +42,9 @@  discard block
 block discarded – undo
42 42
 	 * @return mixed Value associated to the requested key. If no value for the
43 43
 	 *	key is found in the cache, the given default value is returned
44 44
 	 */
45
-	protected function getBasketCached( $key, $default = null )
45
+	protected function getBasketCached($key, $default = null)
46 46
 	{
47
-		return $this->getContext()->getSession()->get( $key, $default );
47
+		return $this->getContext()->getSession()->get($key, $default);
48 48
 	}
49 49
 
50 50
 
@@ -54,7 +54,7 @@  discard block
 block discarded – undo
54 54
 	 * @param string $key Path the cache entry should be stored in
55 55
 	 * @param mixed $value Value stored in the cache for the path
56 56
 	 */
57
-	protected function setBasketCached( $key, $value )
57
+	protected function setBasketCached($key, $value)
58 58
 	{
59 59
 		$context = $this->getContext();
60 60
 
@@ -72,13 +72,13 @@  discard block
 block discarded – undo
72 72
 		 * @category Developer
73 73
 		 * @since 2014.11
74 74
 		 */
75
-		if( $context->getConfig()->get( 'client/html/basket/cache/enable', true ) != false )
75
+		if ($context->getConfig()->get('client/html/basket/cache/enable', true) != false)
76 76
 		{
77 77
 			$session = $context->getSession();
78 78
 
79
-			$cached = $session->get( 'aimeos/basket/cache', array() ) + array( $key => true );
80
-			$session->set( 'aimeos/basket/cache', $cached );
81
-			$session->set( $key, $value );
79
+			$cached = $session->get('aimeos/basket/cache', array()) + array($key => true);
80
+			$session->set('aimeos/basket/cache', $cached);
81
+			$session->set($key, $value);
82 82
 		}
83 83
 	}
84 84
 }
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Standard/Coupon/Standard.php 3 patches
Indentation   +287 added lines, -287 removed lines patch added patch discarded remove patch
@@ -19,292 +19,292 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Basket\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Basket\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/basket/standard/coupon/standard/subparts
26
-	 * List of HTML sub-clients rendered within the basket standard coupon section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.03
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/basket/standard/coupon/standard/subparts';
59
-	private $subPartNames = array();
60
-
61
-
62
-	/**
63
-	 * Returns the HTML code for insertion into the body.
64
-	 *
65
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
-	 * @param array &$tags Result array for the list of tags that are associated to the output
67
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
-	 * @return string HTML code
69
-	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
-	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
73
-
74
-		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
-		}
78
-		$view->couponBody = $html;
79
-
80
-		/** client/html/basket/standard/coupon/standard/template-body
81
-		 * Relative path to the HTML body template of the basket standard coupon client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.03
97
-		 * @category Developer
98
-		 * @see client/html/basket/standard/coupon/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/basket/standard/coupon/standard/template-body';
101
-		$default = 'basket/standard/coupon-body-default.php';
102
-
103
-		return $view->render( $view->config( $tplconf, $default ) );
104
-	}
105
-
106
-
107
-	/**
108
-	 * Returns the HTML string for insertion into the header.
109
-	 *
110
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
-	 * @param array &$tags Result array for the list of tags that are associated to the output
112
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
114
-	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
-	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
118
-
119
-		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
-		}
123
-		$view->couponHeader = $html;
124
-
125
-		/** client/html/basket/standard/coupon/standard/template-header
126
-		 * Relative path to the HTML header template of the basket standard coupon client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.03
143
-		 * @category Developer
144
-		 * @see client/html/basket/standard/coupon/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/basket/standard/coupon/standard/template-header';
147
-		$default = 'basket/standard/coupon-header-default.php';
148
-
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
151
-
152
-
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/basket/standard/coupon/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the basket standard coupon html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/basket/standard/coupon/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/basket/standard/coupon/decorators/global
185
-		 * @see client/html/basket/standard/coupon/decorators/local
186
-		 */
187
-
188
-		/** client/html/basket/standard/coupon/decorators/global
189
-		 * Adds a list of globally available decorators only to the basket standard coupon html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/basket/standard/coupon/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/basket/standard/coupon/decorators/excludes
209
-		 * @see client/html/basket/standard/coupon/decorators/local
210
-		 */
211
-
212
-		/** client/html/basket/standard/coupon/decorators/local
213
-		 * Adds a list of local decorators only to the basket standard coupon html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/basket/standard/coupon/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/basket/standard/coupon/decorators/excludes
233
-		 * @see client/html/basket/standard/coupon/decorators/global
234
-		 */
235
-		return $this->createSubClient( 'basket/standard/coupon/' . $type, $name );
236
-	}
237
-
238
-
239
-	/**
240
-	 * Processes the input, e.g. store given values.
241
-	 * A view must be available and this method doesn't generate any output
242
-	 * besides setting view variables.
243
-	 */
244
-	public function process()
245
-	{
246
-		$view = $this->getView();
247
-		$context = $this->getContext();
248
-
249
-		switch( $view->param( 'b_action' ) )
250
-		{
251
-			case 'coupon-delete':
252
-
253
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
254
-				{
255
-					$this->clearCached();
256
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
257
-					$cntl->deleteCoupon( $coupon );
258
-				}
259
-
260
-				break;
261
-
262
-			default:
263
-
264
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
265
-				{
266
-					$this->clearCached();
267
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
268
-
269
-					/** client/html/basket/standard/coupon/allowed
270
-					 * Number of coupon codes a customer is allowed to enter
271
-					 *
272
-					 * This configuration option enables shop owners to limit the number of coupon
273
-					 * codes that can be added by a customer to his current basket. By default, only
274
-					 * one coupon code is allowed per order.
275
-					 *
276
-					 * Coupon codes are valid until a payed order is placed by the customer. The
277
-					 * "count" of the codes is decreased afterwards. If codes are not personalized
278
-					 * the codes can be reused in the next order until their "count" reaches zero.
279
-					 *
280
-					 * @param integer Positive number of coupon codes including zero
281
-					 * @since 2014.05
282
-					 * @category User
283
-					 * @category Developer
284
-					 */
285
-					$allowed = $context->getConfig()->get( 'client/html/basket/standard/coupon/allowed', 1 );
286
-
287
-					if( $allowed <= count( $cntl->get()->getCoupons() ) ) {
288
-						throw new \Aimeos\Client\Html\Exception( sprintf( 'Number of coupon codes exceeds the limit' ) );
289
-					}
290
-
291
-					$cntl->addCoupon( $coupon );
292
-				}
293
-
294
-				break;
295
-		}
296
-
297
-		parent::process();
298
-	}
299
-
300
-
301
-	/**
302
-	 * Returns the list of sub-client names configured for the client.
303
-	 *
304
-	 * @return array List of HTML client names
305
-	 */
306
-	protected function getSubClientNames()
307
-	{
308
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
309
-	}
25
+    /** client/html/basket/standard/coupon/standard/subparts
26
+     * List of HTML sub-clients rendered within the basket standard coupon section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.03
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/basket/standard/coupon/standard/subparts';
59
+    private $subPartNames = array();
60
+
61
+
62
+    /**
63
+     * Returns the HTML code for insertion into the body.
64
+     *
65
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
+     * @param array &$tags Result array for the list of tags that are associated to the output
67
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
+     * @return string HTML code
69
+     */
70
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
+    {
72
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
73
+
74
+        $html = '';
75
+        foreach( $this->getSubClients() as $subclient ) {
76
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+        }
78
+        $view->couponBody = $html;
79
+
80
+        /** client/html/basket/standard/coupon/standard/template-body
81
+         * Relative path to the HTML body template of the basket standard coupon client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.03
97
+         * @category Developer
98
+         * @see client/html/basket/standard/coupon/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/basket/standard/coupon/standard/template-body';
101
+        $default = 'basket/standard/coupon-body-default.php';
102
+
103
+        return $view->render( $view->config( $tplconf, $default ) );
104
+    }
105
+
106
+
107
+    /**
108
+     * Returns the HTML string for insertion into the header.
109
+     *
110
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
+     * @param array &$tags Result array for the list of tags that are associated to the output
112
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
+     * @return string|null String including HTML tags for the header on error
114
+     */
115
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
+    {
117
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
118
+
119
+        $html = '';
120
+        foreach( $this->getSubClients() as $subclient ) {
121
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+        }
123
+        $view->couponHeader = $html;
124
+
125
+        /** client/html/basket/standard/coupon/standard/template-header
126
+         * Relative path to the HTML header template of the basket standard coupon client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.03
143
+         * @category Developer
144
+         * @see client/html/basket/standard/coupon/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/basket/standard/coupon/standard/template-header';
147
+        $default = 'basket/standard/coupon-header-default.php';
148
+
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151
+
152
+
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/basket/standard/coupon/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the basket standard coupon html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/basket/standard/coupon/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/basket/standard/coupon/decorators/global
185
+         * @see client/html/basket/standard/coupon/decorators/local
186
+         */
187
+
188
+        /** client/html/basket/standard/coupon/decorators/global
189
+         * Adds a list of globally available decorators only to the basket standard coupon html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/basket/standard/coupon/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/basket/standard/coupon/decorators/excludes
209
+         * @see client/html/basket/standard/coupon/decorators/local
210
+         */
211
+
212
+        /** client/html/basket/standard/coupon/decorators/local
213
+         * Adds a list of local decorators only to the basket standard coupon html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/basket/standard/coupon/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/basket/standard/coupon/decorators/excludes
233
+         * @see client/html/basket/standard/coupon/decorators/global
234
+         */
235
+        return $this->createSubClient( 'basket/standard/coupon/' . $type, $name );
236
+    }
237
+
238
+
239
+    /**
240
+     * Processes the input, e.g. store given values.
241
+     * A view must be available and this method doesn't generate any output
242
+     * besides setting view variables.
243
+     */
244
+    public function process()
245
+    {
246
+        $view = $this->getView();
247
+        $context = $this->getContext();
248
+
249
+        switch( $view->param( 'b_action' ) )
250
+        {
251
+            case 'coupon-delete':
252
+
253
+                if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
254
+                {
255
+                    $this->clearCached();
256
+                    $cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
257
+                    $cntl->deleteCoupon( $coupon );
258
+                }
259
+
260
+                break;
261
+
262
+            default:
263
+
264
+                if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
265
+                {
266
+                    $this->clearCached();
267
+                    $cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
268
+
269
+                    /** client/html/basket/standard/coupon/allowed
270
+                     * Number of coupon codes a customer is allowed to enter
271
+                     *
272
+                     * This configuration option enables shop owners to limit the number of coupon
273
+                     * codes that can be added by a customer to his current basket. By default, only
274
+                     * one coupon code is allowed per order.
275
+                     *
276
+                     * Coupon codes are valid until a payed order is placed by the customer. The
277
+                     * "count" of the codes is decreased afterwards. If codes are not personalized
278
+                     * the codes can be reused in the next order until their "count" reaches zero.
279
+                     *
280
+                     * @param integer Positive number of coupon codes including zero
281
+                     * @since 2014.05
282
+                     * @category User
283
+                     * @category Developer
284
+                     */
285
+                    $allowed = $context->getConfig()->get( 'client/html/basket/standard/coupon/allowed', 1 );
286
+
287
+                    if( $allowed <= count( $cntl->get()->getCoupons() ) ) {
288
+                        throw new \Aimeos\Client\Html\Exception( sprintf( 'Number of coupon codes exceeds the limit' ) );
289
+                    }
290
+
291
+                    $cntl->addCoupon( $coupon );
292
+                }
293
+
294
+                break;
295
+        }
296
+
297
+        parent::process();
298
+    }
299
+
300
+
301
+    /**
302
+     * Returns the list of sub-client names configured for the client.
303
+     *
304
+     * @return array List of HTML client names
305
+     */
306
+    protected function getSubClientNames()
307
+    {
308
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
309
+    }
310 310
 }
311 311
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -67,13 +67,13 @@  discard block
 block discarded – undo
67 67
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68 68
 	 * @return string HTML code
69 69
 	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
71 71
 	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
72
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
73 73
 
74 74
 		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
75
+		foreach ($this->getSubClients() as $subclient) {
76
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
77 77
 		}
78 78
 		$view->couponBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/basket/standard/coupon/standard/template-body';
101 101
 		$default = 'basket/standard/coupon-body-default.php';
102 102
 
103
-		return $view->render( $view->config( $tplconf, $default ) );
103
+		return $view->render($view->config($tplconf, $default));
104 104
 	}
105 105
 
106 106
 
@@ -112,13 +112,13 @@  discard block
 block discarded – undo
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113 113
 	 * @return string|null String including HTML tags for the header on error
114 114
 	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
115
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
116 116
 	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
117
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
118 118
 
119 119
 		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
120
+		foreach ($this->getSubClients() as $subclient) {
121
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
122 122
 		}
123 123
 		$view->couponHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/basket/standard/coupon/standard/template-header';
147 147
 		$default = 'basket/standard/coupon-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/basket/standard/coupon/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the basket standard coupon html client
@@ -232,7 +232,7 @@  discard block
 block discarded – undo
232 232
 		 * @see client/html/basket/standard/coupon/decorators/excludes
233 233
 		 * @see client/html/basket/standard/coupon/decorators/global
234 234
 		 */
235
-		return $this->createSubClient( 'basket/standard/coupon/' . $type, $name );
235
+		return $this->createSubClient('basket/standard/coupon/'.$type, $name);
236 236
 	}
237 237
 
238 238
 
@@ -246,25 +246,25 @@  discard block
 block discarded – undo
246 246
 		$view = $this->getView();
247 247
 		$context = $this->getContext();
248 248
 
249
-		switch( $view->param( 'b_action' ) )
249
+		switch ($view->param('b_action'))
250 250
 		{
251 251
 			case 'coupon-delete':
252 252
 
253
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
253
+				if (($coupon = $view->param('b_coupon')) != '')
254 254
 				{
255 255
 					$this->clearCached();
256
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
257
-					$cntl->deleteCoupon( $coupon );
256
+					$cntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
257
+					$cntl->deleteCoupon($coupon);
258 258
 				}
259 259
 
260 260
 				break;
261 261
 
262 262
 			default:
263 263
 
264
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
264
+				if (($coupon = $view->param('b_coupon')) != '')
265 265
 				{
266 266
 					$this->clearCached();
267
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
267
+					$cntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
268 268
 
269 269
 					/** client/html/basket/standard/coupon/allowed
270 270
 					 * Number of coupon codes a customer is allowed to enter
@@ -282,13 +282,13 @@  discard block
 block discarded – undo
282 282
 					 * @category User
283 283
 					 * @category Developer
284 284
 					 */
285
-					$allowed = $context->getConfig()->get( 'client/html/basket/standard/coupon/allowed', 1 );
285
+					$allowed = $context->getConfig()->get('client/html/basket/standard/coupon/allowed', 1);
286 286
 
287
-					if( $allowed <= count( $cntl->get()->getCoupons() ) ) {
288
-						throw new \Aimeos\Client\Html\Exception( sprintf( 'Number of coupon codes exceeds the limit' ) );
287
+					if ($allowed <= count($cntl->get()->getCoupons())) {
288
+						throw new \Aimeos\Client\Html\Exception(sprintf('Number of coupon codes exceeds the limit'));
289 289
 					}
290 290
 
291
-					$cntl->addCoupon( $coupon );
291
+					$cntl->addCoupon($coupon);
292 292
 				}
293 293
 
294 294
 				break;
@@ -305,6 +305,6 @@  discard block
 block discarded – undo
305 305
 	 */
306 306
 	protected function getSubClientNames()
307 307
 	{
308
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
308
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
309 309
 	}
310 310
 }
311 311
\ No newline at end of file
Please login to merge, or discard this patch.
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
110 110
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111 111
 	 * @param array &$tags Result array for the list of tags that are associated to the output
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
113
+	 * @return string String including HTML tags for the header on error
114 114
 	 */
115 115
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116 116
 	{
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Standard/Detail/Standard.php 3 patches
Indentation   +240 added lines, -240 removed lines patch added patch discarded remove patch
@@ -19,268 +19,268 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Summary\Detail\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Common\Summary\Detail\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/basket/standard/detail/standard/subparts
26
-	 * List of HTML sub-clients rendered within the basket standard detail section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2015.11
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/basket/standard/detail/standard/subparts';
59
-	private $subPartNames = array();
60
-	private $cache;
25
+    /** client/html/basket/standard/detail/standard/subparts
26
+     * List of HTML sub-clients rendered within the basket standard detail section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2015.11
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/basket/standard/detail/standard/subparts';
59
+    private $subPartNames = array();
60
+    private $cache;
61 61
 
62 62
 
63
-	/**
64
-	 * Returns the HTML code for insertion into the body.
65
-	 *
66
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
67
-	 * @param array &$tags Result array for the list of tags that are associated to the output
68
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69
-	 * @return string HTML code
70
-	 */
71
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
-	{
73
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
63
+    /**
64
+     * Returns the HTML code for insertion into the body.
65
+     *
66
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
67
+     * @param array &$tags Result array for the list of tags that are associated to the output
68
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69
+     * @return string HTML code
70
+     */
71
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
+    {
73
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
74 74
 
75
-		$html = '';
76
-		foreach( $this->getSubClients() as $subclient ) {
77
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
78
-		}
79
-		$view->detailBody = $html;
75
+        $html = '';
76
+        foreach( $this->getSubClients() as $subclient ) {
77
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
78
+        }
79
+        $view->detailBody = $html;
80 80
 
81
-		/** client/html/basket/standard/detail/standard/template-body
82
-		 * Relative path to the HTML body template of the basket standard detail client.
83
-		 *
84
-		 * The template file contains the HTML code and processing instructions
85
-		 * to generate the result shown in the body of the frontend. The
86
-		 * configuration string is the path to the template file relative
87
-		 * to the templates directory (usually in client/html/templates).
88
-		 *
89
-		 * You can overwrite the template file configuration in extensions and
90
-		 * provide alternative templates. These alternative templates should be
91
-		 * named like the default one but with the string "standard" replaced by
92
-		 * an unique name. You may use the name of your project for this. If
93
-		 * you've implemented an alternative client class as well, "standard"
94
-		 * (second one) should be replaced by the name of the new class in lower
95
-		 * case.
96
-		 *
97
-		 * @param string Relative path to the template creating code for the HTML page body
98
-		 * @since 2015.11
99
-		 * @category Developer
100
-		 * @see client/html/basket/standard/detail/standard/template-header
101
-		 */
102
-		$tplconf = 'client/html/basket/standard/detail/standard/template-body';
103
-		$default = 'common/summary/detail-body-default.php';
81
+        /** client/html/basket/standard/detail/standard/template-body
82
+         * Relative path to the HTML body template of the basket standard detail client.
83
+         *
84
+         * The template file contains the HTML code and processing instructions
85
+         * to generate the result shown in the body of the frontend. The
86
+         * configuration string is the path to the template file relative
87
+         * to the templates directory (usually in client/html/templates).
88
+         *
89
+         * You can overwrite the template file configuration in extensions and
90
+         * provide alternative templates. These alternative templates should be
91
+         * named like the default one but with the string "standard" replaced by
92
+         * an unique name. You may use the name of your project for this. If
93
+         * you've implemented an alternative client class as well, "standard"
94
+         * (second one) should be replaced by the name of the new class in lower
95
+         * case.
96
+         *
97
+         * @param string Relative path to the template creating code for the HTML page body
98
+         * @since 2015.11
99
+         * @category Developer
100
+         * @see client/html/basket/standard/detail/standard/template-header
101
+         */
102
+        $tplconf = 'client/html/basket/standard/detail/standard/template-body';
103
+        $default = 'common/summary/detail-body-default.php';
104 104
 
105
-		return $view->render( $view->config( $tplconf, $default ) );
106
-	}
105
+        return $view->render( $view->config( $tplconf, $default ) );
106
+    }
107 107
 
108 108
 
109
-	/**
110
-	 * Returns the HTML string for insertion into the header.
111
-	 *
112
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
113
-	 * @param array &$tags Result array for the list of tags that are associated to the output
114
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115
-	 * @return string|null String including HTML tags for the header on error
116
-	 */
117
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
118
-	{
119
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
109
+    /**
110
+     * Returns the HTML string for insertion into the header.
111
+     *
112
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
113
+     * @param array &$tags Result array for the list of tags that are associated to the output
114
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115
+     * @return string|null String including HTML tags for the header on error
116
+     */
117
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
118
+    {
119
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
120 120
 
121
-		$html = '';
122
-		foreach( $this->getSubClients() as $subclient ) {
123
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
124
-		}
125
-		$view->detailHeader = $html;
121
+        $html = '';
122
+        foreach( $this->getSubClients() as $subclient ) {
123
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
124
+        }
125
+        $view->detailHeader = $html;
126 126
 
127
-		/** client/html/basket/standard/detail/standard/template-header
128
-		 * Relative path to the HTML header template of the basket standard detail client.
129
-		 *
130
-		 * The template file contains the HTML code and processing instructions
131
-		 * to generate the HTML code that is inserted into the HTML page header
132
-		 * of the rendered page in the frontend. The configuration string is the
133
-		 * path to the template file relative to the templates directory (usually
134
-		 * in client/html/templates).
135
-		 *
136
-		 * You can overwrite the template file configuration in extensions and
137
-		 * provide alternative templates. These alternative templates should be
138
-		 * named like the default one but with the string "standard" replaced by
139
-		 * an unique name. You may use the name of your project for this. If
140
-		 * you've implemented an alternative client class as well, "standard"
141
-		 * (second one) should be replaced by the name of the new class in lower
142
-		 * case.
143
-		 *
144
-		 * @param string Relative path to the template creating code for the HTML page head
145
-		 * @since 2015.11
146
-		 * @category Developer
147
-		 * @see client/html/basket/standard/detail/standard/template-body
148
-		 */
149
-		$tplconf = 'client/html/basket/standard/detail/standard/template-header';
150
-		$default = 'common/summary/detail-header-default.php';
127
+        /** client/html/basket/standard/detail/standard/template-header
128
+         * Relative path to the HTML header template of the basket standard detail client.
129
+         *
130
+         * The template file contains the HTML code and processing instructions
131
+         * to generate the HTML code that is inserted into the HTML page header
132
+         * of the rendered page in the frontend. The configuration string is the
133
+         * path to the template file relative to the templates directory (usually
134
+         * in client/html/templates).
135
+         *
136
+         * You can overwrite the template file configuration in extensions and
137
+         * provide alternative templates. These alternative templates should be
138
+         * named like the default one but with the string "standard" replaced by
139
+         * an unique name. You may use the name of your project for this. If
140
+         * you've implemented an alternative client class as well, "standard"
141
+         * (second one) should be replaced by the name of the new class in lower
142
+         * case.
143
+         *
144
+         * @param string Relative path to the template creating code for the HTML page head
145
+         * @since 2015.11
146
+         * @category Developer
147
+         * @see client/html/basket/standard/detail/standard/template-body
148
+         */
149
+        $tplconf = 'client/html/basket/standard/detail/standard/template-header';
150
+        $default = 'common/summary/detail-header-default.php';
151 151
 
152
-		return $view->render( $view->config( $tplconf, $default ) );
153
-	}
152
+        return $view->render( $view->config( $tplconf, $default ) );
153
+    }
154 154
 
155 155
 
156
-	/**
157
-	 * Returns the sub-client given by its name.
158
-	 *
159
-	 * @param string $type Name of the client type
160
-	 * @param string|null $name Name of the sub-client (Default if null)
161
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
162
-	 */
163
-	public function getSubClient( $type, $name = null )
164
-	{
165
-		/** client/html/basket/standard/detail/decorators/excludes
166
-		 * Excludes decorators added by the "common" option from the basket standard detail html client
167
-		 *
168
-		 * Decorators extend the functionality of a class by adding new aspects
169
-		 * (e.g. log what is currently done), executing the methods of the underlying
170
-		 * class only in certain conditions (e.g. only for logged in users) or
171
-		 * modify what is returned to the caller.
172
-		 *
173
-		 * This option allows you to remove a decorator added via
174
-		 * "client/html/common/decorators/default" before they are wrapped
175
-		 * around the html client.
176
-		 *
177
-		 *  client/html/basket/standard/detail/decorators/excludes = array( 'decorator1' )
178
-		 *
179
-		 * This would remove the decorator named "decorator1" from the list of
180
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
181
-		 * "client/html/common/decorators/default" to the html client.
182
-		 *
183
-		 * @param array List of decorator names
184
-		 * @since 2015.08
185
-		 * @category Developer
186
-		 * @see client/html/common/decorators/default
187
-		 * @see client/html/basket/standard/detail/decorators/global
188
-		 * @see client/html/basket/standard/detail/decorators/local
189
-		 */
156
+    /**
157
+     * Returns the sub-client given by its name.
158
+     *
159
+     * @param string $type Name of the client type
160
+     * @param string|null $name Name of the sub-client (Default if null)
161
+     * @return \Aimeos\Client\Html\Iface Sub-client object
162
+     */
163
+    public function getSubClient( $type, $name = null )
164
+    {
165
+        /** client/html/basket/standard/detail/decorators/excludes
166
+         * Excludes decorators added by the "common" option from the basket standard detail html client
167
+         *
168
+         * Decorators extend the functionality of a class by adding new aspects
169
+         * (e.g. log what is currently done), executing the methods of the underlying
170
+         * class only in certain conditions (e.g. only for logged in users) or
171
+         * modify what is returned to the caller.
172
+         *
173
+         * This option allows you to remove a decorator added via
174
+         * "client/html/common/decorators/default" before they are wrapped
175
+         * around the html client.
176
+         *
177
+         *  client/html/basket/standard/detail/decorators/excludes = array( 'decorator1' )
178
+         *
179
+         * This would remove the decorator named "decorator1" from the list of
180
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
181
+         * "client/html/common/decorators/default" to the html client.
182
+         *
183
+         * @param array List of decorator names
184
+         * @since 2015.08
185
+         * @category Developer
186
+         * @see client/html/common/decorators/default
187
+         * @see client/html/basket/standard/detail/decorators/global
188
+         * @see client/html/basket/standard/detail/decorators/local
189
+         */
190 190
 
191
-		/** client/html/basket/standard/detail/decorators/global
192
-		 * Adds a list of globally available decorators only to the basket standard detail html client
193
-		 *
194
-		 * Decorators extend the functionality of a class by adding new aspects
195
-		 * (e.g. log what is currently done), executing the methods of the underlying
196
-		 * class only in certain conditions (e.g. only for logged in users) or
197
-		 * modify what is returned to the caller.
198
-		 *
199
-		 * This option allows you to wrap global decorators
200
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
201
-		 *
202
-		 *  client/html/basket/standard/detail/decorators/global = array( 'decorator1' )
203
-		 *
204
-		 * This would add the decorator named "decorator1" defined by
205
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
206
-		 *
207
-		 * @param array List of decorator names
208
-		 * @since 2015.08
209
-		 * @category Developer
210
-		 * @see client/html/common/decorators/default
211
-		 * @see client/html/basket/standard/detail/decorators/excludes
212
-		 * @see client/html/basket/standard/detail/decorators/local
213
-		 */
191
+        /** client/html/basket/standard/detail/decorators/global
192
+         * Adds a list of globally available decorators only to the basket standard detail html client
193
+         *
194
+         * Decorators extend the functionality of a class by adding new aspects
195
+         * (e.g. log what is currently done), executing the methods of the underlying
196
+         * class only in certain conditions (e.g. only for logged in users) or
197
+         * modify what is returned to the caller.
198
+         *
199
+         * This option allows you to wrap global decorators
200
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
201
+         *
202
+         *  client/html/basket/standard/detail/decorators/global = array( 'decorator1' )
203
+         *
204
+         * This would add the decorator named "decorator1" defined by
205
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
206
+         *
207
+         * @param array List of decorator names
208
+         * @since 2015.08
209
+         * @category Developer
210
+         * @see client/html/common/decorators/default
211
+         * @see client/html/basket/standard/detail/decorators/excludes
212
+         * @see client/html/basket/standard/detail/decorators/local
213
+         */
214 214
 
215
-		/** client/html/basket/standard/detail/decorators/local
216
-		 * Adds a list of local decorators only to the basket standard detail html client
217
-		 *
218
-		 * Decorators extend the functionality of a class by adding new aspects
219
-		 * (e.g. log what is currently done), executing the methods of the underlying
220
-		 * class only in certain conditions (e.g. only for logged in users) or
221
-		 * modify what is returned to the caller.
222
-		 *
223
-		 * This option allows you to wrap local decorators
224
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
225
-		 *
226
-		 *  client/html/basket/standard/detail/decorators/local = array( 'decorator2' )
227
-		 *
228
-		 * This would add the decorator named "decorator2" defined by
229
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
230
-		 *
231
-		 * @param array List of decorator names
232
-		 * @since 2015.08
233
-		 * @category Developer
234
-		 * @see client/html/common/decorators/default
235
-		 * @see client/html/basket/standard/detail/decorators/excludes
236
-		 * @see client/html/basket/standard/detail/decorators/global
237
-		 */
238
-		return $this->createSubClient( 'basket/standard/detail/' . $type, $name );
239
-	}
215
+        /** client/html/basket/standard/detail/decorators/local
216
+         * Adds a list of local decorators only to the basket standard detail html client
217
+         *
218
+         * Decorators extend the functionality of a class by adding new aspects
219
+         * (e.g. log what is currently done), executing the methods of the underlying
220
+         * class only in certain conditions (e.g. only for logged in users) or
221
+         * modify what is returned to the caller.
222
+         *
223
+         * This option allows you to wrap local decorators
224
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
225
+         *
226
+         *  client/html/basket/standard/detail/decorators/local = array( 'decorator2' )
227
+         *
228
+         * This would add the decorator named "decorator2" defined by
229
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
230
+         *
231
+         * @param array List of decorator names
232
+         * @since 2015.08
233
+         * @category Developer
234
+         * @see client/html/common/decorators/default
235
+         * @see client/html/basket/standard/detail/decorators/excludes
236
+         * @see client/html/basket/standard/detail/decorators/global
237
+         */
238
+        return $this->createSubClient( 'basket/standard/detail/' . $type, $name );
239
+    }
240 240
 
241 241
 
242
-	/**
243
-	 * Returns the list of sub-client names configured for the client.
244
-	 *
245
-	 * @return array List of HTML client names
246
-	 */
247
-	protected function getSubClientNames()
248
-	{
249
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
250
-	}
242
+    /**
243
+     * Returns the list of sub-client names configured for the client.
244
+     *
245
+     * @return array List of HTML client names
246
+     */
247
+    protected function getSubClientNames()
248
+    {
249
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
250
+    }
251 251
 
252 252
 
253
-	/**
254
-	 * Sets the necessary parameter values in the view.
255
-	 *
256
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
257
-	 * @param array &$tags Result array for the list of tags that are associated to the output
258
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259
-	 * @return \Aimeos\MW\View\Iface Modified view object
260
-	 */
261
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
262
-	{
263
-		$view = parent::setViewParams( $view );
253
+    /**
254
+     * Sets the necessary parameter values in the view.
255
+     *
256
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
257
+     * @param array &$tags Result array for the list of tags that are associated to the output
258
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259
+     * @return \Aimeos\MW\View\Iface Modified view object
260
+     */
261
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
262
+    {
263
+        $view = parent::setViewParams( $view );
264 264
 
265
-		if( !isset( $this->cache ) )
266
-		{
267
-			$basket = $view->standardBasket;
265
+        if( !isset( $this->cache ) )
266
+        {
267
+            $basket = $view->standardBasket;
268 268
 
269
-			$target = $view->config( 'client/html/checkout/standard/url/target' );
270
-			$cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
271
-			$action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
272
-			$config = $view->config( 'client/html/checkout/standard/url/config', array() );
269
+            $target = $view->config( 'client/html/checkout/standard/url/target' );
270
+            $cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
271
+            $action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
272
+            $config = $view->config( 'client/html/checkout/standard/url/config', array() );
273 273
 
274
-			$view->summaryParams = $view->get( 'standardParams', array() );
275
-			$view->summaryUrlServicePayment = $view->url( $target, $cntl, $action, array( 'c_step' => 'payment' ), array(), $config );
276
-			$view->summaryUrlServiceDelivery = $view->url( $target, $cntl, $action, array( 'c_step' => 'delivery' ), array(), $config );
277
-			$view->summaryTaxRates = $this->getTaxRates( $basket );
278
-			$view->summaryEnableModify = true;
279
-			$view->summaryBasket = $basket;
274
+            $view->summaryParams = $view->get( 'standardParams', array() );
275
+            $view->summaryUrlServicePayment = $view->url( $target, $cntl, $action, array( 'c_step' => 'payment' ), array(), $config );
276
+            $view->summaryUrlServiceDelivery = $view->url( $target, $cntl, $action, array( 'c_step' => 'delivery' ), array(), $config );
277
+            $view->summaryTaxRates = $this->getTaxRates( $basket );
278
+            $view->summaryEnableModify = true;
279
+            $view->summaryBasket = $basket;
280 280
 
281
-			$this->cache = $view;
282
-		}
281
+            $this->cache = $view;
282
+        }
283 283
 
284
-		return $this->cache;
285
-	}
284
+        return $this->cache;
285
+    }
286 286
 }
287 287
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +24 added lines, -24 removed lines patch added patch discarded remove patch
@@ -68,13 +68,13 @@  discard block
 block discarded – undo
68 68
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69 69
 	 * @return string HTML code
70 70
 	 */
71
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
72 72
 	{
73
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
73
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
74 74
 
75 75
 		$html = '';
76
-		foreach( $this->getSubClients() as $subclient ) {
77
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
76
+		foreach ($this->getSubClients() as $subclient) {
77
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
78 78
 		}
79 79
 		$view->detailBody = $html;
80 80
 
@@ -102,7 +102,7 @@  discard block
 block discarded – undo
102 102
 		$tplconf = 'client/html/basket/standard/detail/standard/template-body';
103 103
 		$default = 'common/summary/detail-body-default.php';
104 104
 
105
-		return $view->render( $view->config( $tplconf, $default ) );
105
+		return $view->render($view->config($tplconf, $default));
106 106
 	}
107 107
 
108 108
 
@@ -114,13 +114,13 @@  discard block
 block discarded – undo
114 114
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115 115
 	 * @return string|null String including HTML tags for the header on error
116 116
 	 */
117
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
118 118
 	{
119
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
119
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
120 120
 
121 121
 		$html = '';
122
-		foreach( $this->getSubClients() as $subclient ) {
123
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+		foreach ($this->getSubClients() as $subclient) {
123
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
124 124
 		}
125 125
 		$view->detailHeader = $html;
126 126
 
@@ -149,7 +149,7 @@  discard block
 block discarded – undo
149 149
 		$tplconf = 'client/html/basket/standard/detail/standard/template-header';
150 150
 		$default = 'common/summary/detail-header-default.php';
151 151
 
152
-		return $view->render( $view->config( $tplconf, $default ) );
152
+		return $view->render($view->config($tplconf, $default));
153 153
 	}
154 154
 
155 155
 
@@ -160,7 +160,7 @@  discard block
 block discarded – undo
160 160
 	 * @param string|null $name Name of the sub-client (Default if null)
161 161
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
162 162
 	 */
163
-	public function getSubClient( $type, $name = null )
163
+	public function getSubClient($type, $name = null)
164 164
 	{
165 165
 		/** client/html/basket/standard/detail/decorators/excludes
166 166
 		 * Excludes decorators added by the "common" option from the basket standard detail html client
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
 		 * @see client/html/basket/standard/detail/decorators/excludes
236 236
 		 * @see client/html/basket/standard/detail/decorators/global
237 237
 		 */
238
-		return $this->createSubClient( 'basket/standard/detail/' . $type, $name );
238
+		return $this->createSubClient('basket/standard/detail/'.$type, $name);
239 239
 	}
240 240
 
241 241
 
@@ -246,7 +246,7 @@  discard block
 block discarded – undo
246 246
 	 */
247 247
 	protected function getSubClientNames()
248 248
 	{
249
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
250 250
 	}
251 251
 
252 252
 
@@ -258,23 +258,23 @@  discard block
 block discarded – undo
258 258
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259 259
 	 * @return \Aimeos\MW\View\Iface Modified view object
260 260
 	 */
261
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
261
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
262 262
 	{
263
-		$view = parent::setViewParams( $view );
263
+		$view = parent::setViewParams($view);
264 264
 
265
-		if( !isset( $this->cache ) )
265
+		if (!isset($this->cache))
266 266
 		{
267 267
 			$basket = $view->standardBasket;
268 268
 
269
-			$target = $view->config( 'client/html/checkout/standard/url/target' );
270
-			$cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
271
-			$action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
272
-			$config = $view->config( 'client/html/checkout/standard/url/config', array() );
269
+			$target = $view->config('client/html/checkout/standard/url/target');
270
+			$cntl = $view->config('client/html/checkout/standard/url/controller', 'checkout');
271
+			$action = $view->config('client/html/checkout/standard/url/action', 'index');
272
+			$config = $view->config('client/html/checkout/standard/url/config', array());
273 273
 
274
-			$view->summaryParams = $view->get( 'standardParams', array() );
275
-			$view->summaryUrlServicePayment = $view->url( $target, $cntl, $action, array( 'c_step' => 'payment' ), array(), $config );
276
-			$view->summaryUrlServiceDelivery = $view->url( $target, $cntl, $action, array( 'c_step' => 'delivery' ), array(), $config );
277
-			$view->summaryTaxRates = $this->getTaxRates( $basket );
274
+			$view->summaryParams = $view->get('standardParams', array());
275
+			$view->summaryUrlServicePayment = $view->url($target, $cntl, $action, array('c_step' => 'payment'), array(), $config);
276
+			$view->summaryUrlServiceDelivery = $view->url($target, $cntl, $action, array('c_step' => 'delivery'), array(), $config);
277
+			$view->summaryTaxRates = $this->getTaxRates($basket);
278 278
 			$view->summaryEnableModify = true;
279 279
 			$view->summaryBasket = $basket;
280 280
 
Please login to merge, or discard this patch.
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
110 110
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111 111
 	 * @param array &$tags Result array for the list of tags that are associated to the output
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
113
+	 * @return string String including HTML tags for the header on error
114 114
 	 */
115 115
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116 116
 	{
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Standard/Factory.php 2 patches
Indentation   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -19,69 +19,69 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Factory
22
-	extends \Aimeos\Client\Html\Common\Factory\Base
23
-	implements \Aimeos\Client\Html\Common\Factory\Iface
22
+    extends \Aimeos\Client\Html\Common\Factory\Base
23
+    implements \Aimeos\Client\Html\Common\Factory\Iface
24 24
 {
25
-	/**
26
-	 * Creates a standard basket client object.
27
-	 *
28
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
29
-	 * @param array $templatePaths List of file system paths where the templates are stored
30
-	 * @param string|null $name Client name (default: "Standard")
31
-	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
32
-	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
33
-	 */
34
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
35
-	{
36
-		/** client/html/basket/standard/name
37
-		 * Class name of the used basket standard client implementation
38
-		 *
39
-		 * Each default HTML client can be replace by an alternative imlementation.
40
-		 * To use this implementation, you have to set the last part of the class
41
-		 * name as configuration value so the client factory knows which class it
42
-		 * has to instantiate.
43
-		 *
44
-		 * For example, if the name of the default class is
45
-		 *
46
-		 *  \Aimeos\Client\Html\Basket\Standard\Standard
47
-		 *
48
-		 * and you want to replace it with your own version named
49
-		 *
50
-		 *  \Aimeos\Client\Html\Basket\Standard\Mybasket
51
-		 *
52
-		 * then you have to set the this configuration option:
53
-		 *
54
-		 *  client/html/basket/standard/name = Mybasket
55
-		 *
56
-		 * The value is the last part of your own class name and it's case sensitive,
57
-		 * so take care that the configuration value is exactly named like the last
58
-		 * part of the class name.
59
-		 *
60
-		 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
61
-		 * characters are possible! You should always start the last part of the class
62
-		 * name with an upper case character and continue only with lower case characters
63
-		 * or numbers. Avoid chamel case names like "MyBasket"!
64
-		 *
65
-		 * @param string Last part of the class name
66
-		 * @since 2014.03
67
-		 * @category Developer
68
-		 */
69
-		if( $name === null ) {
70
-			$name = $context->getConfig()->get( 'client/html/basket/standard/name', 'Standard' );
71
-		}
25
+    /**
26
+     * Creates a standard basket client object.
27
+     *
28
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
29
+     * @param array $templatePaths List of file system paths where the templates are stored
30
+     * @param string|null $name Client name (default: "Standard")
31
+     * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
32
+     * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
33
+     */
34
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
35
+    {
36
+        /** client/html/basket/standard/name
37
+         * Class name of the used basket standard client implementation
38
+         *
39
+         * Each default HTML client can be replace by an alternative imlementation.
40
+         * To use this implementation, you have to set the last part of the class
41
+         * name as configuration value so the client factory knows which class it
42
+         * has to instantiate.
43
+         *
44
+         * For example, if the name of the default class is
45
+         *
46
+         *  \Aimeos\Client\Html\Basket\Standard\Standard
47
+         *
48
+         * and you want to replace it with your own version named
49
+         *
50
+         *  \Aimeos\Client\Html\Basket\Standard\Mybasket
51
+         *
52
+         * then you have to set the this configuration option:
53
+         *
54
+         *  client/html/basket/standard/name = Mybasket
55
+         *
56
+         * The value is the last part of your own class name and it's case sensitive,
57
+         * so take care that the configuration value is exactly named like the last
58
+         * part of the class name.
59
+         *
60
+         * The allowed characters of the class name are A-Z, a-z and 0-9. No other
61
+         * characters are possible! You should always start the last part of the class
62
+         * name with an upper case character and continue only with lower case characters
63
+         * or numbers. Avoid chamel case names like "MyBasket"!
64
+         *
65
+         * @param string Last part of the class name
66
+         * @since 2014.03
67
+         * @category Developer
68
+         */
69
+        if( $name === null ) {
70
+            $name = $context->getConfig()->get( 'client/html/basket/standard/name', 'Standard' );
71
+        }
72 72
 
73
-		if( ctype_alnum( $name ) === false )
74
-		{
75
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name : '<not a string>';
76
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
77
-		}
73
+        if( ctype_alnum( $name ) === false )
74
+        {
75
+            $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name : '<not a string>';
76
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
77
+        }
78 78
 
79
-		$iface = '\\Aimeos\\Client\\Html\\Iface';
80
-		$classname = '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name;
79
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
80
+        $classname = '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name;
81 81
 
82
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
82
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
83 83
 
84
-		return self::addClientDecorators( $context, $client, $templatePaths, 'basket/standard' );
85
-	}
84
+        return self::addClientDecorators( $context, $client, $templatePaths, 'basket/standard' );
85
+    }
86 86
 }
87 87
 
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -31,7 +31,7 @@  discard block
 block discarded – undo
31 31
 	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
32 32
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
33 33
 	 */
34
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
34
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null)
35 35
 	{
36 36
 		/** client/html/basket/standard/name
37 37
 		 * Class name of the used basket standard client implementation
@@ -66,22 +66,22 @@  discard block
 block discarded – undo
66 66
 		 * @since 2014.03
67 67
 		 * @category Developer
68 68
 		 */
69
-		if( $name === null ) {
70
-			$name = $context->getConfig()->get( 'client/html/basket/standard/name', 'Standard' );
69
+		if ($name === null) {
70
+			$name = $context->getConfig()->get('client/html/basket/standard/name', 'Standard');
71 71
 		}
72 72
 
73
-		if( ctype_alnum( $name ) === false )
73
+		if (ctype_alnum($name) === false)
74 74
 		{
75
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name : '<not a string>';
76
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
75
+			$classname = is_string($name) ? '\\Aimeos\\Client\\Html\\Basket\\Standard\\'.$name : '<not a string>';
76
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in class name "%1$s"', $classname));
77 77
 		}
78 78
 
79 79
 		$iface = '\\Aimeos\\Client\\Html\\Iface';
80
-		$classname = '\\Aimeos\\Client\\Html\\Basket\\Standard\\' . $name;
80
+		$classname = '\\Aimeos\\Client\\Html\\Basket\\Standard\\'.$name;
81 81
 
82
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
82
+		$client = self::createClientBase($context, $classname, $iface, $templatePaths);
83 83
 
84
-		return self::addClientDecorators( $context, $client, $templatePaths, 'basket/standard' );
84
+		return self::addClientDecorators($context, $client, $templatePaths, 'basket/standard');
85 85
 	}
86 86
 }
87 87
 
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Standard/Standard.php 4 patches
Braces   +11 added lines, -22 removed lines patch added patch discarded remove patch
@@ -104,23 +104,19 @@  discard block
 block discarded – undo
104 104
 				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
105 105
 			}
106 106
 			$view->standardBody = $html;
107
-		}
108
-		catch( \Aimeos\Client\Html\Exception $e )
107
+		} catch( \Aimeos\Client\Html\Exception $e )
109 108
 		{
110 109
 			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111 110
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
112
-		}
113
-		catch( \Aimeos\Controller\Frontend\Exception $e )
111
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
114 112
 		{
115 113
 			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116 114
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
117
-		}
118
-		catch( \Aimeos\MShop\Exception $e )
115
+		} catch( \Aimeos\MShop\Exception $e )
119 116
 		{
120 117
 			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121 118
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
122
-		}
123
-		catch( \Exception $e )
119
+		} catch( \Exception $e )
124 120
 		{
125 121
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
126 122
 
@@ -174,8 +170,7 @@  discard block
 block discarded – undo
174 170
 				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
175 171
 			}
176 172
 			$view->standardHeader = $html;
177
-		}
178
-		catch( \Exception $e )
173
+		} catch( \Exception $e )
179 174
 		{
180 175
 			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
181 176
 			return '';
@@ -357,31 +352,26 @@  discard block
 block discarded – undo
357 352
 
358 353
 			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
359 354
 			$controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_PRODUCT );
360
-		}
361
-		catch( \Aimeos\Client\Html\Exception $e )
355
+		} catch( \Aimeos\Client\Html\Exception $e )
362 356
 		{
363 357
 			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
364 358
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
365
-		}
366
-		catch( \Aimeos\Controller\Frontend\Exception $e )
359
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
367 360
 		{
368 361
 			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
369 362
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
370
-		}
371
-		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
363
+		} catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
372 364
 		{
373 365
 			$errors = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
374 366
 			$errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
375 367
 
376 368
 			$view->summaryErrorCodes = $e->getErrorCodes();
377 369
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
378
-		}
379
-		catch( \Aimeos\MShop\Exception $e )
370
+		} catch( \Aimeos\MShop\Exception $e )
380 371
 		{
381 372
 			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
382 373
 			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
383
-		}
384
-		catch( \Exception $e )
374
+		} catch( \Exception $e )
385 375
 		{
386 376
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
387 377
 
@@ -423,8 +413,7 @@  discard block
 block discarded – undo
423 413
 				$controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
424 414
 				$action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
425 415
 				$config = $view->config( 'client/html/catalog/detail/url/config', array() );
426
-			}
427
-			else
416
+			} else
428 417
 			{
429 418
 				$params = $context->getSession()->get( 'aimeos/catalog/lists/params/last' . $site, array() );
430 419
 
Please login to merge, or discard this patch.
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
110 110
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111 111
 	 * @param array &$tags Result array for the list of tags that are associated to the output
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
113
+	 * @return string String including HTML tags for the header on error
114 114
 	 */
115 115
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116 116
 	{
Please login to merge, or discard this patch.
Indentation   +531 added lines, -531 removed lines patch added patch discarded remove patch
@@ -19,536 +19,536 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Basket\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Basket\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/basket/standard/standard/subparts
26
-	 * List of HTML sub-clients rendered within the basket standard section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.03
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/basket/standard/standard/subparts';
59
-
60
-	/** client/html/basket/standard/detail/name
61
-	 * Name of the detail part used by the basket standard detail client implementation
62
-	 *
63
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Standard\Detail\Myname".
64
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
65
-	 *
66
-	 * @param string Last part of the client class name
67
-	 * @since 2014.03
68
-	 * @category Developer
69
-	 */
70
-
71
-	/** client/html/basket/standard/coupon/name
72
-	 * Name of the detail part used by the basket standard coupon client implementation
73
-	 *
74
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Standard\Detail\Myname".
75
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
76
-	 *
77
-	 * @param string Last part of the client class name
78
-	 * @since 2014.03
79
-	 * @category Developer
80
-	 */
81
-	private $subPartNames = array( 'detail', 'coupon' );
82
-	private $cache;
83
-
84
-
85
-	/**
86
-	 * Returns the HTML code for insertion into the body.
87
-	 *
88
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
89
-	 * @param array &$tags Result array for the list of tags that are associated to the output
90
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91
-	 * @return string HTML code
92
-	 */
93
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
94
-	{
95
-		$context = $this->getContext();
96
-		$view = $this->getView();
97
-
98
-		try
99
-		{
100
-			$view = $this->setViewParams( $view, $tags, $expire );
101
-
102
-			$html = '';
103
-			foreach( $this->getSubClients() as $subclient ) {
104
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
105
-			}
106
-			$view->standardBody = $html;
107
-		}
108
-		catch( \Aimeos\Client\Html\Exception $e )
109
-		{
110
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
112
-		}
113
-		catch( \Aimeos\Controller\Frontend\Exception $e )
114
-		{
115
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
117
-		}
118
-		catch( \Aimeos\MShop\Exception $e )
119
-		{
120
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
122
-		}
123
-		catch( \Exception $e )
124
-		{
125
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
126
-
127
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
129
-		}
130
-
131
-		/** client/html/basket/standard/standard/template-body
132
-		 * Relative path to the HTML body template of the basket standard client.
133
-		 *
134
-		 * The template file contains the HTML code and processing instructions
135
-		 * to generate the result shown in the body of the frontend. The
136
-		 * configuration string is the path to the template file relative
137
-		 * to the templates directory (usually in client/html/templates).
138
-		 *
139
-		 * You can overwrite the template file configuration in extensions and
140
-		 * provide alternative templates. These alternative templates should be
141
-		 * named like the default one but with the string "standard" replaced by
142
-		 * an unique name. You may use the name of your project for this. If
143
-		 * you've implemented an alternative client class as well, "standard"
144
-		 * should be replaced by the name of the new class.
145
-		 *
146
-		 * @param string Relative path to the template creating code for the HTML page body
147
-		 * @since 2014.03
148
-		 * @category Developer
149
-		 * @see client/html/basket/standard/standard/template-header
150
-		 */
151
-		$tplconf = 'client/html/basket/standard/standard/template-body';
152
-		$default = 'basket/standard/body-default.php';
153
-
154
-		return $view->render( $view->config( $tplconf, $default ) );
155
-	}
156
-
157
-
158
-	/**
159
-	 * Returns the HTML string for insertion into the header.
160
-	 *
161
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
162
-	 * @param array &$tags Result array for the list of tags that are associated to the output
163
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164
-	 * @return string|null String including HTML tags for the header on error
165
-	 */
166
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
167
-	{
168
-		try
169
-		{
170
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
171
-
172
-			$html = '';
173
-			foreach( $this->getSubClients() as $subclient ) {
174
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
175
-			}
176
-			$view->standardHeader = $html;
177
-		}
178
-		catch( \Exception $e )
179
-		{
180
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
181
-			return '';
182
-		}
183
-
184
-		/** client/html/basket/standard/standard/template-header
185
-		 * Relative path to the HTML header template of the basket standard client.
186
-		 *
187
-		 * The template file contains the HTML code and processing instructions
188
-		 * to generate the HTML code that is inserted into the HTML page header
189
-		 * of the rendered page in the frontend. The configuration string is the
190
-		 * path to the template file relative to the templates directory (usually
191
-		 * in client/html/templates).
192
-		 *
193
-		 * You can overwrite the template file configuration in extensions and
194
-		 * provide alternative templates. These alternative templates should be
195
-		 * named like the default one but with the string "standard" replaced by
196
-		 * an unique name. You may use the name of your project for this. If
197
-		 * you've implemented an alternative client class as well, "standard"
198
-		 * should be replaced by the name of the new class.
199
-		 *
200
-		 * @param string Relative path to the template creating code for the HTML page head
201
-		 * @since 2014.03
202
-		 * @category Developer
203
-		 * @see client/html/basket/standard/standard/template-body
204
-		 */
205
-		$tplconf = 'client/html/basket/standard/standard/template-header';
206
-		$default = 'basket/standard/header-default.php';
207
-
208
-		return $view->render( $view->config( $tplconf, $default ) );
209
-	}
210
-
211
-
212
-	/**
213
-	 * Returns the sub-client given by its name.
214
-	 *
215
-	 * @param string $type Name of the client type
216
-	 * @param string|null $name Name of the sub-client (Default if null)
217
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
218
-	 */
219
-	public function getSubClient( $type, $name = null )
220
-	{
221
-		/** client/html/basket/standard/decorators/excludes
222
-		 * Excludes decorators added by the "common" option from the basket standard html client
223
-		 *
224
-		 * Decorators extend the functionality of a class by adding new aspects
225
-		 * (e.g. log what is currently done), executing the methods of the underlying
226
-		 * class only in certain conditions (e.g. only for logged in users) or
227
-		 * modify what is returned to the caller.
228
-		 *
229
-		 * This option allows you to remove a decorator added via
230
-		 * "client/html/common/decorators/default" before they are wrapped
231
-		 * around the html client.
232
-		 *
233
-		 *  client/html/basket/standard/decorators/excludes = array( 'decorator1' )
234
-		 *
235
-		 * This would remove the decorator named "decorator1" from the list of
236
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
237
-		 * "client/html/common/decorators/default" to the html client.
238
-		 *
239
-		 * @param array List of decorator names
240
-		 * @since 2014.05
241
-		 * @category Developer
242
-		 * @see client/html/common/decorators/default
243
-		 * @see client/html/basket/standard/decorators/global
244
-		 * @see client/html/basket/standard/decorators/local
245
-		 */
246
-
247
-		/** client/html/basket/standard/decorators/global
248
-		 * Adds a list of globally available decorators only to the basket standard html client
249
-		 *
250
-		 * Decorators extend the functionality of a class by adding new aspects
251
-		 * (e.g. log what is currently done), executing the methods of the underlying
252
-		 * class only in certain conditions (e.g. only for logged in users) or
253
-		 * modify what is returned to the caller.
254
-		 *
255
-		 * This option allows you to wrap global decorators
256
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
257
-		 *
258
-		 *  client/html/basket/standard/decorators/global = array( 'decorator1' )
259
-		 *
260
-		 * This would add the decorator named "decorator1" defined by
261
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
262
-		 *
263
-		 * @param array List of decorator names
264
-		 * @since 2014.05
265
-		 * @category Developer
266
-		 * @see client/html/common/decorators/default
267
-		 * @see client/html/basket/standard/decorators/excludes
268
-		 * @see client/html/basket/standard/decorators/local
269
-		 */
270
-
271
-		/** client/html/basket/standard/decorators/local
272
-		 * Adds a list of local decorators only to the basket standard html client
273
-		 *
274
-		 * Decorators extend the functionality of a class by adding new aspects
275
-		 * (e.g. log what is currently done), executing the methods of the underlying
276
-		 * class only in certain conditions (e.g. only for logged in users) or
277
-		 * modify what is returned to the caller.
278
-		 *
279
-		 * This option allows you to wrap local decorators
280
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
281
-		 *
282
-		 *  client/html/basket/standard/decorators/local = array( 'decorator2' )
283
-		 *
284
-		 * This would add the decorator named "decorator2" defined by
285
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
286
-		 *
287
-		 * @param array List of decorator names
288
-		 * @since 2014.05
289
-		 * @category Developer
290
-		 * @see client/html/common/decorators/default
291
-		 * @see client/html/basket/standard/decorators/excludes
292
-		 * @see client/html/basket/standard/decorators/global
293
-		 */
294
-
295
-		return $this->createSubClient( 'basket/standard/' . $type, $name );
296
-	}
297
-
298
-
299
-	/**
300
-	 * Sets the necessary parameter values in the view.
301
-	 */
302
-	public function process()
303
-	{
304
-		$view = $this->getView();
305
-		$context = $this->getContext();
306
-
307
-		try
308
-		{
309
-			$options = array(
310
-
311
-				/** client/html/basket/require-stock
312
-				 * Customers can order products only if there are enough products in stock
313
-				 *
314
-				 * Checks that the requested product quantity is in stock before
315
-				 * the customer can add them to his basket and order them. If there
316
-				 * are not enough products available, the customer will get a notice.
317
-				 *
318
-				 * @param boolean True if products must be in stock, false if products can be sold without stock
319
-				 * @since 2014.03
320
-				 * @category Developer
321
-				 * @category User
322
-				 */
323
-				'stock' => $view->config( 'client/html/basket/require-stock', true ),
324
-
325
-				/** client/html/basket/require-variant
326
-				 * A variant of a selection product must be chosen
327
-				 *
328
-				 * Selection products normally consist of several article variants and by default
329
-				 * exactly one article variant of a selection product can be put into the basket.
330
-				 *
331
-				 * By setting this option to false, the selection product including the chosen
332
-				 * attributes (if any attribute values were selected) can be put into the basket
333
-				 * as well. This makes it possible to get all articles or a subset of articles
334
-				 * (e.g. all of a color) at once.
335
-				 *
336
-				 * @param boolean True if a variant must be chosen, false if also the selection product with attributes can be added
337
-				 * @since 2014.03
338
-				 * @category Developer
339
-				 * @category User
340
-				 */
341
-				'variant' => $view->config( 'client/html/basket/require-variant', true ),
342
-			);
343
-
344
-			switch( $view->param( 'b_action' ) )
345
-			{
346
-				case 'add':
347
-					$this->addProducts( $view, $options );
348
-					break;
349
-				case 'delete':
350
-					$this->deleteProducts( $view );
351
-					break;
352
-				default:
353
-					$this->editProducts( $view, $options );
354
-			}
355
-
356
-			parent::process();
357
-
358
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
359
-			$controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_PRODUCT );
360
-		}
361
-		catch( \Aimeos\Client\Html\Exception $e )
362
-		{
363
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
364
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
365
-		}
366
-		catch( \Aimeos\Controller\Frontend\Exception $e )
367
-		{
368
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
369
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
370
-		}
371
-		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
372
-		{
373
-			$errors = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
374
-			$errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
375
-
376
-			$view->summaryErrorCodes = $e->getErrorCodes();
377
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
378
-		}
379
-		catch( \Aimeos\MShop\Exception $e )
380
-		{
381
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
382
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
383
-		}
384
-		catch( \Exception $e )
385
-		{
386
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
387
-
388
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
389
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
390
-		}
391
-	}
392
-
393
-
394
-	/**
395
-	 * Returns the list of sub-client names configured for the client.
396
-	 *
397
-	 * @return array List of HTML client names
398
-	 */
399
-	protected function getSubClientNames()
400
-	{
401
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
402
-	}
403
-
404
-
405
-	/**
406
-	 * Sets the necessary parameter values in the view.
407
-	 *
408
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
409
-	 * @param array &$tags Result array for the list of tags that are associated to the output
410
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
411
-	 * @return \Aimeos\MW\View\Iface Modified view object
412
-	 */
413
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
414
-	{
415
-		if( !isset( $this->cache ) )
416
-		{
417
-			$context = $this->getContext();
418
-			$site = $context->getLocale()->getSite()->getCode();
419
-
420
-			if( ( $params = $context->getSession()->get( 'aimeos/catalog/detail/params/last' . $site ) ) !== null )
421
-			{
422
-				$target = $view->config( 'client/html/catalog/detail/url/target' );
423
-				$controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
424
-				$action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
425
-				$config = $view->config( 'client/html/catalog/detail/url/config', array() );
426
-			}
427
-			else
428
-			{
429
-				$params = $context->getSession()->get( 'aimeos/catalog/lists/params/last' . $site, array() );
430
-
431
-				$target = $view->config( 'client/html/catalog/lists/url/target' );
432
-				$controller = $view->config( 'client/html/catalog/lists/url/controller', 'catalog' );
433
-				$action = $view->config( 'client/html/catalog/lists/url/action', 'list' );
434
-				$config = $view->config( 'client/html/catalog/lists/url/config', array() );
435
-
436
-			}
437
-
438
-			if( empty( $params ) === false )
439
-			{
440
-				$view->standardParams = $this->getClientParams( $view->param() );
441
-				$view->standardBackUrl = $view->url( $target, $controller, $action, $params, array(), $config );
442
-			}
443
-
444
-			$view->standardBasket = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' )->get();
445
-
446
-			$this->cache = $view;
447
-		}
448
-
449
-		return $this->cache;
450
-	}
451
-
452
-
453
-	/**
454
-	 * Adds the products specified by the view parameters to the basket.
455
-	 *
456
-	 * @param \Aimeos\MW\View\Iface $view View object
457
-	 * @param array $options List of options for addProducts() in basket controller
458
-	 */
459
-	protected function addProducts( \Aimeos\MW\View\Iface $view, array $options )
460
-	{
461
-		$this->clearCached();
462
-		$products = (array) $view->param( 'b_prod', array() );
463
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
464
-
465
-		if( ( $prodid = $view->param( 'b_prodid', '' ) ) !== '' )
466
-		{
467
-			$products[] = array(
468
-				'prodid' => $prodid,
469
-				'quantity' => $view->param( 'b_quantity', 1 ),
470
-				'attrvarid' => array_filter( (array) $view->param( 'b_attrvarid', array() ) ),
471
-				'attrconfid' => array_filter( (array) $view->param( 'b_attrconfid', array() ) ),
472
-				'attrhideid' => array_filter( (array) $view->param( 'b_attrhideid', array() ) ),
473
-				'attrcustid' => array_filter( (array) $view->param( 'b_attrcustid', array() ) ),
474
-				'warehouse' => $view->param( 'b_warehouse', 'default' ),
475
-			);
476
-		}
477
-
478
-		foreach( $products as $values ) {
479
-			$this->addProduct( $controller, $values, $options );
480
-		}
481
-	}
482
-
483
-
484
-	/**
485
-	 * Adds a single product specified by its values to the basket.
486
-	 *
487
-	 * @param \Aimeos\Controller\Frontend\Basket\Iface $controller Basket frontend controller
488
-	 * @param array $values Associative list of key/value pairs from the view specifying the product
489
-	 * @param array $options List of options for addProducts() in basket frontend controller
490
-	 */
491
-	protected function addProduct( \Aimeos\Controller\Frontend\Basket\Iface $controller, array $values, array $options )
492
-	{
493
-		$controller->addProduct(
494
-			( isset( $values['prodid'] ) ? (string) $values['prodid'] : '' ),
495
-			( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
496
-			$options,
497
-			( isset( $values['attrvarid'] ) ? array_filter( (array) $values['attrvarid'] ) : array() ),
498
-			( isset( $values['attrconfid'] ) ? array_filter( (array) $values['attrconfid'] ) : array() ),
499
-			( isset( $values['attrhideid'] ) ? array_filter( (array) $values['attrhideid'] ) : array() ),
500
-			( isset( $values['attrcustid'] ) ? array_filter( (array) $values['attrcustid'] ) : array() ),
501
-			( isset( $values['warehouse'] ) ? (string) $values['warehouse'] : 'default' )
502
-		);
503
-	}
504
-
505
-
506
-	/**
507
-	 * Removes the products specified by the view parameters from the basket.
508
-	 *
509
-	 * @param \Aimeos\MW\View\Iface $view View object
510
-	 */
511
-	protected function deleteProducts( \Aimeos\MW\View\Iface $view )
512
-	{
513
-		$this->clearCached();
514
-		$products = (array) $view->param( 'b_position', array() );
515
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
516
-
517
-		foreach( $products as $position ) {
518
-			$controller->deleteProduct( $position );
519
-		}
520
-	}
521
-
522
-
523
-	/**
524
-	 * Edits the products specified by the view parameters to the basket.
525
-	 *
526
-	 * @param \Aimeos\MW\View\Iface $view View object
527
-	 * @param array $options List of options for editProducts() in basket controller
528
-	 */
529
-	protected function editProducts( \Aimeos\MW\View\Iface $view, array $options )
530
-	{
531
-		$this->clearCached();
532
-		$products = (array) $view->param( 'b_prod', array() );
533
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
534
-
535
-		if( ( $position = $view->param( 'b_position', '' ) ) !== '' )
536
-		{
537
-			$products[] = array(
538
-				'position' => $position,
539
-				'quantity' => $view->param( 'b_quantity', 1 ),
540
-				'attrconf-code' => array_filter( (array) $view->param( 'b_attrconfcode', array() ) )
541
-			);
542
-		}
543
-
544
-		foreach( $products as $values )
545
-		{
546
-			$controller->editProduct(
547
-				( isset( $values['position'] ) ? (int) $values['position'] : 0 ),
548
-				( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
549
-				$options,
550
-				( isset( $values['attrconf-code'] ) ? array_filter( (array) $values['attrconf-code'] ) : array() )
551
-			);
552
-		}
553
-	}
25
+    /** client/html/basket/standard/standard/subparts
26
+     * List of HTML sub-clients rendered within the basket standard section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.03
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/basket/standard/standard/subparts';
59
+
60
+    /** client/html/basket/standard/detail/name
61
+     * Name of the detail part used by the basket standard detail client implementation
62
+     *
63
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Standard\Detail\Myname".
64
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
65
+     *
66
+     * @param string Last part of the client class name
67
+     * @since 2014.03
68
+     * @category Developer
69
+     */
70
+
71
+    /** client/html/basket/standard/coupon/name
72
+     * Name of the detail part used by the basket standard coupon client implementation
73
+     *
74
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Standard\Detail\Myname".
75
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
76
+     *
77
+     * @param string Last part of the client class name
78
+     * @since 2014.03
79
+     * @category Developer
80
+     */
81
+    private $subPartNames = array( 'detail', 'coupon' );
82
+    private $cache;
83
+
84
+
85
+    /**
86
+     * Returns the HTML code for insertion into the body.
87
+     *
88
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
89
+     * @param array &$tags Result array for the list of tags that are associated to the output
90
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91
+     * @return string HTML code
92
+     */
93
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
94
+    {
95
+        $context = $this->getContext();
96
+        $view = $this->getView();
97
+
98
+        try
99
+        {
100
+            $view = $this->setViewParams( $view, $tags, $expire );
101
+
102
+            $html = '';
103
+            foreach( $this->getSubClients() as $subclient ) {
104
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
105
+            }
106
+            $view->standardBody = $html;
107
+        }
108
+        catch( \Aimeos\Client\Html\Exception $e )
109
+        {
110
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
112
+        }
113
+        catch( \Aimeos\Controller\Frontend\Exception $e )
114
+        {
115
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
117
+        }
118
+        catch( \Aimeos\MShop\Exception $e )
119
+        {
120
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
122
+        }
123
+        catch( \Exception $e )
124
+        {
125
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
126
+
127
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
129
+        }
130
+
131
+        /** client/html/basket/standard/standard/template-body
132
+         * Relative path to the HTML body template of the basket standard client.
133
+         *
134
+         * The template file contains the HTML code and processing instructions
135
+         * to generate the result shown in the body of the frontend. The
136
+         * configuration string is the path to the template file relative
137
+         * to the templates directory (usually in client/html/templates).
138
+         *
139
+         * You can overwrite the template file configuration in extensions and
140
+         * provide alternative templates. These alternative templates should be
141
+         * named like the default one but with the string "standard" replaced by
142
+         * an unique name. You may use the name of your project for this. If
143
+         * you've implemented an alternative client class as well, "standard"
144
+         * should be replaced by the name of the new class.
145
+         *
146
+         * @param string Relative path to the template creating code for the HTML page body
147
+         * @since 2014.03
148
+         * @category Developer
149
+         * @see client/html/basket/standard/standard/template-header
150
+         */
151
+        $tplconf = 'client/html/basket/standard/standard/template-body';
152
+        $default = 'basket/standard/body-default.php';
153
+
154
+        return $view->render( $view->config( $tplconf, $default ) );
155
+    }
156
+
157
+
158
+    /**
159
+     * Returns the HTML string for insertion into the header.
160
+     *
161
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
162
+     * @param array &$tags Result array for the list of tags that are associated to the output
163
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164
+     * @return string|null String including HTML tags for the header on error
165
+     */
166
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
167
+    {
168
+        try
169
+        {
170
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
171
+
172
+            $html = '';
173
+            foreach( $this->getSubClients() as $subclient ) {
174
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
175
+            }
176
+            $view->standardHeader = $html;
177
+        }
178
+        catch( \Exception $e )
179
+        {
180
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
181
+            return '';
182
+        }
183
+
184
+        /** client/html/basket/standard/standard/template-header
185
+         * Relative path to the HTML header template of the basket standard client.
186
+         *
187
+         * The template file contains the HTML code and processing instructions
188
+         * to generate the HTML code that is inserted into the HTML page header
189
+         * of the rendered page in the frontend. The configuration string is the
190
+         * path to the template file relative to the templates directory (usually
191
+         * in client/html/templates).
192
+         *
193
+         * You can overwrite the template file configuration in extensions and
194
+         * provide alternative templates. These alternative templates should be
195
+         * named like the default one but with the string "standard" replaced by
196
+         * an unique name. You may use the name of your project for this. If
197
+         * you've implemented an alternative client class as well, "standard"
198
+         * should be replaced by the name of the new class.
199
+         *
200
+         * @param string Relative path to the template creating code for the HTML page head
201
+         * @since 2014.03
202
+         * @category Developer
203
+         * @see client/html/basket/standard/standard/template-body
204
+         */
205
+        $tplconf = 'client/html/basket/standard/standard/template-header';
206
+        $default = 'basket/standard/header-default.php';
207
+
208
+        return $view->render( $view->config( $tplconf, $default ) );
209
+    }
210
+
211
+
212
+    /**
213
+     * Returns the sub-client given by its name.
214
+     *
215
+     * @param string $type Name of the client type
216
+     * @param string|null $name Name of the sub-client (Default if null)
217
+     * @return \Aimeos\Client\Html\Iface Sub-client object
218
+     */
219
+    public function getSubClient( $type, $name = null )
220
+    {
221
+        /** client/html/basket/standard/decorators/excludes
222
+         * Excludes decorators added by the "common" option from the basket standard html client
223
+         *
224
+         * Decorators extend the functionality of a class by adding new aspects
225
+         * (e.g. log what is currently done), executing the methods of the underlying
226
+         * class only in certain conditions (e.g. only for logged in users) or
227
+         * modify what is returned to the caller.
228
+         *
229
+         * This option allows you to remove a decorator added via
230
+         * "client/html/common/decorators/default" before they are wrapped
231
+         * around the html client.
232
+         *
233
+         *  client/html/basket/standard/decorators/excludes = array( 'decorator1' )
234
+         *
235
+         * This would remove the decorator named "decorator1" from the list of
236
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
237
+         * "client/html/common/decorators/default" to the html client.
238
+         *
239
+         * @param array List of decorator names
240
+         * @since 2014.05
241
+         * @category Developer
242
+         * @see client/html/common/decorators/default
243
+         * @see client/html/basket/standard/decorators/global
244
+         * @see client/html/basket/standard/decorators/local
245
+         */
246
+
247
+        /** client/html/basket/standard/decorators/global
248
+         * Adds a list of globally available decorators only to the basket standard html client
249
+         *
250
+         * Decorators extend the functionality of a class by adding new aspects
251
+         * (e.g. log what is currently done), executing the methods of the underlying
252
+         * class only in certain conditions (e.g. only for logged in users) or
253
+         * modify what is returned to the caller.
254
+         *
255
+         * This option allows you to wrap global decorators
256
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
257
+         *
258
+         *  client/html/basket/standard/decorators/global = array( 'decorator1' )
259
+         *
260
+         * This would add the decorator named "decorator1" defined by
261
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
262
+         *
263
+         * @param array List of decorator names
264
+         * @since 2014.05
265
+         * @category Developer
266
+         * @see client/html/common/decorators/default
267
+         * @see client/html/basket/standard/decorators/excludes
268
+         * @see client/html/basket/standard/decorators/local
269
+         */
270
+
271
+        /** client/html/basket/standard/decorators/local
272
+         * Adds a list of local decorators only to the basket standard html client
273
+         *
274
+         * Decorators extend the functionality of a class by adding new aspects
275
+         * (e.g. log what is currently done), executing the methods of the underlying
276
+         * class only in certain conditions (e.g. only for logged in users) or
277
+         * modify what is returned to the caller.
278
+         *
279
+         * This option allows you to wrap local decorators
280
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
281
+         *
282
+         *  client/html/basket/standard/decorators/local = array( 'decorator2' )
283
+         *
284
+         * This would add the decorator named "decorator2" defined by
285
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
286
+         *
287
+         * @param array List of decorator names
288
+         * @since 2014.05
289
+         * @category Developer
290
+         * @see client/html/common/decorators/default
291
+         * @see client/html/basket/standard/decorators/excludes
292
+         * @see client/html/basket/standard/decorators/global
293
+         */
294
+
295
+        return $this->createSubClient( 'basket/standard/' . $type, $name );
296
+    }
297
+
298
+
299
+    /**
300
+     * Sets the necessary parameter values in the view.
301
+     */
302
+    public function process()
303
+    {
304
+        $view = $this->getView();
305
+        $context = $this->getContext();
306
+
307
+        try
308
+        {
309
+            $options = array(
310
+
311
+                /** client/html/basket/require-stock
312
+                 * Customers can order products only if there are enough products in stock
313
+                 *
314
+                 * Checks that the requested product quantity is in stock before
315
+                 * the customer can add them to his basket and order them. If there
316
+                 * are not enough products available, the customer will get a notice.
317
+                 *
318
+                 * @param boolean True if products must be in stock, false if products can be sold without stock
319
+                 * @since 2014.03
320
+                 * @category Developer
321
+                 * @category User
322
+                 */
323
+                'stock' => $view->config( 'client/html/basket/require-stock', true ),
324
+
325
+                /** client/html/basket/require-variant
326
+                 * A variant of a selection product must be chosen
327
+                 *
328
+                 * Selection products normally consist of several article variants and by default
329
+                 * exactly one article variant of a selection product can be put into the basket.
330
+                 *
331
+                 * By setting this option to false, the selection product including the chosen
332
+                 * attributes (if any attribute values were selected) can be put into the basket
333
+                 * as well. This makes it possible to get all articles or a subset of articles
334
+                 * (e.g. all of a color) at once.
335
+                 *
336
+                 * @param boolean True if a variant must be chosen, false if also the selection product with attributes can be added
337
+                 * @since 2014.03
338
+                 * @category Developer
339
+                 * @category User
340
+                 */
341
+                'variant' => $view->config( 'client/html/basket/require-variant', true ),
342
+            );
343
+
344
+            switch( $view->param( 'b_action' ) )
345
+            {
346
+                case 'add':
347
+                    $this->addProducts( $view, $options );
348
+                    break;
349
+                case 'delete':
350
+                    $this->deleteProducts( $view );
351
+                    break;
352
+                default:
353
+                    $this->editProducts( $view, $options );
354
+            }
355
+
356
+            parent::process();
357
+
358
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
359
+            $controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_PRODUCT );
360
+        }
361
+        catch( \Aimeos\Client\Html\Exception $e )
362
+        {
363
+            $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
364
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
365
+        }
366
+        catch( \Aimeos\Controller\Frontend\Exception $e )
367
+        {
368
+            $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
369
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
370
+        }
371
+        catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
372
+        {
373
+            $errors = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
374
+            $errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
375
+
376
+            $view->summaryErrorCodes = $e->getErrorCodes();
377
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
378
+        }
379
+        catch( \Aimeos\MShop\Exception $e )
380
+        {
381
+            $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
382
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
383
+        }
384
+        catch( \Exception $e )
385
+        {
386
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
387
+
388
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
389
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
390
+        }
391
+    }
392
+
393
+
394
+    /**
395
+     * Returns the list of sub-client names configured for the client.
396
+     *
397
+     * @return array List of HTML client names
398
+     */
399
+    protected function getSubClientNames()
400
+    {
401
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
402
+    }
403
+
404
+
405
+    /**
406
+     * Sets the necessary parameter values in the view.
407
+     *
408
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
409
+     * @param array &$tags Result array for the list of tags that are associated to the output
410
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
411
+     * @return \Aimeos\MW\View\Iface Modified view object
412
+     */
413
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
414
+    {
415
+        if( !isset( $this->cache ) )
416
+        {
417
+            $context = $this->getContext();
418
+            $site = $context->getLocale()->getSite()->getCode();
419
+
420
+            if( ( $params = $context->getSession()->get( 'aimeos/catalog/detail/params/last' . $site ) ) !== null )
421
+            {
422
+                $target = $view->config( 'client/html/catalog/detail/url/target' );
423
+                $controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
424
+                $action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
425
+                $config = $view->config( 'client/html/catalog/detail/url/config', array() );
426
+            }
427
+            else
428
+            {
429
+                $params = $context->getSession()->get( 'aimeos/catalog/lists/params/last' . $site, array() );
430
+
431
+                $target = $view->config( 'client/html/catalog/lists/url/target' );
432
+                $controller = $view->config( 'client/html/catalog/lists/url/controller', 'catalog' );
433
+                $action = $view->config( 'client/html/catalog/lists/url/action', 'list' );
434
+                $config = $view->config( 'client/html/catalog/lists/url/config', array() );
435
+
436
+            }
437
+
438
+            if( empty( $params ) === false )
439
+            {
440
+                $view->standardParams = $this->getClientParams( $view->param() );
441
+                $view->standardBackUrl = $view->url( $target, $controller, $action, $params, array(), $config );
442
+            }
443
+
444
+            $view->standardBasket = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' )->get();
445
+
446
+            $this->cache = $view;
447
+        }
448
+
449
+        return $this->cache;
450
+    }
451
+
452
+
453
+    /**
454
+     * Adds the products specified by the view parameters to the basket.
455
+     *
456
+     * @param \Aimeos\MW\View\Iface $view View object
457
+     * @param array $options List of options for addProducts() in basket controller
458
+     */
459
+    protected function addProducts( \Aimeos\MW\View\Iface $view, array $options )
460
+    {
461
+        $this->clearCached();
462
+        $products = (array) $view->param( 'b_prod', array() );
463
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
464
+
465
+        if( ( $prodid = $view->param( 'b_prodid', '' ) ) !== '' )
466
+        {
467
+            $products[] = array(
468
+                'prodid' => $prodid,
469
+                'quantity' => $view->param( 'b_quantity', 1 ),
470
+                'attrvarid' => array_filter( (array) $view->param( 'b_attrvarid', array() ) ),
471
+                'attrconfid' => array_filter( (array) $view->param( 'b_attrconfid', array() ) ),
472
+                'attrhideid' => array_filter( (array) $view->param( 'b_attrhideid', array() ) ),
473
+                'attrcustid' => array_filter( (array) $view->param( 'b_attrcustid', array() ) ),
474
+                'warehouse' => $view->param( 'b_warehouse', 'default' ),
475
+            );
476
+        }
477
+
478
+        foreach( $products as $values ) {
479
+            $this->addProduct( $controller, $values, $options );
480
+        }
481
+    }
482
+
483
+
484
+    /**
485
+     * Adds a single product specified by its values to the basket.
486
+     *
487
+     * @param \Aimeos\Controller\Frontend\Basket\Iface $controller Basket frontend controller
488
+     * @param array $values Associative list of key/value pairs from the view specifying the product
489
+     * @param array $options List of options for addProducts() in basket frontend controller
490
+     */
491
+    protected function addProduct( \Aimeos\Controller\Frontend\Basket\Iface $controller, array $values, array $options )
492
+    {
493
+        $controller->addProduct(
494
+            ( isset( $values['prodid'] ) ? (string) $values['prodid'] : '' ),
495
+            ( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
496
+            $options,
497
+            ( isset( $values['attrvarid'] ) ? array_filter( (array) $values['attrvarid'] ) : array() ),
498
+            ( isset( $values['attrconfid'] ) ? array_filter( (array) $values['attrconfid'] ) : array() ),
499
+            ( isset( $values['attrhideid'] ) ? array_filter( (array) $values['attrhideid'] ) : array() ),
500
+            ( isset( $values['attrcustid'] ) ? array_filter( (array) $values['attrcustid'] ) : array() ),
501
+            ( isset( $values['warehouse'] ) ? (string) $values['warehouse'] : 'default' )
502
+        );
503
+    }
504
+
505
+
506
+    /**
507
+     * Removes the products specified by the view parameters from the basket.
508
+     *
509
+     * @param \Aimeos\MW\View\Iface $view View object
510
+     */
511
+    protected function deleteProducts( \Aimeos\MW\View\Iface $view )
512
+    {
513
+        $this->clearCached();
514
+        $products = (array) $view->param( 'b_position', array() );
515
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
516
+
517
+        foreach( $products as $position ) {
518
+            $controller->deleteProduct( $position );
519
+        }
520
+    }
521
+
522
+
523
+    /**
524
+     * Edits the products specified by the view parameters to the basket.
525
+     *
526
+     * @param \Aimeos\MW\View\Iface $view View object
527
+     * @param array $options List of options for editProducts() in basket controller
528
+     */
529
+    protected function editProducts( \Aimeos\MW\View\Iface $view, array $options )
530
+    {
531
+        $this->clearCached();
532
+        $products = (array) $view->param( 'b_prod', array() );
533
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
534
+
535
+        if( ( $position = $view->param( 'b_position', '' ) ) !== '' )
536
+        {
537
+            $products[] = array(
538
+                'position' => $position,
539
+                'quantity' => $view->param( 'b_quantity', 1 ),
540
+                'attrconf-code' => array_filter( (array) $view->param( 'b_attrconfcode', array() ) )
541
+            );
542
+        }
543
+
544
+        foreach( $products as $values )
545
+        {
546
+            $controller->editProduct(
547
+                ( isset( $values['position'] ) ? (int) $values['position'] : 0 ),
548
+                ( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
549
+                $options,
550
+                ( isset( $values['attrconf-code'] ) ? array_filter( (array) $values['attrconf-code'] ) : array() )
551
+            );
552
+        }
553
+    }
554 554
 }
555 555
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +105 added lines, -105 removed lines patch added patch discarded remove patch
@@ -78,7 +78,7 @@  discard block
 block discarded – undo
78 78
 	 * @since 2014.03
79 79
 	 * @category Developer
80 80
 	 */
81
-	private $subPartNames = array( 'detail', 'coupon' );
81
+	private $subPartNames = array('detail', 'coupon');
82 82
 	private $cache;
83 83
 
84 84
 
@@ -90,42 +90,42 @@  discard block
 block discarded – undo
90 90
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
91 91
 	 * @return string HTML code
92 92
 	 */
93
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
93
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
94 94
 	{
95 95
 		$context = $this->getContext();
96 96
 		$view = $this->getView();
97 97
 
98 98
 		try
99 99
 		{
100
-			$view = $this->setViewParams( $view, $tags, $expire );
100
+			$view = $this->setViewParams($view, $tags, $expire);
101 101
 
102 102
 			$html = '';
103
-			foreach( $this->getSubClients() as $subclient ) {
104
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
103
+			foreach ($this->getSubClients() as $subclient) {
104
+				$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
105 105
 			}
106 106
 			$view->standardBody = $html;
107 107
 		}
108
-		catch( \Aimeos\Client\Html\Exception $e )
108
+		catch (\Aimeos\Client\Html\Exception $e)
109 109
 		{
110
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
111
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
110
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
111
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
112 112
 		}
113
-		catch( \Aimeos\Controller\Frontend\Exception $e )
113
+		catch (\Aimeos\Controller\Frontend\Exception $e)
114 114
 		{
115
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
116
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
115
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
116
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
117 117
 		}
118
-		catch( \Aimeos\MShop\Exception $e )
118
+		catch (\Aimeos\MShop\Exception $e)
119 119
 		{
120
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
121
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
120
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
121
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
122 122
 		}
123
-		catch( \Exception $e )
123
+		catch (\Exception $e)
124 124
 		{
125
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
125
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
126 126
 
127
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
128
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
127
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
128
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
129 129
 		}
130 130
 
131 131
 		/** client/html/basket/standard/standard/template-body
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
 		$tplconf = 'client/html/basket/standard/standard/template-body';
152 152
 		$default = 'basket/standard/body-default.php';
153 153
 
154
-		return $view->render( $view->config( $tplconf, $default ) );
154
+		return $view->render($view->config($tplconf, $default));
155 155
 	}
156 156
 
157 157
 
@@ -163,21 +163,21 @@  discard block
 block discarded – undo
163 163
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
164 164
 	 * @return string|null String including HTML tags for the header on error
165 165
 	 */
166
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
166
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
167 167
 	{
168 168
 		try
169 169
 		{
170
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
170
+			$view = $this->setViewParams($this->getView(), $tags, $expire);
171 171
 
172 172
 			$html = '';
173
-			foreach( $this->getSubClients() as $subclient ) {
174
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
173
+			foreach ($this->getSubClients() as $subclient) {
174
+				$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
175 175
 			}
176 176
 			$view->standardHeader = $html;
177 177
 		}
178
-		catch( \Exception $e )
178
+		catch (\Exception $e)
179 179
 		{
180
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
180
+			$this->getContext()->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
181 181
 			return '';
182 182
 		}
183 183
 
@@ -205,7 +205,7 @@  discard block
 block discarded – undo
205 205
 		$tplconf = 'client/html/basket/standard/standard/template-header';
206 206
 		$default = 'basket/standard/header-default.php';
207 207
 
208
-		return $view->render( $view->config( $tplconf, $default ) );
208
+		return $view->render($view->config($tplconf, $default));
209 209
 	}
210 210
 
211 211
 
@@ -216,7 +216,7 @@  discard block
 block discarded – undo
216 216
 	 * @param string|null $name Name of the sub-client (Default if null)
217 217
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
218 218
 	 */
219
-	public function getSubClient( $type, $name = null )
219
+	public function getSubClient($type, $name = null)
220 220
 	{
221 221
 		/** client/html/basket/standard/decorators/excludes
222 222
 		 * Excludes decorators added by the "common" option from the basket standard html client
@@ -292,7 +292,7 @@  discard block
 block discarded – undo
292 292
 		 * @see client/html/basket/standard/decorators/global
293 293
 		 */
294 294
 
295
-		return $this->createSubClient( 'basket/standard/' . $type, $name );
295
+		return $this->createSubClient('basket/standard/'.$type, $name);
296 296
 	}
297 297
 
298 298
 
@@ -320,7 +320,7 @@  discard block
 block discarded – undo
320 320
 				 * @category Developer
321 321
 				 * @category User
322 322
 				 */
323
-				'stock' => $view->config( 'client/html/basket/require-stock', true ),
323
+				'stock' => $view->config('client/html/basket/require-stock', true),
324 324
 
325 325
 				/** client/html/basket/require-variant
326 326
 				 * A variant of a selection product must be chosen
@@ -338,55 +338,55 @@  discard block
 block discarded – undo
338 338
 				 * @category Developer
339 339
 				 * @category User
340 340
 				 */
341
-				'variant' => $view->config( 'client/html/basket/require-variant', true ),
341
+				'variant' => $view->config('client/html/basket/require-variant', true),
342 342
 			);
343 343
 
344
-			switch( $view->param( 'b_action' ) )
344
+			switch ($view->param('b_action'))
345 345
 			{
346 346
 				case 'add':
347
-					$this->addProducts( $view, $options );
347
+					$this->addProducts($view, $options);
348 348
 					break;
349 349
 				case 'delete':
350
-					$this->deleteProducts( $view );
350
+					$this->deleteProducts($view);
351 351
 					break;
352 352
 				default:
353
-					$this->editProducts( $view, $options );
353
+					$this->editProducts($view, $options);
354 354
 			}
355 355
 
356 356
 			parent::process();
357 357
 
358
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
359
-			$controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_PRODUCT );
358
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
359
+			$controller->get()->check(\Aimeos\MShop\Order\Item\Base\Base::PARTS_PRODUCT);
360 360
 		}
361
-		catch( \Aimeos\Client\Html\Exception $e )
361
+		catch (\Aimeos\Client\Html\Exception $e)
362 362
 		{
363
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
364
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
363
+			$error = array($context->getI18n()->dt('client', $e->getMessage()));
364
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
365 365
 		}
366
-		catch( \Aimeos\Controller\Frontend\Exception $e )
366
+		catch (\Aimeos\Controller\Frontend\Exception $e)
367 367
 		{
368
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
369
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
368
+			$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
369
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
370 370
 		}
371
-		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
371
+		catch (\Aimeos\MShop\Plugin\Provider\Exception $e)
372 372
 		{
373
-			$errors = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
374
-			$errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
373
+			$errors = array($context->getI18n()->dt('mshop', $e->getMessage()));
374
+			$errors = array_merge($errors, $this->translatePluginErrorCodes($e->getErrorCodes()));
375 375
 
376 376
 			$view->summaryErrorCodes = $e->getErrorCodes();
377
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
377
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $errors;
378 378
 		}
379
-		catch( \Aimeos\MShop\Exception $e )
379
+		catch (\Aimeos\MShop\Exception $e)
380 380
 		{
381
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
382
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
381
+			$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
382
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
383 383
 		}
384
-		catch( \Exception $e )
384
+		catch (\Exception $e)
385 385
 		{
386
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
386
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
387 387
 
388
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
389
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
388
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
389
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
390 390
 		}
391 391
 	}
392 392
 
@@ -398,7 +398,7 @@  discard block
 block discarded – undo
398 398
 	 */
399 399
 	protected function getSubClientNames()
400 400
 	{
401
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
401
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
402 402
 	}
403 403
 
404 404
 
@@ -410,38 +410,38 @@  discard block
 block discarded – undo
410 410
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
411 411
 	 * @return \Aimeos\MW\View\Iface Modified view object
412 412
 	 */
413
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
413
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
414 414
 	{
415
-		if( !isset( $this->cache ) )
415
+		if (!isset($this->cache))
416 416
 		{
417 417
 			$context = $this->getContext();
418 418
 			$site = $context->getLocale()->getSite()->getCode();
419 419
 
420
-			if( ( $params = $context->getSession()->get( 'aimeos/catalog/detail/params/last' . $site ) ) !== null )
420
+			if (($params = $context->getSession()->get('aimeos/catalog/detail/params/last'.$site)) !== null)
421 421
 			{
422
-				$target = $view->config( 'client/html/catalog/detail/url/target' );
423
-				$controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
424
-				$action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
425
-				$config = $view->config( 'client/html/catalog/detail/url/config', array() );
422
+				$target = $view->config('client/html/catalog/detail/url/target');
423
+				$controller = $view->config('client/html/catalog/detail/url/controller', 'catalog');
424
+				$action = $view->config('client/html/catalog/detail/url/action', 'detail');
425
+				$config = $view->config('client/html/catalog/detail/url/config', array());
426 426
 			}
427 427
 			else
428 428
 			{
429
-				$params = $context->getSession()->get( 'aimeos/catalog/lists/params/last' . $site, array() );
429
+				$params = $context->getSession()->get('aimeos/catalog/lists/params/last'.$site, array());
430 430
 
431
-				$target = $view->config( 'client/html/catalog/lists/url/target' );
432
-				$controller = $view->config( 'client/html/catalog/lists/url/controller', 'catalog' );
433
-				$action = $view->config( 'client/html/catalog/lists/url/action', 'list' );
434
-				$config = $view->config( 'client/html/catalog/lists/url/config', array() );
431
+				$target = $view->config('client/html/catalog/lists/url/target');
432
+				$controller = $view->config('client/html/catalog/lists/url/controller', 'catalog');
433
+				$action = $view->config('client/html/catalog/lists/url/action', 'list');
434
+				$config = $view->config('client/html/catalog/lists/url/config', array());
435 435
 
436 436
 			}
437 437
 
438
-			if( empty( $params ) === false )
438
+			if (empty($params) === false)
439 439
 			{
440
-				$view->standardParams = $this->getClientParams( $view->param() );
441
-				$view->standardBackUrl = $view->url( $target, $controller, $action, $params, array(), $config );
440
+				$view->standardParams = $this->getClientParams($view->param());
441
+				$view->standardBackUrl = $view->url($target, $controller, $action, $params, array(), $config);
442 442
 			}
443 443
 
444
-			$view->standardBasket = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' )->get();
444
+			$view->standardBasket = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket')->get();
445 445
 
446 446
 			$this->cache = $view;
447 447
 		}
@@ -456,27 +456,27 @@  discard block
 block discarded – undo
456 456
 	 * @param \Aimeos\MW\View\Iface $view View object
457 457
 	 * @param array $options List of options for addProducts() in basket controller
458 458
 	 */
459
-	protected function addProducts( \Aimeos\MW\View\Iface $view, array $options )
459
+	protected function addProducts(\Aimeos\MW\View\Iface $view, array $options)
460 460
 	{
461 461
 		$this->clearCached();
462
-		$products = (array) $view->param( 'b_prod', array() );
463
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
462
+		$products = (array) $view->param('b_prod', array());
463
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($this->getContext(), 'basket');
464 464
 
465
-		if( ( $prodid = $view->param( 'b_prodid', '' ) ) !== '' )
465
+		if (($prodid = $view->param('b_prodid', '')) !== '')
466 466
 		{
467 467
 			$products[] = array(
468 468
 				'prodid' => $prodid,
469
-				'quantity' => $view->param( 'b_quantity', 1 ),
470
-				'attrvarid' => array_filter( (array) $view->param( 'b_attrvarid', array() ) ),
471
-				'attrconfid' => array_filter( (array) $view->param( 'b_attrconfid', array() ) ),
472
-				'attrhideid' => array_filter( (array) $view->param( 'b_attrhideid', array() ) ),
473
-				'attrcustid' => array_filter( (array) $view->param( 'b_attrcustid', array() ) ),
474
-				'warehouse' => $view->param( 'b_warehouse', 'default' ),
469
+				'quantity' => $view->param('b_quantity', 1),
470
+				'attrvarid' => array_filter((array) $view->param('b_attrvarid', array())),
471
+				'attrconfid' => array_filter((array) $view->param('b_attrconfid', array())),
472
+				'attrhideid' => array_filter((array) $view->param('b_attrhideid', array())),
473
+				'attrcustid' => array_filter((array) $view->param('b_attrcustid', array())),
474
+				'warehouse' => $view->param('b_warehouse', 'default'),
475 475
 			);
476 476
 		}
477 477
 
478
-		foreach( $products as $values ) {
479
-			$this->addProduct( $controller, $values, $options );
478
+		foreach ($products as $values) {
479
+			$this->addProduct($controller, $values, $options);
480 480
 		}
481 481
 	}
482 482
 
@@ -488,17 +488,17 @@  discard block
 block discarded – undo
488 488
 	 * @param array $values Associative list of key/value pairs from the view specifying the product
489 489
 	 * @param array $options List of options for addProducts() in basket frontend controller
490 490
 	 */
491
-	protected function addProduct( \Aimeos\Controller\Frontend\Basket\Iface $controller, array $values, array $options )
491
+	protected function addProduct(\Aimeos\Controller\Frontend\Basket\Iface $controller, array $values, array $options)
492 492
 	{
493 493
 		$controller->addProduct(
494
-			( isset( $values['prodid'] ) ? (string) $values['prodid'] : '' ),
495
-			( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
494
+			(isset($values['prodid']) ? (string) $values['prodid'] : ''),
495
+			(isset($values['quantity']) ? (int) $values['quantity'] : 1),
496 496
 			$options,
497
-			( isset( $values['attrvarid'] ) ? array_filter( (array) $values['attrvarid'] ) : array() ),
498
-			( isset( $values['attrconfid'] ) ? array_filter( (array) $values['attrconfid'] ) : array() ),
499
-			( isset( $values['attrhideid'] ) ? array_filter( (array) $values['attrhideid'] ) : array() ),
500
-			( isset( $values['attrcustid'] ) ? array_filter( (array) $values['attrcustid'] ) : array() ),
501
-			( isset( $values['warehouse'] ) ? (string) $values['warehouse'] : 'default' )
497
+			(isset($values['attrvarid']) ? array_filter((array) $values['attrvarid']) : array()),
498
+			(isset($values['attrconfid']) ? array_filter((array) $values['attrconfid']) : array()),
499
+			(isset($values['attrhideid']) ? array_filter((array) $values['attrhideid']) : array()),
500
+			(isset($values['attrcustid']) ? array_filter((array) $values['attrcustid']) : array()),
501
+			(isset($values['warehouse']) ? (string) $values['warehouse'] : 'default')
502 502
 		);
503 503
 	}
504 504
 
@@ -508,14 +508,14 @@  discard block
 block discarded – undo
508 508
 	 *
509 509
 	 * @param \Aimeos\MW\View\Iface $view View object
510 510
 	 */
511
-	protected function deleteProducts( \Aimeos\MW\View\Iface $view )
511
+	protected function deleteProducts(\Aimeos\MW\View\Iface $view)
512 512
 	{
513 513
 		$this->clearCached();
514
-		$products = (array) $view->param( 'b_position', array() );
515
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
514
+		$products = (array) $view->param('b_position', array());
515
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($this->getContext(), 'basket');
516 516
 
517
-		foreach( $products as $position ) {
518
-			$controller->deleteProduct( $position );
517
+		foreach ($products as $position) {
518
+			$controller->deleteProduct($position);
519 519
 		}
520 520
 	}
521 521
 
@@ -526,28 +526,28 @@  discard block
 block discarded – undo
526 526
 	 * @param \Aimeos\MW\View\Iface $view View object
527 527
 	 * @param array $options List of options for editProducts() in basket controller
528 528
 	 */
529
-	protected function editProducts( \Aimeos\MW\View\Iface $view, array $options )
529
+	protected function editProducts(\Aimeos\MW\View\Iface $view, array $options)
530 530
 	{
531 531
 		$this->clearCached();
532
-		$products = (array) $view->param( 'b_prod', array() );
533
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
532
+		$products = (array) $view->param('b_prod', array());
533
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($this->getContext(), 'basket');
534 534
 
535
-		if( ( $position = $view->param( 'b_position', '' ) ) !== '' )
535
+		if (($position = $view->param('b_position', '')) !== '')
536 536
 		{
537 537
 			$products[] = array(
538 538
 				'position' => $position,
539
-				'quantity' => $view->param( 'b_quantity', 1 ),
540
-				'attrconf-code' => array_filter( (array) $view->param( 'b_attrconfcode', array() ) )
539
+				'quantity' => $view->param('b_quantity', 1),
540
+				'attrconf-code' => array_filter((array) $view->param('b_attrconfcode', array()))
541 541
 			);
542 542
 		}
543 543
 
544
-		foreach( $products as $values )
544
+		foreach ($products as $values)
545 545
 		{
546 546
 			$controller->editProduct(
547
-				( isset( $values['position'] ) ? (int) $values['position'] : 0 ),
548
-				( isset( $values['quantity'] ) ? (int) $values['quantity'] : 1 ),
547
+				(isset($values['position']) ? (int) $values['position'] : 0),
548
+				(isset($values['quantity']) ? (int) $values['quantity'] : 1),
549 549
 				$options,
550
-				( isset( $values['attrconf-code'] ) ? array_filter( (array) $values['attrconf-code'] ) : array() )
550
+				(isset($values['attrconf-code']) ? array_filter((array) $values['attrconf-code']) : array())
551 551
 			);
552 552
 		}
553 553
 	}
Please login to merge, or discard this patch.
client/html/src/Client/Html/Basket/Related/Bought/Standard.php 3 patches
Indentation   +375 added lines, -375 removed lines patch added patch discarded remove patch
@@ -18,380 +18,380 @@
 block discarded – undo
18 18
  * @subpackage Html
19 19
  */
20 20
 class Standard
21
-	extends \Aimeos\Client\Html\Basket\Base
22
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
21
+    extends \Aimeos\Client\Html\Basket\Base
22
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
23 23
 {
24
-	/** client/html/basket/related/bought/standard/subparts
25
-	 * List of HTML sub-clients rendered within the basket related bought section
26
-	 *
27
-	 * The output of the frontend is composed of the code generated by the HTML
28
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
29
-	 * that are responsible for rendering certain sub-parts of the output. The
30
-	 * sub-clients can contain HTML clients themselves and therefore a
31
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
32
-	 * the output that is placed inside the container of its parent.
33
-	 *
34
-	 * At first, always the HTML code generated by the parent is printed, then
35
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
36
-	 * determines the order of the output of these sub-clients inside the parent
37
-	 * container. If the configured list of clients is
38
-	 *
39
-	 *  array( "subclient1", "subclient2" )
40
-	 *
41
-	 * you can easily change the order of the output by reordering the subparts:
42
-	 *
43
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
44
-	 *
45
-	 * You can also remove one or more parts if they shouldn't be rendered:
46
-	 *
47
-	 *  client/html/<clients>/subparts = array( "subclient1" )
48
-	 *
49
-	 * As the clients only generates structural HTML, the layout defined via CSS
50
-	 * should support adding, removing or reordering content by a fluid like
51
-	 * design.
52
-	 *
53
-	 * @param array List of sub-client names
54
-	 * @since 2014.03
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/basket/related/bought/standard/subparts';
58
-	private $subPartNames = array();
59
-	private $cache;
60
-
61
-
62
-	/**
63
-	 * Returns the HTML code for insertion into the body.
64
-	 *
65
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
-	 * @param array &$tags Result array for the list of tags that are associated to the output
67
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
-	 * @return string HTML code
69
-	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
-	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
73
-
74
-		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
-		}
78
-		$view->boughtBody = $html;
79
-
80
-		/** client/html/basket/related/bought/standard/template-body
81
-		 * Relative path to the HTML body template of the basket related bought client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.03
97
-		 * @category Developer
98
-		 * @see client/html/basket/related/bought/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/basket/related/bought/standard/template-body';
101
-		$default = 'basket/related/bought-body-default.php';
102
-
103
-		return $view->render( $view->config( $tplconf, $default ) );
104
-	}
105
-
106
-
107
-	/**
108
-	 * Returns the HTML string for insertion into the header.
109
-	 *
110
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
-	 * @param array &$tags Result array for the list of tags that are associated to the output
112
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
114
-	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
-	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
118
-
119
-		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
-		}
123
-		$view->boughtHeader = $html;
124
-
125
-		/** client/html/basket/related/bought/standard/template-header
126
-		 * Relative path to the HTML header template of the basket related bought client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.03
143
-		 * @category Developer
144
-		 * @see client/html/basket/related/bought/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/basket/related/bought/standard/template-header';
147
-		$default = 'basket/related/bought-header-default.php';
148
-
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
151
-
152
-
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/basket/related/bought/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the basket related bought html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/basket/related/bought/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2014.05
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/basket/related/bought/decorators/global
185
-		 * @see client/html/basket/related/bought/decorators/local
186
-		 */
187
-
188
-		/** client/html/basket/related/bought/decorators/global
189
-		 * Adds a list of globally available decorators only to the basket related bought html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/basket/related/bought/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2014.05
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/basket/related/bought/decorators/excludes
209
-		 * @see client/html/basket/related/bought/decorators/local
210
-		 */
211
-
212
-		/** client/html/basket/related/bought/decorators/local
213
-		 * Adds a list of local decorators only to the basket related bought html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/basket/related/bought/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2014.05
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/basket/related/bought/decorators/excludes
233
-		 * @see client/html/basket/related/bought/decorators/global
234
-		 */
235
-
236
-		return $this->createSubClient( 'basket/related/bought/' . $type, $name );
237
-	}
238
-
239
-
240
-	/**
241
-	 * Returns the list of sub-client names configured for the client.
242
-	 *
243
-	 * @return array List of HTML client names
244
-	 */
245
-	protected function getSubClientNames()
246
-	{
247
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
248
-	}
249
-
250
-
251
-	/**
252
-	 * Sets the necessary parameter values in the view.
253
-	 *
254
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
255
-	 * @param array &$tags Result array for the list of tags that are associated to the output
256
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
257
-	 * @return \Aimeos\MW\View\Iface Modified view object
258
-	 */
259
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
260
-	{
261
-		if( !isset( $this->cache ) )
262
-		{
263
-			if( isset( $view->relatedBasket ) )
264
-			{
265
-				$refIds = $items = array();
266
-				$context = $this->getContext();
267
-
268
-				$prodIds = $this->getProductIdsFromBasket( $view->relatedBasket );
269
-
270
-				foreach( $this->getListItems( $prodIds ) as $listItem )
271
-				{
272
-					$refId = $listItem->getRefId();
273
-
274
-					if( !isset( $prodIds[$refId] ) ) {
275
-						$refIds[$refId] = $refId;
276
-					}
277
-				}
278
-
279
-				$products = $this->getProductItems( $refIds );
280
-
281
-				foreach( $refIds as $id )
282
-				{
283
-					if( isset( $products[$id] ) ) {
284
-						$items[$id] = $products[$id];
285
-					}
286
-				}
287
-
288
-				/** client/html/basket/related/bought/standard/limit
289
-				 * Number of items in the list of bought together products
290
-				 *
291
-				 * This option limits the number of suggested products in the
292
-				 * list of bought together products. The suggested items are
293
-				 * calculated using the products that are in the current basket
294
-				 * of the customer.
295
-				 *
296
-				 * Note: You need to start the job controller for calculating
297
-				 * the bought together products regularly to get up to date
298
-				 * product suggestions.
299
-				 *
300
-				 * @param integer Number of products
301
-				 * @since 2014.09
302
-				 */
303
-				$size = $context->getConfig()->get( 'client/html/basket/related/bought/standard/limit', 6 );
304
-
305
-
306
-				$view->boughtItems = array_slice( $items, 0, $size, true );
307
-			}
308
-
309
-			$this->cache = $view;
310
-		}
311
-
312
-		return $this->cache;
313
-	}
314
-
315
-
316
-	/**
317
-	 * Returns the list items of type "bought-together" associated to the given product IDs.
318
-	 *
319
-	 * @param string[] $prodIds List of product IDs
320
-	 * @return \Aimeos\MShop\Product\Item\Lists\Iface[] List of product list items
321
-	 */
322
-	protected function getListItems( array $prodIds )
323
-	{
324
-		$typeItem = $this->getTypeItem( 'product/lists/type', 'product', 'bought-together' );
325
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/lists' );
326
-
327
-		$search = $manager->createSearch( true );
328
-		$expr = array(
329
-				$search->compare( '==', 'product.lists.parentid', $prodIds ),
330
-				$search->compare( '==', 'product.lists.typeid', $typeItem->getId() ),
331
-				$search->compare( '==', 'product.lists.domain', 'product' ),
332
-				$search->getConditions(),
333
-		);
334
-		$search->setConditions( $search->combine( '&&', $expr ) );
335
-		$search->setSortations( array( $search->sort( '+', 'product.lists.position' ) ) );
336
-
337
-		return $manager->searchItems( $search );
338
-	}
339
-
340
-
341
-	/**
342
-	 * Returns the IDs of the products in the current basket.
343
-	 *
344
-	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
345
-	 * @return string[] List of product IDs
346
-	 */
347
-	protected function getProductIdsFromBasket( \Aimeos\MShop\Order\Item\Base\Iface $basket )
348
-	{
349
-		$list = array();
350
-
351
-		foreach( $basket->getProducts() as $orderProduct )
352
-		{
353
-			$list[ $orderProduct->getProductId() ] = true;
354
-
355
-			foreach( $orderProduct->getProducts() as $subProduct ) {
356
-				$list[ $subProduct->getProductId() ] = true;
357
-			}
358
-		}
359
-
360
-		return array_keys( $list );
361
-	}
362
-
363
-
364
-	/**
365
-	 * Returns the product items for the given IDs.
366
-	 *
367
-	 * @param string[] $ids List of product IDs
368
-	 * @return \Aimeos\MShop\Product\Item\Iface[] List of product items
369
-	 */
370
-	protected function getProductItems( array $ids )
371
-	{
372
-		$context = $this->getContext();
373
-		$config = $context->getConfig();
374
-
375
-		/** client/html/basket/related/bought/standard/domains
376
-		 * The list of domain names whose items should be available in the template for the products
377
-		 *
378
-		 * The templates rendering product details usually add the images,
379
-		 * prices and texts, etc. associated to the product
380
-		 * item. If you want to display additional or less content, you can
381
-		 * configure your own list of domains (attribute, media, price, product,
382
-		 * text, etc. are domains) whose items are fetched from the storage.
383
-		 * Please keep in mind that the more domains you add to the configuration,
384
-		 * the more time is required for fetching the content!
385
-		 *
386
-		 * @param array List of domain names
387
-		 * @since 2014.09
388
-		 * @category Developer
389
-		 */
390
-		$domains = array( 'text', 'price', 'media' );
391
-		$domains = $config->get( 'client/html/basket/related/bought/standard/domains', $domains );
392
-
393
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
394
-
395
-		return $controller->getProductItems( $ids, $domains );
396
-	}
24
+    /** client/html/basket/related/bought/standard/subparts
25
+     * List of HTML sub-clients rendered within the basket related bought section
26
+     *
27
+     * The output of the frontend is composed of the code generated by the HTML
28
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
29
+     * that are responsible for rendering certain sub-parts of the output. The
30
+     * sub-clients can contain HTML clients themselves and therefore a
31
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
32
+     * the output that is placed inside the container of its parent.
33
+     *
34
+     * At first, always the HTML code generated by the parent is printed, then
35
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
36
+     * determines the order of the output of these sub-clients inside the parent
37
+     * container. If the configured list of clients is
38
+     *
39
+     *  array( "subclient1", "subclient2" )
40
+     *
41
+     * you can easily change the order of the output by reordering the subparts:
42
+     *
43
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
44
+     *
45
+     * You can also remove one or more parts if they shouldn't be rendered:
46
+     *
47
+     *  client/html/<clients>/subparts = array( "subclient1" )
48
+     *
49
+     * As the clients only generates structural HTML, the layout defined via CSS
50
+     * should support adding, removing or reordering content by a fluid like
51
+     * design.
52
+     *
53
+     * @param array List of sub-client names
54
+     * @since 2014.03
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/basket/related/bought/standard/subparts';
58
+    private $subPartNames = array();
59
+    private $cache;
60
+
61
+
62
+    /**
63
+     * Returns the HTML code for insertion into the body.
64
+     *
65
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
66
+     * @param array &$tags Result array for the list of tags that are associated to the output
67
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68
+     * @return string HTML code
69
+     */
70
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
+    {
72
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
73
+
74
+        $html = '';
75
+        foreach( $this->getSubClients() as $subclient ) {
76
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+        }
78
+        $view->boughtBody = $html;
79
+
80
+        /** client/html/basket/related/bought/standard/template-body
81
+         * Relative path to the HTML body template of the basket related bought client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.03
97
+         * @category Developer
98
+         * @see client/html/basket/related/bought/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/basket/related/bought/standard/template-body';
101
+        $default = 'basket/related/bought-body-default.php';
102
+
103
+        return $view->render( $view->config( $tplconf, $default ) );
104
+    }
105
+
106
+
107
+    /**
108
+     * Returns the HTML string for insertion into the header.
109
+     *
110
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
+     * @param array &$tags Result array for the list of tags that are associated to the output
112
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
+     * @return string|null String including HTML tags for the header on error
114
+     */
115
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
+    {
117
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
118
+
119
+        $html = '';
120
+        foreach( $this->getSubClients() as $subclient ) {
121
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+        }
123
+        $view->boughtHeader = $html;
124
+
125
+        /** client/html/basket/related/bought/standard/template-header
126
+         * Relative path to the HTML header template of the basket related bought client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.03
143
+         * @category Developer
144
+         * @see client/html/basket/related/bought/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/basket/related/bought/standard/template-header';
147
+        $default = 'basket/related/bought-header-default.php';
148
+
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151
+
152
+
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/basket/related/bought/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the basket related bought html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/basket/related/bought/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2014.05
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/basket/related/bought/decorators/global
185
+         * @see client/html/basket/related/bought/decorators/local
186
+         */
187
+
188
+        /** client/html/basket/related/bought/decorators/global
189
+         * Adds a list of globally available decorators only to the basket related bought html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/basket/related/bought/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2014.05
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/basket/related/bought/decorators/excludes
209
+         * @see client/html/basket/related/bought/decorators/local
210
+         */
211
+
212
+        /** client/html/basket/related/bought/decorators/local
213
+         * Adds a list of local decorators only to the basket related bought html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/basket/related/bought/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2014.05
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/basket/related/bought/decorators/excludes
233
+         * @see client/html/basket/related/bought/decorators/global
234
+         */
235
+
236
+        return $this->createSubClient( 'basket/related/bought/' . $type, $name );
237
+    }
238
+
239
+
240
+    /**
241
+     * Returns the list of sub-client names configured for the client.
242
+     *
243
+     * @return array List of HTML client names
244
+     */
245
+    protected function getSubClientNames()
246
+    {
247
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
248
+    }
249
+
250
+
251
+    /**
252
+     * Sets the necessary parameter values in the view.
253
+     *
254
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
255
+     * @param array &$tags Result array for the list of tags that are associated to the output
256
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
257
+     * @return \Aimeos\MW\View\Iface Modified view object
258
+     */
259
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
260
+    {
261
+        if( !isset( $this->cache ) )
262
+        {
263
+            if( isset( $view->relatedBasket ) )
264
+            {
265
+                $refIds = $items = array();
266
+                $context = $this->getContext();
267
+
268
+                $prodIds = $this->getProductIdsFromBasket( $view->relatedBasket );
269
+
270
+                foreach( $this->getListItems( $prodIds ) as $listItem )
271
+                {
272
+                    $refId = $listItem->getRefId();
273
+
274
+                    if( !isset( $prodIds[$refId] ) ) {
275
+                        $refIds[$refId] = $refId;
276
+                    }
277
+                }
278
+
279
+                $products = $this->getProductItems( $refIds );
280
+
281
+                foreach( $refIds as $id )
282
+                {
283
+                    if( isset( $products[$id] ) ) {
284
+                        $items[$id] = $products[$id];
285
+                    }
286
+                }
287
+
288
+                /** client/html/basket/related/bought/standard/limit
289
+                 * Number of items in the list of bought together products
290
+                 *
291
+                 * This option limits the number of suggested products in the
292
+                 * list of bought together products. The suggested items are
293
+                 * calculated using the products that are in the current basket
294
+                 * of the customer.
295
+                 *
296
+                 * Note: You need to start the job controller for calculating
297
+                 * the bought together products regularly to get up to date
298
+                 * product suggestions.
299
+                 *
300
+                 * @param integer Number of products
301
+                 * @since 2014.09
302
+                 */
303
+                $size = $context->getConfig()->get( 'client/html/basket/related/bought/standard/limit', 6 );
304
+
305
+
306
+                $view->boughtItems = array_slice( $items, 0, $size, true );
307
+            }
308
+
309
+            $this->cache = $view;
310
+        }
311
+
312
+        return $this->cache;
313
+    }
314
+
315
+
316
+    /**
317
+     * Returns the list items of type "bought-together" associated to the given product IDs.
318
+     *
319
+     * @param string[] $prodIds List of product IDs
320
+     * @return \Aimeos\MShop\Product\Item\Lists\Iface[] List of product list items
321
+     */
322
+    protected function getListItems( array $prodIds )
323
+    {
324
+        $typeItem = $this->getTypeItem( 'product/lists/type', 'product', 'bought-together' );
325
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/lists' );
326
+
327
+        $search = $manager->createSearch( true );
328
+        $expr = array(
329
+                $search->compare( '==', 'product.lists.parentid', $prodIds ),
330
+                $search->compare( '==', 'product.lists.typeid', $typeItem->getId() ),
331
+                $search->compare( '==', 'product.lists.domain', 'product' ),
332
+                $search->getConditions(),
333
+        );
334
+        $search->setConditions( $search->combine( '&&', $expr ) );
335
+        $search->setSortations( array( $search->sort( '+', 'product.lists.position' ) ) );
336
+
337
+        return $manager->searchItems( $search );
338
+    }
339
+
340
+
341
+    /**
342
+     * Returns the IDs of the products in the current basket.
343
+     *
344
+     * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
345
+     * @return string[] List of product IDs
346
+     */
347
+    protected function getProductIdsFromBasket( \Aimeos\MShop\Order\Item\Base\Iface $basket )
348
+    {
349
+        $list = array();
350
+
351
+        foreach( $basket->getProducts() as $orderProduct )
352
+        {
353
+            $list[ $orderProduct->getProductId() ] = true;
354
+
355
+            foreach( $orderProduct->getProducts() as $subProduct ) {
356
+                $list[ $subProduct->getProductId() ] = true;
357
+            }
358
+        }
359
+
360
+        return array_keys( $list );
361
+    }
362
+
363
+
364
+    /**
365
+     * Returns the product items for the given IDs.
366
+     *
367
+     * @param string[] $ids List of product IDs
368
+     * @return \Aimeos\MShop\Product\Item\Iface[] List of product items
369
+     */
370
+    protected function getProductItems( array $ids )
371
+    {
372
+        $context = $this->getContext();
373
+        $config = $context->getConfig();
374
+
375
+        /** client/html/basket/related/bought/standard/domains
376
+         * The list of domain names whose items should be available in the template for the products
377
+         *
378
+         * The templates rendering product details usually add the images,
379
+         * prices and texts, etc. associated to the product
380
+         * item. If you want to display additional or less content, you can
381
+         * configure your own list of domains (attribute, media, price, product,
382
+         * text, etc. are domains) whose items are fetched from the storage.
383
+         * Please keep in mind that the more domains you add to the configuration,
384
+         * the more time is required for fetching the content!
385
+         *
386
+         * @param array List of domain names
387
+         * @since 2014.09
388
+         * @category Developer
389
+         */
390
+        $domains = array( 'text', 'price', 'media' );
391
+        $domains = $config->get( 'client/html/basket/related/bought/standard/domains', $domains );
392
+
393
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
394
+
395
+        return $controller->getProductItems( $ids, $domains );
396
+    }
397 397
 }
398 398
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +45 added lines, -45 removed lines patch added patch discarded remove patch
@@ -67,13 +67,13 @@  discard block
 block discarded – undo
67 67
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
68 68
 	 * @return string HTML code
69 69
 	 */
70
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
71 71
 	{
72
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
72
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
73 73
 
74 74
 		$html = '';
75
-		foreach( $this->getSubClients() as $subclient ) {
76
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
75
+		foreach ($this->getSubClients() as $subclient) {
76
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
77 77
 		}
78 78
 		$view->boughtBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/basket/related/bought/standard/template-body';
101 101
 		$default = 'basket/related/bought-body-default.php';
102 102
 
103
-		return $view->render( $view->config( $tplconf, $default ) );
103
+		return $view->render($view->config($tplconf, $default));
104 104
 	}
105 105
 
106 106
 
@@ -112,13 +112,13 @@  discard block
 block discarded – undo
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113 113
 	 * @return string|null String including HTML tags for the header on error
114 114
 	 */
115
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
115
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
116 116
 	{
117
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
117
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
118 118
 
119 119
 		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
120
+		foreach ($this->getSubClients() as $subclient) {
121
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
122 122
 		}
123 123
 		$view->boughtHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/basket/related/bought/standard/template-header';
147 147
 		$default = 'basket/related/bought-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/basket/related/bought/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the basket related bought html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/basket/related/bought/decorators/global
234 234
 		 */
235 235
 
236
-		return $this->createSubClient( 'basket/related/bought/' . $type, $name );
236
+		return $this->createSubClient('basket/related/bought/'.$type, $name);
237 237
 	}
238 238
 
239 239
 
@@ -244,7 +244,7 @@  discard block
 block discarded – undo
244 244
 	 */
245 245
 	protected function getSubClientNames()
246 246
 	{
247
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
247
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
248 248
 	}
249 249
 
250 250
 
@@ -256,31 +256,31 @@  discard block
 block discarded – undo
256 256
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
257 257
 	 * @return \Aimeos\MW\View\Iface Modified view object
258 258
 	 */
259
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
259
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
260 260
 	{
261
-		if( !isset( $this->cache ) )
261
+		if (!isset($this->cache))
262 262
 		{
263
-			if( isset( $view->relatedBasket ) )
263
+			if (isset($view->relatedBasket))
264 264
 			{
265 265
 				$refIds = $items = array();
266 266
 				$context = $this->getContext();
267 267
 
268
-				$prodIds = $this->getProductIdsFromBasket( $view->relatedBasket );
268
+				$prodIds = $this->getProductIdsFromBasket($view->relatedBasket);
269 269
 
270
-				foreach( $this->getListItems( $prodIds ) as $listItem )
270
+				foreach ($this->getListItems($prodIds) as $listItem)
271 271
 				{
272 272
 					$refId = $listItem->getRefId();
273 273
 
274
-					if( !isset( $prodIds[$refId] ) ) {
274
+					if (!isset($prodIds[$refId])) {
275 275
 						$refIds[$refId] = $refId;
276 276
 					}
277 277
 				}
278 278
 
279
-				$products = $this->getProductItems( $refIds );
279
+				$products = $this->getProductItems($refIds);
280 280
 
281
-				foreach( $refIds as $id )
281
+				foreach ($refIds as $id)
282 282
 				{
283
-					if( isset( $products[$id] ) ) {
283
+					if (isset($products[$id])) {
284 284
 						$items[$id] = $products[$id];
285 285
 					}
286 286
 				}
@@ -300,10 +300,10 @@  discard block
 block discarded – undo
300 300
 				 * @param integer Number of products
301 301
 				 * @since 2014.09
302 302
 				 */
303
-				$size = $context->getConfig()->get( 'client/html/basket/related/bought/standard/limit', 6 );
303
+				$size = $context->getConfig()->get('client/html/basket/related/bought/standard/limit', 6);
304 304
 
305 305
 
306
-				$view->boughtItems = array_slice( $items, 0, $size, true );
306
+				$view->boughtItems = array_slice($items, 0, $size, true);
307 307
 			}
308 308
 
309 309
 			$this->cache = $view;
@@ -319,22 +319,22 @@  discard block
 block discarded – undo
319 319
 	 * @param string[] $prodIds List of product IDs
320 320
 	 * @return \Aimeos\MShop\Product\Item\Lists\Iface[] List of product list items
321 321
 	 */
322
-	protected function getListItems( array $prodIds )
322
+	protected function getListItems(array $prodIds)
323 323
 	{
324
-		$typeItem = $this->getTypeItem( 'product/lists/type', 'product', 'bought-together' );
325
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/lists' );
324
+		$typeItem = $this->getTypeItem('product/lists/type', 'product', 'bought-together');
325
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'product/lists');
326 326
 
327
-		$search = $manager->createSearch( true );
327
+		$search = $manager->createSearch(true);
328 328
 		$expr = array(
329
-				$search->compare( '==', 'product.lists.parentid', $prodIds ),
330
-				$search->compare( '==', 'product.lists.typeid', $typeItem->getId() ),
331
-				$search->compare( '==', 'product.lists.domain', 'product' ),
329
+				$search->compare('==', 'product.lists.parentid', $prodIds),
330
+				$search->compare('==', 'product.lists.typeid', $typeItem->getId()),
331
+				$search->compare('==', 'product.lists.domain', 'product'),
332 332
 				$search->getConditions(),
333 333
 		);
334
-		$search->setConditions( $search->combine( '&&', $expr ) );
335
-		$search->setSortations( array( $search->sort( '+', 'product.lists.position' ) ) );
334
+		$search->setConditions($search->combine('&&', $expr));
335
+		$search->setSortations(array($search->sort('+', 'product.lists.position')));
336 336
 
337
-		return $manager->searchItems( $search );
337
+		return $manager->searchItems($search);
338 338
 	}
339 339
 
340 340
 
@@ -344,20 +344,20 @@  discard block
 block discarded – undo
344 344
 	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
345 345
 	 * @return string[] List of product IDs
346 346
 	 */
347
-	protected function getProductIdsFromBasket( \Aimeos\MShop\Order\Item\Base\Iface $basket )
347
+	protected function getProductIdsFromBasket(\Aimeos\MShop\Order\Item\Base\Iface $basket)
348 348
 	{
349 349
 		$list = array();
350 350
 
351
-		foreach( $basket->getProducts() as $orderProduct )
351
+		foreach ($basket->getProducts() as $orderProduct)
352 352
 		{
353
-			$list[ $orderProduct->getProductId() ] = true;
353
+			$list[$orderProduct->getProductId()] = true;
354 354
 
355
-			foreach( $orderProduct->getProducts() as $subProduct ) {
356
-				$list[ $subProduct->getProductId() ] = true;
355
+			foreach ($orderProduct->getProducts() as $subProduct) {
356
+				$list[$subProduct->getProductId()] = true;
357 357
 			}
358 358
 		}
359 359
 
360
-		return array_keys( $list );
360
+		return array_keys($list);
361 361
 	}
362 362
 
363 363
 
@@ -367,7 +367,7 @@  discard block
 block discarded – undo
367 367
 	 * @param string[] $ids List of product IDs
368 368
 	 * @return \Aimeos\MShop\Product\Item\Iface[] List of product items
369 369
 	 */
370
-	protected function getProductItems( array $ids )
370
+	protected function getProductItems(array $ids)
371 371
 	{
372 372
 		$context = $this->getContext();
373 373
 		$config = $context->getConfig();
@@ -387,11 +387,11 @@  discard block
 block discarded – undo
387 387
 		 * @since 2014.09
388 388
 		 * @category Developer
389 389
 		 */
390
-		$domains = array( 'text', 'price', 'media' );
391
-		$domains = $config->get( 'client/html/basket/related/bought/standard/domains', $domains );
390
+		$domains = array('text', 'price', 'media');
391
+		$domains = $config->get('client/html/basket/related/bought/standard/domains', $domains);
392 392
 
393
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
393
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
394 394
 
395
-		return $controller->getProductItems( $ids, $domains );
395
+		return $controller->getProductItems($ids, $domains);
396 396
 	}
397 397
 }
398 398
\ No newline at end of file
Please login to merge, or discard this patch.
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
110 110
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111 111
 	 * @param array &$tags Result array for the list of tags that are associated to the output
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
113
+	 * @return string String including HTML tags for the header on error
114 114
 	 */
115 115
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116 116
 	{
Please login to merge, or discard this patch.