Rest on multi classes

2026-04-23 02:28:44 +02:00 · 2025-04-01 09:56:56 +02:00
parent 96382377ee
commit 4b05c80416
2 changed files with 171 additions and 45 deletions
--- a/application/applicationextension.inc.php
+++ b/application/applicationextension.inc.php
@@ -1932,38 +1932,72 @@ class RestUtils
 	public static function GetFieldList($sClass, $oData, $sParamName)
 	{
 		$sFields = self::GetOptionalParam($oData, $sParamName, '*');
-		$aShowFields = array();
-		if ($sFields == '*')
-		{
-			foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
-			{
-				$aShowFields[$sClass][] = $sAttCode;
-			}
+		return match($sFields) {
+			'*' => self::GetFieldListForClass($sClass),
+			'*+' => self::GetFieldListForParentClass($sClass),
+			default => self::GetLimitedFieldListForClass($sClass, $sFields, $sParamName),
+		};
+	}
+
+	public static function HasRequestedExtendedOutput(string $sFields): bool
+	{
+		return match($sFields) {
+			'*' => false,
+			'*+' => true,
+			default => substr_count($sFields, ':') > 1,
+		};
+	}
+
+	public static function HasRequestedAllOutputFields(string $sFields): bool
+	{
+		return match($sFields) {
+			'*', '*+' => true,
+			default => false,
+		};
+	}
+
+	protected static function GetFieldListForClass(string $sClass): array
+	{
+		return [$sClass => array_keys(MetaModel::ListAttributeDefs($sClass))];
+	}
+
+	protected static function GetFieldListForParentClass(string $sClass): array
+	{
+		$aFieldList = array();
+		foreach (MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL) as $sRefClass) {
+			$aFieldList = array_merge($aFieldList, self::GetFieldListForClass($sRefClass));
 		}
-		elseif ($sFields == '*+')
+		return $aFieldList;
+	}
+
+	protected static function GetLimitedFieldListForSingleClass(string $sClass, string $sFields, string $sParamName): array
+	{
+		$aFieldList = [$sClass => []];
+		foreach (explode(',', $sFields) as $sAttCode)
 		{
-			foreach (MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL) as $sRefClass)
+			$sAttCode = trim($sAttCode);
+			if (($sAttCode != 'id') && (!MetaModel::IsValidAttCode($sClass, $sAttCode)))
 			{
-				foreach (MetaModel::ListAttributeDefs($sRefClass) as $sAttCode => $oAttDef)
-				{
-					$aShowFields[$sRefClass][] = $sAttCode;
-				}
+				throw new Exception("$sParamName: invalid attribute code '$sAttCode'");
 			}
+			$aFieldList[$sClass][] = $sAttCode;
 		}
-		else
-		{
-			foreach (explode(',', $sFields) as $sAttCode)
-			{
-				$sAttCode = trim($sAttCode);
-				if (($sAttCode != 'id') && (!MetaModel::IsValidAttCode($sClass, $sAttCode)))
-				{
-					throw new Exception("$sParamName: invalid attribute code '$sAttCode'");
-				}
-				$aShowFields[$sClass][] = $sAttCode;
-			}
+		return $aFieldList;
+	}
+
+	protected static function GetLimitedFieldListForClass(string $sClass, string $sFields, string $sParamName): array
+	{
+		if (!str_contains($sFields, ':')) {
+			return self::GetLimitedFieldListForSingleClass($sClass, $sFields, $sParamName);
 		}

-		return $aShowFields;
+		$aFieldList = [];
+		$aFieldListParts = explode(';', $sFields);
+		foreach ($aFieldListParts as $sClassFields) {
+			list($sSubClass, $sSubClassFields) = explode(':', $sClassFields);
+			$aFieldList = array_merge($aFieldList, self::GetLimitedFieldListForSingleClass(trim($sSubClass), trim($sSubClassFields), $sParamName));
+		}
+		return $aFieldList;
 	}

 	/**
--- a/core/restservices.class.inc.php
+++ b/core/restservices.class.inc.php
@@ -185,23 +185,7 @@ class RestResultWithObjects extends RestResult
 	/** @var array "DBObject_class:DBObject_key" as key, {@see \ObjectResult} as value */
 	public $objects;

-	/**
-	 * Report the given object
-	 *
-	 * @api
-	 * @param int $iCode An error code (RestResult::OK is no issue has been found)
-	 * @param string $sMessage Description of the error if any, an empty string otherwise
-	 * @param DBObject $oObject The object being reported
-	 * @param array|null $aFieldSpec An array of class => attribute codes (Cf. RestUtils::GetFieldList). List of the attributes to be reported.
-	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
-	 *
-	 * @return void
-	 * @throws \ArchivedObjectException
-	 * @throws \CoreException
-	 * @throws \CoreUnexpectedValue
-	 * @throws \MySQLException
-	 */
-	public function AddObject($iCode, $sMessage, $oObject, $aFieldSpec = null, $bExtendedOutput = false)
+	public function PrepareObject($iCode, $sMessage, $oObject, $aFieldSpec = null, $bExtendedOutput = false)
 	{
 		$sClass = get_class($oObject);
 		$oObjRes = new ObjectResult($sClass, $oObject->GetKey());
@@ -232,6 +216,28 @@ class RestResultWithObjects extends RestResult
 			$oObjRes->AddField($oObject, $sAttCode, $bExtendedOutput);
 		}

+		return $oObjRes;
+	}
+
+	/**
+	 * Report the given object
+	 *
+	 * @api
+	 * @param int $iCode An error code (RestResult::OK is no issue has been found)
+	 * @param string $sMessage Description of the error if any, an empty string otherwise
+	 * @param DBObject $oObject The object being reported
+	 * @param array|null $aFieldSpec An array of class => attribute codes (Cf. RestUtils::GetFieldList). List of the attributes to be reported.
+	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
+	 *
+	 * @return void
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
+	 */
+	public function AddObject($iCode, $sMessage, $oObject, $aFieldSpec = null, $bExtendedOutput = false)
+	{
+		$oObjRes = $this->PrepareObject($iCode, $sMessage, $oObject, $aFieldSpec, $bExtendedOutput);
 		$sObjKey = get_class($oObject).'::'.$oObject->GetKey();
 		$this->objects[$sObjKey] = $oObjRes;
 	}
@@ -247,6 +253,45 @@ public function SanitizeContent()
 	}
 }

+/**
+ * @package RESTAPI
+ * @api
+ */
+class RestResultWithObjectSets extends RestResultWithObjects
+{
+	private $current_object = null;
+
+	public function MakeNewObjectSet()
+	{
+		$arr = array();
+		$this->current_object = &$arr;
+		$this->objects[] = &$arr;
+	}
+
+	/**
+	 * Report the given object
+	 *
+	 * @api
+	 * @param string $sObjectAlias Name of the subobject, usually the OQL class alias
+	 * @param int $iCode An error code (RestResult::OK is no issue has been found)
+	 * @param string $sMessage Description of the error if any, an empty string otherwise
+	 * @param DBObject $oObject The object being reported
+	 * @param array|null $aFieldSpec An array of class => attribute codes (Cf. RestUtils::GetFieldList). List of the attributes to be reported.
+	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
+	 *
+	 * @return void
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
+	 */
+	public function AppendSubObject($sObjectAlias, $iCode, $sMessage, $oObject, $aFieldSpec = null, $bExtendedOutput = false)
+	{
+		$oObjRes = $this->PrepareObject($iCode, $sMessage, $oObject, $aFieldSpec, $bExtendedOutput);
+		$this->current_object[$sObjectAlias] = $oObjRes;
+	}
+}
+
 /**
 * @package RESTAPI
 * @api
@@ -528,8 +573,8 @@ class CoreServices implements iRestServiceProvider, iRestInputSanitizer
 		case 'core/get':
 			$sClass = RestUtils::GetClass($aParams, 'class');
 			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$sShowFields = RestUtils::GetOptionalParam($aParams, 'output_fields', '*');
 			$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
-			$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
 			$iLimit = (int)RestUtils::GetOptionalParam($aParams, 'limit', 0);
 			$iPage = (int)RestUtils::GetOptionalParam($aParams, 'page', 1);

@@ -551,9 +596,56 @@ class CoreServices implements iRestServiceProvider, iRestInputSanitizer
 			    $oResult->code = RestResult::INVALID_PAGE;
 			    $oResult->message = "The request page number is not valid. It must be an integer greater than 0";
            }
+			elseif (count($oObjectSet->GetSelectedClasses()) > 1)
+			{
+				$oResult = new RestResultWithObjectSets();
+				$aCache = array();
+
+				while ($oObjects = $oObjectSet->FetchAssoc())
+				{
+					$oResult->MakeNewObjectSet();
+
+					foreach ($oObjects as $sAlias => $oObject) {
+						if (!$oObject)
+							continue;
+
+						if (!array_key_exists($sAlias, $aCache))
+						{
+							$sClass = get_class($oObject);
+							$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
+							$bExtendedOutput = RestUtils::HasRequestedExtendedOutput($sShowFields);
+
+							if (!RestUtils::HasRequestedAllOutputFields($sShowFields))
+							{
+								$aFields = $aShowFields[$sClass];
+								//Id is not a valid attribute to optimize
+								if ($aFields && in_array('id', $aFields))
+								{
+									unset($aFields[array_search('id', $aFields)]);
+								}
+								$aAttToLoad = array($sAlias => $aFields);
+								$oObjectSet->OptimizeColumnLoad($aAttToLoad);
+							}
+							$aCache[$sAlias] = array(
+								'aShowFields' => $aShowFields,
+								'bExtendedOutput' => $bExtendedOutput,
+							);
+						}
+						else
+						{
+							$aShowFields = $aCache[$sAlias]['aShowFields'];
+							$bExtendedOutput = $aCache[$sAlias]['bExtendedOutput'];
+						}
+
+						$oResult->AppendSubObject($sAlias, 0, '', $oObject, $aShowFields, $bExtendedOutput);
+					}
+				}
+				$oResult->message = "Found: ".$oObjectSet->Count();
+			}
 			else
 			{
-                                if (!$bExtendedOutput && RestUtils::GetOptionalParam($aParams, 'output_fields', '*') != '*')
+
+                                if (!RestUtils::HasRequestedAllOutputFields($sShowFields))
                                {
                                        $aFields = $aShowFields[$sClass];
                                        //Id is not a valid attribute to optimize
@@ -567,7 +659,7 @@ class CoreServices implements iRestServiceProvider, iRestInputSanitizer

 				while ($oObject = $oObjectSet->Fetch())
 				{
-					$oResult->AddObject(0, '', $oObject, $aShowFields, $bExtendedOutput);
+					$oResult->AddObject(0, '', $oObject, $aShowFields, RestUtils::HasRequestedExtendedOutput($sShowFields));
 				}
 				$oResult->message = "Found: ".$oObjectSet->Count();
 			}