Site::siteId() - Code Metrics - Inspection of "Moved site methods to own trait" - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( da0845...b044b4 )

by Aimeos

created 2022-03-04 11:59 UTC

Site::siteId() B

↳ Parent: Site

Complexity

Conditions	10
Paths	4

Size

Total Lines	23
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	11
nc	4
nop	2
dl	0
loc	23
rs	7.6666
c	1
b	0
f	0

How to fix Complexity

<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2022
 * @package MShop
 * @subpackage Common
 */


namespace Aimeos\MShop\Common\Manager;

use \Aimeos\MShop\Locale\Manager\Base as Locale;


/**
 * Site trait for managers
 *
 * @package MShop
 * @subpackage Common
 */
trait Site
{
	/**
	 * Returns the context object.
	 *
	 * @return \Aimeos\MShop\Context\Item\Iface Context object
	 */
	abstract protected function context() : \Aimeos\MShop\Context\Item\Iface;


	/**
	 * Returns a filter object.
	 *
	 * @return \Aimeos\MW\Criteria\Iface Filter object
	 */
	abstract public function filter( ?bool $default = false, bool $site = false ) : \Aimeos\MW\Criteria\Iface;


	/**
	 * Returns the site expression for the given name
	 *
	 * @param string $name Name of the site condition
	 * @param int $sitelevel Site level constant from \Aimeos\MShop\Locale\Manager\Base
	 * @return \Aimeos\MW\Criteria\Expression\Iface Site search condition
	 * @since 2022.04
	 */
	protected function siteCondition( string $name, int $sitelevel ) : \Aimeos\MW\Criteria\Expression\Iface
	{
		$sites = $this->context()->locale()->getSites();
		$values = [''];

		if( isset( $sites[Locale::SITE_PATH] ) && $sitelevel & Locale::SITE_PATH ) {
			$values = array_merge( $values, $sites[Locale::SITE_PATH] );
		} elseif( isset( $sites[Locale::SITE_ONE] ) ) {
			$values[] = $sites[Locale::SITE_ONE];
		}

		$filter = $this->filter();
		$cond = [$filter->compare( '==', $name, $values )];

		if( isset( $sites[Locale::SITE_SUBTREE] ) && $sitelevel & Locale::SITE_SUBTREE ) {
			$cond[] = $filter->compare( '=~', $name, $sites[Locale::SITE_SUBTREE] );
		}

		return $filter->or( $cond );
	}


	/**
	 * Returns the site expression for the given name
	 *
	 * @param string $name SQL name for the site condition
	 * @param int $sitelevel Site level constant from \Aimeos\MShop\Locale\Manager\Base
	 * @return string Site search condition
	 * @since 2022.04
	 */
	protected function siteString( string $name, int $sitelevel ) : string
	{
		$translation = ['marker' => $name];
		$types = ['marker' => \Aimeos\MW\DB\Statement\Base::PARAM_STR];

		return $this->siteCondition( 'marker', $sitelevel )->toSource( $types, $translation );
	}


	/**
	 * Returns the site ID that should be use based on the site level
	 *
	 * @param string $siteId Site ID to check
	 * @param int $sitelevel Site level to check against
	 * @return string Site ID that should be use based on the site level
	 * @since 2022.04
	 */
	protected function siteId( string $siteId, int $sitelevel ) : string
	{
		$sites = $this->context()->locale()->getSites();

		if( ( $sitelevel & Locale::SITE_ONE ) && isset( $sites[Locale::SITE_ONE] )
			&& $siteId === $sites[Locale::SITE_ONE]
		) {
			return $siteId;
		}

		if( ( $sitelevel & Locale::SITE_PATH ) && isset( $sites[Locale::SITE_PATH] )
			&& in_array( $siteId, $sites[Locale::SITE_PATH] )
		) {
			return $siteId;
		}

		if( ( $sitelevel & Locale::SITE_SUBTREE ) && isset( $sites[Locale::SITE_SUBTREE] )
			&& !strncmp( $sites[Locale::SITE_SUBTREE], $siteId, strlen ( $sites[Locale::SITE_SUBTREE] ) )
		) {
			return $siteId;
		}

		return $this->context()->locale()->getSiteId();
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2022
6			* @package MShop
7			* @subpackage Common
8			*/
9
10
11			namespace Aimeos\MShop\Common\Manager;
12
13			use \Aimeos\MShop\Locale\Manager\Base as Locale;
14
15
16			/**
17			* Site trait for managers
18			*
19			* @package MShop
20			* @subpackage Common
21			*/
22			trait Site
23			{
24			/**
25			* Returns the context object.
26			*
27			* @return \Aimeos\MShop\Context\Item\Iface Context object
28			*/
29			abstract protected function context() : \Aimeos\MShop\Context\Item\Iface;
30
31
32			/**
33			* Returns a filter object.
34			*
35			* @return \Aimeos\MW\Criteria\Iface Filter object
36			*/
37			abstract public function filter( ?bool $default = false, bool $site = false ) : \Aimeos\MW\Criteria\Iface;
38
39
40			/**
41			* Returns the site expression for the given name
42			*
43			* @param string $name Name of the site condition
44			* @param int $sitelevel Site level constant from \Aimeos\MShop\Locale\Manager\Base
45			* @return \Aimeos\MW\Criteria\Expression\Iface Site search condition
46			* @since 2022.04
47			*/
48			protected function siteCondition( string $name, int $sitelevel ) : \Aimeos\MW\Criteria\Expression\Iface
49			{
50			$sites = $this->context()->locale()->getSites();
51			$values = [''];
52
53			if( isset( $sites[Locale::SITE_PATH] ) && $sitelevel & Locale::SITE_PATH ) {
54			$values = array_merge( $values, $sites[Locale::SITE_PATH] );
55			} elseif( isset( $sites[Locale::SITE_ONE] ) ) {
56			$values[] = $sites[Locale::SITE_ONE];
57			}
58
59			$filter = $this->filter();
60			$cond = [$filter->compare( '==', $name, $values )];
61
62			if( isset( $sites[Locale::SITE_SUBTREE] ) && $sitelevel & Locale::SITE_SUBTREE ) {
63			$cond[] = $filter->compare( '=~', $name, $sites[Locale::SITE_SUBTREE] );
64			}
65
66			return $filter->or( $cond );
67			}
68
69
70			/**
71			* Returns the site expression for the given name
72			*
73			* @param string $name SQL name for the site condition
74			* @param int $sitelevel Site level constant from \Aimeos\MShop\Locale\Manager\Base
75			* @return string Site search condition
76			* @since 2022.04
77			*/
78			protected function siteString( string $name, int $sitelevel ) : string
79			{
80			$translation = ['marker' => $name];
81			$types = ['marker' => \Aimeos\MW\DB\Statement\Base::PARAM_STR];
82
83			return $this->siteCondition( 'marker', $sitelevel )->toSource( $types, $translation );
84			}
85
86
87			/**
88			* Returns the site ID that should be use based on the site level
89			*
90			* @param string $siteId Site ID to check
91			* @param int $sitelevel Site level to check against
92			* @return string Site ID that should be use based on the site level
93			* @since 2022.04
94			*/
95			protected function siteId( string $siteId, int $sitelevel ) : string
96			{
97			$sites = $this->context()->locale()->getSites();
98
99			if( ( $sitelevel & Locale::SITE_ONE ) && isset( $sites[Locale::SITE_ONE] )
100			&& $siteId === $sites[Locale::SITE_ONE]
101			) {
102			return $siteId;
103			}
104
105			if( ( $sitelevel & Locale::SITE_PATH ) && isset( $sites[Locale::SITE_PATH] )
106			&& in_array( $siteId, $sites[Locale::SITE_PATH] )
107			) {
108			return $siteId;
109			}
110
111			if( ( $sitelevel & Locale::SITE_SUBTREE ) && isset( $sites[Locale::SITE_SUBTREE] )
112			&& !strncmp( $sites[Locale::SITE_SUBTREE], $siteId, strlen ( $sites[Locale::SITE_SUBTREE] ) )
113			) {
114			return $siteId;
115			}
116
117			return $this->context()->locale()->getSiteId();
118			}
119			}
120

aimeos / aimeos-core

Push — master ( da0845...b044b4 )

Site::siteId() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like