Completed
Push — master ( 33a95e...daccbb )
by Aimeos
09:31
created
client/html/src/Client/Html/Catalog/Detail/Social/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\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/catalog/detail/social/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail social section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.09
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/catalog/detail/social/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->socialBody = $html;
79
-
80
-		/** client/html/catalog/detail/social/standard/template-body
81
-		 * Relative path to the HTML body template of the catalog detail social client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.09
97
-		 * @category Developer
98
-		 * @see client/html/catalog/detail/social/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/catalog/detail/social/standard/template-body';
101
-		$default = 'catalog/detail/social-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->socialHeader = $html;
124
-
125
-		/** client/html/catalog/detail/social/standard/template-header
126
-		 * Relative path to the HTML header template of the catalog detail social client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.09
143
-		 * @category Developer
144
-		 * @see client/html/catalog/detail/social/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/catalog/detail/social/standard/template-header';
147
-		$default = 'catalog/detail/social-header-default.php';
148
-
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
151
-
152
-
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/catalog/detail/social/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the catalog detail social html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/catalog/detail/social/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/catalog/detail/social/decorators/global
185
-		 * @see client/html/catalog/detail/social/decorators/local
186
-		 */
187
-
188
-		/** client/html/catalog/detail/social/decorators/global
189
-		 * Adds a list of globally available decorators only to the catalog detail social html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/catalog/detail/social/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/catalog/detail/social/decorators/excludes
209
-		 * @see client/html/catalog/detail/social/decorators/local
210
-		 */
211
-
212
-		/** client/html/catalog/detail/social/decorators/local
213
-		 * Adds a list of local decorators only to the catalog detail social html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/catalog/detail/social/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/catalog/detail/social/decorators/excludes
233
-		 * @see client/html/catalog/detail/social/decorators/global
234
-		 */
235
-
236
-		return $this->createSubClient( 'catalog/detail/social/' . $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
-	}
25
+    /** client/html/catalog/detail/social/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail social section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.09
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/catalog/detail/social/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->socialBody = $html;
79
+
80
+        /** client/html/catalog/detail/social/standard/template-body
81
+         * Relative path to the HTML body template of the catalog detail social client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.09
97
+         * @category Developer
98
+         * @see client/html/catalog/detail/social/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/catalog/detail/social/standard/template-body';
101
+        $default = 'catalog/detail/social-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->socialHeader = $html;
124
+
125
+        /** client/html/catalog/detail/social/standard/template-header
126
+         * Relative path to the HTML header template of the catalog detail social client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.09
143
+         * @category Developer
144
+         * @see client/html/catalog/detail/social/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/catalog/detail/social/standard/template-header';
147
+        $default = 'catalog/detail/social-header-default.php';
148
+
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151
+
152
+
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/catalog/detail/social/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the catalog detail social html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/catalog/detail/social/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/catalog/detail/social/decorators/global
185
+         * @see client/html/catalog/detail/social/decorators/local
186
+         */
187
+
188
+        /** client/html/catalog/detail/social/decorators/global
189
+         * Adds a list of globally available decorators only to the catalog detail social html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/catalog/detail/social/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/catalog/detail/social/decorators/excludes
209
+         * @see client/html/catalog/detail/social/decorators/local
210
+         */
211
+
212
+        /** client/html/catalog/detail/social/decorators/local
213
+         * Adds a list of local decorators only to the catalog detail social html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/catalog/detail/social/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/catalog/detail/social/decorators/excludes
233
+         * @see client/html/catalog/detail/social/decorators/global
234
+         */
235
+
236
+        return $this->createSubClient( 'catalog/detail/social/' . $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
@@ -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->socialBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/catalog/detail/social/standard/template-body';
101 101
 		$default = 'catalog/detail/social-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->socialHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/catalog/detail/social/standard/template-header';
147 147
 		$default = 'catalog/detail/social-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/catalog/detail/social/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the catalog detail social html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/catalog/detail/social/decorators/global
234 234
 		 */
235 235
 
236
-		return $this->createSubClient( 'catalog/detail/social/' . $type, $name );
236
+		return $this->createSubClient('catalog/detail/social/'.$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/Catalog/Detail/Actions/Standard.php 3 patches
Indentation   +239 added lines, -239 removed lines patch added patch discarded remove patch
@@ -19,267 +19,267 @@
 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/catalog/detail/actions/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail actions section
27
-	 *
28
-	 * The output of the frontend is composed of the code generated by the HTML
29
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
30
-	 * that are responsible for rendering certain sub-parts of the output. The
31
-	 * sub-clients can contain HTML clients themselves and therefore a
32
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
33
-	 * the output that is placed inside the container of its parent.
34
-	 *
35
-	 * At first, always the HTML code generated by the parent is printed, then
36
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
37
-	 * determines the order of the output of these sub-clients inside the parent
38
-	 * container. If the configured list of clients is
39
-	 *
40
-	 *  array( "subclient1", "subclient2" )
41
-	 *
42
-	 * you can easily change the order of the output by reordering the subparts:
43
-	 *
44
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
-	 *
46
-	 * You can also remove one or more parts if they shouldn't be rendered:
47
-	 *
48
-	 *  client/html/<clients>/subparts = array( "subclient1" )
49
-	 *
50
-	 * As the clients only generates structural HTML, the layout defined via CSS
51
-	 * should support adding, removing or reordering content by a fluid like
52
-	 * design.
53
-	 *
54
-	 * @param array List of sub-client names
55
-	 * @since 2014.09
56
-	 * @category Developer
57
-	 */
58
-	private $subPartPath = 'client/html/catalog/detail/actions/standard/subparts';
59
-	private $subPartNames = array();
60
-	private $cache;
25
+    /** client/html/catalog/detail/actions/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail actions section
27
+     *
28
+     * The output of the frontend is composed of the code generated by the HTML
29
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
30
+     * that are responsible for rendering certain sub-parts of the output. The
31
+     * sub-clients can contain HTML clients themselves and therefore a
32
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
33
+     * the output that is placed inside the container of its parent.
34
+     *
35
+     * At first, always the HTML code generated by the parent is printed, then
36
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
37
+     * determines the order of the output of these sub-clients inside the parent
38
+     * container. If the configured list of clients is
39
+     *
40
+     *  array( "subclient1", "subclient2" )
41
+     *
42
+     * you can easily change the order of the output by reordering the subparts:
43
+     *
44
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
45
+     *
46
+     * You can also remove one or more parts if they shouldn't be rendered:
47
+     *
48
+     *  client/html/<clients>/subparts = array( "subclient1" )
49
+     *
50
+     * As the clients only generates structural HTML, the layout defined via CSS
51
+     * should support adding, removing or reordering content by a fluid like
52
+     * design.
53
+     *
54
+     * @param array List of sub-client names
55
+     * @since 2014.09
56
+     * @category Developer
57
+     */
58
+    private $subPartPath = 'client/html/catalog/detail/actions/standard/subparts';
59
+    private $subPartNames = array();
60
+    private $cache;
61 61
 
62 62
 
63
-	/**
64
-	 * Returns the HTML code for insertion into the body.
65
-	 *
66
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
67
-	 * @param array &$tags Result array for the list of tags that are associated to the output
68
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69
-	 * @return string HTML code
70
-	 */
71
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
-	{
73
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
63
+    /**
64
+     * Returns the HTML code for insertion into the body.
65
+     *
66
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
67
+     * @param array &$tags Result array for the list of tags that are associated to the output
68
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69
+     * @return string HTML code
70
+     */
71
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
+    {
73
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
74 74
 
75
-		$html = '';
76
-		foreach( $this->getSubClients() as $subclient ) {
77
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
78
-		}
79
-		$view->actionsBody = $html;
75
+        $html = '';
76
+        foreach( $this->getSubClients() as $subclient ) {
77
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
78
+        }
79
+        $view->actionsBody = $html;
80 80
 
81
-		/** client/html/catalog/detail/actions/standard/template-body
82
-		 * Relative path to the HTML body template of the catalog detail actions client.
83
-		 *
84
-		 * The template file contains the HTML code and processing instructions
85
-		 * to generate the result shown in the body of the frontend. The
86
-		 * configuration string is the path to the template file relative
87
-		 * to the templates directory (usually in client/html/templates).
88
-		 *
89
-		 * You can overwrite the template file configuration in extensions and
90
-		 * provide alternative templates. These alternative templates should be
91
-		 * named like the default one but with the string "standard" replaced by
92
-		 * an unique name. You may use the name of your project for this. If
93
-		 * you've implemented an alternative client class as well, "standard"
94
-		 * should be replaced by the name of the new class.
95
-		 *
96
-		 * @param string Relative path to the template creating code for the HTML page body
97
-		 * @since 2014.09
98
-		 * @category Developer
99
-		 * @see client/html/catalog/detail/actions/standard/template-header
100
-		 */
101
-		$tplconf = 'client/html/catalog/detail/actions/standard/template-body';
102
-		$default = 'catalog/detail/actions-body-default.php';
81
+        /** client/html/catalog/detail/actions/standard/template-body
82
+         * Relative path to the HTML body template of the catalog detail actions client.
83
+         *
84
+         * The template file contains the HTML code and processing instructions
85
+         * to generate the result shown in the body of the frontend. The
86
+         * configuration string is the path to the template file relative
87
+         * to the templates directory (usually in client/html/templates).
88
+         *
89
+         * You can overwrite the template file configuration in extensions and
90
+         * provide alternative templates. These alternative templates should be
91
+         * named like the default one but with the string "standard" replaced by
92
+         * an unique name. You may use the name of your project for this. If
93
+         * you've implemented an alternative client class as well, "standard"
94
+         * should be replaced by the name of the new class.
95
+         *
96
+         * @param string Relative path to the template creating code for the HTML page body
97
+         * @since 2014.09
98
+         * @category Developer
99
+         * @see client/html/catalog/detail/actions/standard/template-header
100
+         */
101
+        $tplconf = 'client/html/catalog/detail/actions/standard/template-body';
102
+        $default = 'catalog/detail/actions-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->actionsHeader = $html;
120
+        $html = '';
121
+        foreach( $this->getSubClients() as $subclient ) {
122
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
+        }
124
+        $view->actionsHeader = $html;
125 125
 
126
-		/** client/html/catalog/detail/actions/standard/template-header
127
-		 * Relative path to the HTML header template of the catalog detail actions 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
-		 * should be replaced by the name of the new class.
141
-		 *
142
-		 * @param string Relative path to the template creating code for the HTML page head
143
-		 * @since 2014.09
144
-		 * @category Developer
145
-		 * @see client/html/catalog/detail/actions/standard/template-body
146
-		 */
147
-		$tplconf = 'client/html/catalog/detail/actions/standard/template-header';
148
-		$default = 'catalog/detail/actions-header-default.php';
126
+        /** client/html/catalog/detail/actions/standard/template-header
127
+         * Relative path to the HTML header template of the catalog detail actions 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
+         * should be replaced by the name of the new class.
141
+         *
142
+         * @param string Relative path to the template creating code for the HTML page head
143
+         * @since 2014.09
144
+         * @category Developer
145
+         * @see client/html/catalog/detail/actions/standard/template-body
146
+         */
147
+        $tplconf = 'client/html/catalog/detail/actions/standard/template-header';
148
+        $default = 'catalog/detail/actions-header-default.php';
149 149
 
150
-		return $view->render( $view->config( $tplconf, $default ) );
151
-	}
150
+        return $view->render( $view->config( $tplconf, $default ) );
151
+    }
152 152
 
153 153
 
154
-	/**
155
-	 * Modifies the cached body content to replace content based on sessions or cookies.
156
-	 *
157
-	 * @param string $content Cached content
158
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
159
-	 * @return string Modified body content
160
-	 */
161
-	public function modifyBody( $content, $uid )
162
-	{
163
-		return $this->replaceSection( $content, $this->getBody( $uid ), 'catalog.detail.actions' );
164
-	}
154
+    /**
155
+     * Modifies the cached body content to replace content based on sessions or cookies.
156
+     *
157
+     * @param string $content Cached content
158
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
159
+     * @return string Modified body content
160
+     */
161
+    public function modifyBody( $content, $uid )
162
+    {
163
+        return $this->replaceSection( $content, $this->getBody( $uid ), 'catalog.detail.actions' );
164
+    }
165 165
 
166 166
 
167
-	/**
168
-	 * Returns the sub-client given by its name.
169
-	 *
170
-	 * @param string $type Name of the client type
171
-	 * @param string|null $name Name of the sub-client (Default if null)
172
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
173
-	 */
174
-	public function getSubClient( $type, $name = null )
175
-	{
176
-		/** client/html/catalog/detail/actions/decorators/excludes
177
-		 * Excludes decorators added by the "common" option from the catalog detail actions html client
178
-		 *
179
-		 * Decorators extend the functionality of a class by adding new aspects
180
-		 * (e.g. log what is currently done), executing the methods of the underlying
181
-		 * class only in certain conditions (e.g. only for logged in users) or
182
-		 * modify what is returned to the caller.
183
-		 *
184
-		 * This option allows you to remove a decorator added via
185
-		 * "client/html/common/decorators/default" before they are wrapped
186
-		 * around the html client.
187
-		 *
188
-		 *  client/html/catalog/detail/actions/decorators/excludes = array( 'decorator1' )
189
-		 *
190
-		 * This would remove the decorator named "decorator1" from the list of
191
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
192
-		 * "client/html/common/decorators/default" to the html client.
193
-		 *
194
-		 * @param array List of decorator names
195
-		 * @since 2015.08
196
-		 * @category Developer
197
-		 * @see client/html/common/decorators/default
198
-		 * @see client/html/catalog/detail/actions/decorators/global
199
-		 * @see client/html/catalog/detail/actions/decorators/local
200
-		 */
167
+    /**
168
+     * Returns the sub-client given by its name.
169
+     *
170
+     * @param string $type Name of the client type
171
+     * @param string|null $name Name of the sub-client (Default if null)
172
+     * @return \Aimeos\Client\Html\Iface Sub-client object
173
+     */
174
+    public function getSubClient( $type, $name = null )
175
+    {
176
+        /** client/html/catalog/detail/actions/decorators/excludes
177
+         * Excludes decorators added by the "common" option from the catalog detail actions html client
178
+         *
179
+         * Decorators extend the functionality of a class by adding new aspects
180
+         * (e.g. log what is currently done), executing the methods of the underlying
181
+         * class only in certain conditions (e.g. only for logged in users) or
182
+         * modify what is returned to the caller.
183
+         *
184
+         * This option allows you to remove a decorator added via
185
+         * "client/html/common/decorators/default" before they are wrapped
186
+         * around the html client.
187
+         *
188
+         *  client/html/catalog/detail/actions/decorators/excludes = array( 'decorator1' )
189
+         *
190
+         * This would remove the decorator named "decorator1" from the list of
191
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
192
+         * "client/html/common/decorators/default" to the html client.
193
+         *
194
+         * @param array List of decorator names
195
+         * @since 2015.08
196
+         * @category Developer
197
+         * @see client/html/common/decorators/default
198
+         * @see client/html/catalog/detail/actions/decorators/global
199
+         * @see client/html/catalog/detail/actions/decorators/local
200
+         */
201 201
 
202
-		/** client/html/catalog/detail/actions/decorators/global
203
-		 * Adds a list of globally available decorators only to the catalog detail actions html client
204
-		 *
205
-		 * Decorators extend the functionality of a class by adding new aspects
206
-		 * (e.g. log what is currently done), executing the methods of the underlying
207
-		 * class only in certain conditions (e.g. only for logged in users) or
208
-		 * modify what is returned to the caller.
209
-		 *
210
-		 * This option allows you to wrap global decorators
211
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
212
-		 *
213
-		 *  client/html/catalog/detail/actions/decorators/global = array( 'decorator1' )
214
-		 *
215
-		 * This would add the decorator named "decorator1" defined by
216
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
217
-		 *
218
-		 * @param array List of decorator names
219
-		 * @since 2015.08
220
-		 * @category Developer
221
-		 * @see client/html/common/decorators/default
222
-		 * @see client/html/catalog/detail/actions/decorators/excludes
223
-		 * @see client/html/catalog/detail/actions/decorators/local
224
-		 */
202
+        /** client/html/catalog/detail/actions/decorators/global
203
+         * Adds a list of globally available decorators only to the catalog detail actions html client
204
+         *
205
+         * Decorators extend the functionality of a class by adding new aspects
206
+         * (e.g. log what is currently done), executing the methods of the underlying
207
+         * class only in certain conditions (e.g. only for logged in users) or
208
+         * modify what is returned to the caller.
209
+         *
210
+         * This option allows you to wrap global decorators
211
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
212
+         *
213
+         *  client/html/catalog/detail/actions/decorators/global = array( 'decorator1' )
214
+         *
215
+         * This would add the decorator named "decorator1" defined by
216
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
217
+         *
218
+         * @param array List of decorator names
219
+         * @since 2015.08
220
+         * @category Developer
221
+         * @see client/html/common/decorators/default
222
+         * @see client/html/catalog/detail/actions/decorators/excludes
223
+         * @see client/html/catalog/detail/actions/decorators/local
224
+         */
225 225
 
226
-		/** client/html/catalog/detail/actions/decorators/local
227
-		 * Adds a list of local decorators only to the catalog detail actions html client
228
-		 *
229
-		 * Decorators extend the functionality of a class by adding new aspects
230
-		 * (e.g. log what is currently done), executing the methods of the underlying
231
-		 * class only in certain conditions (e.g. only for logged in users) or
232
-		 * modify what is returned to the caller.
233
-		 *
234
-		 * This option allows you to wrap local decorators
235
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
236
-		 *
237
-		 *  client/html/catalog/detail/actions/decorators/local = array( 'decorator2' )
238
-		 *
239
-		 * This would add the decorator named "decorator2" defined by
240
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
241
-		 *
242
-		 * @param array List of decorator names
243
-		 * @since 2015.08
244
-		 * @category Developer
245
-		 * @see client/html/common/decorators/default
246
-		 * @see client/html/catalog/detail/actions/decorators/excludes
247
-		 * @see client/html/catalog/detail/actions/decorators/global
248
-		 */
226
+        /** client/html/catalog/detail/actions/decorators/local
227
+         * Adds a list of local decorators only to the catalog detail actions html client
228
+         *
229
+         * Decorators extend the functionality of a class by adding new aspects
230
+         * (e.g. log what is currently done), executing the methods of the underlying
231
+         * class only in certain conditions (e.g. only for logged in users) or
232
+         * modify what is returned to the caller.
233
+         *
234
+         * This option allows you to wrap local decorators
235
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
236
+         *
237
+         *  client/html/catalog/detail/actions/decorators/local = array( 'decorator2' )
238
+         *
239
+         * This would add the decorator named "decorator2" defined by
240
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
241
+         *
242
+         * @param array List of decorator names
243
+         * @since 2015.08
244
+         * @category Developer
245
+         * @see client/html/common/decorators/default
246
+         * @see client/html/catalog/detail/actions/decorators/excludes
247
+         * @see client/html/catalog/detail/actions/decorators/global
248
+         */
249 249
 
250
-		return $this->createSubClient( 'catalog/detail/actions/' . $type, $name );
251
-	}
250
+        return $this->createSubClient( 'catalog/detail/actions/' . $type, $name );
251
+    }
252 252
 
253 253
 
254
-	/**
255
-	 * Returns the list of sub-client names configured for the client.
256
-	 *
257
-	 * @return array List of HTML client names
258
-	 */
259
-	protected function getSubClientNames()
260
-	{
261
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
262
-	}
254
+    /**
255
+     * Returns the list of sub-client names configured for the client.
256
+     *
257
+     * @return array List of HTML client names
258
+     */
259
+    protected function getSubClientNames()
260
+    {
261
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
262
+    }
263 263
 
264 264
 
265
-	/**
266
-	 * Sets the necessary parameter values in the view.
267
-	 *
268
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
269
-	 * @param array &$tags Result array for the list of tags that are associated to the output
270
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
271
-	 * @return \Aimeos\MW\View\Iface Modified view object
272
-	 */
273
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
274
-	{
275
-		if( !isset( $this->cache ) )
276
-		{
277
-			$view->actionsParams = $this->getClientParams( $view->param() );
278
-			$view->actionsUserId = $this->getContext()->getUserId();
265
+    /**
266
+     * Sets the necessary parameter values in the view.
267
+     *
268
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
269
+     * @param array &$tags Result array for the list of tags that are associated to the output
270
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
271
+     * @return \Aimeos\MW\View\Iface Modified view object
272
+     */
273
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
274
+    {
275
+        if( !isset( $this->cache ) )
276
+        {
277
+            $view->actionsParams = $this->getClientParams( $view->param() );
278
+            $view->actionsUserId = $this->getContext()->getUserId();
279 279
 
280
-			$this->cache = $view;
281
-		}
280
+            $this->cache = $view;
281
+        }
282 282
 
283
-		return $this->cache;
284
-	}
283
+        return $this->cache;
284
+    }
285 285
 }
286 286
\ 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
@@ -68,13 +68,13 @@  discard block
 block discarded – undo
68 68
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
69 69
 	 * @return string HTML code
70 70
 	 */
71
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
71
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
72 72
 	{
73
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
73
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
74 74
 
75 75
 		$html = '';
76
-		foreach( $this->getSubClients() as $subclient ) {
77
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
76
+		foreach ($this->getSubClients() as $subclient) {
77
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
78 78
 		}
79 79
 		$view->actionsBody = $html;
80 80
 
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
 		$tplconf = 'client/html/catalog/detail/actions/standard/template-body';
102 102
 		$default = 'catalog/detail/actions-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->actionsHeader = $html;
125 125
 
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
 		$tplconf = 'client/html/catalog/detail/actions/standard/template-header';
148 148
 		$default = 'catalog/detail/actions-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,9 +158,9 @@  discard block
 block discarded – undo
158 158
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
159 159
 	 * @return string Modified body content
160 160
 	 */
161
-	public function modifyBody( $content, $uid )
161
+	public function modifyBody($content, $uid)
162 162
 	{
163
-		return $this->replaceSection( $content, $this->getBody( $uid ), 'catalog.detail.actions' );
163
+		return $this->replaceSection($content, $this->getBody($uid), 'catalog.detail.actions');
164 164
 	}
165 165
 
166 166
 
@@ -171,7 +171,7 @@  discard block
 block discarded – undo
171 171
 	 * @param string|null $name Name of the sub-client (Default if null)
172 172
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
173 173
 	 */
174
-	public function getSubClient( $type, $name = null )
174
+	public function getSubClient($type, $name = null)
175 175
 	{
176 176
 		/** client/html/catalog/detail/actions/decorators/excludes
177 177
 		 * Excludes decorators added by the "common" option from the catalog detail actions html client
@@ -247,7 +247,7 @@  discard block
 block discarded – undo
247 247
 		 * @see client/html/catalog/detail/actions/decorators/global
248 248
 		 */
249 249
 
250
-		return $this->createSubClient( 'catalog/detail/actions/' . $type, $name );
250
+		return $this->createSubClient('catalog/detail/actions/'.$type, $name);
251 251
 	}
252 252
 
253 253
 
@@ -258,7 +258,7 @@  discard block
 block discarded – undo
258 258
 	 */
259 259
 	protected function getSubClientNames()
260 260
 	{
261
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
261
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
262 262
 	}
263 263
 
264 264
 
@@ -270,11 +270,11 @@  discard block
 block discarded – undo
270 270
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
271 271
 	 * @return \Aimeos\MW\View\Iface Modified view object
272 272
 	 */
273
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
273
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
274 274
 	{
275
-		if( !isset( $this->cache ) )
275
+		if (!isset($this->cache))
276 276
 		{
277
-			$view->actionsParams = $this->getClientParams( $view->param() );
277
+			$view->actionsParams = $this->getClientParams($view->param());
278 278
 			$view->actionsUserId = $this->getContext()->getUserId();
279 279
 
280 280
 			$this->cache = $view;
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/Catalog/Detail/Additional/Property/Standard.php 3 patches
Spacing   +21 added lines, -21 removed lines patch added patch discarded remove patch
@@ -69,13 +69,13 @@  discard block
 block discarded – undo
69 69
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
70 70
 	 * @return string HTML code
71 71
 	 */
72
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
73 73
 	{
74
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
74
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
75 75
 
76 76
 		$html = '';
77
-		foreach( $this->getSubClients() as $subclient ) {
78
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+		foreach ($this->getSubClients() as $subclient) {
78
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
79 79
 		}
80 80
 		$view->propertyBody = $html;
81 81
 
@@ -102,7 +102,7 @@  discard block
 block discarded – undo
102 102
 		$tplconf = 'client/html/catalog/detail/additional/property/standard/template-body';
103 103
 		$default = 'catalog/detail/additional-property-body-default.php';
104 104
 
105
-		return $view->render( $view->config( $tplconf, $default ) );
105
+		return $view->render($view->config($tplconf, $default));
106 106
 	}
107 107
 
108 108
 
@@ -114,13 +114,13 @@  discard block
 block discarded – undo
114 114
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115 115
 	 * @return string|null String including HTML tags for the header on error
116 116
 	 */
117
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
118 118
 	{
119
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
119
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
120 120
 
121 121
 		$html = '';
122
-		foreach( $this->getSubClients() as $subclient ) {
123
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+		foreach ($this->getSubClients() as $subclient) {
123
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
124 124
 		}
125 125
 		$view->propertyHeader = $html;
126 126
 
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 		$tplconf = 'client/html/catalog/detail/additional/property/standard/template-header';
149 149
 		$default = 'catalog/detail/additional-property-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/catalog/detail/additional/property/decorators/excludes
165 165
 		 * Excludes decorators added by the "common" option from the catalog detail additional property html client
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
 		 * @see client/html/catalog/detail/additional/property/decorators/global
236 236
 		 */
237 237
 
238
-		return $this->createSubClient( 'catalog/detail/additional/property/' . $type, $name );
238
+		return $this->createSubClient('catalog/detail/additional/property/'.$type, $name);
239 239
 	}
240 240
 
241 241
 
@@ -246,7 +246,7 @@  discard block
 block discarded – undo
246 246
 	 */
247 247
 	protected function getSubClientNames()
248 248
 	{
249
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
250 250
 	}
251 251
 
252 252
 
@@ -258,22 +258,22 @@  discard block
 block discarded – undo
258 258
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259 259
 	 * @return \Aimeos\MW\View\Iface Modified view object
260 260
 	 */
261
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
261
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
262 262
 	{
263
-		if( !isset( $this->cache ) )
263
+		if (!isset($this->cache))
264 264
 		{
265
-			if( isset( $view->detailProductItem ) )
265
+			if (isset($view->detailProductItem))
266 266
 			{
267
-				$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/property' );
267
+				$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'product/property');
268 268
 
269
-				$search = $manager->createSearch( true );
269
+				$search = $manager->createSearch(true);
270 270
 				$expr = array(
271
-					$search->compare( '==', 'product.property.parentid', $view->detailProductItem->getId() ),
271
+					$search->compare('==', 'product.property.parentid', $view->detailProductItem->getId()),
272 272
 					$search->getConditions(),
273 273
 				);
274
-				$search->setConditions( $search->combine( '&&', $expr ) );
274
+				$search->setConditions($search->combine('&&', $expr));
275 275
 
276
-				$properties = $manager->searchItems( $search );
276
+				$properties = $manager->searchItems($search);
277 277
 
278 278
 				$view->propertyItems = $properties;
279 279
 			}
Please login to merge, or discard this patch.
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
110 110
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111 111
 	 * @param array &$tags Result array for the list of tags that are associated to the output
112 112
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|null String including HTML tags for the header on error
113
+	 * @return string String including HTML tags for the header on error
114 114
 	 */
115 115
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
116 116
 	{
Please login to merge, or discard this patch.
Indentation   +238 added lines, -238 removed lines patch added patch discarded remove patch
@@ -18,267 +18,267 @@
 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/catalog/detail/additional/property/standard/subparts
25
-	 * List of HTML sub-clients rendered within the catalog detail additional property 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.01
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/catalog/detail/additional/property/standard/subparts';
58
-	private $subPartNames = array();
59
-	private $cache;
24
+    /** client/html/catalog/detail/additional/property/standard/subparts
25
+     * List of HTML sub-clients rendered within the catalog detail additional property 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.01
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/catalog/detail/additional/property/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->propertyBody = $html;
74
+        $html = '';
75
+        foreach( $this->getSubClients() as $subclient ) {
76
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+        }
78
+        $view->propertyBody = $html;
79 79
 
80
-		/** client/html/catalog/detail/additional/property/standard/template-body
81
-		 * Relative path to the HTML body template of the catalog detail additional property client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2015.01
97
-		 * @category Developer
98
-		 * @see client/html/catalog/detail/additional/property/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/catalog/detail/additional/property/standard/template-body';
101
-		$default = 'catalog/detail/additional-property-body-default.php';
80
+        /** client/html/catalog/detail/additional/property/standard/template-body
81
+         * Relative path to the HTML body template of the catalog detail additional property client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2015.01
97
+         * @category Developer
98
+         * @see client/html/catalog/detail/additional/property/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/catalog/detail/additional/property/standard/template-body';
101
+        $default = 'catalog/detail/additional-property-body-default.php';
102 102
 
103
-		return $view->render( $view->config( $tplconf, $default ) );
104
-	}
103
+        return $view->render( $view->config( $tplconf, $default ) );
104
+    }
105 105
 
106 106
 
107
-	/**
108
-	 * Returns the HTML string for insertion into the header.
109
-	 *
110
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
111
-	 * @param array &$tags Result array for the list of tags that are associated to the output
112
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
113
-	 * @return string|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 );
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 118
 
119
-		$html = '';
120
-		foreach( $this->getSubClients() as $subclient ) {
121
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
-		}
123
-		$view->propertyHeader = $html;
119
+        $html = '';
120
+        foreach( $this->getSubClients() as $subclient ) {
121
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+        }
123
+        $view->propertyHeader = $html;
124 124
 
125
-		/** client/html/catalog/detail/additional/property/standard/template-header
126
-		 * Relative path to the HTML header template of the catalog detail additional property client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2015.01
143
-		 * @category Developer
144
-		 * @see client/html/catalog/detail/additional/property/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/catalog/detail/additional/property/standard/template-header';
147
-		$default = 'catalog/detail/additional-property-header-default.php';
125
+        /** client/html/catalog/detail/additional/property/standard/template-header
126
+         * Relative path to the HTML header template of the catalog detail additional property client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2015.01
143
+         * @category Developer
144
+         * @see client/html/catalog/detail/additional/property/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/catalog/detail/additional/property/standard/template-header';
147
+        $default = 'catalog/detail/additional-property-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151 151
 
152 152
 
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/catalog/detail/additional/property/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the catalog detail additional property html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/catalog/detail/additional/property/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/catalog/detail/additional/property/decorators/global
185
-		 * @see client/html/catalog/detail/additional/property/decorators/local
186
-		 */
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/catalog/detail/additional/property/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the catalog detail additional property html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/catalog/detail/additional/property/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/catalog/detail/additional/property/decorators/global
185
+         * @see client/html/catalog/detail/additional/property/decorators/local
186
+         */
187 187
 
188
-		/** client/html/catalog/detail/additional/property/decorators/global
189
-		 * Adds a list of globally available decorators only to the catalog detail additional property html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/catalog/detail/additional/property/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/catalog/detail/additional/property/decorators/excludes
209
-		 * @see client/html/catalog/detail/additional/property/decorators/local
210
-		 */
188
+        /** client/html/catalog/detail/additional/property/decorators/global
189
+         * Adds a list of globally available decorators only to the catalog detail additional property html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/catalog/detail/additional/property/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/catalog/detail/additional/property/decorators/excludes
209
+         * @see client/html/catalog/detail/additional/property/decorators/local
210
+         */
211 211
 
212
-		/** client/html/catalog/detail/additional/property/decorators/local
213
-		 * Adds a list of local decorators only to the catalog detail additional property html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/catalog/detail/additional/property/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/catalog/detail/additional/property/decorators/excludes
233
-		 * @see client/html/catalog/detail/additional/property/decorators/global
234
-		 */
212
+        /** client/html/catalog/detail/additional/property/decorators/local
213
+         * Adds a list of local decorators only to the catalog detail additional property html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/catalog/detail/additional/property/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/catalog/detail/additional/property/decorators/excludes
233
+         * @see client/html/catalog/detail/additional/property/decorators/global
234
+         */
235 235
 
236
-		return $this->createSubClient( 'catalog/detail/additional/property/' . $type, $name );
237
-	}
236
+        return $this->createSubClient( 'catalog/detail/additional/property/' . $type, $name );
237
+    }
238 238
 
239 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
-	}
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
 
251
-	/**
252
-	 * Sets the necessary parameter values in the view.
253
-	 *
254
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
255
-	 * @param array &$tags Result array for the list of tags that are associated to the output
256
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
257
-	 * @return \Aimeos\MW\View\Iface Modified view object
258
-	 */
259
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
260
-	{
261
-		if( !isset( $this->cache ) )
262
-		{
263
-			if( isset( $view->detailProductItem ) )
264
-			{
265
-				$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/property' );
251
+    /**
252
+     * Sets the necessary parameter values in the view.
253
+     *
254
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
255
+     * @param array &$tags Result array for the list of tags that are associated to the output
256
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
257
+     * @return \Aimeos\MW\View\Iface Modified view object
258
+     */
259
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
260
+    {
261
+        if( !isset( $this->cache ) )
262
+        {
263
+            if( isset( $view->detailProductItem ) )
264
+            {
265
+                $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/property' );
266 266
 
267
-				$search = $manager->createSearch( true );
268
-				$expr = array(
269
-					$search->compare( '==', 'product.property.parentid', $view->detailProductItem->getId() ),
270
-					$search->getConditions(),
271
-				);
272
-				$search->setConditions( $search->combine( '&&', $expr ) );
267
+                $search = $manager->createSearch( true );
268
+                $expr = array(
269
+                    $search->compare( '==', 'product.property.parentid', $view->detailProductItem->getId() ),
270
+                    $search->getConditions(),
271
+                );
272
+                $search->setConditions( $search->combine( '&&', $expr ) );
273 273
 
274
-				$properties = $manager->searchItems( $search );
274
+                $properties = $manager->searchItems( $search );
275 275
 
276
-				$view->propertyItems = $properties;
277
-			}
276
+                $view->propertyItems = $properties;
277
+            }
278 278
 
279
-			$this->cache = $view;
280
-		}
279
+            $this->cache = $view;
280
+        }
281 281
 
282
-		return $this->cache;
283
-	}
282
+        return $this->cache;
283
+    }
284 284
 }
285 285
\ No newline at end of file
Please login to merge, or discard this patch.
html/src/Client/Html/Catalog/Detail/Additional/Attribute/Standard.php 3 patches
Indentation   +368 added lines, -368 removed lines patch added patch discarded remove patch
@@ -19,373 +19,373 @@
 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/catalog/detail/additional/attribute/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail additional attribute 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/catalog/detail/additional/attribute/standard/subparts';
59
-	private $subPartNames = array();
60
-	private $tags = array();
61
-	private $expire;
62
-	private $cache;
63
-
64
-
65
-	/**
66
-	 * Returns the HTML code for insertion into the body.
67
-	 *
68
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
69
-	 * @param array &$tags Result array for the list of tags that are associated to the output
70
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
71
-	 * @return string HTML code
72
-	 */
73
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
74
-	{
75
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
76
-
77
-		$html = '';
78
-		foreach( $this->getSubClients() as $subclient ) {
79
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
80
-		}
81
-		$view->attributeBody = $html;
82
-
83
-		/** client/html/catalog/detail/additional/attribute/standard/template-body
84
-		 * Relative path to the HTML body template of the catalog detail additional attribute client.
85
-		 *
86
-		 * The template file contains the HTML code and processing instructions
87
-		 * to generate the result shown in the body of the frontend. The
88
-		 * configuration string is the path to the template file relative
89
-		 * to the templates directory (usually in client/html/templates).
90
-		 *
91
-		 * You can overwrite the template file configuration in extensions and
92
-		 * provide alternative templates. These alternative templates should be
93
-		 * named like the default one but with the string "standard" replaced by
94
-		 * an unique name. You may use the name of your project for this. If
95
-		 * you've implemented an alternative client class as well, "standard"
96
-		 * should be replaced by the name of the new class.
97
-		 *
98
-		 * @param string Relative path to the template creating code for the HTML page body
99
-		 * @since 2014.03
100
-		 * @category Developer
101
-		 * @see client/html/catalog/detail/additional/attribute/standard/template-header
102
-		 */
103
-		$tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-body';
104
-		$default = 'catalog/detail/additional-attribute-body-default.php';
105
-
106
-		return $view->render( $view->config( $tplconf, $default ) );
107
-	}
108
-
109
-
110
-	/**
111
-	 * Returns the HTML string for insertion into the header.
112
-	 *
113
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
114
-	 * @param array &$tags Result array for the list of tags that are associated to the output
115
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
116
-	 * @return string|null String including HTML tags for the header on error
117
-	 */
118
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
119
-	{
120
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
121
-
122
-		$html = '';
123
-		foreach( $this->getSubClients() as $subclient ) {
124
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
125
-		}
126
-		$view->attributeHeader = $html;
127
-
128
-		/** client/html/catalog/detail/additional/attribute/standard/template-header
129
-		 * Relative path to the HTML header template of the catalog detail additional attribute client.
130
-		 *
131
-		 * The template file contains the HTML code and processing instructions
132
-		 * to generate the HTML code that is inserted into the HTML page header
133
-		 * of the rendered page in the frontend. The configuration string is the
134
-		 * path to the template file relative to the templates directory (usually
135
-		 * in client/html/templates).
136
-		 *
137
-		 * You can overwrite the template file configuration in extensions and
138
-		 * provide alternative templates. These alternative templates should be
139
-		 * named like the default one but with the string "standard" replaced by
140
-		 * an unique name. You may use the name of your project for this. If
141
-		 * you've implemented an alternative client class as well, "standard"
142
-		 * should be replaced by the name of the new class.
143
-		 *
144
-		 * @param string Relative path to the template creating code for the HTML page head
145
-		 * @since 2014.03
146
-		 * @category Developer
147
-		 * @see client/html/catalog/detail/additional/attribute/standard/template-body
148
-		 */
149
-		$tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-header';
150
-		$default = 'catalog/detail/additional-attribute-header-default.php';
151
-
152
-		return $view->render( $view->config( $tplconf, $default ) );
153
-	}
154
-
155
-
156
-	/**
157
-	 * Returns the sub-client given by its name.
158
-	 *
159
-	 * @param string $type Name of the client type
160
-	 * @param string|null $name Name of the sub-client (Default if null)
161
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
162
-	 */
163
-	public function getSubClient( $type, $name = null )
164
-	{
165
-		/** client/html/catalog/detail/additional/attribute/decorators/excludes
166
-		 * Excludes decorators added by the "common" option from the catalog detail additional attribute html client
167
-		 *
168
-		 * Decorators extend the functionality of a class by adding new aspects
169
-		 * (e.g. log what is currently done), executing the methods of the underlying
170
-		 * class only in certain conditions (e.g. only for logged in users) or
171
-		 * modify what is returned to the caller.
172
-		 *
173
-		 * This option allows you to remove a decorator added via
174
-		 * "client/html/common/decorators/default" before they are wrapped
175
-		 * around the html client.
176
-		 *
177
-		 *  client/html/catalog/detail/additional/attribute/decorators/excludes = array( 'decorator1' )
178
-		 *
179
-		 * This would remove the decorator named "decorator1" from the list of
180
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
181
-		 * "client/html/common/decorators/default" to the html client.
182
-		 *
183
-		 * @param array List of decorator names
184
-		 * @since 2015.08
185
-		 * @category Developer
186
-		 * @see client/html/common/decorators/default
187
-		 * @see client/html/catalog/detail/additional/attribute/decorators/global
188
-		 * @see client/html/catalog/detail/additional/attribute/decorators/local
189
-		 */
190
-
191
-		/** client/html/catalog/detail/additional/attribute/decorators/global
192
-		 * Adds a list of globally available decorators only to the catalog detail additional attribute html client
193
-		 *
194
-		 * Decorators extend the functionality of a class by adding new aspects
195
-		 * (e.g. log what is currently done), executing the methods of the underlying
196
-		 * class only in certain conditions (e.g. only for logged in users) or
197
-		 * modify what is returned to the caller.
198
-		 *
199
-		 * This option allows you to wrap global decorators
200
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
201
-		 *
202
-		 *  client/html/catalog/detail/additional/attribute/decorators/global = array( 'decorator1' )
203
-		 *
204
-		 * This would add the decorator named "decorator1" defined by
205
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
206
-		 *
207
-		 * @param array List of decorator names
208
-		 * @since 2015.08
209
-		 * @category Developer
210
-		 * @see client/html/common/decorators/default
211
-		 * @see client/html/catalog/detail/additional/attribute/decorators/excludes
212
-		 * @see client/html/catalog/detail/additional/attribute/decorators/local
213
-		 */
214
-
215
-		/** client/html/catalog/detail/additional/attribute/decorators/local
216
-		 * Adds a list of local decorators only to the catalog detail additional attribute html client
217
-		 *
218
-		 * Decorators extend the functionality of a class by adding new aspects
219
-		 * (e.g. log what is currently done), executing the methods of the underlying
220
-		 * class only in certain conditions (e.g. only for logged in users) or
221
-		 * modify what is returned to the caller.
222
-		 *
223
-		 * This option allows you to wrap local decorators
224
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
225
-		 *
226
-		 *  client/html/catalog/detail/additional/attribute/decorators/local = array( 'decorator2' )
227
-		 *
228
-		 * This would add the decorator named "decorator2" defined by
229
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
230
-		 *
231
-		 * @param array List of decorator names
232
-		 * @since 2015.08
233
-		 * @category Developer
234
-		 * @see client/html/common/decorators/default
235
-		 * @see client/html/catalog/detail/additional/attribute/decorators/excludes
236
-		 * @see client/html/catalog/detail/additional/attribute/decorators/global
237
-		 */
238
-
239
-		return $this->createSubClient( 'catalog/detail/additional/attribute/' . $type, $name );
240
-	}
241
-
242
-
243
-	/**
244
-	 * Returns the list of sub-client names configured for the client.
245
-	 *
246
-	 * @return array List of HTML client names
247
-	 */
248
-	protected function getSubClientNames()
249
-	{
250
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
251
-	}
252
-
253
-
254
-	/**
255
-	 * Sets the necessary parameter values in the view.
256
-	 *
257
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
258
-	 * @param array &$tags Result array for the list of tags that are associated to the output
259
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
260
-	 * @return \Aimeos\MW\View\Iface Modified view object
261
-	 */
262
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
263
-	{
264
-		if( !isset( $this->cache ) )
265
-		{
266
-			$context = $this->getContext();
267
-			$config = $context->getConfig();
268
-			$attrIds = $attributeMap = $subAttrDeps = array();
269
-
270
-			/** client/html/catalog/detail/additional/attribute/variants
271
-			 * If variant attributes should be displayed in the additional section too
272
-			 *
273
-			 * The additional attribute section of the catalog details views contains
274
-			 * all attributes of type "default" that have been assigned to the product.
275
-			 * By default, this also includes variant attributes assigned to the article
276
-			 * of selection products and the ones for the selected variant are displayed
277
-			 * as well.
278
-			 *
279
-			 * This setting can disable displaying them in the additional attribute
280
-			 * section.
281
-			 *
282
-			 * @param boolean True to also display variant attibutes, false to hide them
283
-			 * @since 2016.05
284
-			 * @category Developer
285
-			*/
286
-			$variants = (bool) $config->get( 'client/html/catalog/detail/additional/attribute/variants', true );
287
-
288
-			if( isset( $view->detailProductItem ) )
289
-			{
290
-				$attrIds = array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'default' ) );
291
-
292
-				if( $variants === true ) {
293
-					$attrIds += array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'variant' ) );
294
-				}
295
-			}
296
-
297
-
298
-			$products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' );
299
-
300
-			/** client/html/catalog/detail/additional/attribute/domains
301
-			 * A list of domain names whose items should be available in the additional attribute part of the catalog detail view templates
302
-			 *
303
-			 * The templates rendering additional attribute related data usually add
304
-			 * the images and texts associated to each item. If you want to
305
-			 * display additional content like the attributes, you can configure
306
-			 * your own list of domains (attribute, media, price, product, text,
307
-			 * etc. are domains) whose items are fetched from the storage.
308
-			 * Please keep in mind that the more domains you add to the
309
-			 * configuration, the more time is required for fetching the content!
310
-			 *
311
-			 * @param array List of domain names
312
-			 * @since 2015.09
313
-			 * @category Developer
314
-			 * @see client/html/catalog/detail/basket/selection/domains-attributes
315
-			*/
316
-			$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', array( 'attribute' ) );
317
-
318
-			// find regular attributes from sub-products
319
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
320
-			$products = $controller->getProductItems( array_keys( $products ), $domains );
321
-
322
-			foreach( $products as $subProdId => $subProduct )
323
-			{
324
-				$subItems = $subProduct->getRefItems( 'attribute', null, 'default' );
325
-
326
-				if( $variants === true ) {
327
-					$subItems += $subProduct->getRefItems( 'attribute', null, 'variant' );
328
-				}
329
-
330
-				foreach( $subItems as $attrId => $attrItem )
331
-				{
332
-					$subAttrDeps[$attrId][] = $subProdId;
333
-					$attrIds[] = $attrId;
334
-				}
335
-			}
336
-
337
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
338
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
339
-
340
-
341
-			$attrManager = $controller->createManager( 'attribute' );
342
-
343
-			$search = $attrManager->createSearch( true );
344
-			$expr = array(
345
-				$search->compare( '==', 'attribute.id', $attrIds ),
346
-				$search->getConditions(),
347
-			);
348
-			$search->setConditions( $search->combine( '&&', $expr ) );
349
-
350
-
351
-			/** client/html/catalog/detail/basket/selection/domains-attributes
352
-			 * A list of domain names whose items should be available for the attributes in the
353
-			 * additional attribute part of the catalog detail view templates
354
-			 *
355
-			 * The templates rendering additional attribute related data usually add
356
-			 * the images and texts associated to each item. If you want to
357
-			 * display additional content like the attributes, you can configure
358
-			 * your own list of domains (attribute, media, price, product, text,
359
-			 * etc. are domains) whose items are fetched from the storage.
360
-			 * Please keep in mind that the more domains you add to the
361
-			 * configuration, the more time is required for fetching the content!
362
-			 *
363
-			 * @param array List of domain names
364
-			 * @since 2015.09
365
-			 * @category Developer
366
-			 * @see client/html/catalog/detail/basket/selection/domains
367
-			*/
368
-			$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', array( 'text', 'media' ) );
369
-
370
-			$attributes = $attrManager->searchItems( $search, $domains );
371
-
372
-			foreach( $attributes as $id => $item ) {
373
-				$attributeMap[$item->getType()][$id] = $item;
374
-			}
375
-
376
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
377
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
378
-
379
-
380
-			$view->attributeMap = $attributeMap;
381
-			$view->subAttributeDependencies = $subAttrDeps;
382
-
383
-			$this->cache = $view;
384
-		}
385
-
386
-		$expire = $this->expires( $this->expire, $expire );
387
-		$tags = array_merge( $tags, $this->tags );
388
-
389
-		return $this->cache;
390
-	}
25
+    /** client/html/catalog/detail/additional/attribute/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail additional attribute 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/catalog/detail/additional/attribute/standard/subparts';
59
+    private $subPartNames = array();
60
+    private $tags = array();
61
+    private $expire;
62
+    private $cache;
63
+
64
+
65
+    /**
66
+     * Returns the HTML code for insertion into the body.
67
+     *
68
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
69
+     * @param array &$tags Result array for the list of tags that are associated to the output
70
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
71
+     * @return string HTML code
72
+     */
73
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
74
+    {
75
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
76
+
77
+        $html = '';
78
+        foreach( $this->getSubClients() as $subclient ) {
79
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
80
+        }
81
+        $view->attributeBody = $html;
82
+
83
+        /** client/html/catalog/detail/additional/attribute/standard/template-body
84
+         * Relative path to the HTML body template of the catalog detail additional attribute client.
85
+         *
86
+         * The template file contains the HTML code and processing instructions
87
+         * to generate the result shown in the body of the frontend. The
88
+         * configuration string is the path to the template file relative
89
+         * to the templates directory (usually in client/html/templates).
90
+         *
91
+         * You can overwrite the template file configuration in extensions and
92
+         * provide alternative templates. These alternative templates should be
93
+         * named like the default one but with the string "standard" replaced by
94
+         * an unique name. You may use the name of your project for this. If
95
+         * you've implemented an alternative client class as well, "standard"
96
+         * should be replaced by the name of the new class.
97
+         *
98
+         * @param string Relative path to the template creating code for the HTML page body
99
+         * @since 2014.03
100
+         * @category Developer
101
+         * @see client/html/catalog/detail/additional/attribute/standard/template-header
102
+         */
103
+        $tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-body';
104
+        $default = 'catalog/detail/additional-attribute-body-default.php';
105
+
106
+        return $view->render( $view->config( $tplconf, $default ) );
107
+    }
108
+
109
+
110
+    /**
111
+     * Returns the HTML string for insertion into the header.
112
+     *
113
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
114
+     * @param array &$tags Result array for the list of tags that are associated to the output
115
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
116
+     * @return string|null String including HTML tags for the header on error
117
+     */
118
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
119
+    {
120
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
121
+
122
+        $html = '';
123
+        foreach( $this->getSubClients() as $subclient ) {
124
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
125
+        }
126
+        $view->attributeHeader = $html;
127
+
128
+        /** client/html/catalog/detail/additional/attribute/standard/template-header
129
+         * Relative path to the HTML header template of the catalog detail additional attribute client.
130
+         *
131
+         * The template file contains the HTML code and processing instructions
132
+         * to generate the HTML code that is inserted into the HTML page header
133
+         * of the rendered page in the frontend. The configuration string is the
134
+         * path to the template file relative to the templates directory (usually
135
+         * in client/html/templates).
136
+         *
137
+         * You can overwrite the template file configuration in extensions and
138
+         * provide alternative templates. These alternative templates should be
139
+         * named like the default one but with the string "standard" replaced by
140
+         * an unique name. You may use the name of your project for this. If
141
+         * you've implemented an alternative client class as well, "standard"
142
+         * should be replaced by the name of the new class.
143
+         *
144
+         * @param string Relative path to the template creating code for the HTML page head
145
+         * @since 2014.03
146
+         * @category Developer
147
+         * @see client/html/catalog/detail/additional/attribute/standard/template-body
148
+         */
149
+        $tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-header';
150
+        $default = 'catalog/detail/additional-attribute-header-default.php';
151
+
152
+        return $view->render( $view->config( $tplconf, $default ) );
153
+    }
154
+
155
+
156
+    /**
157
+     * Returns the sub-client given by its name.
158
+     *
159
+     * @param string $type Name of the client type
160
+     * @param string|null $name Name of the sub-client (Default if null)
161
+     * @return \Aimeos\Client\Html\Iface Sub-client object
162
+     */
163
+    public function getSubClient( $type, $name = null )
164
+    {
165
+        /** client/html/catalog/detail/additional/attribute/decorators/excludes
166
+         * Excludes decorators added by the "common" option from the catalog detail additional attribute html client
167
+         *
168
+         * Decorators extend the functionality of a class by adding new aspects
169
+         * (e.g. log what is currently done), executing the methods of the underlying
170
+         * class only in certain conditions (e.g. only for logged in users) or
171
+         * modify what is returned to the caller.
172
+         *
173
+         * This option allows you to remove a decorator added via
174
+         * "client/html/common/decorators/default" before they are wrapped
175
+         * around the html client.
176
+         *
177
+         *  client/html/catalog/detail/additional/attribute/decorators/excludes = array( 'decorator1' )
178
+         *
179
+         * This would remove the decorator named "decorator1" from the list of
180
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
181
+         * "client/html/common/decorators/default" to the html client.
182
+         *
183
+         * @param array List of decorator names
184
+         * @since 2015.08
185
+         * @category Developer
186
+         * @see client/html/common/decorators/default
187
+         * @see client/html/catalog/detail/additional/attribute/decorators/global
188
+         * @see client/html/catalog/detail/additional/attribute/decorators/local
189
+         */
190
+
191
+        /** client/html/catalog/detail/additional/attribute/decorators/global
192
+         * Adds a list of globally available decorators only to the catalog detail additional attribute html client
193
+         *
194
+         * Decorators extend the functionality of a class by adding new aspects
195
+         * (e.g. log what is currently done), executing the methods of the underlying
196
+         * class only in certain conditions (e.g. only for logged in users) or
197
+         * modify what is returned to the caller.
198
+         *
199
+         * This option allows you to wrap global decorators
200
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
201
+         *
202
+         *  client/html/catalog/detail/additional/attribute/decorators/global = array( 'decorator1' )
203
+         *
204
+         * This would add the decorator named "decorator1" defined by
205
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
206
+         *
207
+         * @param array List of decorator names
208
+         * @since 2015.08
209
+         * @category Developer
210
+         * @see client/html/common/decorators/default
211
+         * @see client/html/catalog/detail/additional/attribute/decorators/excludes
212
+         * @see client/html/catalog/detail/additional/attribute/decorators/local
213
+         */
214
+
215
+        /** client/html/catalog/detail/additional/attribute/decorators/local
216
+         * Adds a list of local decorators only to the catalog detail additional attribute html client
217
+         *
218
+         * Decorators extend the functionality of a class by adding new aspects
219
+         * (e.g. log what is currently done), executing the methods of the underlying
220
+         * class only in certain conditions (e.g. only for logged in users) or
221
+         * modify what is returned to the caller.
222
+         *
223
+         * This option allows you to wrap local decorators
224
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
225
+         *
226
+         *  client/html/catalog/detail/additional/attribute/decorators/local = array( 'decorator2' )
227
+         *
228
+         * This would add the decorator named "decorator2" defined by
229
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
230
+         *
231
+         * @param array List of decorator names
232
+         * @since 2015.08
233
+         * @category Developer
234
+         * @see client/html/common/decorators/default
235
+         * @see client/html/catalog/detail/additional/attribute/decorators/excludes
236
+         * @see client/html/catalog/detail/additional/attribute/decorators/global
237
+         */
238
+
239
+        return $this->createSubClient( 'catalog/detail/additional/attribute/' . $type, $name );
240
+    }
241
+
242
+
243
+    /**
244
+     * Returns the list of sub-client names configured for the client.
245
+     *
246
+     * @return array List of HTML client names
247
+     */
248
+    protected function getSubClientNames()
249
+    {
250
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
251
+    }
252
+
253
+
254
+    /**
255
+     * Sets the necessary parameter values in the view.
256
+     *
257
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
258
+     * @param array &$tags Result array for the list of tags that are associated to the output
259
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
260
+     * @return \Aimeos\MW\View\Iface Modified view object
261
+     */
262
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
263
+    {
264
+        if( !isset( $this->cache ) )
265
+        {
266
+            $context = $this->getContext();
267
+            $config = $context->getConfig();
268
+            $attrIds = $attributeMap = $subAttrDeps = array();
269
+
270
+            /** client/html/catalog/detail/additional/attribute/variants
271
+             * If variant attributes should be displayed in the additional section too
272
+             *
273
+             * The additional attribute section of the catalog details views contains
274
+             * all attributes of type "default" that have been assigned to the product.
275
+             * By default, this also includes variant attributes assigned to the article
276
+             * of selection products and the ones for the selected variant are displayed
277
+             * as well.
278
+             *
279
+             * This setting can disable displaying them in the additional attribute
280
+             * section.
281
+             *
282
+             * @param boolean True to also display variant attibutes, false to hide them
283
+             * @since 2016.05
284
+             * @category Developer
285
+             */
286
+            $variants = (bool) $config->get( 'client/html/catalog/detail/additional/attribute/variants', true );
287
+
288
+            if( isset( $view->detailProductItem ) )
289
+            {
290
+                $attrIds = array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'default' ) );
291
+
292
+                if( $variants === true ) {
293
+                    $attrIds += array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'variant' ) );
294
+                }
295
+            }
296
+
297
+
298
+            $products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' );
299
+
300
+            /** client/html/catalog/detail/additional/attribute/domains
301
+             * A list of domain names whose items should be available in the additional attribute part of the catalog detail view templates
302
+             *
303
+             * The templates rendering additional attribute related data usually add
304
+             * the images and texts associated to each item. If you want to
305
+             * display additional content like the attributes, you can configure
306
+             * your own list of domains (attribute, media, price, product, text,
307
+             * etc. are domains) whose items are fetched from the storage.
308
+             * Please keep in mind that the more domains you add to the
309
+             * configuration, the more time is required for fetching the content!
310
+             *
311
+             * @param array List of domain names
312
+             * @since 2015.09
313
+             * @category Developer
314
+             * @see client/html/catalog/detail/basket/selection/domains-attributes
315
+             */
316
+            $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', array( 'attribute' ) );
317
+
318
+            // find regular attributes from sub-products
319
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
320
+            $products = $controller->getProductItems( array_keys( $products ), $domains );
321
+
322
+            foreach( $products as $subProdId => $subProduct )
323
+            {
324
+                $subItems = $subProduct->getRefItems( 'attribute', null, 'default' );
325
+
326
+                if( $variants === true ) {
327
+                    $subItems += $subProduct->getRefItems( 'attribute', null, 'variant' );
328
+                }
329
+
330
+                foreach( $subItems as $attrId => $attrItem )
331
+                {
332
+                    $subAttrDeps[$attrId][] = $subProdId;
333
+                    $attrIds[] = $attrId;
334
+                }
335
+            }
336
+
337
+            $this->addMetaItem( $products, 'product', $this->expire, $this->tags );
338
+            $this->addMetaList( array_keys( $products ), 'product', $this->expire );
339
+
340
+
341
+            $attrManager = $controller->createManager( 'attribute' );
342
+
343
+            $search = $attrManager->createSearch( true );
344
+            $expr = array(
345
+                $search->compare( '==', 'attribute.id', $attrIds ),
346
+                $search->getConditions(),
347
+            );
348
+            $search->setConditions( $search->combine( '&&', $expr ) );
349
+
350
+
351
+            /** client/html/catalog/detail/basket/selection/domains-attributes
352
+             * A list of domain names whose items should be available for the attributes in the
353
+             * additional attribute part of the catalog detail view templates
354
+             *
355
+             * The templates rendering additional attribute related data usually add
356
+             * the images and texts associated to each item. If you want to
357
+             * display additional content like the attributes, you can configure
358
+             * your own list of domains (attribute, media, price, product, text,
359
+             * etc. are domains) whose items are fetched from the storage.
360
+             * Please keep in mind that the more domains you add to the
361
+             * configuration, the more time is required for fetching the content!
362
+             *
363
+             * @param array List of domain names
364
+             * @since 2015.09
365
+             * @category Developer
366
+             * @see client/html/catalog/detail/basket/selection/domains
367
+             */
368
+            $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', array( 'text', 'media' ) );
369
+
370
+            $attributes = $attrManager->searchItems( $search, $domains );
371
+
372
+            foreach( $attributes as $id => $item ) {
373
+                $attributeMap[$item->getType()][$id] = $item;
374
+            }
375
+
376
+            $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
377
+            $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
378
+
379
+
380
+            $view->attributeMap = $attributeMap;
381
+            $view->subAttributeDependencies = $subAttrDeps;
382
+
383
+            $this->cache = $view;
384
+        }
385
+
386
+        $expire = $this->expires( $this->expire, $expire );
387
+        $tags = array_merge( $tags, $this->tags );
388
+
389
+        return $this->cache;
390
+    }
391 391
 }
392 392
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -70,13 +70,13 @@  discard block
 block discarded – undo
70 70
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
71 71
 	 * @return string HTML code
72 72
 	 */
73
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
73
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
74 74
 	{
75
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
75
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
76 76
 
77 77
 		$html = '';
78
-		foreach( $this->getSubClients() as $subclient ) {
79
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
78
+		foreach ($this->getSubClients() as $subclient) {
79
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
80 80
 		}
81 81
 		$view->attributeBody = $html;
82 82
 
@@ -103,7 +103,7 @@  discard block
 block discarded – undo
103 103
 		$tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-body';
104 104
 		$default = 'catalog/detail/additional-attribute-body-default.php';
105 105
 
106
-		return $view->render( $view->config( $tplconf, $default ) );
106
+		return $view->render($view->config($tplconf, $default));
107 107
 	}
108 108
 
109 109
 
@@ -115,13 +115,13 @@  discard block
 block discarded – undo
115 115
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
116 116
 	 * @return string|null String including HTML tags for the header on error
117 117
 	 */
118
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
118
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
119 119
 	{
120
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
120
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
121 121
 
122 122
 		$html = '';
123
-		foreach( $this->getSubClients() as $subclient ) {
124
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
123
+		foreach ($this->getSubClients() as $subclient) {
124
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
125 125
 		}
126 126
 		$view->attributeHeader = $html;
127 127
 
@@ -149,7 +149,7 @@  discard block
 block discarded – undo
149 149
 		$tplconf = 'client/html/catalog/detail/additional/attribute/standard/template-header';
150 150
 		$default = 'catalog/detail/additional-attribute-header-default.php';
151 151
 
152
-		return $view->render( $view->config( $tplconf, $default ) );
152
+		return $view->render($view->config($tplconf, $default));
153 153
 	}
154 154
 
155 155
 
@@ -160,7 +160,7 @@  discard block
 block discarded – undo
160 160
 	 * @param string|null $name Name of the sub-client (Default if null)
161 161
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
162 162
 	 */
163
-	public function getSubClient( $type, $name = null )
163
+	public function getSubClient($type, $name = null)
164 164
 	{
165 165
 		/** client/html/catalog/detail/additional/attribute/decorators/excludes
166 166
 		 * Excludes decorators added by the "common" option from the catalog detail additional attribute html client
@@ -236,7 +236,7 @@  discard block
 block discarded – undo
236 236
 		 * @see client/html/catalog/detail/additional/attribute/decorators/global
237 237
 		 */
238 238
 
239
-		return $this->createSubClient( 'catalog/detail/additional/attribute/' . $type, $name );
239
+		return $this->createSubClient('catalog/detail/additional/attribute/'.$type, $name);
240 240
 	}
241 241
 
242 242
 
@@ -247,7 +247,7 @@  discard block
 block discarded – undo
247 247
 	 */
248 248
 	protected function getSubClientNames()
249 249
 	{
250
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
250
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
251 251
 	}
252 252
 
253 253
 
@@ -259,9 +259,9 @@  discard block
 block discarded – undo
259 259
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
260 260
 	 * @return \Aimeos\MW\View\Iface Modified view object
261 261
 	 */
262
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
262
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
263 263
 	{
264
-		if( !isset( $this->cache ) )
264
+		if (!isset($this->cache))
265 265
 		{
266 266
 			$context = $this->getContext();
267 267
 			$config = $context->getConfig();
@@ -283,19 +283,19 @@  discard block
 block discarded – undo
283 283
 			 * @since 2016.05
284 284
 			 * @category Developer
285 285
 			*/
286
-			$variants = (bool) $config->get( 'client/html/catalog/detail/additional/attribute/variants', true );
286
+			$variants = (bool) $config->get('client/html/catalog/detail/additional/attribute/variants', true);
287 287
 
288
-			if( isset( $view->detailProductItem ) )
288
+			if (isset($view->detailProductItem))
289 289
 			{
290
-				$attrIds = array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'default' ) );
290
+				$attrIds = array_keys($view->detailProductItem->getRefItems('attribute', null, 'default'));
291 291
 
292
-				if( $variants === true ) {
293
-					$attrIds += array_keys( $view->detailProductItem->getRefItems( 'attribute', null, 'variant' ) );
292
+				if ($variants === true) {
293
+					$attrIds += array_keys($view->detailProductItem->getRefItems('attribute', null, 'variant'));
294 294
 				}
295 295
 			}
296 296
 
297 297
 
298
-			$products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' );
298
+			$products = $view->detailProductItem->getRefItems('product', 'default', 'default');
299 299
 
300 300
 			/** client/html/catalog/detail/additional/attribute/domains
301 301
 			 * A list of domain names whose items should be available in the additional attribute part of the catalog detail view templates
@@ -313,39 +313,39 @@  discard block
 block discarded – undo
313 313
 			 * @category Developer
314 314
 			 * @see client/html/catalog/detail/basket/selection/domains-attributes
315 315
 			*/
316
-			$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', array( 'attribute' ) );
316
+			$domains = $config->get('client/html/catalog/detail/basket/selection/domains', array('attribute'));
317 317
 
318 318
 			// find regular attributes from sub-products
319
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
320
-			$products = $controller->getProductItems( array_keys( $products ), $domains );
319
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
320
+			$products = $controller->getProductItems(array_keys($products), $domains);
321 321
 
322
-			foreach( $products as $subProdId => $subProduct )
322
+			foreach ($products as $subProdId => $subProduct)
323 323
 			{
324
-				$subItems = $subProduct->getRefItems( 'attribute', null, 'default' );
324
+				$subItems = $subProduct->getRefItems('attribute', null, 'default');
325 325
 
326
-				if( $variants === true ) {
327
-					$subItems += $subProduct->getRefItems( 'attribute', null, 'variant' );
326
+				if ($variants === true) {
327
+					$subItems += $subProduct->getRefItems('attribute', null, 'variant');
328 328
 				}
329 329
 
330
-				foreach( $subItems as $attrId => $attrItem )
330
+				foreach ($subItems as $attrId => $attrItem)
331 331
 				{
332 332
 					$subAttrDeps[$attrId][] = $subProdId;
333 333
 					$attrIds[] = $attrId;
334 334
 				}
335 335
 			}
336 336
 
337
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
338
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
337
+			$this->addMetaItem($products, 'product', $this->expire, $this->tags);
338
+			$this->addMetaList(array_keys($products), 'product', $this->expire);
339 339
 
340 340
 
341
-			$attrManager = $controller->createManager( 'attribute' );
341
+			$attrManager = $controller->createManager('attribute');
342 342
 
343
-			$search = $attrManager->createSearch( true );
343
+			$search = $attrManager->createSearch(true);
344 344
 			$expr = array(
345
-				$search->compare( '==', 'attribute.id', $attrIds ),
345
+				$search->compare('==', 'attribute.id', $attrIds),
346 346
 				$search->getConditions(),
347 347
 			);
348
-			$search->setConditions( $search->combine( '&&', $expr ) );
348
+			$search->setConditions($search->combine('&&', $expr));
349 349
 
350 350
 
351 351
 			/** client/html/catalog/detail/basket/selection/domains-attributes
@@ -365,16 +365,16 @@  discard block
 block discarded – undo
365 365
 			 * @category Developer
366 366
 			 * @see client/html/catalog/detail/basket/selection/domains
367 367
 			*/
368
-			$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', array( 'text', 'media' ) );
368
+			$domains = $config->get('client/html/catalog/detail/basket/selection/domains-attributes', array('text', 'media'));
369 369
 
370
-			$attributes = $attrManager->searchItems( $search, $domains );
370
+			$attributes = $attrManager->searchItems($search, $domains);
371 371
 
372
-			foreach( $attributes as $id => $item ) {
372
+			foreach ($attributes as $id => $item) {
373 373
 				$attributeMap[$item->getType()][$id] = $item;
374 374
 			}
375 375
 
376
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
377
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
376
+			$this->addMetaItem($attributes, 'attribute', $this->expire, $this->tags);
377
+			$this->addMetaList(array_keys($attributes), 'attribute', $this->expire);
378 378
 
379 379
 
380 380
 			$view->attributeMap = $attributeMap;
@@ -383,8 +383,8 @@  discard block
 block discarded – undo
383 383
 			$this->cache = $view;
384 384
 		}
385 385
 
386
-		$expire = $this->expires( $this->expire, $expire );
387
-		$tags = array_merge( $tags, $this->tags );
386
+		$expire = $this->expires($this->expire, $expire);
387
+		$tags = array_merge($tags, $this->tags);
388 388
 
389 389
 		return $this->cache;
390 390
 	}
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/Catalog/Detail/Additional/Download/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\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/catalog/detail/additional/download/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail additional download 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/catalog/detail/additional/download/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->downloadBody = $html;
79
-
80
-		/** client/html/catalog/detail/additional/download/standard/template-body
81
-		 * Relative path to the HTML body template of the catalog detail additional download client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.03
97
-		 * @category Developer
98
-		 * @see client/html/catalog/detail/additional/download/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/catalog/detail/additional/download/standard/template-body';
101
-		$default = 'catalog/detail/additional-download-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->downloadHeader = $html;
124
-
125
-		/** client/html/catalog/detail/additional/download/standard/template-header
126
-		 * Relative path to the HTML header template of the catalog detail additional download client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.03
143
-		 * @category Developer
144
-		 * @see client/html/catalog/detail/additional/download/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/catalog/detail/additional/download/standard/template-header';
147
-		$default = 'catalog/detail/additional-download-header-default.php';
148
-
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
151
-
152
-
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/catalog/detail/additional/download/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the catalog detail additional download html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/catalog/detail/additional/download/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/catalog/detail/additional/download/decorators/global
185
-		 * @see client/html/catalog/detail/additional/download/decorators/local
186
-		 */
187
-
188
-		/** client/html/catalog/detail/additional/download/decorators/global
189
-		 * Adds a list of globally available decorators only to the catalog detail additional download html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/catalog/detail/additional/download/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/catalog/detail/additional/download/decorators/excludes
209
-		 * @see client/html/catalog/detail/additional/download/decorators/local
210
-		 */
211
-
212
-		/** client/html/catalog/detail/additional/download/decorators/local
213
-		 * Adds a list of local decorators only to the catalog detail additional download html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/catalog/detail/additional/download/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/catalog/detail/additional/download/decorators/excludes
233
-		 * @see client/html/catalog/detail/additional/download/decorators/global
234
-		 */
235
-
236
-		return $this->createSubClient( 'catalog/detail/additional/download/' . $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
-	}
25
+    /** client/html/catalog/detail/additional/download/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail additional download 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/catalog/detail/additional/download/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->downloadBody = $html;
79
+
80
+        /** client/html/catalog/detail/additional/download/standard/template-body
81
+         * Relative path to the HTML body template of the catalog detail additional download client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.03
97
+         * @category Developer
98
+         * @see client/html/catalog/detail/additional/download/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/catalog/detail/additional/download/standard/template-body';
101
+        $default = 'catalog/detail/additional-download-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->downloadHeader = $html;
124
+
125
+        /** client/html/catalog/detail/additional/download/standard/template-header
126
+         * Relative path to the HTML header template of the catalog detail additional download client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.03
143
+         * @category Developer
144
+         * @see client/html/catalog/detail/additional/download/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/catalog/detail/additional/download/standard/template-header';
147
+        $default = 'catalog/detail/additional-download-header-default.php';
148
+
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151
+
152
+
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/catalog/detail/additional/download/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the catalog detail additional download html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/catalog/detail/additional/download/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/catalog/detail/additional/download/decorators/global
185
+         * @see client/html/catalog/detail/additional/download/decorators/local
186
+         */
187
+
188
+        /** client/html/catalog/detail/additional/download/decorators/global
189
+         * Adds a list of globally available decorators only to the catalog detail additional download html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/catalog/detail/additional/download/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/catalog/detail/additional/download/decorators/excludes
209
+         * @see client/html/catalog/detail/additional/download/decorators/local
210
+         */
211
+
212
+        /** client/html/catalog/detail/additional/download/decorators/local
213
+         * Adds a list of local decorators only to the catalog detail additional download html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/catalog/detail/additional/download/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/catalog/detail/additional/download/decorators/excludes
233
+         * @see client/html/catalog/detail/additional/download/decorators/global
234
+         */
235
+
236
+        return $this->createSubClient( 'catalog/detail/additional/download/' . $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
@@ -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->downloadBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/catalog/detail/additional/download/standard/template-body';
101 101
 		$default = 'catalog/detail/additional-download-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->downloadHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/catalog/detail/additional/download/standard/template-header';
147 147
 		$default = 'catalog/detail/additional-download-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/catalog/detail/additional/download/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the catalog detail additional download html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/catalog/detail/additional/download/decorators/global
234 234
 		 */
235 235
 
236
-		return $this->createSubClient( 'catalog/detail/additional/download/' . $type, $name );
236
+		return $this->createSubClient('catalog/detail/additional/download/'.$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/Catalog/Detail/Additional/Standard.php 3 patches
Indentation   +249 added lines, -249 removed lines patch added patch discarded remove patch
@@ -19,275 +19,275 @@
 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/catalog/detail/additional/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail additional 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/catalog/detail/additional/standard/subparts';
25
+    /** client/html/catalog/detail/additional/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail additional 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/catalog/detail/additional/standard/subparts';
59 59
 
60
-	/** client/html/catalog/detail/additional/text/name
61
-	 * Name of the text part used by the catalog detail additional client implementation
62
-	 *
63
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Text\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/catalog/detail/additional/text/name
61
+     * Name of the text part used by the catalog detail additional client implementation
62
+     *
63
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Text\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/catalog/detail/additional/attribute/name
72
-	 * Name of the attribute part used by the catalog detail additional client implementation
73
-	 *
74
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Attribute\Myname".
75
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
76
-	 *
77
-	 * @param string Last part of the client class name
78
-	 * @since 2014.03
79
-	 * @category Developer
80
-	 */
71
+    /** client/html/catalog/detail/additional/attribute/name
72
+     * Name of the attribute part used by the catalog detail additional client implementation
73
+     *
74
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Attribute\Myname".
75
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
76
+     *
77
+     * @param string Last part of the client class name
78
+     * @since 2014.03
79
+     * @category Developer
80
+     */
81 81
 
82
-	/** client/html/catalog/detail/additional/property/name
83
-	 * Name of the property part used by the catalog detail additional client implementation
84
-	 *
85
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Property\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.01
90
-	 * @category Developer
91
-	 */
82
+    /** client/html/catalog/detail/additional/property/name
83
+     * Name of the property part used by the catalog detail additional client implementation
84
+     *
85
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Property\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.01
90
+     * @category Developer
91
+     */
92 92
 
93
-	/** client/html/catalog/detail/additional/download/name
94
-	 * Name of the download part used by the catalog detail additional client implementation
95
-	 *
96
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Download\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 2014.03
101
-	 * @category Developer
102
-	 */
103
-	private $subPartNames = array( 'text', 'attribute', 'property', 'download' );
93
+    /** client/html/catalog/detail/additional/download/name
94
+     * Name of the download part used by the catalog detail additional client implementation
95
+     *
96
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\Download\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 2014.03
101
+     * @category Developer
102
+     */
103
+    private $subPartNames = array( 'text', 'attribute', 'property', 'download' );
104 104
 
105 105
 
106
-	/**
107
-	 * Returns the HTML code for insertion into the body.
108
-	 *
109
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
110
-	 * @param array &$tags Result array for the list of tags that are associated to the output
111
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
112
-	 * @return string HTML code
113
-	 */
114
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
115
-	{
116
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
106
+    /**
107
+     * Returns the HTML code for insertion into the body.
108
+     *
109
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
110
+     * @param array &$tags Result array for the list of tags that are associated to the output
111
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
112
+     * @return string HTML code
113
+     */
114
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
115
+    {
116
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
117 117
 
118
-		$html = '';
119
-		foreach( $this->getSubClients() as $subclient ) {
120
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
121
-		}
122
-		$view->additionalBody = $html;
118
+        $html = '';
119
+        foreach( $this->getSubClients() as $subclient ) {
120
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
121
+        }
122
+        $view->additionalBody = $html;
123 123
 
124
-		/** client/html/catalog/detail/additional/standard/template-body
125
-		 * Relative path to the HTML body template of the catalog detail additional client.
126
-		 *
127
-		 * The template file contains the HTML code and processing instructions
128
-		 * to generate the result shown in the body of the frontend. The
129
-		 * configuration string is the path to the template file relative
130
-		 * to the templates directory (usually in client/html/templates).
131
-		 *
132
-		 * You can overwrite the template file configuration in extensions and
133
-		 * provide alternative templates. These alternative templates should be
134
-		 * named like the default one but with the string "standard" replaced by
135
-		 * an unique name. You may use the name of your project for this. If
136
-		 * you've implemented an alternative client class as well, "standard"
137
-		 * should be replaced by the name of the new class.
138
-		 *
139
-		 * @param string Relative path to the template creating code for the HTML page body
140
-		 * @since 2014.03
141
-		 * @category Developer
142
-		 * @see client/html/catalog/detail/additional/standard/template-header
143
-		 */
144
-		$tplconf = 'client/html/catalog/detail/additional/standard/template-body';
145
-		$default = 'catalog/detail/additional-body-default.php';
124
+        /** client/html/catalog/detail/additional/standard/template-body
125
+         * Relative path to the HTML body template of the catalog detail additional client.
126
+         *
127
+         * The template file contains the HTML code and processing instructions
128
+         * to generate the result shown in the body of the frontend. The
129
+         * configuration string is the path to the template file relative
130
+         * to the templates directory (usually in client/html/templates).
131
+         *
132
+         * You can overwrite the template file configuration in extensions and
133
+         * provide alternative templates. These alternative templates should be
134
+         * named like the default one but with the string "standard" replaced by
135
+         * an unique name. You may use the name of your project for this. If
136
+         * you've implemented an alternative client class as well, "standard"
137
+         * should be replaced by the name of the new class.
138
+         *
139
+         * @param string Relative path to the template creating code for the HTML page body
140
+         * @since 2014.03
141
+         * @category Developer
142
+         * @see client/html/catalog/detail/additional/standard/template-header
143
+         */
144
+        $tplconf = 'client/html/catalog/detail/additional/standard/template-body';
145
+        $default = 'catalog/detail/additional-body-default.php';
146 146
 
147
-		return $view->render( $view->config( $tplconf, $default ) );
148
-	}
147
+        return $view->render( $view->config( $tplconf, $default ) );
148
+    }
149 149
 
150 150
 
151
-	/**
152
-	 * Returns the HTML string for insertion into the header.
153
-	 *
154
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
155
-	 * @param array &$tags Result array for the list of tags that are associated to the output
156
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
157
-	 * @return string|null String including HTML tags for the header on error
158
-	 */
159
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
160
-	{
161
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
151
+    /**
152
+     * Returns the HTML string for insertion into the header.
153
+     *
154
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
155
+     * @param array &$tags Result array for the list of tags that are associated to the output
156
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
157
+     * @return string|null String including HTML tags for the header on error
158
+     */
159
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
160
+    {
161
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
162 162
 
163
-		$html = '';
164
-		foreach( $this->getSubClients() as $subclient ) {
165
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
166
-		}
167
-		$view->additionalHeader = $html;
163
+        $html = '';
164
+        foreach( $this->getSubClients() as $subclient ) {
165
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
166
+        }
167
+        $view->additionalHeader = $html;
168 168
 
169
-		/** client/html/catalog/detail/additional/standard/template-header
170
-		 * Relative path to the HTML header template of the catalog detail additional client.
171
-		 *
172
-		 * The template file contains the HTML code and processing instructions
173
-		 * to generate the HTML code that is inserted into the HTML page header
174
-		 * of the rendered page in the frontend. The configuration string is the
175
-		 * path to the template file relative to the templates directory (usually
176
-		 * in client/html/templates).
177
-		 *
178
-		 * You can overwrite the template file configuration in extensions and
179
-		 * provide alternative templates. These alternative templates should be
180
-		 * named like the default one but with the string "standard" replaced by
181
-		 * an unique name. You may use the name of your project for this. If
182
-		 * you've implemented an alternative client class as well, "standard"
183
-		 * should be replaced by the name of the new class.
184
-		 *
185
-		 * @param string Relative path to the template creating code for the HTML page head
186
-		 * @since 2014.03
187
-		 * @category Developer
188
-		 * @see client/html/catalog/detail/additional/standard/template-body
189
-		 */
190
-		$tplconf = 'client/html/catalog/detail/additional/standard/template-header';
191
-		$default = 'catalog/detail/additional-header-default.php';
169
+        /** client/html/catalog/detail/additional/standard/template-header
170
+         * Relative path to the HTML header template of the catalog detail additional client.
171
+         *
172
+         * The template file contains the HTML code and processing instructions
173
+         * to generate the HTML code that is inserted into the HTML page header
174
+         * of the rendered page in the frontend. The configuration string is the
175
+         * path to the template file relative to the templates directory (usually
176
+         * in client/html/templates).
177
+         *
178
+         * You can overwrite the template file configuration in extensions and
179
+         * provide alternative templates. These alternative templates should be
180
+         * named like the default one but with the string "standard" replaced by
181
+         * an unique name. You may use the name of your project for this. If
182
+         * you've implemented an alternative client class as well, "standard"
183
+         * should be replaced by the name of the new class.
184
+         *
185
+         * @param string Relative path to the template creating code for the HTML page head
186
+         * @since 2014.03
187
+         * @category Developer
188
+         * @see client/html/catalog/detail/additional/standard/template-body
189
+         */
190
+        $tplconf = 'client/html/catalog/detail/additional/standard/template-header';
191
+        $default = 'catalog/detail/additional-header-default.php';
192 192
 
193
-		return $view->render( $view->config( $tplconf, $default ) );
194
-	}
193
+        return $view->render( $view->config( $tplconf, $default ) );
194
+    }
195 195
 
196 196
 
197
-	/**
198
-	 * Returns the sub-client given by its name.
199
-	 *
200
-	 * @param string $type Name of the client type
201
-	 * @param string|null $name Name of the sub-client (Default if null)
202
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
203
-	 */
204
-	public function getSubClient( $type, $name = null )
205
-	{
206
-		/** client/html/catalog/detail/additional/decorators/excludes
207
-		 * Excludes decorators added by the "common" option from the catalog detail additional html client
208
-		 *
209
-		 * Decorators extend the functionality of a class by adding new aspects
210
-		 * (e.g. log what is currently done), executing the methods of the underlying
211
-		 * class only in certain conditions (e.g. only for logged in users) or
212
-		 * modify what is returned to the caller.
213
-		 *
214
-		 * This option allows you to remove a decorator added via
215
-		 * "client/html/common/decorators/default" before they are wrapped
216
-		 * around the html client.
217
-		 *
218
-		 *  client/html/catalog/detail/additional/decorators/excludes = array( 'decorator1' )
219
-		 *
220
-		 * This would remove the decorator named "decorator1" from the list of
221
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
222
-		 * "client/html/common/decorators/default" to the html client.
223
-		 *
224
-		 * @param array List of decorator names
225
-		 * @since 2015.08
226
-		 * @category Developer
227
-		 * @see client/html/common/decorators/default
228
-		 * @see client/html/catalog/detail/additional/decorators/global
229
-		 * @see client/html/catalog/detail/additional/decorators/local
230
-		 */
197
+    /**
198
+     * Returns the sub-client given by its name.
199
+     *
200
+     * @param string $type Name of the client type
201
+     * @param string|null $name Name of the sub-client (Default if null)
202
+     * @return \Aimeos\Client\Html\Iface Sub-client object
203
+     */
204
+    public function getSubClient( $type, $name = null )
205
+    {
206
+        /** client/html/catalog/detail/additional/decorators/excludes
207
+         * Excludes decorators added by the "common" option from the catalog detail additional html client
208
+         *
209
+         * Decorators extend the functionality of a class by adding new aspects
210
+         * (e.g. log what is currently done), executing the methods of the underlying
211
+         * class only in certain conditions (e.g. only for logged in users) or
212
+         * modify what is returned to the caller.
213
+         *
214
+         * This option allows you to remove a decorator added via
215
+         * "client/html/common/decorators/default" before they are wrapped
216
+         * around the html client.
217
+         *
218
+         *  client/html/catalog/detail/additional/decorators/excludes = array( 'decorator1' )
219
+         *
220
+         * This would remove the decorator named "decorator1" from the list of
221
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
222
+         * "client/html/common/decorators/default" to the html client.
223
+         *
224
+         * @param array List of decorator names
225
+         * @since 2015.08
226
+         * @category Developer
227
+         * @see client/html/common/decorators/default
228
+         * @see client/html/catalog/detail/additional/decorators/global
229
+         * @see client/html/catalog/detail/additional/decorators/local
230
+         */
231 231
 
232
-		/** client/html/catalog/detail/additional/decorators/global
233
-		 * Adds a list of globally available decorators only to the catalog detail additional html client
234
-		 *
235
-		 * Decorators extend the functionality of a class by adding new aspects
236
-		 * (e.g. log what is currently done), executing the methods of the underlying
237
-		 * class only in certain conditions (e.g. only for logged in users) or
238
-		 * modify what is returned to the caller.
239
-		 *
240
-		 * This option allows you to wrap global decorators
241
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
242
-		 *
243
-		 *  client/html/catalog/detail/additional/decorators/global = array( 'decorator1' )
244
-		 *
245
-		 * This would add the decorator named "decorator1" defined by
246
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
247
-		 *
248
-		 * @param array List of decorator names
249
-		 * @since 2015.08
250
-		 * @category Developer
251
-		 * @see client/html/common/decorators/default
252
-		 * @see client/html/catalog/detail/additional/decorators/excludes
253
-		 * @see client/html/catalog/detail/additional/decorators/local
254
-		 */
232
+        /** client/html/catalog/detail/additional/decorators/global
233
+         * Adds a list of globally available decorators only to the catalog detail additional html client
234
+         *
235
+         * Decorators extend the functionality of a class by adding new aspects
236
+         * (e.g. log what is currently done), executing the methods of the underlying
237
+         * class only in certain conditions (e.g. only for logged in users) or
238
+         * modify what is returned to the caller.
239
+         *
240
+         * This option allows you to wrap global decorators
241
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
242
+         *
243
+         *  client/html/catalog/detail/additional/decorators/global = array( 'decorator1' )
244
+         *
245
+         * This would add the decorator named "decorator1" defined by
246
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
247
+         *
248
+         * @param array List of decorator names
249
+         * @since 2015.08
250
+         * @category Developer
251
+         * @see client/html/common/decorators/default
252
+         * @see client/html/catalog/detail/additional/decorators/excludes
253
+         * @see client/html/catalog/detail/additional/decorators/local
254
+         */
255 255
 
256
-		/** client/html/catalog/detail/additional/decorators/local
257
-		 * Adds a list of local decorators only to the catalog detail additional html client
258
-		 *
259
-		 * Decorators extend the functionality of a class by adding new aspects
260
-		 * (e.g. log what is currently done), executing the methods of the underlying
261
-		 * class only in certain conditions (e.g. only for logged in users) or
262
-		 * modify what is returned to the caller.
263
-		 *
264
-		 * This option allows you to wrap local decorators
265
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
266
-		 *
267
-		 *  client/html/catalog/detail/additional/decorators/local = array( 'decorator2' )
268
-		 *
269
-		 * This would add the decorator named "decorator2" defined by
270
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
271
-		 *
272
-		 * @param array List of decorator names
273
-		 * @since 2015.08
274
-		 * @category Developer
275
-		 * @see client/html/common/decorators/default
276
-		 * @see client/html/catalog/detail/additional/decorators/excludes
277
-		 * @see client/html/catalog/detail/additional/decorators/global
278
-		 */
256
+        /** client/html/catalog/detail/additional/decorators/local
257
+         * Adds a list of local decorators only to the catalog detail additional html client
258
+         *
259
+         * Decorators extend the functionality of a class by adding new aspects
260
+         * (e.g. log what is currently done), executing the methods of the underlying
261
+         * class only in certain conditions (e.g. only for logged in users) or
262
+         * modify what is returned to the caller.
263
+         *
264
+         * This option allows you to wrap local decorators
265
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
266
+         *
267
+         *  client/html/catalog/detail/additional/decorators/local = array( 'decorator2' )
268
+         *
269
+         * This would add the decorator named "decorator2" defined by
270
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
271
+         *
272
+         * @param array List of decorator names
273
+         * @since 2015.08
274
+         * @category Developer
275
+         * @see client/html/common/decorators/default
276
+         * @see client/html/catalog/detail/additional/decorators/excludes
277
+         * @see client/html/catalog/detail/additional/decorators/global
278
+         */
279 279
 
280
-		return $this->createSubClient( 'catalog/detail/additional/' . $type, $name );
281
-	}
280
+        return $this->createSubClient( 'catalog/detail/additional/' . $type, $name );
281
+    }
282 282
 
283 283
 
284
-	/**
285
-	 * Returns the list of sub-client names configured for the client.
286
-	 *
287
-	 * @return array List of HTML client names
288
-	 */
289
-	protected function getSubClientNames()
290
-	{
291
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
292
-	}
284
+    /**
285
+     * Returns the list of sub-client names configured for the client.
286
+     *
287
+     * @return array List of HTML client names
288
+     */
289
+    protected function getSubClientNames()
290
+    {
291
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
292
+    }
293 293
 }
294 294
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 	 * @since 2014.03
101 101
 	 * @category Developer
102 102
 	 */
103
-	private $subPartNames = array( 'text', 'attribute', 'property', 'download' );
103
+	private $subPartNames = array('text', 'attribute', 'property', 'download');
104 104
 
105 105
 
106 106
 	/**
@@ -111,13 +111,13 @@  discard block
 block discarded – undo
111 111
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
112 112
 	 * @return string HTML code
113 113
 	 */
114
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
114
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
115 115
 	{
116
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
116
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
117 117
 
118 118
 		$html = '';
119
-		foreach( $this->getSubClients() as $subclient ) {
120
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
119
+		foreach ($this->getSubClients() as $subclient) {
120
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
121 121
 		}
122 122
 		$view->additionalBody = $html;
123 123
 
@@ -144,7 +144,7 @@  discard block
 block discarded – undo
144 144
 		$tplconf = 'client/html/catalog/detail/additional/standard/template-body';
145 145
 		$default = 'catalog/detail/additional-body-default.php';
146 146
 
147
-		return $view->render( $view->config( $tplconf, $default ) );
147
+		return $view->render($view->config($tplconf, $default));
148 148
 	}
149 149
 
150 150
 
@@ -156,13 +156,13 @@  discard block
 block discarded – undo
156 156
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
157 157
 	 * @return string|null String including HTML tags for the header on error
158 158
 	 */
159
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
159
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
160 160
 	{
161
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
161
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
162 162
 
163 163
 		$html = '';
164
-		foreach( $this->getSubClients() as $subclient ) {
165
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
164
+		foreach ($this->getSubClients() as $subclient) {
165
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
166 166
 		}
167 167
 		$view->additionalHeader = $html;
168 168
 
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
 		$tplconf = 'client/html/catalog/detail/additional/standard/template-header';
191 191
 		$default = 'catalog/detail/additional-header-default.php';
192 192
 
193
-		return $view->render( $view->config( $tplconf, $default ) );
193
+		return $view->render($view->config($tplconf, $default));
194 194
 	}
195 195
 
196 196
 
@@ -201,7 +201,7 @@  discard block
 block discarded – undo
201 201
 	 * @param string|null $name Name of the sub-client (Default if null)
202 202
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
203 203
 	 */
204
-	public function getSubClient( $type, $name = null )
204
+	public function getSubClient($type, $name = null)
205 205
 	{
206 206
 		/** client/html/catalog/detail/additional/decorators/excludes
207 207
 		 * Excludes decorators added by the "common" option from the catalog detail additional html client
@@ -277,7 +277,7 @@  discard block
 block discarded – undo
277 277
 		 * @see client/html/catalog/detail/additional/decorators/global
278 278
 		 */
279 279
 
280
-		return $this->createSubClient( 'catalog/detail/additional/' . $type, $name );
280
+		return $this->createSubClient('catalog/detail/additional/'.$type, $name);
281 281
 	}
282 282
 
283 283
 
@@ -288,6 +288,6 @@  discard block
 block discarded – undo
288 288
 	 */
289 289
 	protected function getSubClientNames()
290 290
 	{
291
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
291
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
292 292
 	}
293 293
 }
294 294
\ 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/Catalog/Detail/Additional/Text/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\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/catalog/detail/additional/text/standard/subparts
26
-	 * List of HTML sub-clients rendered within the catalog detail additional text 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/catalog/detail/additional/text/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->textBody = $html;
79
-
80
-		/** client/html/catalog/detail/additional/text/standard/template-body
81
-		 * Relative path to the HTML body template of the catalog detail additional text client.
82
-		 *
83
-		 * The template file contains the HTML code and processing instructions
84
-		 * to generate the result shown in the body of the frontend. The
85
-		 * configuration string is the path to the template file relative
86
-		 * to the templates directory (usually in client/html/templates).
87
-		 *
88
-		 * You can overwrite the template file configuration in extensions and
89
-		 * provide alternative templates. These alternative templates should be
90
-		 * named like the default one but with the string "standard" replaced by
91
-		 * an unique name. You may use the name of your project for this. If
92
-		 * you've implemented an alternative client class as well, "standard"
93
-		 * should be replaced by the name of the new class.
94
-		 *
95
-		 * @param string Relative path to the template creating code for the HTML page body
96
-		 * @since 2014.03
97
-		 * @category Developer
98
-		 * @see client/html/catalog/detail/additional/text/standard/template-header
99
-		 */
100
-		$tplconf = 'client/html/catalog/detail/additional/text/standard/template-body';
101
-		$default = 'catalog/detail/additional-text-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->textHeader = $html;
124
-
125
-		/** client/html/catalog/detail/additional/text/standard/template-header
126
-		 * Relative path to the HTML header template of the catalog detail additional text client.
127
-		 *
128
-		 * The template file contains the HTML code and processing instructions
129
-		 * to generate the HTML code that is inserted into the HTML page header
130
-		 * of the rendered page in the frontend. The configuration string is the
131
-		 * path to the template file relative to the templates directory (usually
132
-		 * in client/html/templates).
133
-		 *
134
-		 * You can overwrite the template file configuration in extensions and
135
-		 * provide alternative templates. These alternative templates should be
136
-		 * named like the default one but with the string "standard" replaced by
137
-		 * an unique name. You may use the name of your project for this. If
138
-		 * you've implemented an alternative client class as well, "standard"
139
-		 * should be replaced by the name of the new class.
140
-		 *
141
-		 * @param string Relative path to the template creating code for the HTML page head
142
-		 * @since 2014.03
143
-		 * @category Developer
144
-		 * @see client/html/catalog/detail/additional/text/standard/template-body
145
-		 */
146
-		$tplconf = 'client/html/catalog/detail/additional/text/standard/template-header';
147
-		$default = 'catalog/detail/additional-text-header-default.php';
148
-
149
-		return $view->render( $view->config( $tplconf, $default ) );
150
-	}
151
-
152
-
153
-	/**
154
-	 * Returns the sub-client given by its name.
155
-	 *
156
-	 * @param string $type Name of the client type
157
-	 * @param string|null $name Name of the sub-client (Default if null)
158
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
159
-	 */
160
-	public function getSubClient( $type, $name = null )
161
-	{
162
-		/** client/html/catalog/detail/additional/text/decorators/excludes
163
-		 * Excludes decorators added by the "common" option from the catalog detail additional text html client
164
-		 *
165
-		 * Decorators extend the functionality of a class by adding new aspects
166
-		 * (e.g. log what is currently done), executing the methods of the underlying
167
-		 * class only in certain conditions (e.g. only for logged in users) or
168
-		 * modify what is returned to the caller.
169
-		 *
170
-		 * This option allows you to remove a decorator added via
171
-		 * "client/html/common/decorators/default" before they are wrapped
172
-		 * around the html client.
173
-		 *
174
-		 *  client/html/catalog/detail/additional/text/decorators/excludes = array( 'decorator1' )
175
-		 *
176
-		 * This would remove the decorator named "decorator1" from the list of
177
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
-		 * "client/html/common/decorators/default" to the html client.
179
-		 *
180
-		 * @param array List of decorator names
181
-		 * @since 2015.08
182
-		 * @category Developer
183
-		 * @see client/html/common/decorators/default
184
-		 * @see client/html/catalog/detail/additional/text/decorators/global
185
-		 * @see client/html/catalog/detail/additional/text/decorators/local
186
-		 */
187
-
188
-		/** client/html/catalog/detail/additional/text/decorators/global
189
-		 * Adds a list of globally available decorators only to the catalog detail additional text html client
190
-		 *
191
-		 * Decorators extend the functionality of a class by adding new aspects
192
-		 * (e.g. log what is currently done), executing the methods of the underlying
193
-		 * class only in certain conditions (e.g. only for logged in users) or
194
-		 * modify what is returned to the caller.
195
-		 *
196
-		 * This option allows you to wrap global decorators
197
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
-		 *
199
-		 *  client/html/catalog/detail/additional/text/decorators/global = array( 'decorator1' )
200
-		 *
201
-		 * This would add the decorator named "decorator1" defined by
202
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
-		 *
204
-		 * @param array List of decorator names
205
-		 * @since 2015.08
206
-		 * @category Developer
207
-		 * @see client/html/common/decorators/default
208
-		 * @see client/html/catalog/detail/additional/text/decorators/excludes
209
-		 * @see client/html/catalog/detail/additional/text/decorators/local
210
-		 */
211
-
212
-		/** client/html/catalog/detail/additional/text/decorators/local
213
-		 * Adds a list of local decorators only to the catalog detail additional text html client
214
-		 *
215
-		 * Decorators extend the functionality of a class by adding new aspects
216
-		 * (e.g. log what is currently done), executing the methods of the underlying
217
-		 * class only in certain conditions (e.g. only for logged in users) or
218
-		 * modify what is returned to the caller.
219
-		 *
220
-		 * This option allows you to wrap local decorators
221
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
-		 *
223
-		 *  client/html/catalog/detail/additional/text/decorators/local = array( 'decorator2' )
224
-		 *
225
-		 * This would add the decorator named "decorator2" defined by
226
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
-		 *
228
-		 * @param array List of decorator names
229
-		 * @since 2015.08
230
-		 * @category Developer
231
-		 * @see client/html/common/decorators/default
232
-		 * @see client/html/catalog/detail/additional/text/decorators/excludes
233
-		 * @see client/html/catalog/detail/additional/text/decorators/global
234
-		 */
235
-
236
-		return $this->createSubClient( 'catalog/detail/additional/text/' . $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
-	}
25
+    /** client/html/catalog/detail/additional/text/standard/subparts
26
+     * List of HTML sub-clients rendered within the catalog detail additional text 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/catalog/detail/additional/text/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->textBody = $html;
79
+
80
+        /** client/html/catalog/detail/additional/text/standard/template-body
81
+         * Relative path to the HTML body template of the catalog detail additional text client.
82
+         *
83
+         * The template file contains the HTML code and processing instructions
84
+         * to generate the result shown in the body of the frontend. The
85
+         * configuration string is the path to the template file relative
86
+         * to the templates directory (usually in client/html/templates).
87
+         *
88
+         * You can overwrite the template file configuration in extensions and
89
+         * provide alternative templates. These alternative templates should be
90
+         * named like the default one but with the string "standard" replaced by
91
+         * an unique name. You may use the name of your project for this. If
92
+         * you've implemented an alternative client class as well, "standard"
93
+         * should be replaced by the name of the new class.
94
+         *
95
+         * @param string Relative path to the template creating code for the HTML page body
96
+         * @since 2014.03
97
+         * @category Developer
98
+         * @see client/html/catalog/detail/additional/text/standard/template-header
99
+         */
100
+        $tplconf = 'client/html/catalog/detail/additional/text/standard/template-body';
101
+        $default = 'catalog/detail/additional-text-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->textHeader = $html;
124
+
125
+        /** client/html/catalog/detail/additional/text/standard/template-header
126
+         * Relative path to the HTML header template of the catalog detail additional text client.
127
+         *
128
+         * The template file contains the HTML code and processing instructions
129
+         * to generate the HTML code that is inserted into the HTML page header
130
+         * of the rendered page in the frontend. The configuration string is the
131
+         * path to the template file relative to the templates directory (usually
132
+         * in client/html/templates).
133
+         *
134
+         * You can overwrite the template file configuration in extensions and
135
+         * provide alternative templates. These alternative templates should be
136
+         * named like the default one but with the string "standard" replaced by
137
+         * an unique name. You may use the name of your project for this. If
138
+         * you've implemented an alternative client class as well, "standard"
139
+         * should be replaced by the name of the new class.
140
+         *
141
+         * @param string Relative path to the template creating code for the HTML page head
142
+         * @since 2014.03
143
+         * @category Developer
144
+         * @see client/html/catalog/detail/additional/text/standard/template-body
145
+         */
146
+        $tplconf = 'client/html/catalog/detail/additional/text/standard/template-header';
147
+        $default = 'catalog/detail/additional-text-header-default.php';
148
+
149
+        return $view->render( $view->config( $tplconf, $default ) );
150
+    }
151
+
152
+
153
+    /**
154
+     * Returns the sub-client given by its name.
155
+     *
156
+     * @param string $type Name of the client type
157
+     * @param string|null $name Name of the sub-client (Default if null)
158
+     * @return \Aimeos\Client\Html\Iface Sub-client object
159
+     */
160
+    public function getSubClient( $type, $name = null )
161
+    {
162
+        /** client/html/catalog/detail/additional/text/decorators/excludes
163
+         * Excludes decorators added by the "common" option from the catalog detail additional text html client
164
+         *
165
+         * Decorators extend the functionality of a class by adding new aspects
166
+         * (e.g. log what is currently done), executing the methods of the underlying
167
+         * class only in certain conditions (e.g. only for logged in users) or
168
+         * modify what is returned to the caller.
169
+         *
170
+         * This option allows you to remove a decorator added via
171
+         * "client/html/common/decorators/default" before they are wrapped
172
+         * around the html client.
173
+         *
174
+         *  client/html/catalog/detail/additional/text/decorators/excludes = array( 'decorator1' )
175
+         *
176
+         * This would remove the decorator named "decorator1" from the list of
177
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
178
+         * "client/html/common/decorators/default" to the html client.
179
+         *
180
+         * @param array List of decorator names
181
+         * @since 2015.08
182
+         * @category Developer
183
+         * @see client/html/common/decorators/default
184
+         * @see client/html/catalog/detail/additional/text/decorators/global
185
+         * @see client/html/catalog/detail/additional/text/decorators/local
186
+         */
187
+
188
+        /** client/html/catalog/detail/additional/text/decorators/global
189
+         * Adds a list of globally available decorators only to the catalog detail additional text html client
190
+         *
191
+         * Decorators extend the functionality of a class by adding new aspects
192
+         * (e.g. log what is currently done), executing the methods of the underlying
193
+         * class only in certain conditions (e.g. only for logged in users) or
194
+         * modify what is returned to the caller.
195
+         *
196
+         * This option allows you to wrap global decorators
197
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
198
+         *
199
+         *  client/html/catalog/detail/additional/text/decorators/global = array( 'decorator1' )
200
+         *
201
+         * This would add the decorator named "decorator1" defined by
202
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
203
+         *
204
+         * @param array List of decorator names
205
+         * @since 2015.08
206
+         * @category Developer
207
+         * @see client/html/common/decorators/default
208
+         * @see client/html/catalog/detail/additional/text/decorators/excludes
209
+         * @see client/html/catalog/detail/additional/text/decorators/local
210
+         */
211
+
212
+        /** client/html/catalog/detail/additional/text/decorators/local
213
+         * Adds a list of local decorators only to the catalog detail additional text html client
214
+         *
215
+         * Decorators extend the functionality of a class by adding new aspects
216
+         * (e.g. log what is currently done), executing the methods of the underlying
217
+         * class only in certain conditions (e.g. only for logged in users) or
218
+         * modify what is returned to the caller.
219
+         *
220
+         * This option allows you to wrap local decorators
221
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
222
+         *
223
+         *  client/html/catalog/detail/additional/text/decorators/local = array( 'decorator2' )
224
+         *
225
+         * This would add the decorator named "decorator2" defined by
226
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
227
+         *
228
+         * @param array List of decorator names
229
+         * @since 2015.08
230
+         * @category Developer
231
+         * @see client/html/common/decorators/default
232
+         * @see client/html/catalog/detail/additional/text/decorators/excludes
233
+         * @see client/html/catalog/detail/additional/text/decorators/global
234
+         */
235
+
236
+        return $this->createSubClient( 'catalog/detail/additional/text/' . $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
@@ -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->textBody = $html;
79 79
 
@@ -100,7 +100,7 @@  discard block
 block discarded – undo
100 100
 		$tplconf = 'client/html/catalog/detail/additional/text/standard/template-body';
101 101
 		$default = 'catalog/detail/additional-text-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->textHeader = $html;
124 124
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
 		$tplconf = 'client/html/catalog/detail/additional/text/standard/template-header';
147 147
 		$default = 'catalog/detail/additional-text-header-default.php';
148 148
 
149
-		return $view->render( $view->config( $tplconf, $default ) );
149
+		return $view->render($view->config($tplconf, $default));
150 150
 	}
151 151
 
152 152
 
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @param string|null $name Name of the sub-client (Default if null)
158 158
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
159 159
 	 */
160
-	public function getSubClient( $type, $name = null )
160
+	public function getSubClient($type, $name = null)
161 161
 	{
162 162
 		/** client/html/catalog/detail/additional/text/decorators/excludes
163 163
 		 * Excludes decorators added by the "common" option from the catalog detail additional text html client
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 		 * @see client/html/catalog/detail/additional/text/decorators/global
234 234
 		 */
235 235
 
236
-		return $this->createSubClient( 'catalog/detail/additional/text/' . $type, $name );
236
+		return $this->createSubClient('catalog/detail/additional/text/'.$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/Catalog/Detail/Bundle/Standard.php 3 patches
Indentation   +297 added lines, -297 removed lines patch added patch discarded remove patch
@@ -18,302 +18,302 @@
 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/catalog/detail/bundle/standard/subparts
25
-	 * List of HTML sub-clients rendered within the catalog detail bundle section
26
-	 *
27
-	 * The output of the frontend is composed of the code generated by the HTML
28
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
29
-	 * that are responsible for rendering certain sub-parts of the output. The
30
-	 * sub-clients can contain HTML clients themselves and therefore a
31
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
32
-	 * the output that is placed inside the container of its parent.
33
-	 *
34
-	 * At first, always the HTML code generated by the parent is printed, then
35
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
36
-	 * determines the order of the output of these sub-clients inside the parent
37
-	 * container. If the configured list of clients is
38
-	 *
39
-	 *  array( "subclient1", "subclient2" )
40
-	 *
41
-	 * you can easily change the order of the output by reordering the subparts:
42
-	 *
43
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
44
-	 *
45
-	 * You can also remove one or more parts if they shouldn't be rendered:
46
-	 *
47
-	 *  client/html/<clients>/subparts = array( "subclient1" )
48
-	 *
49
-	 * As the clients only generates structural HTML, the layout defined via CSS
50
-	 * should support adding, removing or reordering content by a fluid like
51
-	 * design.
52
-	 *
53
-	 * @param array List of sub-client names
54
-	 * @since 2014.03
55
-	 * @category Developer
56
-	 */
57
-	private $subPartPath = 'client/html/catalog/detail/bundle/standard/subparts';
58
-	private $subPartNames = array();
59
-	private $tags = array();
60
-	private $expire;
61
-	private $cache;
62
-
63
-
64
-	/**
65
-	 * Returns the HTML code for insertion into the body.
66
-	 *
67
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
68
-	 * @param array &$tags Result array for the list of tags that are associated to the output
69
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
70
-	 * @return string HTML code
71
-	 */
72
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
73
-	{
74
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
75
-
76
-		$html = '';
77
-		foreach( $this->getSubClients() as $subclient ) {
78
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
79
-		}
80
-		$view->bundleBody = $html;
81
-
82
-		/** client/html/catalog/detail/bundle/standard/template-body
83
-		 * Relative path to the HTML body template of the catalog detail bundle client.
84
-		 *
85
-		 * The template file contains the HTML code and processing instructions
86
-		 * to generate the result shown in the body of the frontend. The
87
-		 * configuration string is the path to the template file relative
88
-		 * to the templates directory (usually in client/html/templates).
89
-		 *
90
-		 * You can overwrite the template file configuration in extensions and
91
-		 * provide alternative templates. These alternative templates should be
92
-		 * named like the default one but with the string "standard" replaced by
93
-		 * an unique name. You may use the name of your project for this. If
94
-		 * you've implemented an alternative client class as well, "standard"
95
-		 * should be replaced by the name of the new class.
96
-		 *
97
-		 * @param string Relative path to the template creating code for the HTML page body
98
-		 * @since 2014.03
99
-		 * @category Developer
100
-		 * @see client/html/catalog/detail/bundle/standard/template-header
101
-		 */
102
-		$tplconf = 'client/html/catalog/detail/bundle/standard/template-body';
103
-		$default = 'catalog/detail/bundle-body-default.php';
104
-
105
-		return $view->render( $view->config( $tplconf, $default ) );
106
-	}
107
-
108
-
109
-	/**
110
-	 * Returns the HTML string for insertion into the header.
111
-	 *
112
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
113
-	 * @param array &$tags Result array for the list of tags that are associated to the output
114
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115
-	 * @return string|null String including HTML tags for the header on error
116
-	 */
117
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
118
-	{
119
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
120
-
121
-		$html = '';
122
-		foreach( $this->getSubClients() as $subclient ) {
123
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
124
-		}
125
-		$view->bundleHeader = $html;
126
-
127
-		/** client/html/catalog/detail/bundle/standard/template-header
128
-		 * Relative path to the HTML header template of the catalog detail bundle client.
129
-		 *
130
-		 * The template file contains the HTML code and processing instructions
131
-		 * to generate the HTML code that is inserted into the HTML page header
132
-		 * of the rendered page in the frontend. The configuration string is the
133
-		 * path to the template file relative to the templates directory (usually
134
-		 * in client/html/templates).
135
-		 *
136
-		 * You can overwrite the template file configuration in extensions and
137
-		 * provide alternative templates. These alternative templates should be
138
-		 * named like the default one but with the string "standard" replaced by
139
-		 * an unique name. You may use the name of your project for this. If
140
-		 * you've implemented an alternative client class as well, "standard"
141
-		 * should be replaced by the name of the new class.
142
-		 *
143
-		 * @param string Relative path to the template creating code for the HTML page head
144
-		 * @since 2014.03
145
-		 * @category Developer
146
-		 * @see client/html/catalog/detail/bundle/standard/template-body
147
-		 */
148
-		$tplconf = 'client/html/catalog/detail/bundle/standard/template-header';
149
-		$default = 'catalog/detail/bundle-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/catalog/detail/bundle/decorators/excludes
165
-		 * Excludes decorators added by the "common" option from the catalog detail bundle 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/catalog/detail/bundle/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/catalog/detail/bundle/decorators/global
187
-		 * @see client/html/catalog/detail/bundle/decorators/local
188
-		 */
189
-
190
-		/** client/html/catalog/detail/bundle/decorators/global
191
-		 * Adds a list of globally available decorators only to the catalog detail bundle 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/catalog/detail/bundle/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/catalog/detail/bundle/decorators/excludes
211
-		 * @see client/html/catalog/detail/bundle/decorators/local
212
-		 */
213
-
214
-		/** client/html/catalog/detail/bundle/decorators/local
215
-		 * Adds a list of local decorators only to the catalog detail bundle 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\Catalog\Decorator\*") around the html client.
224
-		 *
225
-		 *  client/html/catalog/detail/bundle/decorators/local = array( 'decorator2' )
226
-		 *
227
-		 * This would add the decorator named "decorator2" defined by
228
-		 * "\Aimeos\Client\Html\Catalog\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/catalog/detail/bundle/decorators/excludes
235
-		 * @see client/html/catalog/detail/bundle/decorators/global
236
-		 */
237
-
238
-		return $this->createSubClient( 'catalog/detail/bundle/' . $type, $name );
239
-	}
240
-
241
-
242
-	/**
243
-	 * Returns the list of sub-client names configured for the client.
244
-	 *
245
-	 * @return array List of HTML client names
246
-	 */
247
-	protected function getSubClientNames()
248
-	{
249
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
250
-	}
251
-
252
-
253
-	/**
254
-	 * Sets the necessary parameter values in the view.
255
-	 *
256
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
257
-	 * @param array &$tags Result array for the list of tags that are associated to the output
258
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259
-	 * @return \Aimeos\MW\View\Iface Modified view object
260
-	 */
261
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
262
-	{
263
-		if( !isset( $this->cache ) )
264
-		{
265
-			if( isset( $view->detailProductItem ) && $view->detailProductItem->getType() === 'bundle' )
266
-			{
267
-				$context = $this->getContext();
268
-				$config = $context->getConfig();
269
-				$domains = array( 'text', 'price', 'media' );
270
-				$products = $view->detailProductItem->getRefItems( 'product', null, 'default' );
271
-
272
-				/** client/html/catalog/detail/domains
273
-				 * A list of domain names whose items should be available in the catalog view templates
274
-				 *
275
-				 * @see client/html/catalog/detail/domains
276
-				 */
277
-				$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
278
-
279
-				/** client/html/catalog/detail/bundle/domains
280
-				 * A list of domain names whose items should be available in the bundle part of the catalog detail view templates
281
-				 *
282
-				 * The templates rendering bundle related data usually add
283
-				 * the images and texts associated to each item. If you want to
284
-				 * display additional content like the attributes, you can configure
285
-				 * your own list of domains (attribute, media, price, product, text,
286
-				 * etc. are domains) whose items are fetched from the storage.
287
-				 * Please keep in mind that the more domains you add to the
288
-				 * configuration, the more time is required for fetching the content!
289
-				 *
290
-				 * This configuration option can be overwritten by the
291
-				 * "client/html/catalog/detail/domains" configuration option that
292
-				 * allows to configure the domain names of the items fetched
293
-				 * specifically for all types of product listings.
294
-				 *
295
-				 * @param array List of domain names
296
-				 * @since 2015.09
297
-				 * @category Developer
298
-				 * @see client/html/catalog/detail/domains
299
-				 */
300
-				$domains = $config->get( 'client/html/catalog/detail/bundle/domains', $domains );
301
-
302
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
303
-
304
-				$view->bundleItems = $controller->getProductItems( array_keys( $products ), $domains );
305
-				$view->bundlePosItems = $products;
306
-
307
-				$this->addMetaItem( $view->bundleItems, 'product', $this->expire, $this->tags );
308
-				$this->addMetaList( array_keys( $view->bundleItems ), 'product', $this->expire );
309
-			}
310
-
311
-			$this->cache = $view;
312
-		}
313
-
314
-		$expire = $this->expires( $this->expire, $expire );
315
-		$tags = array_merge( $tags, $this->tags );
316
-
317
-		return $this->cache;
318
-	}
24
+    /** client/html/catalog/detail/bundle/standard/subparts
25
+     * List of HTML sub-clients rendered within the catalog detail bundle section
26
+     *
27
+     * The output of the frontend is composed of the code generated by the HTML
28
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
29
+     * that are responsible for rendering certain sub-parts of the output. The
30
+     * sub-clients can contain HTML clients themselves and therefore a
31
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
32
+     * the output that is placed inside the container of its parent.
33
+     *
34
+     * At first, always the HTML code generated by the parent is printed, then
35
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
36
+     * determines the order of the output of these sub-clients inside the parent
37
+     * container. If the configured list of clients is
38
+     *
39
+     *  array( "subclient1", "subclient2" )
40
+     *
41
+     * you can easily change the order of the output by reordering the subparts:
42
+     *
43
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
44
+     *
45
+     * You can also remove one or more parts if they shouldn't be rendered:
46
+     *
47
+     *  client/html/<clients>/subparts = array( "subclient1" )
48
+     *
49
+     * As the clients only generates structural HTML, the layout defined via CSS
50
+     * should support adding, removing or reordering content by a fluid like
51
+     * design.
52
+     *
53
+     * @param array List of sub-client names
54
+     * @since 2014.03
55
+     * @category Developer
56
+     */
57
+    private $subPartPath = 'client/html/catalog/detail/bundle/standard/subparts';
58
+    private $subPartNames = array();
59
+    private $tags = array();
60
+    private $expire;
61
+    private $cache;
62
+
63
+
64
+    /**
65
+     * Returns the HTML code for insertion into the body.
66
+     *
67
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
68
+     * @param array &$tags Result array for the list of tags that are associated to the output
69
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
70
+     * @return string HTML code
71
+     */
72
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
73
+    {
74
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
75
+
76
+        $html = '';
77
+        foreach( $this->getSubClients() as $subclient ) {
78
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
79
+        }
80
+        $view->bundleBody = $html;
81
+
82
+        /** client/html/catalog/detail/bundle/standard/template-body
83
+         * Relative path to the HTML body template of the catalog detail bundle client.
84
+         *
85
+         * The template file contains the HTML code and processing instructions
86
+         * to generate the result shown in the body of the frontend. The
87
+         * configuration string is the path to the template file relative
88
+         * to the templates directory (usually in client/html/templates).
89
+         *
90
+         * You can overwrite the template file configuration in extensions and
91
+         * provide alternative templates. These alternative templates should be
92
+         * named like the default one but with the string "standard" replaced by
93
+         * an unique name. You may use the name of your project for this. If
94
+         * you've implemented an alternative client class as well, "standard"
95
+         * should be replaced by the name of the new class.
96
+         *
97
+         * @param string Relative path to the template creating code for the HTML page body
98
+         * @since 2014.03
99
+         * @category Developer
100
+         * @see client/html/catalog/detail/bundle/standard/template-header
101
+         */
102
+        $tplconf = 'client/html/catalog/detail/bundle/standard/template-body';
103
+        $default = 'catalog/detail/bundle-body-default.php';
104
+
105
+        return $view->render( $view->config( $tplconf, $default ) );
106
+    }
107
+
108
+
109
+    /**
110
+     * Returns the HTML string for insertion into the header.
111
+     *
112
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
113
+     * @param array &$tags Result array for the list of tags that are associated to the output
114
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115
+     * @return string|null String including HTML tags for the header on error
116
+     */
117
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
118
+    {
119
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
120
+
121
+        $html = '';
122
+        foreach( $this->getSubClients() as $subclient ) {
123
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
124
+        }
125
+        $view->bundleHeader = $html;
126
+
127
+        /** client/html/catalog/detail/bundle/standard/template-header
128
+         * Relative path to the HTML header template of the catalog detail bundle client.
129
+         *
130
+         * The template file contains the HTML code and processing instructions
131
+         * to generate the HTML code that is inserted into the HTML page header
132
+         * of the rendered page in the frontend. The configuration string is the
133
+         * path to the template file relative to the templates directory (usually
134
+         * in client/html/templates).
135
+         *
136
+         * You can overwrite the template file configuration in extensions and
137
+         * provide alternative templates. These alternative templates should be
138
+         * named like the default one but with the string "standard" replaced by
139
+         * an unique name. You may use the name of your project for this. If
140
+         * you've implemented an alternative client class as well, "standard"
141
+         * should be replaced by the name of the new class.
142
+         *
143
+         * @param string Relative path to the template creating code for the HTML page head
144
+         * @since 2014.03
145
+         * @category Developer
146
+         * @see client/html/catalog/detail/bundle/standard/template-body
147
+         */
148
+        $tplconf = 'client/html/catalog/detail/bundle/standard/template-header';
149
+        $default = 'catalog/detail/bundle-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/catalog/detail/bundle/decorators/excludes
165
+         * Excludes decorators added by the "common" option from the catalog detail bundle 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/catalog/detail/bundle/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/catalog/detail/bundle/decorators/global
187
+         * @see client/html/catalog/detail/bundle/decorators/local
188
+         */
189
+
190
+        /** client/html/catalog/detail/bundle/decorators/global
191
+         * Adds a list of globally available decorators only to the catalog detail bundle 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/catalog/detail/bundle/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/catalog/detail/bundle/decorators/excludes
211
+         * @see client/html/catalog/detail/bundle/decorators/local
212
+         */
213
+
214
+        /** client/html/catalog/detail/bundle/decorators/local
215
+         * Adds a list of local decorators only to the catalog detail bundle 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\Catalog\Decorator\*") around the html client.
224
+         *
225
+         *  client/html/catalog/detail/bundle/decorators/local = array( 'decorator2' )
226
+         *
227
+         * This would add the decorator named "decorator2" defined by
228
+         * "\Aimeos\Client\Html\Catalog\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/catalog/detail/bundle/decorators/excludes
235
+         * @see client/html/catalog/detail/bundle/decorators/global
236
+         */
237
+
238
+        return $this->createSubClient( 'catalog/detail/bundle/' . $type, $name );
239
+    }
240
+
241
+
242
+    /**
243
+     * Returns the list of sub-client names configured for the client.
244
+     *
245
+     * @return array List of HTML client names
246
+     */
247
+    protected function getSubClientNames()
248
+    {
249
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
250
+    }
251
+
252
+
253
+    /**
254
+     * Sets the necessary parameter values in the view.
255
+     *
256
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
257
+     * @param array &$tags Result array for the list of tags that are associated to the output
258
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259
+     * @return \Aimeos\MW\View\Iface Modified view object
260
+     */
261
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
262
+    {
263
+        if( !isset( $this->cache ) )
264
+        {
265
+            if( isset( $view->detailProductItem ) && $view->detailProductItem->getType() === 'bundle' )
266
+            {
267
+                $context = $this->getContext();
268
+                $config = $context->getConfig();
269
+                $domains = array( 'text', 'price', 'media' );
270
+                $products = $view->detailProductItem->getRefItems( 'product', null, 'default' );
271
+
272
+                /** client/html/catalog/detail/domains
273
+                 * A list of domain names whose items should be available in the catalog view templates
274
+                 *
275
+                 * @see client/html/catalog/detail/domains
276
+                 */
277
+                $domains = $config->get( 'client/html/catalog/detail/domains', $domains );
278
+
279
+                /** client/html/catalog/detail/bundle/domains
280
+                 * A list of domain names whose items should be available in the bundle part of the catalog detail view templates
281
+                 *
282
+                 * The templates rendering bundle related data usually add
283
+                 * the images and texts associated to each item. If you want to
284
+                 * display additional content like the attributes, you can configure
285
+                 * your own list of domains (attribute, media, price, product, text,
286
+                 * etc. are domains) whose items are fetched from the storage.
287
+                 * Please keep in mind that the more domains you add to the
288
+                 * configuration, the more time is required for fetching the content!
289
+                 *
290
+                 * This configuration option can be overwritten by the
291
+                 * "client/html/catalog/detail/domains" configuration option that
292
+                 * allows to configure the domain names of the items fetched
293
+                 * specifically for all types of product listings.
294
+                 *
295
+                 * @param array List of domain names
296
+                 * @since 2015.09
297
+                 * @category Developer
298
+                 * @see client/html/catalog/detail/domains
299
+                 */
300
+                $domains = $config->get( 'client/html/catalog/detail/bundle/domains', $domains );
301
+
302
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
303
+
304
+                $view->bundleItems = $controller->getProductItems( array_keys( $products ), $domains );
305
+                $view->bundlePosItems = $products;
306
+
307
+                $this->addMetaItem( $view->bundleItems, 'product', $this->expire, $this->tags );
308
+                $this->addMetaList( array_keys( $view->bundleItems ), 'product', $this->expire );
309
+            }
310
+
311
+            $this->cache = $view;
312
+        }
313
+
314
+        $expire = $this->expires( $this->expire, $expire );
315
+        $tags = array_merge( $tags, $this->tags );
316
+
317
+        return $this->cache;
318
+    }
319 319
 }
320 320
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -69,13 +69,13 @@  discard block
 block discarded – undo
69 69
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
70 70
 	 * @return string HTML code
71 71
 	 */
72
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
72
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
73 73
 	{
74
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
74
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
75 75
 
76 76
 		$html = '';
77
-		foreach( $this->getSubClients() as $subclient ) {
78
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
77
+		foreach ($this->getSubClients() as $subclient) {
78
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
79 79
 		}
80 80
 		$view->bundleBody = $html;
81 81
 
@@ -102,7 +102,7 @@  discard block
 block discarded – undo
102 102
 		$tplconf = 'client/html/catalog/detail/bundle/standard/template-body';
103 103
 		$default = 'catalog/detail/bundle-body-default.php';
104 104
 
105
-		return $view->render( $view->config( $tplconf, $default ) );
105
+		return $view->render($view->config($tplconf, $default));
106 106
 	}
107 107
 
108 108
 
@@ -114,13 +114,13 @@  discard block
 block discarded – undo
114 114
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
115 115
 	 * @return string|null String including HTML tags for the header on error
116 116
 	 */
117
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
117
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
118 118
 	{
119
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
119
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
120 120
 
121 121
 		$html = '';
122
-		foreach( $this->getSubClients() as $subclient ) {
123
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
122
+		foreach ($this->getSubClients() as $subclient) {
123
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
124 124
 		}
125 125
 		$view->bundleHeader = $html;
126 126
 
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 		$tplconf = 'client/html/catalog/detail/bundle/standard/template-header';
149 149
 		$default = 'catalog/detail/bundle-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/catalog/detail/bundle/decorators/excludes
165 165
 		 * Excludes decorators added by the "common" option from the catalog detail bundle html client
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
 		 * @see client/html/catalog/detail/bundle/decorators/global
236 236
 		 */
237 237
 
238
-		return $this->createSubClient( 'catalog/detail/bundle/' . $type, $name );
238
+		return $this->createSubClient('catalog/detail/bundle/'.$type, $name);
239 239
 	}
240 240
 
241 241
 
@@ -246,7 +246,7 @@  discard block
 block discarded – undo
246 246
 	 */
247 247
 	protected function getSubClientNames()
248 248
 	{
249
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
249
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
250 250
 	}
251 251
 
252 252
 
@@ -258,23 +258,23 @@  discard block
 block discarded – undo
258 258
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
259 259
 	 * @return \Aimeos\MW\View\Iface Modified view object
260 260
 	 */
261
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
261
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
262 262
 	{
263
-		if( !isset( $this->cache ) )
263
+		if (!isset($this->cache))
264 264
 		{
265
-			if( isset( $view->detailProductItem ) && $view->detailProductItem->getType() === 'bundle' )
265
+			if (isset($view->detailProductItem) && $view->detailProductItem->getType() === 'bundle')
266 266
 			{
267 267
 				$context = $this->getContext();
268 268
 				$config = $context->getConfig();
269
-				$domains = array( 'text', 'price', 'media' );
270
-				$products = $view->detailProductItem->getRefItems( 'product', null, 'default' );
269
+				$domains = array('text', 'price', 'media');
270
+				$products = $view->detailProductItem->getRefItems('product', null, 'default');
271 271
 
272 272
 				/** client/html/catalog/detail/domains
273 273
 				 * A list of domain names whose items should be available in the catalog view templates
274 274
 				 *
275 275
 				 * @see client/html/catalog/detail/domains
276 276
 				 */
277
-				$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
277
+				$domains = $config->get('client/html/catalog/detail/domains', $domains);
278 278
 
279 279
 				/** client/html/catalog/detail/bundle/domains
280 280
 				 * A list of domain names whose items should be available in the bundle part of the catalog detail view templates
@@ -297,22 +297,22 @@  discard block
 block discarded – undo
297 297
 				 * @category Developer
298 298
 				 * @see client/html/catalog/detail/domains
299 299
 				 */
300
-				$domains = $config->get( 'client/html/catalog/detail/bundle/domains', $domains );
300
+				$domains = $config->get('client/html/catalog/detail/bundle/domains', $domains);
301 301
 
302
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
302
+				$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
303 303
 
304
-				$view->bundleItems = $controller->getProductItems( array_keys( $products ), $domains );
304
+				$view->bundleItems = $controller->getProductItems(array_keys($products), $domains);
305 305
 				$view->bundlePosItems = $products;
306 306
 
307
-				$this->addMetaItem( $view->bundleItems, 'product', $this->expire, $this->tags );
308
-				$this->addMetaList( array_keys( $view->bundleItems ), 'product', $this->expire );
307
+				$this->addMetaItem($view->bundleItems, 'product', $this->expire, $this->tags);
308
+				$this->addMetaList(array_keys($view->bundleItems), 'product', $this->expire);
309 309
 			}
310 310
 
311 311
 			$this->cache = $view;
312 312
 		}
313 313
 
314
-		$expire = $this->expires( $this->expire, $expire );
315
-		$tags = array_merge( $tags, $this->tags );
314
+		$expire = $this->expires($this->expire, $expire);
315
+		$tags = array_merge($tags, $this->tags);
316 316
 
317 317
 		return $this->cache;
318 318
 	}
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/Catalog/Detail/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 list 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/catalog/detail/name
37
-		 * Class name of the used catalog detail 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\Catalog\Detail\Standard
47
-		 *
48
-		 * and you want to replace it with your own version named
49
-		 *
50
-		 *  \Aimeos\Client\Html\Catalog\Detail\Mydetail
51
-		 *
52
-		 * then you have to set the this configuration option:
53
-		 *
54
-		 *  client/html/catalog/detail/name = Mydetail
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 "MyDetail"!
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/catalog/detail/name', 'Standard' );
71
-		}
25
+    /**
26
+     * Creates a list 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/catalog/detail/name
37
+         * Class name of the used catalog detail 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\Catalog\Detail\Standard
47
+         *
48
+         * and you want to replace it with your own version named
49
+         *
50
+         *  \Aimeos\Client\Html\Catalog\Detail\Mydetail
51
+         *
52
+         * then you have to set the this configuration option:
53
+         *
54
+         *  client/html/catalog/detail/name = Mydetail
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 "MyDetail"!
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/catalog/detail/name', 'Standard' );
71
+        }
72 72
 
73
-		if( ctype_alnum( $name ) === false )
74
-		{
75
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Detail\\' . $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\\Catalog\\Detail\\' . $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\\Catalog\\Detail\\' . $name;
79
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
80
+        $classname = '\\Aimeos\\Client\\Html\\Catalog\\Detail\\' . $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, 'catalog/detail' );
85
-	}
84
+        return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/detail' );
85
+    }
86 86
 }
87 87
 
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -31,7 +31,7 @@  discard block
 block discarded – undo
31 31
 	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
32 32
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
33 33
 	 */
34
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
34
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null)
35 35
 	{
36 36
 		/** client/html/catalog/detail/name
37 37
 		 * Class name of the used catalog detail 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/catalog/detail/name', 'Standard' );
69
+		if ($name === null) {
70
+			$name = $context->getConfig()->get('client/html/catalog/detail/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\\Catalog\\Detail\\' . $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\\Catalog\\Detail\\'.$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\\Catalog\\Detail\\' . $name;
80
+		$classname = '\\Aimeos\\Client\\Html\\Catalog\\Detail\\'.$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, 'catalog/detail' );
84
+		return self::addClientDecorators($context, $client, $templatePaths, 'catalog/detail');
85 85
 	}
86 86
 }
87 87
 
Please login to merge, or discard this patch.