Aimeos\MShop\Common\Item\Config\Traits

Complexity

Total Complexity

20

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfigValue()	0	3	1
A	getArrayValue()	0	17	5
A	setConfigFlat()	0	13	3
A	setConfigValue()	0	3	1
B	compareConfig()	0	23	8
A	setArrayValue()	0	11	2

<?php

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


namespace Aimeos\MShop\Common\Item\Config;


/**
 * Common trait for items containing configurations
 *
 * @package MShop
 * @subpackage Common
 */
trait Traits
{
	/**
	 * Returns the configuration values of the item
	 *
	 * @return array Configuration values
	 */
	abstract public function getConfig() : array;


	/**
	 * Sets the configuration values of the item
	 *
	 * @param array $config Configuration values
	 * @return \Aimeos\MShop\Common\Item\Iface Item for chaining method calls
	 */
	abstract public function setConfig( array $config ) : \Aimeos\MShop\Common\Item\Iface;


	/**
	 * Returns the configuration value for the specified path
	 *
	 * @param string $key Key of the associative array or path to value like "path/to/value"
	 * @param mixed $default Default value if no configration is found
	 * @return mixed Configuration value or array of values
	 */
	public function getConfigValue( string $key, $default = null )
	{
		return $this->getArrayValue( $this->getConfig(), explode( '/', trim( $key, '/' ) ), $default );
	}


	/**
	 * Sets all configuration values at once
	 *
	 * @param array $flat Associative list of keys (with "/" for nested arrays) and values
	 * @return \Aimeos\MShop\Common\Item\Iface Item for chaining method calls
	 */
	public function setConfigFlat( array $flat ) : \Aimeos\MShop\Common\Item\Iface
	{
		$config = [];

		foreach( $flat as $key => $value ) {
			$config = $this->setArrayValue( $config, explode( '/', trim( $key, '/' ) ), $value );
		}

		if( !$this->compareConfig( $this->getConfig(), $config ) ) {
			return $this->setConfig( $config );
		}

		return $this;
	}


	/**
	 * Sets the configuration value for the specified path
	 *
	 *  Setting "value" by using "path/to" as key would result in:
	 *  [
	 *    'path' => [
	 *      'to' => 'value'
	 *    ]
	 *  ]
	 *
	 * @param string $key Key of the associative array or path to value like "path/to/value"
	 * @param mixed $value Value to set for the key
	 * @return \Aimeos\MShop\Common\Item\Iface Item for chaining method calls
	 */
	public function setConfigValue( string $key, $value ) : \Aimeos\MShop\Common\Item\Iface
	{
		return $this->setConfig( $this->setArrayValue( $this->getConfig(), explode( '/', trim( $key, '/' ) ), $value ) );
	}


	/**
	 * Returns if two associative arrays with string keys are equal
	 *
	 * @param array $a First associative array
	 * @param array $b Second associative array
	 * @return bool TRUE if arrays are loosly equal, FALSE if there are differences other than the order of keys
	 */
	protected function compareConfig( array $a, array $b ) : bool
	{
		if( count( $a ) !== count( $b ) || array_diff_key( $a, $b ) ) {
			return false;
		}

		foreach( $a as $k => $v )
		{
			$bv = $b[$k];

			if( is_array( $v ) && is_array( $bv ) )
			{
				if( !$this->compareConfig( $v, $bv ) ) {
					return false;
				}
			}
			elseif( $v != $bv )
			{
				return false;
			}
		}

		return true;
	}


	/**
	 * Returns a configuration value from an array
	 *
	 * @param array $config The array to search in
	 * @param array $parts Configuration path parts to look for inside the array
	 * @param mixed $default Default value if no configuration is found
	 * @return mixed Found value or null if no value is available
	 */
	protected function getArrayValue( array $config, array $parts, $default )
	{
		if( ( $current = array_shift( $parts ) ) !== null && isset( $config[$current] ) )
		{
			if( count( $parts ) > 0 )
			{
				if( is_array( $config[$current] ) ) {
					return $this->getArrayValue( $config[$current], $parts, $default );
				}

				return $default;
			}

			return $config[$current];
		}

		return $default;
	}


	/**
	 * Sets the value for the given key parts in the array configuration
	 *
	 * @param array $config The configuration array to set the key/value pair in
	 * @param array $parts Configuration path parts to use in the array
	 * @param mixed $value Value to set in the configuration array
	 * @return array Modified configuration array
	 */
	protected function setArrayValue( array $config, array $parts, $value ) : array
	{
		$current = array_shift( $parts );

		if( !empty( $parts ) ) {
			$config[$current] = $this->setArrayValue( $config[$current] ?? [], $parts, $value );
		} else {
			$config[$current] = $value;
		}

		return $config;
	}
}