Started working on user-defined-fields for all entities (references #176)

services/UserfieldsService.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Grocy\Services;
+
+class UserfieldsService extends BaseService
+{
+	const USERFIELD_TYPE_SINGLE_LINE_TEXT = 'text-single-line';
+	const USERFIELD_TYPE_SINGLE_MULTILINE_TEXT = 'text-multi-line';
+	const USERFIELD_TYPE_INTEGRAL_NUMBER = 'number-integral';
+	const USERFIELD_TYPE_DECIMAL_NUMBER = 'number-decimal';
+	const USERFIELD_TYPE_DATE = 'date';
+	const USERFIELD_TYPE_DATETIME = 'datetime';
+	const USERFIELD_TYPE_CHECKBOX = 'checkbox';
+
+	public function __construct()
+	{
+		parent::__construct();
+		$this->OpenApiSpec = json_decode(file_get_contents(__DIR__ . '/../grocy.openapi.json'));
+	}
+
+	protected $OpenApiSpec;
+	
+	public function GetFields($entity)
+	{
+		if (!$this->IsValidEntity($entity))
+		{
+			throw new \Exception('Entity does not exist or is not exposed');
+		}
+
+		return $this->Database->userfields()->where('entity', $entity)->orderBy('name')->fetchAll();
+	}
+
+	public function GetField($fieldId)
+	{
+		return $this->Database->userfields($fieldId);
+	}
+
+	public function GetAllFields()
+	{
+		return $this->Database->userfields()->orderBy('name')->fetchAll();
+	}
+
+	public function GetValues($entity, $objectId)
+	{
+		if (!$this->IsValidEntity($entity))
+		{
+			throw new \Exception('Entity does not exist or is not exposed');
+		}
+
+		$userfields = $this->Database->userfield_values_resolved()->where('entity = :1 AND object_id = :2', $entity, $objectId)->orderBy('name')->fetchAll();
+		$userfieldKeyValuePairs = array();
+		foreach ($userfields as $userfield)
+		{
+			$userfieldKeyValuePairs[$userfield->name] = $userfield->value;
+		}
+
+		return $userfieldKeyValuePairs;
+	}
+
+	public function GetAllValues($entity)
+	{
+		if (!$this->IsValidEntity($entity))
+		{
+			throw new \Exception('Entity does not exist or is not exposed');
+		}
+
+		return $this->Database->userfield_values_resolved()->where('entity', $entity)->orderBy('name')->fetchAll();
+	}
+
+	public function SetValues($entity, $objectId, $userfields)
+	{
+		if (!$this->IsValidEntity($entity))
+		{
+			throw new \Exception('Entity does not exist or is not exposed');
+		}
+
+		foreach ($userfields as $key => $value)
+		{
+			$fieldRow = $this->Database->userfields()->where('entity = :1 AND name = :2', $entity, $key)->fetch();
+
+			if ($fieldRow === null)
+			{
+				throw new \Exception("Field $key is not a valid userfield of the given entity");
+			}
+
+			$fieldId = $fieldRow->id;
+
+			$alreadyExistingEntry = $this->Database->userfield_values()->where('field_id = :1 AND object_id = :2', $fieldId, $objectId)->fetch();
+			if ($alreadyExistingEntry) // Update
+			{
+				$alreadyExistingEntry->update(array(
+					'value' => $value
+				));
+			}
+			else // Insert
+			{
+				$newRow = $this->Database->userfield_values()->createRow(array(
+					'field_id' => $fieldId,
+					'object_id' => $objectId,
+					'value' => $value
+				));
+				$newRow->save();
+			}
+		}
+	}
+
+	public function GetEntities()
+	{
+		return $this->OpenApiSpec->components->internalSchemas->ExposedEntity->enum;
+	}
+
+	public function GetFieldTypes()
+	{
+		return GetClassConstants('\Grocy\Services\UserfieldsService');
+	}
+
+	private function IsValidEntity($entity)
+	{
+		return in_array($entity, $this->OpenApiSpec->components->internalSchemas->ExposedEntity->enum);
+	}
+}