Release of v4.0.0-alpha8

Add power path override option on component level. Fix the sql build feature. #1032.

libraries/vendor_jcb/VDM.Joomla/src/Abstraction/Registry.php

@@ -0,0 +1,184 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    4th September, 2022
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace VDM\Joomla\Abstraction;
+
+
+use VDM\Joomla\Interfaces\Activeregistryinterface;
+use VDM\Joomla\Interfaces\Registryinterface;
+use VDM\Joomla\Abstraction\ActiveRegistry;
+
+
+/**
+ * VDM Basic Registry.
+ * 
+ * Don't use this beyond 10 dimensional depth for best performance.
+ * 
+ * @since 3.2.0
+ */
+abstract class Registry extends ActiveRegistry implements Activeregistryinterface, Registryinterface
+{
+	/**
+	 * Path separator
+	 *
+	 * @var    string|null
+	 * @since 3.2.0
+	 */
+	protected ?string $separator = '.';
+
+	/**
+	 * Sets a value into the registry using multiple keys.
+	 *
+	 * @param  string  $path      Registry path (e.g. vdm.content.builder)
+	 * @param  mixed   $value     Value of entry
+	 *
+	 * @throws \InvalidArgumentException If any of the path values are not a number or string.
+	 * @return void
+	 * @since 3.2.0
+	 */
+	public function set(string $path, $value): void
+	{
+		if (($keys = $this->getActiveKeys($path)) === null)
+		{
+			throw new \InvalidArgumentException("Path must only be strings or numbers to set any value.");
+		}
+
+		$this->setActive($value, ...$keys);
+	}
+
+	/**
+	 * Adds content into the registry. If a key exists,
+	 * it either appends or concatenates based on $asArray switch.
+	 *
+	 * @param  string      $path      Registry path (e.g. vdm.content.builder)
+	 * @param  mixed       $value     Value of entry
+	 * @param  bool|null   $asArray   Determines if the new value should be treated as an array.
+	 *                                Default is $addAsArray = false (if null) in base class.
+	 *                                Override in child class allowed set class property $addAsArray = true.
+	 *
+	 * @throws \InvalidArgumentException If any of the path values are not a number or string.
+	 * @return void
+	 * @since 3.2.0
+	 */
+	public function add(string $path, $value, ?bool $asArray = null): void
+	{
+		if (($keys = $this->getActiveKeys($path)) === null)
+		{
+			throw new \InvalidArgumentException("Path must only be strings or numbers to add any value.");
+		}
+
+		$this->addActive($value, $asArray, ...$keys);
+	}
+
+	/**
+	 * Retrieves a value (or sub-array) from the registry using multiple keys.
+	 *
+	 * @param  string  $path     Registry path (e.g. vdm.content.builder)
+	 * @param  mixed   $default  Optional default value, returned if the internal doesn't exist.
+	 *
+	 * @throws \InvalidArgumentException If any of the path values are not a number or string.
+	 * @return mixed The value or sub-array from the storage. Null if the location doesn't exist.
+	 * @since 3.2.0
+	 */
+	public function get(string $path, $default = null)
+	{
+		if (($keys = $this->getActiveKeys($path)) === null)
+		{
+			throw new \InvalidArgumentException("Path must only be strings or numbers to get any value.");
+		}
+
+		return $this->getActive($default, ...$keys);
+	}
+
+	/**
+	 * Removes a value (or sub-array) from the registry using multiple keys.
+	 *
+	 * @param  string  $path  Registry path (e.g. vdm.content.builder)
+	 *
+	 * @throws \InvalidArgumentException If any of the path values are not a number or string.
+	 * @return void
+	 * @since 3.2.0
+	 */
+	public function remove(string $path): void
+	{
+		if (($keys = $this->getActiveKeys($path)) === null)
+		{
+			throw new \InvalidArgumentException("Path must only be strings or numbers to remove any value.");
+		}
+
+		$this->removeActive(...$keys);
+	}
+
+	/**
+	 * Checks the existence of a particular location in the registry using multiple keys.
+	 *
+	 * @param  string  $path  Registry path (e.g. vdm.content.builder)
+	 *
+	 * @throws \InvalidArgumentException If any of the path values are not a number or string.
+	 * @return bool True if the location exists, false otherwise.
+	 * @since 3.2.0
+	 */
+	public function exists(string $path): bool
+	{
+		if (($keys = $this->getActiveKeys($path)) === null)
+		{
+			throw new \InvalidArgumentException("Path must only be strings or numbers to check if any value exist.");
+		}
+
+		return $this->existsActive(...$keys);
+	}
+
+	/**
+	 * Sets a separator value
+	 *
+	 * @param string|null   $value     The value to set.
+	 *
+	 * @return void
+	 * @since 3.2.0
+	 */
+	public function setSeparator(?string $value): void
+	{
+		$this->separator = $value;
+	}
+
+	/**
+	 * Get that the active keys from a path
+	 *
+	 * @param string  $path   The path to determine the location registry.
+	 *
+	 * @return array|null      The valid array of keys
+	 * @since 3.2.0
+	 */
+	protected function getActiveKeys(string $path): ?array
+	{
+		// empty path no allowed
+		if ($path === '')
+		{
+			return null;
+		}
+
+		// Flatten the path
+		if ($this->separator === null || $this->separator === '')
+		{
+			return [$path];
+		}
+
+		$keys = array_values(array_filter(explode($this->separator, $path), 'strlen'));
+
+		if (empty($keys))
+		{
+			return null;
+		}
+
+		return $keys;
+	}
+}
+