Added a plugin system for looking up products against external services by barcode (references #6)

helpers/BaseBarcodeLookupPlugin.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Grocy\Helpers;
+
+abstract class BaseBarcodeLookupPlugin
+{
+	final public function __construct($locations, $quantityUnits)
+	{
+		$this->Locations = $locations;
+		$this->QuantityUnits = $quantityUnits;
+	}
+
+	protected $Locations;
+	protected $QuantityUnits;
+
+	abstract protected function ExecuteLookup($barcode);
+
+	final public function Lookup($barcode)
+	{
+		$pluginOutput = $this->ExecuteLookup($barcode);
+
+		if ($pluginOutput === null)
+		{
+			return $pluginOutput;
+		}
+
+		// Plugin must return an associative array
+		if (!is_array($pluginOutput))
+		{
+			throw new \Exception('Plugin output must be an associative array');
+		}
+		if (!IsAssociativeArray($pluginOutput)) // $pluginOutput is at least an indexed array here
+		{
+			throw new \Exception('Plugin output must be an associative array');
+		}
+
+		// Check for minimum needed properties
+		$minimunNeededProperties = array(
+			'name',
+			'location_id',
+			'qu_id_purchase',
+			'qu_id_stock',
+			'qu_factor_purchase_to_stock',
+			'barcode'
+		);
+		foreach ($minimunNeededProperties as $prop)
+		{
+			if (!array_key_exists($prop, $pluginOutput))
+			{
+				throw new \Exception("Plugin output does not provide needed property $prop");
+			}
+		}
+
+		// $pluginOutput contains all needed properties here
+
+		// Check referenced entity ids are valid
+		$locationId = $pluginOutput['location_id'];
+		if (FindObjectInArrayByPropertyValue($this->Locations, 'id', $locationId) === null)
+		{
+			throw new \Exception("Location $locationId is not a valid location id");
+		}
+		$quIdPurchase = $pluginOutput['qu_id_purchase'];
+		if (FindObjectInArrayByPropertyValue($this->QuantityUnits, 'id', $quIdPurchase) === null)
+		{
+			throw new \Exception("Location $quIdPurchase is not a valid quantity unit id");
+		}
+		$quIdStock = $pluginOutput['qu_id_stock'];
+		if (FindObjectInArrayByPropertyValue($this->QuantityUnits, 'id', $quIdStock) === null)
+		{
+			throw new \Exception("Location $quIdStock is not a valid quantity unit id");
+		}
+		$quFactor = $pluginOutput['qu_factor_purchase_to_stock'];
+		if (empty($quFactor) || !is_numeric($quFactor))
+		{
+			throw new \Exception('Quantity unit factor is empty or not a number');
+		}
+
+		return $pluginOutput;
+	}
+}

helpers/extensions.php

@@ -72,3 +72,9 @@ function RandomString($length, $allowedChars = '0123456789abcdefghijklmnopqrstuv
 
 	return $randomString;
 }
+
+function IsAssociativeArray(array $array)
+{
+	$keys = array_keys($array);
+	return array_keys($keys) !== $keys;
+}