Completed
Push — master ( 37ef18...cbde41 )
by Aimeos
06:05
created
client/html/src/Client/Html/Account/History/Order/Coupon/Standard.php 3 patches
Indentation   +226 added lines, -226 removed lines patch added patch discarded remove patch
@@ -19,231 +19,231 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Summary\Coupon\Base
22
+    extends \Aimeos\Client\Html\Common\Summary\Coupon\Base
23 23
 {
24
-	/** client/html/account/history/order/coupon/standard/subparts
25
-	 * List of HTML sub-clients rendered within the account history order coupon 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 2015.11
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/account/history/order/coupon/standard/subparts';
58
-	private $subPartNames = array();
59
-
60
-
61
-	/**
62
-	 * Returns the HTML code for insertion into the body.
63
-	 *
64
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
65
-	 * @param array &$tags Result array for the list of tags that are associated to the output
66
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67
-	 * @return string HTML code
68
-	*/
69
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
-	{
71
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
72
-
73
-		$html = '';
74
-		foreach( $this->getSubClients() as $subclient ) {
75
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
76
-		}
77
-		$view->couponBody = $html;
78
-
79
-		/** client/html/account/history/order/coupon/standard/template-body
80
-		 * Relative path to the HTML body template of the account history order coupon client.
81
-		 *
82
-		 * The template file contains the HTML code and processing instructions
83
-		 * to generate the result shown in the body of the frontend. The
84
-		 * configuration string is the path to the template file relative
85
-		 * to the templates directory (usually in client/html/templates).
86
-		 *
87
-		 * You can overwrite the template file configuration in extensions and
88
-		 * provide alternative templates. These alternative templates should be
89
-		 * named like the default one but with the string "standard" replaced by
90
-		 * an unique name. You may use the name of your project for this. If
91
-		 * you've implemented an alternative client class as well, "standard"
92
-		 * (second one) should be replaced by the name of the new class in lower
93
-		 * case.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2015.11
97
-		 * @category Developer
98
-		 * @see client/html/account/history/order/coupon/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/account/history/order/coupon/standard/template-body';
101
-		$default = 'common/summary/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/account/history/order/coupon/standard/template-header
126
-		 * Relative path to the HTML header template of the account history order 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
-		 * (second one) should be replaced by the name of the new class in lower
140
-		 * case.
141
-		 *
142
-		 * @param string Relative path to the template creating code for the HTML page head
143
-		 * @since 2015.11
144
-		 * @category Developer
145
-		 * @see client/html/account/history/order/coupon/standard/template-body
146
-		 */
147
-		$tplconf = 'client/html/account/history/order/coupon/standard/template-header';
148
-		$default = 'common/summary/coupon-header-default.php';
149
-
150
-		return $view->render( $view->config( $tplconf, $default ) );
151
-	}
152
-
153
-
154
-	/**
155
-	 * Returns the sub-client given by its name.
156
-	 *
157
-	 * @param string $type Name of the client type
158
-	 * @param string|null $name Name of the sub-client (Default if null)
159
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
160
-	 */
161
-	public function getSubClient( $type, $name = null )
162
-	{
163
-		/** client/html/account/history/order/coupon/decorators/excludes
164
-		 * Excludes decorators added by the "common" option from the account history order coupon html client
165
-		 *
166
-		 * Decorators extend the functionality of a class by adding new aspects
167
-		 * (e.g. log what is currently done), executing the methods of the underlying
168
-		 * class only in certain conditions (e.g. only for logged in users) or
169
-		 * modify what is returned to the caller.
170
-		 *
171
-		 * This option allows you to remove a decorator added via
172
-		 * "client/html/common/decorators/default" before they are wrapped
173
-		 * around the html client.
174
-		 *
175
-		 *  client/html/account/history/order/coupon/decorators/excludes = array( 'decorator1' )
176
-		 *
177
-		 * This would remove the decorator named "decorator1" from the list of
178
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
179
-		 * "client/html/common/decorators/default" to the html client.
180
-		 *
181
-		 * @param array List of decorator names
182
-		 * @since 2015.08
183
-		 * @category Developer
184
-		 * @see client/html/common/decorators/default
185
-		 * @see client/html/account/history/order/coupon/decorators/global
186
-		 * @see client/html/account/history/order/coupon/decorators/local
187
-		 */
188
-
189
-		/** client/html/account/history/order/coupon/decorators/global
190
-		 * Adds a list of globally available decorators only to the account history order coupon html client
191
-		 *
192
-		 * Decorators extend the functionality of a class by adding new aspects
193
-		 * (e.g. log what is currently done), executing the methods of the underlying
194
-		 * class only in certain conditions (e.g. only for logged in users) or
195
-		 * modify what is returned to the caller.
196
-		 *
197
-		 * This option allows you to wrap global decorators
198
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
199
-		 *
200
-		 *  client/html/account/history/order/coupon/decorators/global = array( 'decorator1' )
201
-		 *
202
-		 * This would add the decorator named "decorator1" defined by
203
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
204
-		 *
205
-		 * @param array List of decorator names
206
-		 * @since 2015.08
207
-		 * @category Developer
208
-		 * @see client/html/common/decorators/default
209
-		 * @see client/html/account/history/order/coupon/decorators/excludes
210
-		 * @see client/html/account/history/order/coupon/decorators/local
211
-		 */
212
-
213
-		/** client/html/account/history/order/coupon/decorators/local
214
-		 * Adds a list of local decorators only to the account history order coupon html client
215
-		 *
216
-		 * Decorators extend the functionality of a class by adding new aspects
217
-		 * (e.g. log what is currently done), executing the methods of the underlying
218
-		 * class only in certain conditions (e.g. only for logged in users) or
219
-		 * modify what is returned to the caller.
220
-		 *
221
-		 * This option allows you to wrap local decorators
222
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
223
-		 *
224
-		 *  client/html/account/history/order/coupon/decorators/local = array( 'decorator2' )
225
-		 *
226
-		 * This would add the decorator named "decorator2" defined by
227
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
228
-		 *
229
-		 * @param array List of decorator names
230
-		 * @since 2015.08
231
-		 * @category Developer
232
-		 * @see client/html/common/decorators/default
233
-		 * @see client/html/account/history/order/coupon/decorators/excludes
234
-		 * @see client/html/account/history/order/coupon/decorators/global
235
-		 */
236
-		return $this->createSubClient( 'account/history/order/coupon/' . $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
-	}
24
+    /** client/html/account/history/order/coupon/standard/subparts
25
+     * List of HTML sub-clients rendered within the account history order coupon 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 2015.11
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/account/history/order/coupon/standard/subparts';
58
+    private $subPartNames = array();
59
+
60
+
61
+    /**
62
+     * Returns the HTML code for insertion into the body.
63
+     *
64
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
65
+     * @param array &$tags Result array for the list of tags that are associated to the output
66
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67
+     * @return string HTML code
68
+     */
69
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
+    {
71
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
72
+
73
+        $html = '';
74
+        foreach( $this->getSubClients() as $subclient ) {
75
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
76
+        }
77
+        $view->couponBody = $html;
78
+
79
+        /** client/html/account/history/order/coupon/standard/template-body
80
+         * Relative path to the HTML body template of the account history order coupon client.
81
+         *
82
+         * The template file contains the HTML code and processing instructions
83
+         * to generate the result shown in the body of the frontend. The
84
+         * configuration string is the path to the template file relative
85
+         * to the templates directory (usually in client/html/templates).
86
+         *
87
+         * You can overwrite the template file configuration in extensions and
88
+         * provide alternative templates. These alternative templates should be
89
+         * named like the default one but with the string "standard" replaced by
90
+         * an unique name. You may use the name of your project for this. If
91
+         * you've implemented an alternative client class as well, "standard"
92
+         * (second one) should be replaced by the name of the new class in lower
93
+         * case.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2015.11
97
+         * @category Developer
98
+         * @see client/html/account/history/order/coupon/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/account/history/order/coupon/standard/template-body';
101
+        $default = 'common/summary/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/account/history/order/coupon/standard/template-header
126
+         * Relative path to the HTML header template of the account history order 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
+         * (second one) should be replaced by the name of the new class in lower
140
+         * case.
141
+         *
142
+         * @param string Relative path to the template creating code for the HTML page head
143
+         * @since 2015.11
144
+         * @category Developer
145
+         * @see client/html/account/history/order/coupon/standard/template-body
146
+         */
147
+        $tplconf = 'client/html/account/history/order/coupon/standard/template-header';
148
+        $default = 'common/summary/coupon-header-default.php';
149
+
150
+        return $view->render( $view->config( $tplconf, $default ) );
151
+    }
152
+
153
+
154
+    /**
155
+     * Returns the sub-client given by its name.
156
+     *
157
+     * @param string $type Name of the client type
158
+     * @param string|null $name Name of the sub-client (Default if null)
159
+     * @return \Aimeos\Client\Html\Iface Sub-client object
160
+     */
161
+    public function getSubClient( $type, $name = null )
162
+    {
163
+        /** client/html/account/history/order/coupon/decorators/excludes
164
+         * Excludes decorators added by the "common" option from the account history order coupon html client
165
+         *
166
+         * Decorators extend the functionality of a class by adding new aspects
167
+         * (e.g. log what is currently done), executing the methods of the underlying
168
+         * class only in certain conditions (e.g. only for logged in users) or
169
+         * modify what is returned to the caller.
170
+         *
171
+         * This option allows you to remove a decorator added via
172
+         * "client/html/common/decorators/default" before they are wrapped
173
+         * around the html client.
174
+         *
175
+         *  client/html/account/history/order/coupon/decorators/excludes = array( 'decorator1' )
176
+         *
177
+         * This would remove the decorator named "decorator1" from the list of
178
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
179
+         * "client/html/common/decorators/default" to the html client.
180
+         *
181
+         * @param array List of decorator names
182
+         * @since 2015.08
183
+         * @category Developer
184
+         * @see client/html/common/decorators/default
185
+         * @see client/html/account/history/order/coupon/decorators/global
186
+         * @see client/html/account/history/order/coupon/decorators/local
187
+         */
188
+
189
+        /** client/html/account/history/order/coupon/decorators/global
190
+         * Adds a list of globally available decorators only to the account history order coupon html client
191
+         *
192
+         * Decorators extend the functionality of a class by adding new aspects
193
+         * (e.g. log what is currently done), executing the methods of the underlying
194
+         * class only in certain conditions (e.g. only for logged in users) or
195
+         * modify what is returned to the caller.
196
+         *
197
+         * This option allows you to wrap global decorators
198
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
199
+         *
200
+         *  client/html/account/history/order/coupon/decorators/global = array( 'decorator1' )
201
+         *
202
+         * This would add the decorator named "decorator1" defined by
203
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
204
+         *
205
+         * @param array List of decorator names
206
+         * @since 2015.08
207
+         * @category Developer
208
+         * @see client/html/common/decorators/default
209
+         * @see client/html/account/history/order/coupon/decorators/excludes
210
+         * @see client/html/account/history/order/coupon/decorators/local
211
+         */
212
+
213
+        /** client/html/account/history/order/coupon/decorators/local
214
+         * Adds a list of local decorators only to the account history order coupon html client
215
+         *
216
+         * Decorators extend the functionality of a class by adding new aspects
217
+         * (e.g. log what is currently done), executing the methods of the underlying
218
+         * class only in certain conditions (e.g. only for logged in users) or
219
+         * modify what is returned to the caller.
220
+         *
221
+         * This option allows you to wrap local decorators
222
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
223
+         *
224
+         *  client/html/account/history/order/coupon/decorators/local = array( 'decorator2' )
225
+         *
226
+         * This would add the decorator named "decorator2" defined by
227
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
228
+         *
229
+         * @param array List of decorator names
230
+         * @since 2015.08
231
+         * @category Developer
232
+         * @see client/html/common/decorators/default
233
+         * @see client/html/account/history/order/coupon/decorators/excludes
234
+         * @see client/html/account/history/order/coupon/decorators/global
235
+         */
236
+        return $this->createSubClient( 'account/history/order/coupon/' . $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 249
 }
250 250
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -66,13 +66,13 @@  discard block
 block discarded – undo
66 66
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67 67
 	 * @return string HTML code
68 68
 	*/
69
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
69
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
70 70
 	{
71
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
71
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
72 72
 
73 73
 		$html = '';
74
-		foreach( $this->getSubClients() as $subclient ) {
75
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
74
+		foreach ($this->getSubClients() as $subclient) {
75
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
76 76
 		}
77 77
 		$view->couponBody = $html;
78 78
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/account/history/order/coupon/standard/template-body';
101 101
 		$default = 'common/summary/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
 
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
 		$tplconf = 'client/html/account/history/order/coupon/standard/template-header';
148 148
 		$default = 'common/summary/coupon-header-default.php';
149 149
 
150
-		return $view->render( $view->config( $tplconf, $default ) );
150
+		return $view->render($view->config($tplconf, $default));
151 151
 	}
152 152
 
153 153
 
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
158 158
 	 * @param string|null $name Name of the sub-client (Default if null)
159 159
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
160 160
 	 */
161
-	public function getSubClient( $type, $name = null )
161
+	public function getSubClient($type, $name = null)
162 162
 	{
163 163
 		/** client/html/account/history/order/coupon/decorators/excludes
164 164
 		 * Excludes decorators added by the "common" option from the account history order coupon html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/account/history/order/coupon/decorators/excludes
234 234
 		 * @see client/html/account/history/order/coupon/decorators/global
235 235
 		 */
236
-		return $this->createSubClient( 'account/history/order/coupon/' . $type, $name );
236
+		return $this->createSubClient('account/history/order/coupon/'.$type, $name);
237 237
 	}
238 238
 
239 239
 
@@ -244,6 +244,6 @@  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
\ 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/Account/History/Order/Detail/Standard.php 3 patches
Indentation   +232 added lines, -232 removed lines patch added patch discarded remove patch
@@ -19,259 +19,259 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Summary\Detail\Base
22
+    extends \Aimeos\Client\Html\Common\Summary\Detail\Base
23 23
 {
24
-	/** client/html/account/history/order/detail/standard/subparts
25
-	 * List of HTML sub-clients rendered within the account history order detail 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 2015.11
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/account/history/order/detail/standard/subparts';
58
-	private $subPartNames = array();
59
-	private $cache;
24
+    /** client/html/account/history/order/detail/standard/subparts
25
+     * List of HTML sub-clients rendered within the account history order detail 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 2015.11
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/account/history/order/detail/standard/subparts';
58
+    private $subPartNames = array();
59
+    private $cache;
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->detailBody = $html;
74
+        $html = '';
75
+        foreach( $this->getSubClients() as $subclient ) {
76
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+        }
78
+        $view->detailBody = $html;
79 79
 
80
-		/** client/html/account/history/order/detail/standard/template-body
81
-		 * Relative path to the HTML body template of the account history order detail 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
-		 * (second one) should be replaced by the name of the new class in lower
94
-		 * case.
95
-		 *
96
-		 * @param string Relative path to the template creating code for the HTML page body
97
-		 * @since 2015.11
98
-		 * @category Developer
99
-		 * @see client/html/account/history/order/detail/standard/template-header
100
-		 */
101
-		$tplconf = 'client/html/account/history/order/detail/standard/template-body';
102
-		$default = 'common/summary/detail-body-default.php';
80
+        /** client/html/account/history/order/detail/standard/template-body
81
+         * Relative path to the HTML body template of the account history order detail 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
+         * (second one) should be replaced by the name of the new class in lower
94
+         * case.
95
+         *
96
+         * @param string Relative path to the template creating code for the HTML page body
97
+         * @since 2015.11
98
+         * @category Developer
99
+         * @see client/html/account/history/order/detail/standard/template-header
100
+         */
101
+        $tplconf = 'client/html/account/history/order/detail/standard/template-body';
102
+        $default = 'common/summary/detail-body-default.php';
103 103
 
104
-		return $view->render( $view->config( $tplconf, $default ) );
105
-	}
104
+        return $view->render( $view->config( $tplconf, $default ) );
105
+    }
106 106
 
107 107
 
108
-	/**
109
-	 * Returns the HTML string for insertion into the header.
110
-	 *
111
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
-	 * @param array &$tags Result array for the list of tags that are associated to the output
113
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
-	 * @return string|null String including HTML tags for the header on error
115
-	 */
116
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
-	{
118
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
108
+    /**
109
+     * Returns the HTML string for insertion into the header.
110
+     *
111
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
+     * @param array &$tags Result array for the list of tags that are associated to the output
113
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
+     * @return string|null String including HTML tags for the header on error
115
+     */
116
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
+    {
118
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
119 119
 
120
-		$html = '';
121
-		foreach( $this->getSubClients() as $subclient ) {
122
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
-		}
124
-		$view->detailHeader = $html;
120
+        $html = '';
121
+        foreach( $this->getSubClients() as $subclient ) {
122
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
+        }
124
+        $view->detailHeader = $html;
125 125
 
126
-		/** client/html/account/history/order/detail/standard/template-header
127
-		 * Relative path to the HTML header template of the account history order detail client.
128
-		 *
129
-		 * The template file contains the HTML code and processing instructions
130
-		 * to generate the HTML code that is inserted into the HTML page header
131
-		 * of the rendered page in the frontend. The configuration string is the
132
-		 * path to the template file relative to the templates directory (usually
133
-		 * in client/html/templates).
134
-		 *
135
-		 * You can overwrite the template file configuration in extensions and
136
-		 * provide alternative templates. These alternative templates should be
137
-		 * named like the default one but with the string "standard" replaced by
138
-		 * an unique name. You may use the name of your project for this. If
139
-		 * you've implemented an alternative client class as well, "standard"
140
-		 * (second one) should be replaced by the name of the new class in lower
141
-		 * case.
142
-		 *
143
-		 * @param string Relative path to the template creating code for the HTML page head
144
-		 * @since 2015.11
145
-		 * @category Developer
146
-		 * @see client/html/account/history/order/detail/standard/template-body
147
-		 */
148
-		$tplconf = 'client/html/account/history/order/detail/standard/template-header';
149
-		$default = 'common/summary/detail-header-default.php';
126
+        /** client/html/account/history/order/detail/standard/template-header
127
+         * Relative path to the HTML header template of the account history order detail client.
128
+         *
129
+         * The template file contains the HTML code and processing instructions
130
+         * to generate the HTML code that is inserted into the HTML page header
131
+         * of the rendered page in the frontend. The configuration string is the
132
+         * path to the template file relative to the templates directory (usually
133
+         * in client/html/templates).
134
+         *
135
+         * You can overwrite the template file configuration in extensions and
136
+         * provide alternative templates. These alternative templates should be
137
+         * named like the default one but with the string "standard" replaced by
138
+         * an unique name. You may use the name of your project for this. If
139
+         * you've implemented an alternative client class as well, "standard"
140
+         * (second one) should be replaced by the name of the new class in lower
141
+         * case.
142
+         *
143
+         * @param string Relative path to the template creating code for the HTML page head
144
+         * @since 2015.11
145
+         * @category Developer
146
+         * @see client/html/account/history/order/detail/standard/template-body
147
+         */
148
+        $tplconf = 'client/html/account/history/order/detail/standard/template-header';
149
+        $default = 'common/summary/detail-header-default.php';
150 150
 
151
-		return $view->render( $view->config( $tplconf, $default ) );
152
-	}
151
+        return $view->render( $view->config( $tplconf, $default ) );
152
+    }
153 153
 
154 154
 
155
-	/**
156
-	 * Returns the sub-client given by its name.
157
-	 *
158
-	 * @param string $type Name of the client type
159
-	 * @param string|null $name Name of the sub-client (Default if null)
160
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
161
-	 */
162
-	public function getSubClient( $type, $name = null )
163
-	{
164
-		/** client/html/account/history/order/detail/decorators/excludes
165
-		 * Excludes decorators added by the "common" option from the account history order detail html client
166
-		 *
167
-		 * Decorators extend the functionality of a class by adding new aspects
168
-		 * (e.g. log what is currently done), executing the methods of the underlying
169
-		 * class only in certain conditions (e.g. only for logged in users) or
170
-		 * modify what is returned to the caller.
171
-		 *
172
-		 * This option allows you to remove a decorator added via
173
-		 * "client/html/common/decorators/default" before they are wrapped
174
-		 * around the html client.
175
-		 *
176
-		 *  client/html/account/history/order/detail/decorators/excludes = array( 'decorator1' )
177
-		 *
178
-		 * This would remove the decorator named "decorator1" from the list of
179
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
180
-		 * "client/html/common/decorators/default" to the html client.
181
-		 *
182
-		 * @param array List of decorator names
183
-		 * @since 2015.08
184
-		 * @category Developer
185
-		 * @see client/html/common/decorators/default
186
-		 * @see client/html/account/history/order/detail/decorators/global
187
-		 * @see client/html/account/history/order/detail/decorators/local
188
-		 */
155
+    /**
156
+     * Returns the sub-client given by its name.
157
+     *
158
+     * @param string $type Name of the client type
159
+     * @param string|null $name Name of the sub-client (Default if null)
160
+     * @return \Aimeos\Client\Html\Iface Sub-client object
161
+     */
162
+    public function getSubClient( $type, $name = null )
163
+    {
164
+        /** client/html/account/history/order/detail/decorators/excludes
165
+         * Excludes decorators added by the "common" option from the account history order detail html client
166
+         *
167
+         * Decorators extend the functionality of a class by adding new aspects
168
+         * (e.g. log what is currently done), executing the methods of the underlying
169
+         * class only in certain conditions (e.g. only for logged in users) or
170
+         * modify what is returned to the caller.
171
+         *
172
+         * This option allows you to remove a decorator added via
173
+         * "client/html/common/decorators/default" before they are wrapped
174
+         * around the html client.
175
+         *
176
+         *  client/html/account/history/order/detail/decorators/excludes = array( 'decorator1' )
177
+         *
178
+         * This would remove the decorator named "decorator1" from the list of
179
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
180
+         * "client/html/common/decorators/default" to the html client.
181
+         *
182
+         * @param array List of decorator names
183
+         * @since 2015.08
184
+         * @category Developer
185
+         * @see client/html/common/decorators/default
186
+         * @see client/html/account/history/order/detail/decorators/global
187
+         * @see client/html/account/history/order/detail/decorators/local
188
+         */
189 189
 
190
-		/** client/html/account/history/order/detail/decorators/global
191
-		 * Adds a list of globally available decorators only to the account history order detail html client
192
-		 *
193
-		 * Decorators extend the functionality of a class by adding new aspects
194
-		 * (e.g. log what is currently done), executing the methods of the underlying
195
-		 * class only in certain conditions (e.g. only for logged in users) or
196
-		 * modify what is returned to the caller.
197
-		 *
198
-		 * This option allows you to wrap global decorators
199
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
200
-		 *
201
-		 *  client/html/account/history/order/detail/decorators/global = array( 'decorator1' )
202
-		 *
203
-		 * This would add the decorator named "decorator1" defined by
204
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
205
-		 *
206
-		 * @param array List of decorator names
207
-		 * @since 2015.08
208
-		 * @category Developer
209
-		 * @see client/html/common/decorators/default
210
-		 * @see client/html/account/history/order/detail/decorators/excludes
211
-		 * @see client/html/account/history/order/detail/decorators/local
212
-		 */
190
+        /** client/html/account/history/order/detail/decorators/global
191
+         * Adds a list of globally available decorators only to the account history order detail html client
192
+         *
193
+         * Decorators extend the functionality of a class by adding new aspects
194
+         * (e.g. log what is currently done), executing the methods of the underlying
195
+         * class only in certain conditions (e.g. only for logged in users) or
196
+         * modify what is returned to the caller.
197
+         *
198
+         * This option allows you to wrap global decorators
199
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
200
+         *
201
+         *  client/html/account/history/order/detail/decorators/global = array( 'decorator1' )
202
+         *
203
+         * This would add the decorator named "decorator1" defined by
204
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
205
+         *
206
+         * @param array List of decorator names
207
+         * @since 2015.08
208
+         * @category Developer
209
+         * @see client/html/common/decorators/default
210
+         * @see client/html/account/history/order/detail/decorators/excludes
211
+         * @see client/html/account/history/order/detail/decorators/local
212
+         */
213 213
 
214
-		/** client/html/account/history/order/detail/decorators/local
215
-		 * Adds a list of local decorators only to the account history order detail html client
216
-		 *
217
-		 * Decorators extend the functionality of a class by adding new aspects
218
-		 * (e.g. log what is currently done), executing the methods of the underlying
219
-		 * class only in certain conditions (e.g. only for logged in users) or
220
-		 * modify what is returned to the caller.
221
-		 *
222
-		 * This option allows you to wrap local decorators
223
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
224
-		 *
225
-		 *  client/html/account/history/order/detail/decorators/local = array( 'decorator2' )
226
-		 *
227
-		 * This would add the decorator named "decorator2" defined by
228
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
229
-		 *
230
-		 * @param array List of decorator names
231
-		 * @since 2015.08
232
-		 * @category Developer
233
-		 * @see client/html/common/decorators/default
234
-		 * @see client/html/account/history/order/detail/decorators/excludes
235
-		 * @see client/html/account/history/order/detail/decorators/global
236
-		 */
237
-		return $this->createSubClient( 'account/history/order/detail/' . $type, $name );
238
-	}
214
+        /** client/html/account/history/order/detail/decorators/local
215
+         * Adds a list of local decorators only to the account history order detail html client
216
+         *
217
+         * Decorators extend the functionality of a class by adding new aspects
218
+         * (e.g. log what is currently done), executing the methods of the underlying
219
+         * class only in certain conditions (e.g. only for logged in users) or
220
+         * modify what is returned to the caller.
221
+         *
222
+         * This option allows you to wrap local decorators
223
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
224
+         *
225
+         *  client/html/account/history/order/detail/decorators/local = array( 'decorator2' )
226
+         *
227
+         * This would add the decorator named "decorator2" defined by
228
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
229
+         *
230
+         * @param array List of decorator names
231
+         * @since 2015.08
232
+         * @category Developer
233
+         * @see client/html/common/decorators/default
234
+         * @see client/html/account/history/order/detail/decorators/excludes
235
+         * @see client/html/account/history/order/detail/decorators/global
236
+         */
237
+        return $this->createSubClient( 'account/history/order/detail/' . $type, $name );
238
+    }
239 239
 
240 240
 
241
-	/**
242
-	 * Returns the list of sub-client names configured for the client.
243
-	 *
244
-	 * @return array List of HTML client names
245
-	 */
246
-	protected function getSubClientNames()
247
-	{
248
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
-	}
241
+    /**
242
+     * Returns the list of sub-client names configured for the client.
243
+     *
244
+     * @return array List of HTML client names
245
+     */
246
+    protected function getSubClientNames()
247
+    {
248
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
+    }
250 250
 
251 251
 
252
-	/**
253
-	 * Sets the necessary parameter values in the view.
254
-	 *
255
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
256
-	 * @param array &$tags Result array for the list of tags that are associated to the output
257
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
258
-	 * @return \Aimeos\MW\View\Iface Modified view object
259
-	 */
260
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
261
-	{
262
-		if( !isset( $this->cache ) )
263
-		{
264
-			$view = parent::setViewParams( $view );
252
+    /**
253
+     * Sets the necessary parameter values in the view.
254
+     *
255
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
256
+     * @param array &$tags Result array for the list of tags that are associated to the output
257
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
258
+     * @return \Aimeos\MW\View\Iface Modified view object
259
+     */
260
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
261
+    {
262
+        if( !isset( $this->cache ) )
263
+        {
264
+            $view = parent::setViewParams( $view );
265 265
 
266
-			if( $view->orderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
267
-				$view->summaryShowDownloadAttributes = true;
268
-			}
266
+            if( $view->orderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
267
+                $view->summaryShowDownloadAttributes = true;
268
+            }
269 269
 
270
-			$view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
270
+            $view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
271 271
 
272
-			$this->cache = $view;
273
-		}
272
+            $this->cache = $view;
273
+        }
274 274
 
275
-		return $this->cache;
276
-	}
275
+        return $this->cache;
276
+    }
277 277
 }
278 278
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +18 added lines, -18 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->detailBody = $html;
79 79
 
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
 		$tplconf = 'client/html/account/history/order/detail/standard/template-body';
102 102
 		$default = 'common/summary/detail-body-default.php';
103 103
 
104
-		return $view->render( $view->config( $tplconf, $default ) );
104
+		return $view->render($view->config($tplconf, $default));
105 105
 	}
106 106
 
107 107
 
@@ -113,13 +113,13 @@  discard block
 block discarded – undo
113 113
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114 114
 	 * @return string|null String including HTML tags for the header on error
115 115
 	 */
116
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
117 117
 	{
118
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
118
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
119 119
 
120 120
 		$html = '';
121
-		foreach( $this->getSubClients() as $subclient ) {
122
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
121
+		foreach ($this->getSubClients() as $subclient) {
122
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
123 123
 		}
124 124
 		$view->detailHeader = $html;
125 125
 
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 		$tplconf = 'client/html/account/history/order/detail/standard/template-header';
149 149
 		$default = 'common/summary/detail-header-default.php';
150 150
 
151
-		return $view->render( $view->config( $tplconf, $default ) );
151
+		return $view->render($view->config($tplconf, $default));
152 152
 	}
153 153
 
154 154
 
@@ -159,7 +159,7 @@  discard block
 block discarded – undo
159 159
 	 * @param string|null $name Name of the sub-client (Default if null)
160 160
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
161 161
 	 */
162
-	public function getSubClient( $type, $name = null )
162
+	public function getSubClient($type, $name = null)
163 163
 	{
164 164
 		/** client/html/account/history/order/detail/decorators/excludes
165 165
 		 * Excludes decorators added by the "common" option from the account history order detail html client
@@ -234,7 +234,7 @@  discard block
 block discarded – undo
234 234
 		 * @see client/html/account/history/order/detail/decorators/excludes
235 235
 		 * @see client/html/account/history/order/detail/decorators/global
236 236
 		 */
237
-		return $this->createSubClient( 'account/history/order/detail/' . $type, $name );
237
+		return $this->createSubClient('account/history/order/detail/'.$type, $name);
238 238
 	}
239 239
 
240 240
 
@@ -245,7 +245,7 @@  discard block
 block discarded – undo
245 245
 	 */
246 246
 	protected function getSubClientNames()
247 247
 	{
248
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
248
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
249 249
 	}
250 250
 
251 251
 
@@ -257,17 +257,17 @@  discard block
 block discarded – undo
257 257
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
258 258
 	 * @return \Aimeos\MW\View\Iface Modified view object
259 259
 	 */
260
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
260
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
261 261
 	{
262
-		if( !isset( $this->cache ) )
262
+		if (!isset($this->cache))
263 263
 		{
264
-			$view = parent::setViewParams( $view );
264
+			$view = parent::setViewParams($view);
265 265
 
266
-			if( $view->orderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
266
+			if ($view->orderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus()) {
267 267
 				$view->summaryShowDownloadAttributes = true;
268 268
 			}
269 269
 
270
-			$view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
270
+			$view->summaryTaxRates = $this->getTaxRates($view->summaryBasket);
271 271
 
272 272
 			$this->cache = $view;
273 273
 		}
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/Account/History/Order/Standard.php 3 patches
Indentation   +331 added lines, -331 removed lines patch added patch discarded remove patch
@@ -19,336 +19,336 @@
 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/account/history/order/standard/subparts
26
-	 * List of HTML sub-clients rendered within the account history order 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.02
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/account/history/order/standard/subparts';
59
-
60
-	/** client/html/account/history/order/address/name
61
-	 * Name of the address part used by the account history order client implementation
62
-	 *
63
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Address\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 2015.02
68
-	 * @category Developer
69
-	 */
70
-
71
-	/** client/html/account/history/order/service/name
72
-	 * Name of the service part used by the account history order client implementation
73
-	 *
74
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Service\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 2015.02
79
-	 * @category Developer
80
-	 */
81
-
82
-	/** client/html/account/history/order/coupon/name
83
-	 * Name of the coupon part used by the account history order client implementation
84
-	 *
85
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Coupon\Myname".
86
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
87
-	 *
88
-	 * @param string Last part of the client class name
89
-	 * @since 2015.02
90
-	 * @category Developer
91
-	 */
92
-
93
-	/** client/html/account/history/order/detail/name
94
-	 * Name of the detail part used by the account history order client implementation
95
-	 *
96
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Detail\Myname".
97
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
98
-	 *
99
-	 * @param string Last part of the client class name
100
-	 * @since 2015.02
101
-	 * @category Developer
102
-	 */
103
-	private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
104
-
105
-	private $cache;
106
-
107
-
108
-	/**
109
-	 * Returns the HTML code for insertion into the body.
110
-	 *
111
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
-	 * @param array &$tags Result array for the list of tags that are associated to the output
113
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
-	 * @return string HTML code
115
-	 */
116
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
117
-	{
118
-		$view = $this->getView();
119
-
120
-		if( $view->param( 'his_action' ) != 'order' ) {
121
-			return '';
122
-		}
123
-
124
-		$view = $this->setViewParams( $view, $tags, $expire );
125
-
126
-		$html = '';
127
-		foreach( $this->getSubClients() as $subclient ) {
128
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
129
-		}
130
-		$view->orderBody = $html;
131
-
132
-		/** client/html/account/history/order/standard/template-body
133
-		 * Relative path to the HTML body template of the account history order client.
134
-		 *
135
-		 * The template file contains the HTML code and processing instructions
136
-		 * to generate the result shown in the body of the frontend. The
137
-		 * configuration string is the path to the template file relative
138
-		 * to the templates directory (usually in client/html/templates).
139
-		 *
140
-		 * You can overwrite the template file configuration in extensions and
141
-		 * provide alternative templates. These alternative templates should be
142
-		 * named like the default one but with the string "standard" replaced by
143
-		 * an unique name. You may use the name of your project for this. If
144
-		 * you've implemented an alternative client class as well, "standard"
145
-		 * should be replaced by the name of the new class.
146
-		 *
147
-		 * @param string Relative path to the template creating code for the HTML page body
148
-		 * @since 2015.02
149
-		 * @category Developer
150
-		 * @see client/html/account/history/order/standard/template-header
151
-		 */
152
-		$tplconf = 'client/html/account/history/order/standard/template-body';
153
-		$default = 'account/history/order-body-default.php';
154
-
155
-		return $view->render( $view->config( $tplconf, $default ) );
156
-	}
157
-
158
-
159
-	/**
160
-	 * Returns the HTML string for insertion into the header.
161
-	 *
162
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
163
-	 * @param array &$tags Result array for the list of tags that are associated to the output
164
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
165
-	 * @return string|null String including HTML tags for the header on error
166
-	 */
167
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
168
-	{
169
-		$view = $this->getView();
170
-
171
-		if( $view->param( 'his_action' ) != 'order' ) {
172
-			return '';
173
-		}
174
-
175
-		$view = $this->setViewParams( $view, $tags, $expire );
176
-
177
-		$html = '';
178
-		foreach( $this->getSubClients() as $subclient ) {
179
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
180
-		}
181
-		$view->orderHeader = $html;
182
-
183
-		/** client/html/account/history/order/standard/template-header
184
-		 * Relative path to the HTML header template of the account history order client.
185
-		 *
186
-		 * The template file contains the HTML code and processing instructions
187
-		 * to generate the HTML code that is inserted into the HTML page header
188
-		 * of the rendered page in the frontend. The configuration string is the
189
-		 * path to the template file relative to the templates directory (usually
190
-		 * in client/html/templates).
191
-		 *
192
-		 * You can overwrite the template file configuration in extensions and
193
-		 * provide alternative templates. These alternative templates should be
194
-		 * named like the default one but with the string "standard" replaced by
195
-		 * an unique name. You may use the name of your project for this. If
196
-		 * you've implemented an alternative client class as well, "standard"
197
-		 * should be replaced by the name of the new class.
198
-		 *
199
-		 * @param string Relative path to the template creating code for the HTML page head
200
-		 * @since 2015.02
201
-		 * @category Developer
202
-		 * @see client/html/account/history/order/standard/template-body
203
-		 */
204
-		$tplconf = 'client/html/account/history/order/standard/template-header';
205
-		$default = 'account/history/order-header-default.php';
206
-
207
-		return $view->render( $view->config( $tplconf, $default ) );
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/account/history/order/decorators/excludes
221
-		 * Excludes decorators added by the "common" option from the account history order 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/account/history/order/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 2015.08
240
-		 * @category Developer
241
-		 * @see client/html/common/decorators/default
242
-		 * @see client/html/account/history/order/decorators/global
243
-		 * @see client/html/account/history/order/decorators/local
244
-		 */
245
-
246
-		/** client/html/account/history/order/decorators/global
247
-		 * Adds a list of globally available decorators only to the account history order 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/account/history/order/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 2015.08
264
-		 * @category Developer
265
-		 * @see client/html/common/decorators/default
266
-		 * @see client/html/account/history/order/decorators/excludes
267
-		 * @see client/html/account/history/order/decorators/local
268
-		 */
269
-
270
-		/** client/html/account/history/order/decorators/local
271
-		 * Adds a list of local decorators only to the account history order 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\Account\Decorator\*") around the html client.
280
-		 *
281
-		 *  client/html/account/history/order/decorators/local = array( 'decorator2' )
282
-		 *
283
-		 * This would add the decorator named "decorator2" defined by
284
-		 * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
285
-		 *
286
-		 * @param array List of decorator names
287
-		 * @since 2015.08
288
-		 * @category Developer
289
-		 * @see client/html/common/decorators/default
290
-		 * @see client/html/account/history/order/decorators/excludes
291
-		 * @see client/html/account/history/order/decorators/global
292
-		 */
293
-
294
-		return $this->createSubClient( 'account/history/order/' . $type, $name );
295
-	}
296
-
297
-
298
-	/**
299
-	 * Returns the list of sub-client names configured for the client.
300
-	 *
301
-	 * @return array List of HTML client names
302
-	 */
303
-	protected function getSubClientNames()
304
-	{
305
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
306
-	}
307
-
308
-
309
-	/**
310
-	 * Sets the necessary parameter values in the view.
311
-	 *
312
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
313
-	 * @param array &$tags Result array for the list of tags that are associated to the output
314
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
315
-	 * @return \Aimeos\MW\View\Iface Modified view object
316
-	 */
317
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
318
-	{
319
-		if( !isset( $this->cache ) )
320
-		{
321
-			$context = $this->getContext();
322
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
323
-
324
-			$orderId = $view->param( 'his_id', null );
325
-
326
-			if( $orderId !== null )
327
-			{
328
-				$search = $manager->createSearch( true );
329
-				$expr = array(
330
-					$search->getConditions(),
331
-					$search->compare( '==', 'order.id', $orderId ),
332
-					$search->compare( '==', 'order.base.customerid', $context->getUserId() ),
333
-				);
334
-				$search->setConditions( $search->combine( '&&', $expr ) );
335
-
336
-				$orderItems = $manager->searchItems( $search );
337
-
338
-				if( ( $orderItem = reset( $orderItems ) ) === false )
339
-				{
340
-					$msg = $view->translate( 'client', 'Order with ID "%1$s" not found' );
341
-					throw new \Aimeos\Client\Html\Exception( sprintf( $msg, $orderId ) );
342
-				}
343
-
344
-				$baseManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
345
-				$view->summaryBasket = $baseManager->load( $orderItem->getBaseId() );
346
-				$view->orderItem = $orderItem;
347
-			}
348
-
349
-			$this->cache = $view;
350
-		}
351
-
352
-		return $this->cache;
353
-	}
25
+    /** client/html/account/history/order/standard/subparts
26
+     * List of HTML sub-clients rendered within the account history order 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.02
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/account/history/order/standard/subparts';
59
+
60
+    /** client/html/account/history/order/address/name
61
+     * Name of the address part used by the account history order client implementation
62
+     *
63
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Address\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 2015.02
68
+     * @category Developer
69
+     */
70
+
71
+    /** client/html/account/history/order/service/name
72
+     * Name of the service part used by the account history order client implementation
73
+     *
74
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Service\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 2015.02
79
+     * @category Developer
80
+     */
81
+
82
+    /** client/html/account/history/order/coupon/name
83
+     * Name of the coupon part used by the account history order client implementation
84
+     *
85
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Coupon\Myname".
86
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
87
+     *
88
+     * @param string Last part of the client class name
89
+     * @since 2015.02
90
+     * @category Developer
91
+     */
92
+
93
+    /** client/html/account/history/order/detail/name
94
+     * Name of the detail part used by the account history order client implementation
95
+     *
96
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Detail\Myname".
97
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
98
+     *
99
+     * @param string Last part of the client class name
100
+     * @since 2015.02
101
+     * @category Developer
102
+     */
103
+    private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
104
+
105
+    private $cache;
106
+
107
+
108
+    /**
109
+     * Returns the HTML code for insertion into the body.
110
+     *
111
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
+     * @param array &$tags Result array for the list of tags that are associated to the output
113
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
+     * @return string HTML code
115
+     */
116
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
117
+    {
118
+        $view = $this->getView();
119
+
120
+        if( $view->param( 'his_action' ) != 'order' ) {
121
+            return '';
122
+        }
123
+
124
+        $view = $this->setViewParams( $view, $tags, $expire );
125
+
126
+        $html = '';
127
+        foreach( $this->getSubClients() as $subclient ) {
128
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
129
+        }
130
+        $view->orderBody = $html;
131
+
132
+        /** client/html/account/history/order/standard/template-body
133
+         * Relative path to the HTML body template of the account history order client.
134
+         *
135
+         * The template file contains the HTML code and processing instructions
136
+         * to generate the result shown in the body of the frontend. The
137
+         * configuration string is the path to the template file relative
138
+         * to the templates directory (usually in client/html/templates).
139
+         *
140
+         * You can overwrite the template file configuration in extensions and
141
+         * provide alternative templates. These alternative templates should be
142
+         * named like the default one but with the string "standard" replaced by
143
+         * an unique name. You may use the name of your project for this. If
144
+         * you've implemented an alternative client class as well, "standard"
145
+         * should be replaced by the name of the new class.
146
+         *
147
+         * @param string Relative path to the template creating code for the HTML page body
148
+         * @since 2015.02
149
+         * @category Developer
150
+         * @see client/html/account/history/order/standard/template-header
151
+         */
152
+        $tplconf = 'client/html/account/history/order/standard/template-body';
153
+        $default = 'account/history/order-body-default.php';
154
+
155
+        return $view->render( $view->config( $tplconf, $default ) );
156
+    }
157
+
158
+
159
+    /**
160
+     * Returns the HTML string for insertion into the header.
161
+     *
162
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
163
+     * @param array &$tags Result array for the list of tags that are associated to the output
164
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
165
+     * @return string|null String including HTML tags for the header on error
166
+     */
167
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
168
+    {
169
+        $view = $this->getView();
170
+
171
+        if( $view->param( 'his_action' ) != 'order' ) {
172
+            return '';
173
+        }
174
+
175
+        $view = $this->setViewParams( $view, $tags, $expire );
176
+
177
+        $html = '';
178
+        foreach( $this->getSubClients() as $subclient ) {
179
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
180
+        }
181
+        $view->orderHeader = $html;
182
+
183
+        /** client/html/account/history/order/standard/template-header
184
+         * Relative path to the HTML header template of the account history order client.
185
+         *
186
+         * The template file contains the HTML code and processing instructions
187
+         * to generate the HTML code that is inserted into the HTML page header
188
+         * of the rendered page in the frontend. The configuration string is the
189
+         * path to the template file relative to the templates directory (usually
190
+         * in client/html/templates).
191
+         *
192
+         * You can overwrite the template file configuration in extensions and
193
+         * provide alternative templates. These alternative templates should be
194
+         * named like the default one but with the string "standard" replaced by
195
+         * an unique name. You may use the name of your project for this. If
196
+         * you've implemented an alternative client class as well, "standard"
197
+         * should be replaced by the name of the new class.
198
+         *
199
+         * @param string Relative path to the template creating code for the HTML page head
200
+         * @since 2015.02
201
+         * @category Developer
202
+         * @see client/html/account/history/order/standard/template-body
203
+         */
204
+        $tplconf = 'client/html/account/history/order/standard/template-header';
205
+        $default = 'account/history/order-header-default.php';
206
+
207
+        return $view->render( $view->config( $tplconf, $default ) );
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/account/history/order/decorators/excludes
221
+         * Excludes decorators added by the "common" option from the account history order 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/account/history/order/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 2015.08
240
+         * @category Developer
241
+         * @see client/html/common/decorators/default
242
+         * @see client/html/account/history/order/decorators/global
243
+         * @see client/html/account/history/order/decorators/local
244
+         */
245
+
246
+        /** client/html/account/history/order/decorators/global
247
+         * Adds a list of globally available decorators only to the account history order 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/account/history/order/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 2015.08
264
+         * @category Developer
265
+         * @see client/html/common/decorators/default
266
+         * @see client/html/account/history/order/decorators/excludes
267
+         * @see client/html/account/history/order/decorators/local
268
+         */
269
+
270
+        /** client/html/account/history/order/decorators/local
271
+         * Adds a list of local decorators only to the account history order 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\Account\Decorator\*") around the html client.
280
+         *
281
+         *  client/html/account/history/order/decorators/local = array( 'decorator2' )
282
+         *
283
+         * This would add the decorator named "decorator2" defined by
284
+         * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
285
+         *
286
+         * @param array List of decorator names
287
+         * @since 2015.08
288
+         * @category Developer
289
+         * @see client/html/common/decorators/default
290
+         * @see client/html/account/history/order/decorators/excludes
291
+         * @see client/html/account/history/order/decorators/global
292
+         */
293
+
294
+        return $this->createSubClient( 'account/history/order/' . $type, $name );
295
+    }
296
+
297
+
298
+    /**
299
+     * Returns the list of sub-client names configured for the client.
300
+     *
301
+     * @return array List of HTML client names
302
+     */
303
+    protected function getSubClientNames()
304
+    {
305
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
306
+    }
307
+
308
+
309
+    /**
310
+     * Sets the necessary parameter values in the view.
311
+     *
312
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
313
+     * @param array &$tags Result array for the list of tags that are associated to the output
314
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
315
+     * @return \Aimeos\MW\View\Iface Modified view object
316
+     */
317
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
318
+    {
319
+        if( !isset( $this->cache ) )
320
+        {
321
+            $context = $this->getContext();
322
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
323
+
324
+            $orderId = $view->param( 'his_id', null );
325
+
326
+            if( $orderId !== null )
327
+            {
328
+                $search = $manager->createSearch( true );
329
+                $expr = array(
330
+                    $search->getConditions(),
331
+                    $search->compare( '==', 'order.id', $orderId ),
332
+                    $search->compare( '==', 'order.base.customerid', $context->getUserId() ),
333
+                );
334
+                $search->setConditions( $search->combine( '&&', $expr ) );
335
+
336
+                $orderItems = $manager->searchItems( $search );
337
+
338
+                if( ( $orderItem = reset( $orderItems ) ) === false )
339
+                {
340
+                    $msg = $view->translate( 'client', 'Order with ID "%1$s" not found' );
341
+                    throw new \Aimeos\Client\Html\Exception( sprintf( $msg, $orderId ) );
342
+                }
343
+
344
+                $baseManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
345
+                $view->summaryBasket = $baseManager->load( $orderItem->getBaseId() );
346
+                $view->orderItem = $orderItem;
347
+            }
348
+
349
+            $this->cache = $view;
350
+        }
351
+
352
+        return $this->cache;
353
+    }
354 354
 }
355 355
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +31 added lines, -31 removed lines patch added patch discarded remove patch
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 	 * @since 2015.02
101 101
 	 * @category Developer
102 102
 	 */
103
-	private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
103
+	private $subPartNames = array('address', 'service', 'coupon', 'detail');
104 104
 
105 105
 	private $cache;
106 106
 
@@ -113,19 +113,19 @@  discard block
 block discarded – undo
113 113
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114 114
 	 * @return string HTML code
115 115
 	 */
116
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
116
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
117 117
 	{
118 118
 		$view = $this->getView();
119 119
 
120
-		if( $view->param( 'his_action' ) != 'order' ) {
120
+		if ($view->param('his_action') != 'order') {
121 121
 			return '';
122 122
 		}
123 123
 
124
-		$view = $this->setViewParams( $view, $tags, $expire );
124
+		$view = $this->setViewParams($view, $tags, $expire);
125 125
 
126 126
 		$html = '';
127
-		foreach( $this->getSubClients() as $subclient ) {
128
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
127
+		foreach ($this->getSubClients() as $subclient) {
128
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
129 129
 		}
130 130
 		$view->orderBody = $html;
131 131
 
@@ -152,7 +152,7 @@  discard block
 block discarded – undo
152 152
 		$tplconf = 'client/html/account/history/order/standard/template-body';
153 153
 		$default = 'account/history/order-body-default.php';
154 154
 
155
-		return $view->render( $view->config( $tplconf, $default ) );
155
+		return $view->render($view->config($tplconf, $default));
156 156
 	}
157 157
 
158 158
 
@@ -164,19 +164,19 @@  discard block
 block discarded – undo
164 164
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
165 165
 	 * @return string|null String including HTML tags for the header on error
166 166
 	 */
167
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
167
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
168 168
 	{
169 169
 		$view = $this->getView();
170 170
 
171
-		if( $view->param( 'his_action' ) != 'order' ) {
171
+		if ($view->param('his_action') != 'order') {
172 172
 			return '';
173 173
 		}
174 174
 
175
-		$view = $this->setViewParams( $view, $tags, $expire );
175
+		$view = $this->setViewParams($view, $tags, $expire);
176 176
 
177 177
 		$html = '';
178
-		foreach( $this->getSubClients() as $subclient ) {
179
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
178
+		foreach ($this->getSubClients() as $subclient) {
179
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
180 180
 		}
181 181
 		$view->orderHeader = $html;
182 182
 
@@ -204,7 +204,7 @@  discard block
 block discarded – undo
204 204
 		$tplconf = 'client/html/account/history/order/standard/template-header';
205 205
 		$default = 'account/history/order-header-default.php';
206 206
 
207
-		return $view->render( $view->config( $tplconf, $default ) );
207
+		return $view->render($view->config($tplconf, $default));
208 208
 	}
209 209
 
210 210
 
@@ -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/account/history/order/decorators/excludes
221 221
 		 * Excludes decorators added by the "common" option from the account history order html client
@@ -291,7 +291,7 @@  discard block
 block discarded – undo
291 291
 		 * @see client/html/account/history/order/decorators/global
292 292
 		 */
293 293
 
294
-		return $this->createSubClient( 'account/history/order/' . $type, $name );
294
+		return $this->createSubClient('account/history/order/'.$type, $name);
295 295
 	}
296 296
 
297 297
 
@@ -302,7 +302,7 @@  discard block
 block discarded – undo
302 302
 	 */
303 303
 	protected function getSubClientNames()
304 304
 	{
305
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
305
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
306 306
 	}
307 307
 
308 308
 
@@ -314,35 +314,35 @@  discard block
 block discarded – undo
314 314
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
315 315
 	 * @return \Aimeos\MW\View\Iface Modified view object
316 316
 	 */
317
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
317
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
318 318
 	{
319
-		if( !isset( $this->cache ) )
319
+		if (!isset($this->cache))
320 320
 		{
321 321
 			$context = $this->getContext();
322
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
322
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'order');
323 323
 
324
-			$orderId = $view->param( 'his_id', null );
324
+			$orderId = $view->param('his_id', null);
325 325
 
326
-			if( $orderId !== null )
326
+			if ($orderId !== null)
327 327
 			{
328
-				$search = $manager->createSearch( true );
328
+				$search = $manager->createSearch(true);
329 329
 				$expr = array(
330 330
 					$search->getConditions(),
331
-					$search->compare( '==', 'order.id', $orderId ),
332
-					$search->compare( '==', 'order.base.customerid', $context->getUserId() ),
331
+					$search->compare('==', 'order.id', $orderId),
332
+					$search->compare('==', 'order.base.customerid', $context->getUserId()),
333 333
 				);
334
-				$search->setConditions( $search->combine( '&&', $expr ) );
334
+				$search->setConditions($search->combine('&&', $expr));
335 335
 
336
-				$orderItems = $manager->searchItems( $search );
336
+				$orderItems = $manager->searchItems($search);
337 337
 
338
-				if( ( $orderItem = reset( $orderItems ) ) === false )
338
+				if (($orderItem = reset($orderItems)) === false)
339 339
 				{
340
-					$msg = $view->translate( 'client', 'Order with ID "%1$s" not found' );
341
-					throw new \Aimeos\Client\Html\Exception( sprintf( $msg, $orderId ) );
340
+					$msg = $view->translate('client', 'Order with ID "%1$s" not found');
341
+					throw new \Aimeos\Client\Html\Exception(sprintf($msg, $orderId));
342 342
 				}
343 343
 
344
-				$baseManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
345
-				$view->summaryBasket = $baseManager->load( $orderItem->getBaseId() );
344
+				$baseManager = \Aimeos\MShop\Factory::createManager($context, 'order/base');
345
+				$view->summaryBasket = $baseManager->load($orderItem->getBaseId());
346 346
 				$view->orderItem = $orderItem;
347 347
 			}
348 348
 
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/Account/History/Order/Address/Standard.php 3 patches
Indentation   +227 added lines, -227 removed lines patch added patch discarded remove patch
@@ -19,232 +19,232 @@
 block discarded – undo
19 19
  * @subpackage Html
20 20
  */
21 21
 class Standard
22
-	extends \Aimeos\Client\Html\Common\Summary\Address\Base
23
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
22
+    extends \Aimeos\Client\Html\Common\Summary\Address\Base
23
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24 24
 {
25
-	/** client/html/account/history/order/address/standard/subparts
26
-	 * List of HTML sub-clients rendered within the account history order address 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/account/history/order/address/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->addressBody = $html;
79
-
80
-		/** client/html/account/history/order/address/standard/template-body
81
-		 * Relative path to the HTML body template of the account history order address 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
-		 * (second one) should be replaced by the name of the new class in lower
94
-		 * case.
95
-		 *
96
-		 * @param string Relative path to the template creating code for the HTML page body
97
-		 * @since 2015.11
98
-		 * @category Developer
99
-		 * @see client/html/account/history/order/address/standard/template-header
100
-		 */
101
-		$tplconf = 'client/html/account/history/order/address/standard/template-body';
102
-		$default = 'common/summary/address-body-default.php';
103
-
104
-		return $view->render( $view->config( $tplconf, $default ) );
105
-	}
106
-
107
-
108
-	/**
109
-	 * Returns the HTML string for insertion into the header.
110
-	 *
111
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
-	 * @param array &$tags Result array for the list of tags that are associated to the output
113
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
-	 * @return string|null String including HTML tags for the header on error
115
-	 */
116
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
-	{
118
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
119
-
120
-		$html = '';
121
-		foreach( $this->getSubClients() as $subclient ) {
122
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
-		}
124
-		$view->addressHeader = $html;
125
-
126
-		/** client/html/account/history/order/address/standard/template-header
127
-		 * Relative path to the HTML header template of the account history order address client.
128
-		 *
129
-		 * The template file contains the HTML code and processing instructions
130
-		 * to generate the HTML code that is inserted into the HTML page header
131
-		 * of the rendered page in the frontend. The configuration string is the
132
-		 * path to the template file relative to the templates directory (usually
133
-		 * in client/html/templates).
134
-		 *
135
-		 * You can overwrite the template file configuration in extensions and
136
-		 * provide alternative templates. These alternative templates should be
137
-		 * named like the default one but with the string "standard" replaced by
138
-		 * an unique name. You may use the name of your project for this. If
139
-		 * you've implemented an alternative client class as well, "standard"
140
-		 * (second one) should be replaced by the name of the new class in lower
141
-		 * case.
142
-		 *
143
-		 * @param string Relative path to the template creating code for the HTML page head
144
-		 * @since 2015.11
145
-		 * @category Developer
146
-		 * @see client/html/account/history/order/address/standard/template-body
147
-		 */
148
-		$tplconf = 'client/html/account/history/order/address/standard/template-header';
149
-		$default = 'common/summary/address-header-default.php';
150
-
151
-		return $view->render( $view->config( $tplconf, $default ) );
152
-	}
153
-
154
-
155
-	/**
156
-	 * Returns the sub-client given by its name.
157
-	 *
158
-	 * @param string $type Name of the client type
159
-	 * @param string|null $name Name of the sub-client (Default if null)
160
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
161
-	 */
162
-	public function getSubClient( $type, $name = null )
163
-	{
164
-		/** client/html/account/history/order/address/decorators/excludes
165
-		 * Excludes decorators added by the "common" option from the account history order address html client
166
-		 *
167
-		 * Decorators extend the functionality of a class by adding new aspects
168
-		 * (e.g. log what is currently done), executing the methods of the underlying
169
-		 * class only in certain conditions (e.g. only for logged in users) or
170
-		 * modify what is returned to the caller.
171
-		 *
172
-		 * This option allows you to remove a decorator added via
173
-		 * "client/html/common/decorators/default" before they are wrapped
174
-		 * around the html client.
175
-		 *
176
-		 *  client/html/account/history/order/address/decorators/excludes = array( 'decorator1' )
177
-		 *
178
-		 * This would remove the decorator named "decorator1" from the list of
179
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
180
-		 * "client/html/common/decorators/default" to the html client.
181
-		 *
182
-		 * @param array List of decorator names
183
-		 * @since 2015.08
184
-		 * @category Developer
185
-		 * @see client/html/common/decorators/default
186
-		 * @see client/html/account/history/order/address/decorators/global
187
-		 * @see client/html/account/history/order/address/decorators/local
188
-		 */
189
-
190
-		/** client/html/account/history/order/address/decorators/global
191
-		 * Adds a list of globally available decorators only to the account history order address html client
192
-		 *
193
-		 * Decorators extend the functionality of a class by adding new aspects
194
-		 * (e.g. log what is currently done), executing the methods of the underlying
195
-		 * class only in certain conditions (e.g. only for logged in users) or
196
-		 * modify what is returned to the caller.
197
-		 *
198
-		 * This option allows you to wrap global decorators
199
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
200
-		 *
201
-		 *  client/html/account/history/order/address/decorators/global = array( 'decorator1' )
202
-		 *
203
-		 * This would add the decorator named "decorator1" defined by
204
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
205
-		 *
206
-		 * @param array List of decorator names
207
-		 * @since 2015.08
208
-		 * @category Developer
209
-		 * @see client/html/common/decorators/default
210
-		 * @see client/html/account/history/order/address/decorators/excludes
211
-		 * @see client/html/account/history/order/address/decorators/local
212
-		 */
213
-
214
-		/** client/html/account/history/order/address/decorators/local
215
-		 * Adds a list of local decorators only to the account history order address html client
216
-		 *
217
-		 * Decorators extend the functionality of a class by adding new aspects
218
-		 * (e.g. log what is currently done), executing the methods of the underlying
219
-		 * class only in certain conditions (e.g. only for logged in users) or
220
-		 * modify what is returned to the caller.
221
-		 *
222
-		 * This option allows you to wrap local decorators
223
-		 * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
224
-		 *
225
-		 *  client/html/account/history/order/address/decorators/local = array( 'decorator2' )
226
-		 *
227
-		 * This would add the decorator named "decorator2" defined by
228
-		 * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
229
-		 *
230
-		 * @param array List of decorator names
231
-		 * @since 2015.08
232
-		 * @category Developer
233
-		 * @see client/html/common/decorators/default
234
-		 * @see client/html/account/history/order/address/decorators/excludes
235
-		 * @see client/html/account/history/order/address/decorators/global
236
-		 */
237
-		return $this->createSubClient( 'account/history/order/address/' . $type, $name );
238
-	}
239
-
240
-
241
-	/**
242
-	 * Returns the list of sub-client names configured for the client.
243
-	 *
244
-	 * @return array List of HTML client names
245
-	 */
246
-	protected function getSubClientNames()
247
-	{
248
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
-	}
25
+    /** client/html/account/history/order/address/standard/subparts
26
+     * List of HTML sub-clients rendered within the account history order address 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/account/history/order/address/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->addressBody = $html;
79
+
80
+        /** client/html/account/history/order/address/standard/template-body
81
+         * Relative path to the HTML body template of the account history order address 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
+         * (second one) should be replaced by the name of the new class in lower
94
+         * case.
95
+         *
96
+         * @param string Relative path to the template creating code for the HTML page body
97
+         * @since 2015.11
98
+         * @category Developer
99
+         * @see client/html/account/history/order/address/standard/template-header
100
+         */
101
+        $tplconf = 'client/html/account/history/order/address/standard/template-body';
102
+        $default = 'common/summary/address-body-default.php';
103
+
104
+        return $view->render( $view->config( $tplconf, $default ) );
105
+    }
106
+
107
+
108
+    /**
109
+     * Returns the HTML string for insertion into the header.
110
+     *
111
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
112
+     * @param array &$tags Result array for the list of tags that are associated to the output
113
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114
+     * @return string|null String including HTML tags for the header on error
115
+     */
116
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
+    {
118
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
119
+
120
+        $html = '';
121
+        foreach( $this->getSubClients() as $subclient ) {
122
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
+        }
124
+        $view->addressHeader = $html;
125
+
126
+        /** client/html/account/history/order/address/standard/template-header
127
+         * Relative path to the HTML header template of the account history order address client.
128
+         *
129
+         * The template file contains the HTML code and processing instructions
130
+         * to generate the HTML code that is inserted into the HTML page header
131
+         * of the rendered page in the frontend. The configuration string is the
132
+         * path to the template file relative to the templates directory (usually
133
+         * in client/html/templates).
134
+         *
135
+         * You can overwrite the template file configuration in extensions and
136
+         * provide alternative templates. These alternative templates should be
137
+         * named like the default one but with the string "standard" replaced by
138
+         * an unique name. You may use the name of your project for this. If
139
+         * you've implemented an alternative client class as well, "standard"
140
+         * (second one) should be replaced by the name of the new class in lower
141
+         * case.
142
+         *
143
+         * @param string Relative path to the template creating code for the HTML page head
144
+         * @since 2015.11
145
+         * @category Developer
146
+         * @see client/html/account/history/order/address/standard/template-body
147
+         */
148
+        $tplconf = 'client/html/account/history/order/address/standard/template-header';
149
+        $default = 'common/summary/address-header-default.php';
150
+
151
+        return $view->render( $view->config( $tplconf, $default ) );
152
+    }
153
+
154
+
155
+    /**
156
+     * Returns the sub-client given by its name.
157
+     *
158
+     * @param string $type Name of the client type
159
+     * @param string|null $name Name of the sub-client (Default if null)
160
+     * @return \Aimeos\Client\Html\Iface Sub-client object
161
+     */
162
+    public function getSubClient( $type, $name = null )
163
+    {
164
+        /** client/html/account/history/order/address/decorators/excludes
165
+         * Excludes decorators added by the "common" option from the account history order address html client
166
+         *
167
+         * Decorators extend the functionality of a class by adding new aspects
168
+         * (e.g. log what is currently done), executing the methods of the underlying
169
+         * class only in certain conditions (e.g. only for logged in users) or
170
+         * modify what is returned to the caller.
171
+         *
172
+         * This option allows you to remove a decorator added via
173
+         * "client/html/common/decorators/default" before they are wrapped
174
+         * around the html client.
175
+         *
176
+         *  client/html/account/history/order/address/decorators/excludes = array( 'decorator1' )
177
+         *
178
+         * This would remove the decorator named "decorator1" from the list of
179
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
180
+         * "client/html/common/decorators/default" to the html client.
181
+         *
182
+         * @param array List of decorator names
183
+         * @since 2015.08
184
+         * @category Developer
185
+         * @see client/html/common/decorators/default
186
+         * @see client/html/account/history/order/address/decorators/global
187
+         * @see client/html/account/history/order/address/decorators/local
188
+         */
189
+
190
+        /** client/html/account/history/order/address/decorators/global
191
+         * Adds a list of globally available decorators only to the account history order address html client
192
+         *
193
+         * Decorators extend the functionality of a class by adding new aspects
194
+         * (e.g. log what is currently done), executing the methods of the underlying
195
+         * class only in certain conditions (e.g. only for logged in users) or
196
+         * modify what is returned to the caller.
197
+         *
198
+         * This option allows you to wrap global decorators
199
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
200
+         *
201
+         *  client/html/account/history/order/address/decorators/global = array( 'decorator1' )
202
+         *
203
+         * This would add the decorator named "decorator1" defined by
204
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
205
+         *
206
+         * @param array List of decorator names
207
+         * @since 2015.08
208
+         * @category Developer
209
+         * @see client/html/common/decorators/default
210
+         * @see client/html/account/history/order/address/decorators/excludes
211
+         * @see client/html/account/history/order/address/decorators/local
212
+         */
213
+
214
+        /** client/html/account/history/order/address/decorators/local
215
+         * Adds a list of local decorators only to the account history order address html client
216
+         *
217
+         * Decorators extend the functionality of a class by adding new aspects
218
+         * (e.g. log what is currently done), executing the methods of the underlying
219
+         * class only in certain conditions (e.g. only for logged in users) or
220
+         * modify what is returned to the caller.
221
+         *
222
+         * This option allows you to wrap local decorators
223
+         * ("\Aimeos\Client\Html\Basket\Decorator\*") around the html client.
224
+         *
225
+         *  client/html/account/history/order/address/decorators/local = array( 'decorator2' )
226
+         *
227
+         * This would add the decorator named "decorator2" defined by
228
+         * "\Aimeos\Client\Html\Basket\Decorator\Decorator2" only to the html client.
229
+         *
230
+         * @param array List of decorator names
231
+         * @since 2015.08
232
+         * @category Developer
233
+         * @see client/html/common/decorators/default
234
+         * @see client/html/account/history/order/address/decorators/excludes
235
+         * @see client/html/account/history/order/address/decorators/global
236
+         */
237
+        return $this->createSubClient( 'account/history/order/address/' . $type, $name );
238
+    }
239
+
240
+
241
+    /**
242
+     * Returns the list of sub-client names configured for the client.
243
+     *
244
+     * @return array List of HTML client names
245
+     */
246
+    protected function getSubClientNames()
247
+    {
248
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
+    }
250 250
 }
251 251
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 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->addressBody = $html;
79 79
 
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
 		$tplconf = 'client/html/account/history/order/address/standard/template-body';
102 102
 		$default = 'common/summary/address-body-default.php';
103 103
 
104
-		return $view->render( $view->config( $tplconf, $default ) );
104
+		return $view->render($view->config($tplconf, $default));
105 105
 	}
106 106
 
107 107
 
@@ -113,13 +113,13 @@  discard block
 block discarded – undo
113 113
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
114 114
 	 * @return string|null String including HTML tags for the header on error
115 115
 	 */
116
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
117 117
 	{
118
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
118
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
119 119
 
120 120
 		$html = '';
121
-		foreach( $this->getSubClients() as $subclient ) {
122
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
121
+		foreach ($this->getSubClients() as $subclient) {
122
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
123 123
 		}
124 124
 		$view->addressHeader = $html;
125 125
 
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 		$tplconf = 'client/html/account/history/order/address/standard/template-header';
149 149
 		$default = 'common/summary/address-header-default.php';
150 150
 
151
-		return $view->render( $view->config( $tplconf, $default ) );
151
+		return $view->render($view->config($tplconf, $default));
152 152
 	}
153 153
 
154 154
 
@@ -159,7 +159,7 @@  discard block
 block discarded – undo
159 159
 	 * @param string|null $name Name of the sub-client (Default if null)
160 160
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
161 161
 	 */
162
-	public function getSubClient( $type, $name = null )
162
+	public function getSubClient($type, $name = null)
163 163
 	{
164 164
 		/** client/html/account/history/order/address/decorators/excludes
165 165
 		 * Excludes decorators added by the "common" option from the account history order address html client
@@ -234,7 +234,7 @@  discard block
 block discarded – undo
234 234
 		 * @see client/html/account/history/order/address/decorators/excludes
235 235
 		 * @see client/html/account/history/order/address/decorators/global
236 236
 		 */
237
-		return $this->createSubClient( 'account/history/order/address/' . $type, $name );
237
+		return $this->createSubClient('account/history/order/address/'.$type, $name);
238 238
 	}
239 239
 
240 240
 
@@ -245,6 +245,6 @@  discard block
 block discarded – undo
245 245
 	 */
246 246
 	protected function getSubClientNames()
247 247
 	{
248
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
248
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
249 249
 	}
250 250
 }
251 251
\ 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/Account/History/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 account history 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/account/history/name
37
-		 * Class name of the used account history 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\Account\History\Standard
47
-		 *
48
-		 * and you want to replace it with your own version named
49
-		 *
50
-		 *  \Aimeos\Client\Html\Account\History\Myhistory
51
-		 *
52
-		 * then you have to set the this configuration option:
53
-		 *
54
-		 *  client/html/account/history/name = Myhistory
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 "MyHistory"!
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/account/history/name', 'Standard' );
71
-		}
25
+    /**
26
+     * Creates a account history 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/account/history/name
37
+         * Class name of the used account history 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\Account\History\Standard
47
+         *
48
+         * and you want to replace it with your own version named
49
+         *
50
+         *  \Aimeos\Client\Html\Account\History\Myhistory
51
+         *
52
+         * then you have to set the this configuration option:
53
+         *
54
+         *  client/html/account/history/name = Myhistory
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 "MyHistory"!
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/account/history/name', 'Standard' );
71
+        }
72 72
 
73
-		if( ctype_alnum( $name ) === false )
74
-		{
75
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\History\\' . $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\\Account\\History\\' . $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\\Account\\History\\' . $name;
79
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
80
+        $classname = '\\Aimeos\\Client\\Html\\Account\\History\\' . $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, 'account/history' );
85
-	}
84
+        return self::addClientDecorators( $context, $client, $templatePaths, 'account/history' );
85
+    }
86 86
 
87 87
 }
88 88
\ No newline at end of file
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/account/history/name
37 37
 		 * Class name of the used account history 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/account/history/name', 'Standard' );
69
+		if ($name === null) {
70
+			$name = $context->getConfig()->get('client/html/account/history/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\\Account\\History\\' . $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\\Account\\History\\'.$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\\Account\\History\\' . $name;
80
+		$classname = '\\Aimeos\\Client\\Html\\Account\\History\\'.$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, 'account/history' );
84
+		return self::addClientDecorators($context, $client, $templatePaths, 'account/history');
85 85
 	}
86 86
 
87 87
 }
88 88
\ No newline at end of file
Please login to merge, or discard this patch.
client/html/src/Client/Html/Account/History/Standard.php 3 patches
Indentation   +262 added lines, -262 removed lines patch added patch discarded remove patch
@@ -19,288 +19,288 @@
 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\Iface
22
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
23
+    implements \Aimeos\Client\Html\Iface
24 24
 {
25
-	/** client/html/account/history/standard/subparts
26
-	 * List of HTML sub-clients rendered within the account history 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/account/history/standard/subparts';
25
+    /** client/html/account/history/standard/subparts
26
+     * List of HTML sub-clients rendered within the account history 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/account/history/standard/subparts';
59 59
 
60
-	/** client/html/account/history/lists/name
61
-	 * Name of the list part used by the account history client implementation
62
-	 *
63
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Lists\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
-	 */
60
+    /** client/html/account/history/lists/name
61
+     * Name of the list part used by the account history client implementation
62
+     *
63
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Lists\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 70
 
71
-	/** client/html/account/history/order/name
72
-	 * Name of the order part used by the account history client implementation
73
-	 *
74
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\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 2015.02
79
-	 * @category Developer
80
-	 */
81
-	private $subPartNames = array( 'lists', 'order' );
71
+    /** client/html/account/history/order/name
72
+     * Name of the order part used by the account history client implementation
73
+     *
74
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\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 2015.02
79
+     * @category Developer
80
+     */
81
+    private $subPartNames = array( 'lists', 'order' );
82 82
 
83 83
 
84
-	/**
85
-	 * Returns the HTML code for insertion into the body.
86
-	 *
87
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
88
-	 * @param array &$tags Result array for the list of tags that are associated to the output
89
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
90
-	 * @return string HTML code
91
-	 */
92
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
93
-	{
94
-		$context = $this->getContext();
95
-		$view = $this->getView();
84
+    /**
85
+     * Returns the HTML code for insertion into the body.
86
+     *
87
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
88
+     * @param array &$tags Result array for the list of tags that are associated to the output
89
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
90
+     * @return string HTML code
91
+     */
92
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
93
+    {
94
+        $context = $this->getContext();
95
+        $view = $this->getView();
96 96
 
97
-		try
98
-		{
99
-			$view = $this->setViewParams( $view, $tags, $expire );
97
+        try
98
+        {
99
+            $view = $this->setViewParams( $view, $tags, $expire );
100 100
 
101
-			$html = '';
102
-			foreach( $this->getSubClients() as $subclient ) {
103
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
104
-			}
105
-			$view->historyBody = $html;
106
-		}
107
-		catch( \Aimeos\Client\Html\Exception $e )
108
-		{
109
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
110
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
111
-		}
112
-		catch( \Aimeos\Controller\Frontend\Exception $e )
113
-		{
114
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
115
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
116
-		}
117
-		catch( \Aimeos\MShop\Exception $e )
118
-		{
119
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
120
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
121
-		}
122
-		catch( \Exception $e )
123
-		{
124
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
101
+            $html = '';
102
+            foreach( $this->getSubClients() as $subclient ) {
103
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
104
+            }
105
+            $view->historyBody = $html;
106
+        }
107
+        catch( \Aimeos\Client\Html\Exception $e )
108
+        {
109
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
110
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
111
+        }
112
+        catch( \Aimeos\Controller\Frontend\Exception $e )
113
+        {
114
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
115
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
116
+        }
117
+        catch( \Aimeos\MShop\Exception $e )
118
+        {
119
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
120
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
121
+        }
122
+        catch( \Exception $e )
123
+        {
124
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
125 125
 
126
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
127
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
128
-		}
126
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
127
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
128
+        }
129 129
 
130
-		/** client/html/account/history/standard/template-body
131
-		 * Relative path to the HTML body template of the account history client.
132
-		 *
133
-		 * The template file contains the HTML code and processing instructions
134
-		 * to generate the result shown in the body of the frontend. The
135
-		 * configuration string is the path to the template file relative
136
-		 * to the templates directory (usually in client/html/templates).
137
-		 *
138
-		 * You can overwrite the template file configuration in extensions and
139
-		 * provide alternative templates. These alternative templates should be
140
-		 * named like the default one but with the string "standard" replaced by
141
-		 * an unique name. You may use the name of your project for this. If
142
-		 * you've implemented an alternative client class as well, "standard"
143
-		 * should be replaced by the name of the new class.
144
-		 *
145
-		 * @param string Relative path to the template creating code for the HTML page body
146
-		 * @since 2014.03
147
-		 * @category Developer
148
-		 * @see client/html/account/history/standard/template-header
149
-		 */
150
-		$tplconf = 'client/html/account/history/standard/template-body';
151
-		$default = 'account/history/body-default.php';
130
+        /** client/html/account/history/standard/template-body
131
+         * Relative path to the HTML body template of the account history client.
132
+         *
133
+         * The template file contains the HTML code and processing instructions
134
+         * to generate the result shown in the body of the frontend. The
135
+         * configuration string is the path to the template file relative
136
+         * to the templates directory (usually in client/html/templates).
137
+         *
138
+         * You can overwrite the template file configuration in extensions and
139
+         * provide alternative templates. These alternative templates should be
140
+         * named like the default one but with the string "standard" replaced by
141
+         * an unique name. You may use the name of your project for this. If
142
+         * you've implemented an alternative client class as well, "standard"
143
+         * should be replaced by the name of the new class.
144
+         *
145
+         * @param string Relative path to the template creating code for the HTML page body
146
+         * @since 2014.03
147
+         * @category Developer
148
+         * @see client/html/account/history/standard/template-header
149
+         */
150
+        $tplconf = 'client/html/account/history/standard/template-body';
151
+        $default = 'account/history/body-default.php';
152 152
 
153
-		return $view->render( $view->config( $tplconf, $default ) );
154
-	}
153
+        return $view->render( $view->config( $tplconf, $default ) );
154
+    }
155 155
 
156 156
 
157
-	/**
158
-	 * Returns the HTML string for insertion into the header.
159
-	 *
160
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
161
-	 * @param array &$tags Result array for the list of tags that are associated to the output
162
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
163
-	 * @return string|null String including HTML tags for the header on error
164
-	 */
165
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
166
-	{
167
-		try
168
-		{
169
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
157
+    /**
158
+     * Returns the HTML string for insertion into the header.
159
+     *
160
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
161
+     * @param array &$tags Result array for the list of tags that are associated to the output
162
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
163
+     * @return string|null String including HTML tags for the header on error
164
+     */
165
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
166
+    {
167
+        try
168
+        {
169
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
170 170
 
171
-			$html = '';
172
-			foreach( $this->getSubClients() as $subclient ) {
173
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
174
-			}
175
-			$view->historyHeader = $html;
171
+            $html = '';
172
+            foreach( $this->getSubClients() as $subclient ) {
173
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
174
+            }
175
+            $view->historyHeader = $html;
176 176
 
177
-			/** client/html/account/history/standard/template-header
178
-			 * Relative path to the HTML header template of the account history client.
179
-			 *
180
-			 * The template file contains the HTML code and processing instructions
181
-			 * to generate the HTML code that is inserted into the HTML page header
182
-			 * of the rendered page in the frontend. The configuration string is the
183
-			 * path to the template file relative to the templates directory (usually
184
-			 * in client/html/templates).
185
-			 *
186
-			 * You can overwrite the template file configuration in extensions and
187
-			 * provide alternative templates. These alternative templates should be
188
-			 * named like the default one but with the string "standard" replaced by
189
-			 * an unique name. You may use the name of your project for this. If
190
-			 * you've implemented an alternative client class as well, "standard"
191
-			 * should be replaced by the name of the new class.
192
-			 *
193
-			 * @param string Relative path to the template creating code for the HTML page head
194
-			 * @since 2014.03
195
-			 * @category Developer
196
-			 * @see client/html/account/history/standard/template-body
197
-			 */
198
-			$tplconf = 'client/html/account/history/standard/template-header';
199
-			$default = 'account/history/header-default.php';
177
+            /** client/html/account/history/standard/template-header
178
+             * Relative path to the HTML header template of the account history client.
179
+             *
180
+             * The template file contains the HTML code and processing instructions
181
+             * to generate the HTML code that is inserted into the HTML page header
182
+             * of the rendered page in the frontend. The configuration string is the
183
+             * path to the template file relative to the templates directory (usually
184
+             * in client/html/templates).
185
+             *
186
+             * You can overwrite the template file configuration in extensions and
187
+             * provide alternative templates. These alternative templates should be
188
+             * named like the default one but with the string "standard" replaced by
189
+             * an unique name. You may use the name of your project for this. If
190
+             * you've implemented an alternative client class as well, "standard"
191
+             * should be replaced by the name of the new class.
192
+             *
193
+             * @param string Relative path to the template creating code for the HTML page head
194
+             * @since 2014.03
195
+             * @category Developer
196
+             * @see client/html/account/history/standard/template-body
197
+             */
198
+            $tplconf = 'client/html/account/history/standard/template-header';
199
+            $default = 'account/history/header-default.php';
200 200
 
201
-			return $view->render( $view->config( $tplconf, $default ) );
202
-		}
203
-		catch( \Exception $e )
204
-		{
205
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
206
-		}
207
-	}
201
+            return $view->render( $view->config( $tplconf, $default ) );
202
+        }
203
+        catch( \Exception $e )
204
+        {
205
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
206
+        }
207
+    }
208 208
 
209 209
 
210
-	/**
211
-	 * Returns the sub-client given by its name.
212
-	 *
213
-	 * @param string $type Name of the client type
214
-	 * @param string|null $name Name of the sub-client (Default if null)
215
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
216
-	 */
217
-	public function getSubClient( $type, $name = null )
218
-	{
219
-		/** client/html/account/history/decorators/excludes
220
-		 * Excludes decorators added by the "common" option from the account history html client
221
-		 *
222
-		 * Decorators extend the functionality of a class by adding new aspects
223
-		 * (e.g. log what is currently done), executing the methods of the underlying
224
-		 * class only in certain conditions (e.g. only for logged in users) or
225
-		 * modify what is returned to the caller.
226
-		 *
227
-		 * This option allows you to remove a decorator added via
228
-		 * "client/html/common/decorators/default" before they are wrapped
229
-		 * around the html client.
230
-		 *
231
-		 *  client/html/account/history/decorators/excludes = array( 'decorator1' )
232
-		 *
233
-		 * This would remove the decorator named "decorator1" from the list of
234
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
235
-		 * "client/html/common/decorators/default" to the html client.
236
-		 *
237
-		 * @param array List of decorator names
238
-		 * @since 2014.05
239
-		 * @category Developer
240
-		 * @see client/html/common/decorators/default
241
-		 * @see client/html/account/history/decorators/global
242
-		 * @see client/html/account/history/decorators/local
243
-		 */
210
+    /**
211
+     * Returns the sub-client given by its name.
212
+     *
213
+     * @param string $type Name of the client type
214
+     * @param string|null $name Name of the sub-client (Default if null)
215
+     * @return \Aimeos\Client\Html\Iface Sub-client object
216
+     */
217
+    public function getSubClient( $type, $name = null )
218
+    {
219
+        /** client/html/account/history/decorators/excludes
220
+         * Excludes decorators added by the "common" option from the account history html client
221
+         *
222
+         * Decorators extend the functionality of a class by adding new aspects
223
+         * (e.g. log what is currently done), executing the methods of the underlying
224
+         * class only in certain conditions (e.g. only for logged in users) or
225
+         * modify what is returned to the caller.
226
+         *
227
+         * This option allows you to remove a decorator added via
228
+         * "client/html/common/decorators/default" before they are wrapped
229
+         * around the html client.
230
+         *
231
+         *  client/html/account/history/decorators/excludes = array( 'decorator1' )
232
+         *
233
+         * This would remove the decorator named "decorator1" from the list of
234
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
235
+         * "client/html/common/decorators/default" to the html client.
236
+         *
237
+         * @param array List of decorator names
238
+         * @since 2014.05
239
+         * @category Developer
240
+         * @see client/html/common/decorators/default
241
+         * @see client/html/account/history/decorators/global
242
+         * @see client/html/account/history/decorators/local
243
+         */
244 244
 
245
-		/** client/html/account/history/decorators/global
246
-		 * Adds a list of globally available decorators only to the account history html client
247
-		 *
248
-		 * Decorators extend the functionality of a class by adding new aspects
249
-		 * (e.g. log what is currently done), executing the methods of the underlying
250
-		 * class only in certain conditions (e.g. only for logged in users) or
251
-		 * modify what is returned to the caller.
252
-		 *
253
-		 * This option allows you to wrap global decorators
254
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
255
-		 *
256
-		 *  client/html/account/history/decorators/global = array( 'decorator1' )
257
-		 *
258
-		 * This would add the decorator named "decorator1" defined by
259
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
260
-		 *
261
-		 * @param array List of decorator names
262
-		 * @since 2014.05
263
-		 * @category Developer
264
-		 * @see client/html/common/decorators/default
265
-		 * @see client/html/account/history/decorators/excludes
266
-		 * @see client/html/account/history/decorators/local
267
-		 */
245
+        /** client/html/account/history/decorators/global
246
+         * Adds a list of globally available decorators only to the account history html client
247
+         *
248
+         * Decorators extend the functionality of a class by adding new aspects
249
+         * (e.g. log what is currently done), executing the methods of the underlying
250
+         * class only in certain conditions (e.g. only for logged in users) or
251
+         * modify what is returned to the caller.
252
+         *
253
+         * This option allows you to wrap global decorators
254
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
255
+         *
256
+         *  client/html/account/history/decorators/global = array( 'decorator1' )
257
+         *
258
+         * This would add the decorator named "decorator1" defined by
259
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
260
+         *
261
+         * @param array List of decorator names
262
+         * @since 2014.05
263
+         * @category Developer
264
+         * @see client/html/common/decorators/default
265
+         * @see client/html/account/history/decorators/excludes
266
+         * @see client/html/account/history/decorators/local
267
+         */
268 268
 
269
-		/** client/html/account/history/decorators/local
270
-		 * Adds a list of local decorators only to the account history html client
271
-		 *
272
-		 * Decorators extend the functionality of a class by adding new aspects
273
-		 * (e.g. log what is currently done), executing the methods of the underlying
274
-		 * class only in certain conditions (e.g. only for logged in users) or
275
-		 * modify what is returned to the caller.
276
-		 *
277
-		 * This option allows you to wrap local decorators
278
-		 * ("\Aimeos\Client\Html\Account\Decorator\*") around the html client.
279
-		 *
280
-		 *  client/html/account/history/decorators/local = array( 'decorator2' )
281
-		 *
282
-		 * This would add the decorator named "decorator2" defined by
283
-		 * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
284
-		 *
285
-		 * @param array List of decorator names
286
-		 * @since 2014.05
287
-		 * @category Developer
288
-		 * @see client/html/common/decorators/default
289
-		 * @see client/html/account/history/decorators/excludes
290
-		 * @see client/html/account/history/decorators/global
291
-		 */
269
+        /** client/html/account/history/decorators/local
270
+         * Adds a list of local decorators only to the account history html client
271
+         *
272
+         * Decorators extend the functionality of a class by adding new aspects
273
+         * (e.g. log what is currently done), executing the methods of the underlying
274
+         * class only in certain conditions (e.g. only for logged in users) or
275
+         * modify what is returned to the caller.
276
+         *
277
+         * This option allows you to wrap local decorators
278
+         * ("\Aimeos\Client\Html\Account\Decorator\*") around the html client.
279
+         *
280
+         *  client/html/account/history/decorators/local = array( 'decorator2' )
281
+         *
282
+         * This would add the decorator named "decorator2" defined by
283
+         * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
284
+         *
285
+         * @param array List of decorator names
286
+         * @since 2014.05
287
+         * @category Developer
288
+         * @see client/html/common/decorators/default
289
+         * @see client/html/account/history/decorators/excludes
290
+         * @see client/html/account/history/decorators/global
291
+         */
292 292
 
293
-		return $this->createSubClient( 'account/history/' . $type, $name );
294
-	}
293
+        return $this->createSubClient( 'account/history/' . $type, $name );
294
+    }
295 295
 
296 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
-	}
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 306
 }
307 307
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +29 added lines, -29 removed lines patch added patch discarded remove patch
@@ -78,7 +78,7 @@  discard block
 block discarded – undo
78 78
 	 * @since 2015.02
79 79
 	 * @category Developer
80 80
 	 */
81
-	private $subPartNames = array( 'lists', 'order' );
81
+	private $subPartNames = array('lists', 'order');
82 82
 
83 83
 
84 84
 	/**
@@ -89,42 +89,42 @@  discard block
 block discarded – undo
89 89
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
90 90
 	 * @return string HTML code
91 91
 	 */
92
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
92
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
93 93
 	{
94 94
 		$context = $this->getContext();
95 95
 		$view = $this->getView();
96 96
 
97 97
 		try
98 98
 		{
99
-			$view = $this->setViewParams( $view, $tags, $expire );
99
+			$view = $this->setViewParams($view, $tags, $expire);
100 100
 
101 101
 			$html = '';
102
-			foreach( $this->getSubClients() as $subclient ) {
103
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
102
+			foreach ($this->getSubClients() as $subclient) {
103
+				$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
104 104
 			}
105 105
 			$view->historyBody = $html;
106 106
 		}
107
-		catch( \Aimeos\Client\Html\Exception $e )
107
+		catch (\Aimeos\Client\Html\Exception $e)
108 108
 		{
109
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
110
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
109
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
110
+			$view->historyErrorList = $view->get('historyErrorList', array()) + $error;
111 111
 		}
112
-		catch( \Aimeos\Controller\Frontend\Exception $e )
112
+		catch (\Aimeos\Controller\Frontend\Exception $e)
113 113
 		{
114
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
115
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
114
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
115
+			$view->historyErrorList = $view->get('historyErrorList', array()) + $error;
116 116
 		}
117
-		catch( \Aimeos\MShop\Exception $e )
117
+		catch (\Aimeos\MShop\Exception $e)
118 118
 		{
119
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
120
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
119
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
120
+			$view->historyErrorList = $view->get('historyErrorList', array()) + $error;
121 121
 		}
122
-		catch( \Exception $e )
122
+		catch (\Exception $e)
123 123
 		{
124
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
124
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
125 125
 
126
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
127
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
126
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
127
+			$view->historyErrorList = $view->get('historyErrorList', array()) + $error;
128 128
 		}
129 129
 
130 130
 		/** client/html/account/history/standard/template-body
@@ -150,7 +150,7 @@  discard block
 block discarded – undo
150 150
 		$tplconf = 'client/html/account/history/standard/template-body';
151 151
 		$default = 'account/history/body-default.php';
152 152
 
153
-		return $view->render( $view->config( $tplconf, $default ) );
153
+		return $view->render($view->config($tplconf, $default));
154 154
 	}
155 155
 
156 156
 
@@ -162,15 +162,15 @@  discard block
 block discarded – undo
162 162
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
163 163
 	 * @return string|null String including HTML tags for the header on error
164 164
 	 */
165
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
165
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
166 166
 	{
167 167
 		try
168 168
 		{
169
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
169
+			$view = $this->setViewParams($this->getView(), $tags, $expire);
170 170
 
171 171
 			$html = '';
172
-			foreach( $this->getSubClients() as $subclient ) {
173
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
172
+			foreach ($this->getSubClients() as $subclient) {
173
+				$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
174 174
 			}
175 175
 			$view->historyHeader = $html;
176 176
 
@@ -198,11 +198,11 @@  discard block
 block discarded – undo
198 198
 			$tplconf = 'client/html/account/history/standard/template-header';
199 199
 			$default = 'account/history/header-default.php';
200 200
 
201
-			return $view->render( $view->config( $tplconf, $default ) );
201
+			return $view->render($view->config($tplconf, $default));
202 202
 		}
203
-		catch( \Exception $e )
203
+		catch (\Exception $e)
204 204
 		{
205
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
205
+			$this->getContext()->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
206 206
 		}
207 207
 	}
208 208
 
@@ -214,7 +214,7 @@  discard block
 block discarded – undo
214 214
 	 * @param string|null $name Name of the sub-client (Default if null)
215 215
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
216 216
 	 */
217
-	public function getSubClient( $type, $name = null )
217
+	public function getSubClient($type, $name = null)
218 218
 	{
219 219
 		/** client/html/account/history/decorators/excludes
220 220
 		 * Excludes decorators added by the "common" option from the account history html client
@@ -290,7 +290,7 @@  discard block
 block discarded – undo
290 290
 		 * @see client/html/account/history/decorators/global
291 291
 		 */
292 292
 
293
-		return $this->createSubClient( 'account/history/' . $type, $name );
293
+		return $this->createSubClient('account/history/'.$type, $name);
294 294
 	}
295 295
 
296 296
 
@@ -301,6 +301,6 @@  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
\ No newline at end of file
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/Account/Download/Factory.php 2 patches
Indentation   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -18,69 +18,69 @@
 block discarded – undo
18 18
  * @subpackage Html
19 19
  */
20 20
 class Factory
21
-	extends \Aimeos\Client\Html\Common\Factory\Base
22
-	implements \Aimeos\Client\Html\Common\Factory\Iface
21
+    extends \Aimeos\Client\Html\Common\Factory\Base
22
+    implements \Aimeos\Client\Html\Common\Factory\Iface
23 23
 {
24
-	/**
25
-	 * Creates a account download client object.
26
-	 *
27
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
28
-	 * @param array $templatePaths List of file system paths where the templates are stored
29
-	 * @param string|null $name Client name (default: "Standard")
30
-	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
31
-	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
32
-	 */
33
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
34
-	{
35
-		/** client/html/account/download/name
36
-		 * Class name of the used account download client implementation
37
-		 *
38
-		 * Each default HTML client can be replace by an alternative imlementation.
39
-		 * To use this implementation, you have to set the last part of the class
40
-		 * name as configuration value so the client factory knows which class it
41
-		 * has to instantiate.
42
-		 *
43
-		 * For example, if the name of the default class is
44
-		 *
45
-		 *  \Aimeos\Client\Html\Account\Download\Standard
46
-		 *
47
-		 * and you want to replace it with your own version named
48
-		 *
49
-		 *  \Aimeos\Client\Html\Account\Download\Mydownload
50
-		 *
51
-		 * then you have to set the this configuration option:
52
-		 *
53
-		 *  client/html/account/download/name = Mydownload
54
-		 *
55
-		 * The value is the last part of your own class name and it's case sensitive,
56
-		 * so take care that the configuration value is exactly named like the last
57
-		 * part of the class name.
58
-		 *
59
-		 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
60
-		 * characters are possible! You should always start the last part of the class
61
-		 * name with an upper case character and continue only with lower case characters
62
-		 * or numbers. Avoid chamel case names like "MyDownload"!
63
-		 *
64
-		 * @param string Last part of the class name
65
-		 * @since 2014.03
66
-		 * @category Developer
67
-		 */
68
-		if( $name === null ) {
69
-			$name = $context->getConfig()->get( 'client/html/account/download/name', 'Standard' );
70
-		}
24
+    /**
25
+     * Creates a account download client object.
26
+     *
27
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
28
+     * @param array $templatePaths List of file system paths where the templates are stored
29
+     * @param string|null $name Client name (default: "Standard")
30
+     * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
31
+     * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
32
+     */
33
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
34
+    {
35
+        /** client/html/account/download/name
36
+         * Class name of the used account download client implementation
37
+         *
38
+         * Each default HTML client can be replace by an alternative imlementation.
39
+         * To use this implementation, you have to set the last part of the class
40
+         * name as configuration value so the client factory knows which class it
41
+         * has to instantiate.
42
+         *
43
+         * For example, if the name of the default class is
44
+         *
45
+         *  \Aimeos\Client\Html\Account\Download\Standard
46
+         *
47
+         * and you want to replace it with your own version named
48
+         *
49
+         *  \Aimeos\Client\Html\Account\Download\Mydownload
50
+         *
51
+         * then you have to set the this configuration option:
52
+         *
53
+         *  client/html/account/download/name = Mydownload
54
+         *
55
+         * The value is the last part of your own class name and it's case sensitive,
56
+         * so take care that the configuration value is exactly named like the last
57
+         * part of the class name.
58
+         *
59
+         * The allowed characters of the class name are A-Z, a-z and 0-9. No other
60
+         * characters are possible! You should always start the last part of the class
61
+         * name with an upper case character and continue only with lower case characters
62
+         * or numbers. Avoid chamel case names like "MyDownload"!
63
+         *
64
+         * @param string Last part of the class name
65
+         * @since 2014.03
66
+         * @category Developer
67
+         */
68
+        if( $name === null ) {
69
+            $name = $context->getConfig()->get( 'client/html/account/download/name', 'Standard' );
70
+        }
71 71
 
72
-		if( ctype_alnum( $name ) === false )
73
-		{
74
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name : '<not a string>';
75
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
76
-		}
72
+        if( ctype_alnum( $name ) === false )
73
+        {
74
+            $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name : '<not a string>';
75
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
76
+        }
77 77
 
78
-		$iface = '\\Aimeos\\Client\\Html\\Iface';
79
-		$classname = '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name;
78
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
79
+        $classname = '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name;
80 80
 
81
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
81
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
82 82
 
83
-		return self::addClientDecorators( $context, $client, $templatePaths, 'account/download' );
84
-	}
83
+        return self::addClientDecorators( $context, $client, $templatePaths, 'account/download' );
84
+    }
85 85
 
86 86
 }
87 87
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -30,7 +30,7 @@  discard block
 block discarded – undo
30 30
 	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
31 31
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
32 32
 	 */
33
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
33
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null)
34 34
 	{
35 35
 		/** client/html/account/download/name
36 36
 		 * Class name of the used account download client implementation
@@ -65,22 +65,22 @@  discard block
 block discarded – undo
65 65
 		 * @since 2014.03
66 66
 		 * @category Developer
67 67
 		 */
68
-		if( $name === null ) {
69
-			$name = $context->getConfig()->get( 'client/html/account/download/name', 'Standard' );
68
+		if ($name === null) {
69
+			$name = $context->getConfig()->get('client/html/account/download/name', 'Standard');
70 70
 		}
71 71
 
72
-		if( ctype_alnum( $name ) === false )
72
+		if (ctype_alnum($name) === false)
73 73
 		{
74
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name : '<not a string>';
75
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
74
+			$classname = is_string($name) ? '\\Aimeos\\Client\\Html\\Account\\Download\\'.$name : '<not a string>';
75
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in class name "%1$s"', $classname));
76 76
 		}
77 77
 
78 78
 		$iface = '\\Aimeos\\Client\\Html\\Iface';
79
-		$classname = '\\Aimeos\\Client\\Html\\Account\\Download\\' . $name;
79
+		$classname = '\\Aimeos\\Client\\Html\\Account\\Download\\'.$name;
80 80
 
81
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
81
+		$client = self::createClientBase($context, $classname, $iface, $templatePaths);
82 82
 
83
-		return self::addClientDecorators( $context, $client, $templatePaths, 'account/download' );
83
+		return self::addClientDecorators($context, $client, $templatePaths, 'account/download');
84 84
 	}
85 85
 
86 86
 }
87 87
\ No newline at end of file
Please login to merge, or discard this patch.
client/html/src/Client/Html/Account/Download/Standard.php 3 patches
Indentation   +360 added lines, -360 removed lines patch added patch discarded remove patch
@@ -18,365 +18,365 @@
 block discarded – undo
18 18
  * @subpackage Html
19 19
  */
20 20
 class Standard
21
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
22
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
21
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
22
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
23 23
 {
24
-	/** client/html/account/download/standard/subparts
25
-	 * List of HTML sub-clients rendered within the account download 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 2016.02
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/account/download/standard/subparts';
58
-	private $subPartNames = array();
59
-
60
-
61
-	/**
62
-	 * Returns the HTML code for insertion into the body.
63
-	 *
64
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
65
-	 * @param array &$tags Result array for the list of tags that are associated to the output
66
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67
-	 * @return string HTML code
68
-	 */
69
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
-	{
71
-		return '';
72
-	}
73
-
74
-
75
-	/**
76
-	 * Returns the HTML string for insertion into the header.
77
-	 *
78
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
79
-	 * @param array &$tags Result array for the list of tags that are associated to the output
80
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
81
-	 * @return string|null String including HTML tags for the header on error
82
-	 */
83
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
84
-	{
85
-		return '';
86
-	}
87
-
88
-
89
-	/**
90
-	 * Returns the sub-client given by its name.
91
-	 *
92
-	 * @param string $type Name of the client type
93
-	 * @param string|null $name Name of the sub-client (Default if null)
94
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
95
-	 */
96
-	public function getSubClient( $type, $name = null )
97
-	{
98
-		/** client/html/account/download/decorators/excludes
99
-		 * Excludes decorators added by the "common" option from the account download html client
100
-		 *
101
-		 * Decorators extend the functionality of a class by adding new aspects
102
-		 * (e.g. log what is currently done), executing the methods of the underlying
103
-		 * class only in certain conditions (e.g. only for logged in users) or
104
-		 * modify what is returned to the caller.
105
-		 *
106
-		 * This option allows you to remove a decorator added via
107
-		 * "client/html/common/decorators/default" before they are wrapped
108
-		 * around the html client.
109
-		 *
110
-		 *  client/html/account/download/decorators/excludes = array( 'decorator1' )
111
-		 *
112
-		 * This would remove the decorator named "decorator1" from the list of
113
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
114
-		 * "client/html/common/decorators/default" to the html client.
115
-		 *
116
-		 * @param array List of decorator names
117
-		 * @since 2016.02
118
-		 * @category Developer
119
-		 * @see client/html/common/decorators/default
120
-		 * @see client/html/account/download/decorators/global
121
-		 * @see client/html/account/download/decorators/local
122
-		 */
123
-
124
-		/** client/html/account/download/decorators/global
125
-		 * Adds a list of globally available decorators only to the account download html client
126
-		 *
127
-		 * Decorators extend the functionality of a class by adding new aspects
128
-		 * (e.g. log what is currently done), executing the methods of the underlying
129
-		 * class only in certain conditions (e.g. only for logged in users) or
130
-		 * modify what is returned to the caller.
131
-		 *
132
-		 * This option allows you to wrap global decorators
133
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
134
-		 *
135
-		 *  client/html/account/download/decorators/global = array( 'decorator1' )
136
-		 *
137
-		 * This would add the decorator named "decorator1" defined by
138
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
139
-		 *
140
-		 * @param array List of decorator names
141
-		 * @since 2016.02
142
-		 * @category Developer
143
-		 * @see client/html/common/decorators/default
144
-		 * @see client/html/account/download/decorators/excludes
145
-		 * @see client/html/account/download/decorators/local
146
-		 */
147
-
148
-		/** client/html/account/download/decorators/local
149
-		 * Adds a list of local decorators only to the account download html client
150
-		 *
151
-		 * Decorators extend the functionality of a class by adding new aspects
152
-		 * (e.g. log what is currently done), executing the methods of the underlying
153
-		 * class only in certain conditions (e.g. only for logged in users) or
154
-		 * modify what is returned to the caller.
155
-		 *
156
-		 * This option allows you to wrap local decorators
157
-		 * ("\Aimeos\Client\Html\Account\Decorator\*") around the html client.
158
-		 *
159
-		 *  client/html/account/download/decorators/local = array( 'decorator2' )
160
-		 *
161
-		 * This would add the decorator named "decorator2" defined by
162
-		 * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
163
-		 *
164
-		 * @param array List of decorator names
165
-		 * @since 2016.02
166
-		 * @category Developer
167
-		 * @see client/html/common/decorators/default
168
-		 * @see client/html/account/download/decorators/excludes
169
-		 * @see client/html/account/download/decorators/global
170
-		 */
171
-		return $this->createSubClient( 'account/download/' . $type, $name );
172
-	}
173
-
174
-
175
-	/**
176
-	 * Processes the input, e.g. store given values.
177
-	 * A view must be available and this method doesn't generate any output
178
-	 * besides setting view variables.
179
-	 */
180
-	public function process()
181
-	{
182
-		$context = $this->getContext();
183
-
184
-		try
185
-		{
186
-			$view = $this->getView();
187
-			$id = $view->param( 'dl_id' );
188
-			$customerId = $context->getUserId();
189
-
190
-			if( $this->checkAccess( $customerId, $id ) === false )
191
-			{
192
-				$view->response()->withStatus( 401 );
193
-				return;
194
-			}
195
-
196
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product/attribute' );
197
-			$item = $manager->getItem( $id );
198
-
199
-			if( $this->checkDownload( $context->getUserId(), $id ) === true ) {
200
-				$this->addDownload( $item );
201
-			} else {
202
-				$view->response()->withStatus( 403 );
203
-			}
204
-
205
-			parent::process();
206
-		}
207
-		catch( \Exception $e )
208
-		{
209
-			$context->getLogger()->log( $e->getMessage() );
210
-		}
211
-	}
212
-
213
-
214
-	/**
215
-	 * Returns the list of sub-client names configured for the client.
216
-	 *
217
-	 * @return array List of HTML client names
218
-	 */
219
-	protected function getSubClientNames()
220
-	{
221
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
222
-	}
223
-
224
-
225
-	/**
226
-	 * Adds the necessary headers and the download content to the reponse object
227
-	 *
228
-	 * @param \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item Order product attribute item with file reference
229
-	 */
230
-	protected function addDownload( \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item )
231
-	{
232
-		$fs = $this->getContext()->getFilesystemManager()->get( 'fs-secure' );
233
-		$response = $this->getView()->response();
234
-		$value = (string) $item->getValue();
235
-
236
-		if( $fs->has( $value ) )
237
-		{
238
-			$name = $item->getName();
239
-
240
-			if( pathinfo( $name, PATHINFO_EXTENSION ) == null
241
-					&& ( $ext = pathinfo( $value, PATHINFO_EXTENSION ) ) != null
242
-			) {
243
-				$name .= '.' . $ext;
244
-			}
245
-
246
-			$response->withHeader( 'Content-Description', 'File Transfer' );
247
-			$response->withHeader( 'Content-Type', 'application/octet-stream' );
248
-			$response->withHeader( 'Content-Disposition', 'attachment; filename="' . $name . '"' );
249
-			$response->withHeader( 'Content-Length', (string) $fs->size( $value ) );
250
-			$response->withHeader( 'Cache-Control', 'must-revalidate' );
251
-			$response->withHeader( 'Pragma', 'private' );
252
-			$response->withHeader( 'Expires', '0' );
253
-
254
-			$response->withBody( $response->createStream( $fs->reads( $value ) ) );
255
-		}
256
-		elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
257
-		{
258
-			$response->withHeader( 'Location', $value );
259
-			$response->withStatus( 303 );
260
-		}
261
-		else
262
-		{
263
-			$response->withStatus( 404 );
264
-		}
265
-	}
266
-
267
-
268
-	/**
269
-	 * Checks if the customer is allowed to download the file
270
-	 *
271
-	 * @param string $customerId Unique customer ID
272
-	 * @param string $id Unique order base product attribute ID referencing the download file
273
-	 * @return boolean True if download is allowed, false if not
274
-	 */
275
-	protected function checkAccess( $customerId, $id )
276
-	{
277
-		if( $customerId !== null && $id !== null )
278
-		{
279
-			$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base' );
280
-
281
-			$search = $manager->createSearch();
282
-			$expr = array(
283
-				$search->compare( '==', 'order.base.customerid', $customerId ),
284
-				$search->compare( '==', 'order.base.product.attribute.id', $id ),
285
-			);
286
-			$search->setConditions( $search->combine( '&&', $expr ) );
287
-			$search->setSlice( 0, 1 );
288
-
289
-			if( count( $manager->searchItems( $search ) ) > 0 ) {
290
-				return true;
291
-			}
292
-		}
293
-
294
-		return false;
295
-	}
296
-
297
-
298
-	/**
299
-	 * Updates the download counter for the downloaded file
300
-	 *
301
-	 * @param string $customerId Unique customer ID
302
-	 * @param string $id Unique order base product attribute ID referencing the download file
303
-	 * @return boolean True if download is allowed, false if not
304
-	 */
305
-	protected function checkDownload( $customerId, $id )
306
-	{
307
-		$context = $this->getContext();
308
-
309
-		/** client/html/account/download/maxcount
310
-		 * Maximum number of file downloads allowed for an ordered product
311
-		 *
312
-		 * This configuration setting enables you to limit the number of downloads
313
-		 * of a product download file. The count is the maximum number for each
314
-		 * bought product and customer, i.e. setting the count to "3" allows
315
-		 * a customer to download the bought product file up to three times.
316
-		 *
317
-		 * The default value of null enforces no limit.
318
-		 *
319
-		 * @param integer Maximum number of downloads
320
-		 * @since 2016.02
321
-		 * @category Developer
322
-		 * @category User
323
-		 */
324
-		$maxcnt = $context->getConfig()->get( 'client/html/account/download/maxcount' );
325
-
326
-		$listItem = $this->getListItem( $customerId, $id );
327
-		$config = $listItem->getConfig();
328
-
329
-		if( !isset( $config['count'] ) ) {
330
-			$config['count'] = 0;
331
-		}
332
-
333
-		if( $maxcnt === null || ((int) $config['count']) < $maxcnt )
334
-		{
335
-			$config['count']++;
336
-			$listItem->setConfig( $config );
337
-
338
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
339
-			$manager->saveItem( $listItem, false );
340
-
341
-			return true;
342
-		}
343
-
344
-		return false;
345
-	}
346
-
347
-
348
-	/**
349
-	 * Returns the list item storing the download counter
350
-	 *
351
-	 * @param string $customerId Unique customer ID
352
-	 * @param string $refId Unique order base product attribute ID referencing the download file
353
-	 * @return \Aimeos\MSho\Common\Item\Lists\Iface List item object
354
-	 */
355
-	protected function getListItem( $customerId, $refId )
356
-	{
357
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'customer/lists' );
358
-
359
-		$search = $manager->createSearch();
360
-		$expr = array(
361
-			$search->compare( '==', 'customer.lists.parentid', $customerId ),
362
-			$search->compare( '==', 'customer.lists.refid', $refId ),
363
-			$search->compare( '==', 'customer.lists.domain', 'order' ),
364
-			$search->compare( '==', 'customer.lists.type.domain', 'order' ),
365
-			$search->compare( '==', 'customer.lists.type.code', 'download' ),
366
-		);
367
-		$search->setConditions( $search->combine( '&&', $expr ) );
368
-
369
-		$listItems = $manager->searchItems( $search );
370
-
371
-		if( ( $listItem = reset( $listItems ) ) === false )
372
-		{
373
-			$listItem = $manager->createItem();
374
-			$listItem->setTypeId( $this->getTypeItem( 'customer/lists/type', 'order', 'download' )->getId() );
375
-			$listItem->setParentId( $customerId );
376
-			$listItem->setDomain( 'order' );
377
-			$listItem->setRefId( $refId );
378
-		}
379
-
380
-		return $listItem;
381
-	}
24
+    /** client/html/account/download/standard/subparts
25
+     * List of HTML sub-clients rendered within the account download 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 2016.02
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/account/download/standard/subparts';
58
+    private $subPartNames = array();
59
+
60
+
61
+    /**
62
+     * Returns the HTML code for insertion into the body.
63
+     *
64
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
65
+     * @param array &$tags Result array for the list of tags that are associated to the output
66
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67
+     * @return string HTML code
68
+     */
69
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
70
+    {
71
+        return '';
72
+    }
73
+
74
+
75
+    /**
76
+     * Returns the HTML string for insertion into the header.
77
+     *
78
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
79
+     * @param array &$tags Result array for the list of tags that are associated to the output
80
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
81
+     * @return string|null String including HTML tags for the header on error
82
+     */
83
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
84
+    {
85
+        return '';
86
+    }
87
+
88
+
89
+    /**
90
+     * Returns the sub-client given by its name.
91
+     *
92
+     * @param string $type Name of the client type
93
+     * @param string|null $name Name of the sub-client (Default if null)
94
+     * @return \Aimeos\Client\Html\Iface Sub-client object
95
+     */
96
+    public function getSubClient( $type, $name = null )
97
+    {
98
+        /** client/html/account/download/decorators/excludes
99
+         * Excludes decorators added by the "common" option from the account download html client
100
+         *
101
+         * Decorators extend the functionality of a class by adding new aspects
102
+         * (e.g. log what is currently done), executing the methods of the underlying
103
+         * class only in certain conditions (e.g. only for logged in users) or
104
+         * modify what is returned to the caller.
105
+         *
106
+         * This option allows you to remove a decorator added via
107
+         * "client/html/common/decorators/default" before they are wrapped
108
+         * around the html client.
109
+         *
110
+         *  client/html/account/download/decorators/excludes = array( 'decorator1' )
111
+         *
112
+         * This would remove the decorator named "decorator1" from the list of
113
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
114
+         * "client/html/common/decorators/default" to the html client.
115
+         *
116
+         * @param array List of decorator names
117
+         * @since 2016.02
118
+         * @category Developer
119
+         * @see client/html/common/decorators/default
120
+         * @see client/html/account/download/decorators/global
121
+         * @see client/html/account/download/decorators/local
122
+         */
123
+
124
+        /** client/html/account/download/decorators/global
125
+         * Adds a list of globally available decorators only to the account download html client
126
+         *
127
+         * Decorators extend the functionality of a class by adding new aspects
128
+         * (e.g. log what is currently done), executing the methods of the underlying
129
+         * class only in certain conditions (e.g. only for logged in users) or
130
+         * modify what is returned to the caller.
131
+         *
132
+         * This option allows you to wrap global decorators
133
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
134
+         *
135
+         *  client/html/account/download/decorators/global = array( 'decorator1' )
136
+         *
137
+         * This would add the decorator named "decorator1" defined by
138
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
139
+         *
140
+         * @param array List of decorator names
141
+         * @since 2016.02
142
+         * @category Developer
143
+         * @see client/html/common/decorators/default
144
+         * @see client/html/account/download/decorators/excludes
145
+         * @see client/html/account/download/decorators/local
146
+         */
147
+
148
+        /** client/html/account/download/decorators/local
149
+         * Adds a list of local decorators only to the account download html client
150
+         *
151
+         * Decorators extend the functionality of a class by adding new aspects
152
+         * (e.g. log what is currently done), executing the methods of the underlying
153
+         * class only in certain conditions (e.g. only for logged in users) or
154
+         * modify what is returned to the caller.
155
+         *
156
+         * This option allows you to wrap local decorators
157
+         * ("\Aimeos\Client\Html\Account\Decorator\*") around the html client.
158
+         *
159
+         *  client/html/account/download/decorators/local = array( 'decorator2' )
160
+         *
161
+         * This would add the decorator named "decorator2" defined by
162
+         * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
163
+         *
164
+         * @param array List of decorator names
165
+         * @since 2016.02
166
+         * @category Developer
167
+         * @see client/html/common/decorators/default
168
+         * @see client/html/account/download/decorators/excludes
169
+         * @see client/html/account/download/decorators/global
170
+         */
171
+        return $this->createSubClient( 'account/download/' . $type, $name );
172
+    }
173
+
174
+
175
+    /**
176
+     * Processes the input, e.g. store given values.
177
+     * A view must be available and this method doesn't generate any output
178
+     * besides setting view variables.
179
+     */
180
+    public function process()
181
+    {
182
+        $context = $this->getContext();
183
+
184
+        try
185
+        {
186
+            $view = $this->getView();
187
+            $id = $view->param( 'dl_id' );
188
+            $customerId = $context->getUserId();
189
+
190
+            if( $this->checkAccess( $customerId, $id ) === false )
191
+            {
192
+                $view->response()->withStatus( 401 );
193
+                return;
194
+            }
195
+
196
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product/attribute' );
197
+            $item = $manager->getItem( $id );
198
+
199
+            if( $this->checkDownload( $context->getUserId(), $id ) === true ) {
200
+                $this->addDownload( $item );
201
+            } else {
202
+                $view->response()->withStatus( 403 );
203
+            }
204
+
205
+            parent::process();
206
+        }
207
+        catch( \Exception $e )
208
+        {
209
+            $context->getLogger()->log( $e->getMessage() );
210
+        }
211
+    }
212
+
213
+
214
+    /**
215
+     * Returns the list of sub-client names configured for the client.
216
+     *
217
+     * @return array List of HTML client names
218
+     */
219
+    protected function getSubClientNames()
220
+    {
221
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
222
+    }
223
+
224
+
225
+    /**
226
+     * Adds the necessary headers and the download content to the reponse object
227
+     *
228
+     * @param \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item Order product attribute item with file reference
229
+     */
230
+    protected function addDownload( \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item )
231
+    {
232
+        $fs = $this->getContext()->getFilesystemManager()->get( 'fs-secure' );
233
+        $response = $this->getView()->response();
234
+        $value = (string) $item->getValue();
235
+
236
+        if( $fs->has( $value ) )
237
+        {
238
+            $name = $item->getName();
239
+
240
+            if( pathinfo( $name, PATHINFO_EXTENSION ) == null
241
+                    && ( $ext = pathinfo( $value, PATHINFO_EXTENSION ) ) != null
242
+            ) {
243
+                $name .= '.' . $ext;
244
+            }
245
+
246
+            $response->withHeader( 'Content-Description', 'File Transfer' );
247
+            $response->withHeader( 'Content-Type', 'application/octet-stream' );
248
+            $response->withHeader( 'Content-Disposition', 'attachment; filename="' . $name . '"' );
249
+            $response->withHeader( 'Content-Length', (string) $fs->size( $value ) );
250
+            $response->withHeader( 'Cache-Control', 'must-revalidate' );
251
+            $response->withHeader( 'Pragma', 'private' );
252
+            $response->withHeader( 'Expires', '0' );
253
+
254
+            $response->withBody( $response->createStream( $fs->reads( $value ) ) );
255
+        }
256
+        elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
257
+        {
258
+            $response->withHeader( 'Location', $value );
259
+            $response->withStatus( 303 );
260
+        }
261
+        else
262
+        {
263
+            $response->withStatus( 404 );
264
+        }
265
+    }
266
+
267
+
268
+    /**
269
+     * Checks if the customer is allowed to download the file
270
+     *
271
+     * @param string $customerId Unique customer ID
272
+     * @param string $id Unique order base product attribute ID referencing the download file
273
+     * @return boolean True if download is allowed, false if not
274
+     */
275
+    protected function checkAccess( $customerId, $id )
276
+    {
277
+        if( $customerId !== null && $id !== null )
278
+        {
279
+            $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base' );
280
+
281
+            $search = $manager->createSearch();
282
+            $expr = array(
283
+                $search->compare( '==', 'order.base.customerid', $customerId ),
284
+                $search->compare( '==', 'order.base.product.attribute.id', $id ),
285
+            );
286
+            $search->setConditions( $search->combine( '&&', $expr ) );
287
+            $search->setSlice( 0, 1 );
288
+
289
+            if( count( $manager->searchItems( $search ) ) > 0 ) {
290
+                return true;
291
+            }
292
+        }
293
+
294
+        return false;
295
+    }
296
+
297
+
298
+    /**
299
+     * Updates the download counter for the downloaded file
300
+     *
301
+     * @param string $customerId Unique customer ID
302
+     * @param string $id Unique order base product attribute ID referencing the download file
303
+     * @return boolean True if download is allowed, false if not
304
+     */
305
+    protected function checkDownload( $customerId, $id )
306
+    {
307
+        $context = $this->getContext();
308
+
309
+        /** client/html/account/download/maxcount
310
+         * Maximum number of file downloads allowed for an ordered product
311
+         *
312
+         * This configuration setting enables you to limit the number of downloads
313
+         * of a product download file. The count is the maximum number for each
314
+         * bought product and customer, i.e. setting the count to "3" allows
315
+         * a customer to download the bought product file up to three times.
316
+         *
317
+         * The default value of null enforces no limit.
318
+         *
319
+         * @param integer Maximum number of downloads
320
+         * @since 2016.02
321
+         * @category Developer
322
+         * @category User
323
+         */
324
+        $maxcnt = $context->getConfig()->get( 'client/html/account/download/maxcount' );
325
+
326
+        $listItem = $this->getListItem( $customerId, $id );
327
+        $config = $listItem->getConfig();
328
+
329
+        if( !isset( $config['count'] ) ) {
330
+            $config['count'] = 0;
331
+        }
332
+
333
+        if( $maxcnt === null || ((int) $config['count']) < $maxcnt )
334
+        {
335
+            $config['count']++;
336
+            $listItem->setConfig( $config );
337
+
338
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
339
+            $manager->saveItem( $listItem, false );
340
+
341
+            return true;
342
+        }
343
+
344
+        return false;
345
+    }
346
+
347
+
348
+    /**
349
+     * Returns the list item storing the download counter
350
+     *
351
+     * @param string $customerId Unique customer ID
352
+     * @param string $refId Unique order base product attribute ID referencing the download file
353
+     * @return \Aimeos\MSho\Common\Item\Lists\Iface List item object
354
+     */
355
+    protected function getListItem( $customerId, $refId )
356
+    {
357
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'customer/lists' );
358
+
359
+        $search = $manager->createSearch();
360
+        $expr = array(
361
+            $search->compare( '==', 'customer.lists.parentid', $customerId ),
362
+            $search->compare( '==', 'customer.lists.refid', $refId ),
363
+            $search->compare( '==', 'customer.lists.domain', 'order' ),
364
+            $search->compare( '==', 'customer.lists.type.domain', 'order' ),
365
+            $search->compare( '==', 'customer.lists.type.code', 'download' ),
366
+        );
367
+        $search->setConditions( $search->combine( '&&', $expr ) );
368
+
369
+        $listItems = $manager->searchItems( $search );
370
+
371
+        if( ( $listItem = reset( $listItems ) ) === false )
372
+        {
373
+            $listItem = $manager->createItem();
374
+            $listItem->setTypeId( $this->getTypeItem( 'customer/lists/type', 'order', 'download' )->getId() );
375
+            $listItem->setParentId( $customerId );
376
+            $listItem->setDomain( 'order' );
377
+            $listItem->setRefId( $refId );
378
+        }
379
+
380
+        return $listItem;
381
+    }
382 382
 }
383 383
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +63 added lines, -63 removed lines patch added patch discarded remove patch
@@ -66,7 +66,7 @@  discard block
 block discarded – undo
66 66
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
67 67
 	 * @return string HTML code
68 68
 	 */
69
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
69
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
70 70
 	{
71 71
 		return '';
72 72
 	}
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
81 81
 	 * @return string|null String including HTML tags for the header on error
82 82
 	 */
83
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
83
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
84 84
 	{
85 85
 		return '';
86 86
 	}
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
 	 * @param string|null $name Name of the sub-client (Default if null)
94 94
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
95 95
 	 */
96
-	public function getSubClient( $type, $name = null )
96
+	public function getSubClient($type, $name = null)
97 97
 	{
98 98
 		/** client/html/account/download/decorators/excludes
99 99
 		 * Excludes decorators added by the "common" option from the account download html client
@@ -168,7 +168,7 @@  discard block
 block discarded – undo
168 168
 		 * @see client/html/account/download/decorators/excludes
169 169
 		 * @see client/html/account/download/decorators/global
170 170
 		 */
171
-		return $this->createSubClient( 'account/download/' . $type, $name );
171
+		return $this->createSubClient('account/download/'.$type, $name);
172 172
 	}
173 173
 
174 174
 
@@ -184,29 +184,29 @@  discard block
 block discarded – undo
184 184
 		try
185 185
 		{
186 186
 			$view = $this->getView();
187
-			$id = $view->param( 'dl_id' );
187
+			$id = $view->param('dl_id');
188 188
 			$customerId = $context->getUserId();
189 189
 
190
-			if( $this->checkAccess( $customerId, $id ) === false )
190
+			if ($this->checkAccess($customerId, $id) === false)
191 191
 			{
192
-				$view->response()->withStatus( 401 );
192
+				$view->response()->withStatus(401);
193 193
 				return;
194 194
 			}
195 195
 
196
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product/attribute' );
197
-			$item = $manager->getItem( $id );
196
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'order/base/product/attribute');
197
+			$item = $manager->getItem($id);
198 198
 
199
-			if( $this->checkDownload( $context->getUserId(), $id ) === true ) {
200
-				$this->addDownload( $item );
199
+			if ($this->checkDownload($context->getUserId(), $id) === true) {
200
+				$this->addDownload($item);
201 201
 			} else {
202
-				$view->response()->withStatus( 403 );
202
+				$view->response()->withStatus(403);
203 203
 			}
204 204
 
205 205
 			parent::process();
206 206
 		}
207
-		catch( \Exception $e )
207
+		catch (\Exception $e)
208 208
 		{
209
-			$context->getLogger()->log( $e->getMessage() );
209
+			$context->getLogger()->log($e->getMessage());
210 210
 		}
211 211
 	}
212 212
 
@@ -218,7 +218,7 @@  discard block
 block discarded – undo
218 218
 	 */
219 219
 	protected function getSubClientNames()
220 220
 	{
221
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
221
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
222 222
 	}
223 223
 
224 224
 
@@ -227,40 +227,40 @@  discard block
 block discarded – undo
227 227
 	 *
228 228
 	 * @param \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item Order product attribute item with file reference
229 229
 	 */
230
-	protected function addDownload( \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item )
230
+	protected function addDownload(\Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item)
231 231
 	{
232
-		$fs = $this->getContext()->getFilesystemManager()->get( 'fs-secure' );
232
+		$fs = $this->getContext()->getFilesystemManager()->get('fs-secure');
233 233
 		$response = $this->getView()->response();
234 234
 		$value = (string) $item->getValue();
235 235
 
236
-		if( $fs->has( $value ) )
236
+		if ($fs->has($value))
237 237
 		{
238 238
 			$name = $item->getName();
239 239
 
240
-			if( pathinfo( $name, PATHINFO_EXTENSION ) == null
241
-					&& ( $ext = pathinfo( $value, PATHINFO_EXTENSION ) ) != null
240
+			if (pathinfo($name, PATHINFO_EXTENSION) == null
241
+					&& ($ext = pathinfo($value, PATHINFO_EXTENSION)) != null
242 242
 			) {
243
-				$name .= '.' . $ext;
243
+				$name .= '.'.$ext;
244 244
 			}
245 245
 
246
-			$response->withHeader( 'Content-Description', 'File Transfer' );
247
-			$response->withHeader( 'Content-Type', 'application/octet-stream' );
248
-			$response->withHeader( 'Content-Disposition', 'attachment; filename="' . $name . '"' );
249
-			$response->withHeader( 'Content-Length', (string) $fs->size( $value ) );
250
-			$response->withHeader( 'Cache-Control', 'must-revalidate' );
251
-			$response->withHeader( 'Pragma', 'private' );
252
-			$response->withHeader( 'Expires', '0' );
246
+			$response->withHeader('Content-Description', 'File Transfer');
247
+			$response->withHeader('Content-Type', 'application/octet-stream');
248
+			$response->withHeader('Content-Disposition', 'attachment; filename="'.$name.'"');
249
+			$response->withHeader('Content-Length', (string) $fs->size($value));
250
+			$response->withHeader('Cache-Control', 'must-revalidate');
251
+			$response->withHeader('Pragma', 'private');
252
+			$response->withHeader('Expires', '0');
253 253
 
254
-			$response->withBody( $response->createStream( $fs->reads( $value ) ) );
254
+			$response->withBody($response->createStream($fs->reads($value)));
255 255
 		}
256
-		elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
256
+		elseif (filter_var($value, FILTER_VALIDATE_URL) !== false)
257 257
 		{
258
-			$response->withHeader( 'Location', $value );
259
-			$response->withStatus( 303 );
258
+			$response->withHeader('Location', $value);
259
+			$response->withStatus(303);
260 260
 		}
261 261
 		else
262 262
 		{
263
-			$response->withStatus( 404 );
263
+			$response->withStatus(404);
264 264
 		}
265 265
 	}
266 266
 
@@ -272,21 +272,21 @@  discard block
 block discarded – undo
272 272
 	 * @param string $id Unique order base product attribute ID referencing the download file
273 273
 	 * @return boolean True if download is allowed, false if not
274 274
 	 */
275
-	protected function checkAccess( $customerId, $id )
275
+	protected function checkAccess($customerId, $id)
276 276
 	{
277
-		if( $customerId !== null && $id !== null )
277
+		if ($customerId !== null && $id !== null)
278 278
 		{
279
-			$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base' );
279
+			$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'order/base');
280 280
 
281 281
 			$search = $manager->createSearch();
282 282
 			$expr = array(
283
-				$search->compare( '==', 'order.base.customerid', $customerId ),
284
-				$search->compare( '==', 'order.base.product.attribute.id', $id ),
283
+				$search->compare('==', 'order.base.customerid', $customerId),
284
+				$search->compare('==', 'order.base.product.attribute.id', $id),
285 285
 			);
286
-			$search->setConditions( $search->combine( '&&', $expr ) );
287
-			$search->setSlice( 0, 1 );
286
+			$search->setConditions($search->combine('&&', $expr));
287
+			$search->setSlice(0, 1);
288 288
 
289
-			if( count( $manager->searchItems( $search ) ) > 0 ) {
289
+			if (count($manager->searchItems($search)) > 0) {
290 290
 				return true;
291 291
 			}
292 292
 		}
@@ -302,7 +302,7 @@  discard block
 block discarded – undo
302 302
 	 * @param string $id Unique order base product attribute ID referencing the download file
303 303
 	 * @return boolean True if download is allowed, false if not
304 304
 	 */
305
-	protected function checkDownload( $customerId, $id )
305
+	protected function checkDownload($customerId, $id)
306 306
 	{
307 307
 		$context = $this->getContext();
308 308
 
@@ -321,22 +321,22 @@  discard block
 block discarded – undo
321 321
 		 * @category Developer
322 322
 		 * @category User
323 323
 		 */
324
-		$maxcnt = $context->getConfig()->get( 'client/html/account/download/maxcount' );
324
+		$maxcnt = $context->getConfig()->get('client/html/account/download/maxcount');
325 325
 
326
-		$listItem = $this->getListItem( $customerId, $id );
326
+		$listItem = $this->getListItem($customerId, $id);
327 327
 		$config = $listItem->getConfig();
328 328
 
329
-		if( !isset( $config['count'] ) ) {
329
+		if (!isset($config['count'])) {
330 330
 			$config['count'] = 0;
331 331
 		}
332 332
 
333
-		if( $maxcnt === null || ((int) $config['count']) < $maxcnt )
333
+		if ($maxcnt === null || ((int) $config['count']) < $maxcnt)
334 334
 		{
335 335
 			$config['count']++;
336
-			$listItem->setConfig( $config );
336
+			$listItem->setConfig($config);
337 337
 
338
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
339
-			$manager->saveItem( $listItem, false );
338
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'customer/lists');
339
+			$manager->saveItem($listItem, false);
340 340
 
341 341
 			return true;
342 342
 		}
@@ -352,29 +352,29 @@  discard block
 block discarded – undo
352 352
 	 * @param string $refId Unique order base product attribute ID referencing the download file
353 353
 	 * @return \Aimeos\MSho\Common\Item\Lists\Iface List item object
354 354
 	 */
355
-	protected function getListItem( $customerId, $refId )
355
+	protected function getListItem($customerId, $refId)
356 356
 	{
357
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'customer/lists' );
357
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'customer/lists');
358 358
 
359 359
 		$search = $manager->createSearch();
360 360
 		$expr = array(
361
-			$search->compare( '==', 'customer.lists.parentid', $customerId ),
362
-			$search->compare( '==', 'customer.lists.refid', $refId ),
363
-			$search->compare( '==', 'customer.lists.domain', 'order' ),
364
-			$search->compare( '==', 'customer.lists.type.domain', 'order' ),
365
-			$search->compare( '==', 'customer.lists.type.code', 'download' ),
361
+			$search->compare('==', 'customer.lists.parentid', $customerId),
362
+			$search->compare('==', 'customer.lists.refid', $refId),
363
+			$search->compare('==', 'customer.lists.domain', 'order'),
364
+			$search->compare('==', 'customer.lists.type.domain', 'order'),
365
+			$search->compare('==', 'customer.lists.type.code', 'download'),
366 366
 		);
367
-		$search->setConditions( $search->combine( '&&', $expr ) );
367
+		$search->setConditions($search->combine('&&', $expr));
368 368
 
369
-		$listItems = $manager->searchItems( $search );
369
+		$listItems = $manager->searchItems($search);
370 370
 
371
-		if( ( $listItem = reset( $listItems ) ) === false )
371
+		if (($listItem = reset($listItems)) === false)
372 372
 		{
373 373
 			$listItem = $manager->createItem();
374
-			$listItem->setTypeId( $this->getTypeItem( 'customer/lists/type', 'order', 'download' )->getId() );
375
-			$listItem->setParentId( $customerId );
376
-			$listItem->setDomain( 'order' );
377
-			$listItem->setRefId( $refId );
374
+			$listItem->setTypeId($this->getTypeItem('customer/lists/type', 'order', 'download')->getId());
375
+			$listItem->setParentId($customerId);
376
+			$listItem->setDomain('order');
377
+			$listItem->setRefId($refId);
378 378
 		}
379 379
 
380 380
 		return $listItem;
Please login to merge, or discard this patch.
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -203,8 +203,7 @@  discard block
 block discarded – undo
203 203
 			}
204 204
 
205 205
 			parent::process();
206
-		}
207
-		catch( \Exception $e )
206
+		} catch( \Exception $e )
208 207
 		{
209 208
 			$context->getLogger()->log( $e->getMessage() );
210 209
 		}
@@ -252,13 +251,11 @@  discard block
 block discarded – undo
252 251
 			$response->withHeader( 'Expires', '0' );
253 252
 
254 253
 			$response->withBody( $response->createStream( $fs->reads( $value ) ) );
255
-		}
256
-		elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
254
+		} elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
257 255
 		{
258 256
 			$response->withHeader( 'Location', $value );
259 257
 			$response->withStatus( 303 );
260
-		}
261
-		else
258
+		} else
262 259
 		{
263 260
 			$response->withStatus( 404 );
264 261
 		}
Please login to merge, or discard this patch.
client/html/src/Client/Html/Account/Watch/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 account watch 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/account/watch/name
37
-		 * Class name of the used account watch 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\Account\Watch\Standard
47
-		 *
48
-		 * and you want to replace it with your own version named
49
-		 *
50
-		 *  \Aimeos\Client\Html\Account\Watch\Mywatch
51
-		 *
52
-		 * then you have to set the this configuration option:
53
-		 *
54
-		 *  client/html/account/watch/name = Mywatch
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 "MyWatch"!
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/account/watch/name', 'Standard' );
71
-		}
25
+    /**
26
+     * Creates a account watch 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/account/watch/name
37
+         * Class name of the used account watch 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\Account\Watch\Standard
47
+         *
48
+         * and you want to replace it with your own version named
49
+         *
50
+         *  \Aimeos\Client\Html\Account\Watch\Mywatch
51
+         *
52
+         * then you have to set the this configuration option:
53
+         *
54
+         *  client/html/account/watch/name = Mywatch
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 "MyWatch"!
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/account/watch/name', 'Standard' );
71
+        }
72 72
 
73
-		if( ctype_alnum( $name ) === false )
74
-		{
75
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Watch\\' . $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\\Account\\Watch\\' . $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\\Account\\Watch\\' . $name;
79
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
80
+        $classname = '\\Aimeos\\Client\\Html\\Account\\Watch\\' . $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, 'account/watch' );
85
-	}
84
+        return self::addClientDecorators( $context, $client, $templatePaths, 'account/watch' );
85
+    }
86 86
 
87 87
 }
88 88
\ No newline at end of file
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/account/watch/name
37 37
 		 * Class name of the used account watch 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/account/watch/name', 'Standard' );
69
+		if ($name === null) {
70
+			$name = $context->getConfig()->get('client/html/account/watch/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\\Account\\Watch\\' . $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\\Account\\Watch\\'.$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\\Account\\Watch\\' . $name;
80
+		$classname = '\\Aimeos\\Client\\Html\\Account\\Watch\\'.$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, 'account/watch' );
84
+		return self::addClientDecorators($context, $client, $templatePaths, 'account/watch');
85 85
 	}
86 86
 
87 87
 }
88 88
\ No newline at end of file
Please login to merge, or discard this patch.