Standard::getSubClient() - Code Metrics - Inspection of "Simplified catalog session component" - aimeos/ai-client-html - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8bf70e...6a7093 )

by Aimeos

created 2022-02-05 08:53 UTC

Standard::getSubClient() A

↳ Parent: Standard

Complexity

Conditions	1
Paths	1

Size

Total Lines	74
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	74
rs	10
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2013
 * @copyright Aimeos (aimeos.org), 2015-2022
 * @package Client
 * @subpackage Html
 */


namespace Aimeos\Client\Html\Catalog\Session;


/**
 * Default implementation of catalog session section HTML clients.
 *
 * @package Client
 * @subpackage Html
 */
class Standard
	extends \Aimeos\Client\Html\Common\Client\Factory\Base
	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
{
	/** client/html/catalog/session/subparts
	 * List of HTML sub-clients rendered within the catalog session section
	 *
	 * The output of the frontend is composed of the code generated by the HTML
	 * clients. Each HTML client can consist of serveral (or none) sub-clients
	 * that are responsible for rendering certain sub-parts of the output. The
	 * sub-clients can contain HTML clients themselves and therefore a
	 * hierarchical tree of HTML clients is composed. Each HTML client creates
	 * the output that is placed inside the container of its parent.
	 *
	 * At first, always the HTML code generated by the parent is printed, then
	 * the HTML code of its sub-clients. The order of the HTML sub-clients
	 * determines the order of the output of these sub-clients inside the parent
	 * container. If the configured list of clients is
	 *
	 *  array( "subclient1", "subclient2" )
	 *
	 * you can easily change the order of the output by reordering the subparts:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
	 *
	 * You can also remove one or more parts if they shouldn't be rendered:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1" )
	 *
	 * As the clients only generates structural HTML, the layout defined via CSS
	 * should support adding, removing or reordering content by a fluid like
	 * design.
	 *
	 * @param array List of sub-client names
	 * @since 2014.03
	 */
	private $subPartPath = 'client/html/catalog/session/subparts';

	/** client/html/catalog/session/pinned/name
	 * Name of the pinned part used by the catalog session client implementation
	 *
	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Pinned\Myname".
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
	 *
	 * @param string Last part of the client class name
	 * @since 2014.09
	 */

	/** client/html/catalog/session/seen/name
	 * Name of the seen part used by the catalog session client implementation
	 *
	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Seen\Myname".
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
	 *
	 * @param string Last part of the client class name
	 * @since 2014.03
	 */
	private $subPartNames = array( 'pinned', 'seen' );


	/**
	 * Returns the sub-client given by its name.
	 *
	 * @param string $type Name of the client type
	 * @param string|null $name Name of the sub-client (Default if null)
	 * @return \Aimeos\Client\Html\Iface Sub-client object
	 */
	public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface
	{
		/** client/html/catalog/session/decorators/excludes
		 * Excludes decorators added by the "common" option from the catalog session html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to remove a decorator added via
		 * "client/html/common/decorators/default" before they are wrapped
		 * around the html client.
		 *
		 *  client/html/catalog/session/decorators/excludes = array( 'decorator1' )
		 *
		 * This would remove the decorator named "decorator1" from the list of
		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
		 * "client/html/common/decorators/default" to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2014.05
		 * @see client/html/common/decorators/default
		 * @see client/html/catalog/session/decorators/global
		 * @see client/html/catalog/session/decorators/local
		 */

		/** client/html/catalog/session/decorators/global
		 * Adds a list of globally available decorators only to the catalog session html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap global decorators
		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
		 *
		 *  client/html/catalog/session/decorators/global = array( 'decorator1' )
		 *
		 * This would add the decorator named "decorator1" defined by
		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2014.05
		 * @see client/html/common/decorators/default
		 * @see client/html/catalog/session/decorators/excludes
		 * @see client/html/catalog/session/decorators/local
		 */

		/** client/html/catalog/session/decorators/local
		 * Adds a list of local decorators only to the catalog session html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap local decorators
		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
		 *
		 *  client/html/catalog/session/decorators/local = array( 'decorator2' )
		 *
		 * This would add the decorator named "decorator2" defined by
		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2014.05
		 * @see client/html/common/decorators/default
		 * @see client/html/catalog/session/decorators/excludes
		 * @see client/html/catalog/session/decorators/global
		 */

		return $this->createSubClient( 'catalog/session/' . $type, $name );
	}


	/**
	 * Returns the list of sub-client names configured for the client.
	 *
	 * @return array List of HTML client names
	 */
	protected function getSubClientNames() : array
	{
		return $this->context()->config()->get( $this->subPartPath, $this->subPartNames );
	}


	/** client/html/catalog/session/template-body
	 * Relative path to the HTML body template of the catalog session client.
	 *
	 * The template file contains the HTML code and processing instructions
	 * to generate the result shown in the body of the frontend. The
	 * configuration string is the path to the template file relative
	 * to the templates directory (usually in client/html/templates).
	 *
	 * You can overwrite the template file configuration in extensions and
	 * provide alternative templates. These alternative templates should be
	 * named like the default one but suffixed by
	 * an unique name. You may use the name of your project for this. If
	 * you've implemented an alternative client class as well, it
	 * should be suffixed by the name of the new class.
	 *
	 * @param string Relative path to the template creating code for the HTML page body
	 * @since 2014.03
	 * @see client/html/catalog/session/template-header
	 */

	/** client/html/catalog/session/template-header
	 * Relative path to the HTML header template of the catalog session client.
	 *
	 * The template file contains the HTML code and processing instructions
	 * to generate the HTML code that is inserted into the HTML page header
	 * of the rendered page in the frontend. The configuration string is the
	 * path to the template file relative to the templates directory (usually
	 * in client/html/templates).
	 *
	 * You can overwrite the template file configuration in extensions and
	 * provide alternative templates. These alternative templates should be
	 * named like the default one but suffixed by
	 * an unique name. You may use the name of your project for this. If
	 * you've implemented an alternative client class as well, it
	 * should be suffixed by the name of the new class.
	 *
	 * @param string Relative path to the template creating code for the HTML page head
	 * @since 2014.03
	 * @see client/html/catalog/session/template-body
	 */
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Metaways Infosystems GmbH, 2013
6			* @copyright Aimeos (aimeos.org), 2015-2022
7			* @package Client
8			* @subpackage Html
9			*/
10
11
12			namespace Aimeos\Client\Html\Catalog\Session;
13
14
15			/**
16			* Default implementation of catalog session section HTML clients.
17			*
18			* @package Client
19			* @subpackage Html
20			*/
21			class Standard
22			extends \Aimeos\Client\Html\Common\Client\Factory\Base
23			implements \Aimeos\Client\Html\Common\Client\Factory\Iface
24			{
25			/** client/html/catalog/session/subparts
26			* List of HTML sub-clients rendered within the catalog session 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			*/
57			private $subPartPath = 'client/html/catalog/session/subparts';
58
59			/** client/html/catalog/session/pinned/name
60			* Name of the pinned part used by the catalog session client implementation
61			*
62			* Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Pinned\Myname".
63			* The name is case-sensitive and you should avoid camel case names like "MyName".
64			*
65			* @param string Last part of the client class name
66			* @since 2014.09
67			*/
68
69			/** client/html/catalog/session/seen/name
70			* Name of the seen part used by the catalog session client implementation
71			*
72			* Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Seen\Myname".
73			* The name is case-sensitive and you should avoid camel case names like "MyName".
74			*
75			* @param string Last part of the client class name
76			* @since 2014.03
77			*/
78			private $subPartNames = array( 'pinned', 'seen' );
79
80
81			/**
82			* Returns the sub-client given by its name.
83			*
84			* @param string $type Name of the client type
85			* @param string\|null $name Name of the sub-client (Default if null)
86			* @return \Aimeos\Client\Html\Iface Sub-client object
87			*/
88			public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface
89			{
90			/** client/html/catalog/session/decorators/excludes
91			* Excludes decorators added by the "common" option from the catalog session html client
92			*
93			* Decorators extend the functionality of a class by adding new aspects
94			* (e.g. log what is currently done), executing the methods of the underlying
95			* class only in certain conditions (e.g. only for logged in users) or
96			* modify what is returned to the caller.
97			*
98			* This option allows you to remove a decorator added via
99			* "client/html/common/decorators/default" before they are wrapped
100			* around the html client.
101			*
102			* client/html/catalog/session/decorators/excludes = array( 'decorator1' )
103			*
104			* This would remove the decorator named "decorator1" from the list of
105			* common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
106			* "client/html/common/decorators/default" to the html client.
107			*
108			* @param array List of decorator names
109			* @since 2014.05
110			* @see client/html/common/decorators/default
111			* @see client/html/catalog/session/decorators/global
112			* @see client/html/catalog/session/decorators/local
113			*/
114
115			/** client/html/catalog/session/decorators/global
116			* Adds a list of globally available decorators only to the catalog session html client
117			*
118			* Decorators extend the functionality of a class by adding new aspects
119			* (e.g. log what is currently done), executing the methods of the underlying
120			* class only in certain conditions (e.g. only for logged in users) or
121			* modify what is returned to the caller.
122			*
123			* This option allows you to wrap global decorators
124			* ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
125			*
126			* client/html/catalog/session/decorators/global = array( 'decorator1' )
127			*
128			* This would add the decorator named "decorator1" defined by
129			* "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
130			*
131			* @param array List of decorator names
132			* @since 2014.05
133			* @see client/html/common/decorators/default
134			* @see client/html/catalog/session/decorators/excludes
135			* @see client/html/catalog/session/decorators/local
136			*/
137
138			/** client/html/catalog/session/decorators/local
139			* Adds a list of local decorators only to the catalog session html client
140			*
141			* Decorators extend the functionality of a class by adding new aspects
142			* (e.g. log what is currently done), executing the methods of the underlying
143			* class only in certain conditions (e.g. only for logged in users) or
144			* modify what is returned to the caller.
145			*
146			* This option allows you to wrap local decorators
147			* ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
148			*
149			* client/html/catalog/session/decorators/local = array( 'decorator2' )
150			*
151			* This would add the decorator named "decorator2" defined by
152			* "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
153			*
154			* @param array List of decorator names
155			* @since 2014.05
156			* @see client/html/common/decorators/default
157			* @see client/html/catalog/session/decorators/excludes
158			* @see client/html/catalog/session/decorators/global
159			*/
160
161			return $this->createSubClient( 'catalog/session/' . $type, $name );
162			}
163
164
165			/**
166			* Returns the list of sub-client names configured for the client.
167			*
168			* @return array List of HTML client names
169			*/
170			protected function getSubClientNames() : array
171			{
172			return $this->context()->config()->get( $this->subPartPath, $this->subPartNames );
173			}
174
175
176			/** client/html/catalog/session/template-body
177			* Relative path to the HTML body template of the catalog session client.
178			*
179			* The template file contains the HTML code and processing instructions
180			* to generate the result shown in the body of the frontend. The
181			* configuration string is the path to the template file relative
182			* to the templates directory (usually in client/html/templates).
183			*
184			* You can overwrite the template file configuration in extensions and
185			* provide alternative templates. These alternative templates should be
186			* named like the default one but suffixed by
187			* an unique name. You may use the name of your project for this. If
188			* you've implemented an alternative client class as well, it
189			* should be suffixed by the name of the new class.
190			*
191			* @param string Relative path to the template creating code for the HTML page body
192			* @since 2014.03
193			* @see client/html/catalog/session/template-header
194			*/
195
196			/** client/html/catalog/session/template-header
197			* Relative path to the HTML header template of the catalog session client.
198			*
199			* The template file contains the HTML code and processing instructions
200			* to generate the HTML code that is inserted into the HTML page header
201			* of the rendered page in the frontend. The configuration string is the
202			* path to the template file relative to the templates directory (usually
203			* in client/html/templates).
204			*
205			* You can overwrite the template file configuration in extensions and
206			* provide alternative templates. These alternative templates should be
207			* named like the default one but suffixed by
208			* an unique name. You may use the name of your project for this. If
209			* you've implemented an alternative client class as well, it
210			* should be suffixed by the name of the new class.
211			*
212			* @param string Relative path to the template creating code for the HTML page head
213			* @since 2014.03
214			* @see client/html/catalog/session/template-body
215			*/
216			}
217

aimeos / ai-client-html

Push — master ( 8bf70e...6a7093 )

Standard::getSubClient() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like