N°6516 - Add @experimental PHP annotation on temporary objects features

core/attributedef.class.inc.php

@@ -10,7 +10,6 @@ use Combodo\iTop\Form\Field\LabelField;
 use Combodo\iTop\Form\Field\TextAreaField;
 use Combodo\iTop\Form\Form;
 use Combodo\iTop\Form\Validator\CustomRegexpValidator;
-use Combodo\iTop\Form\Validator\LinkedSetValidator;
 use Combodo\iTop\Renderer\BlockRenderer;
 use Combodo\iTop\Renderer\Console\ConsoleBlockRenderer;
 use Combodo\iTop\Service\Links\LinkSetModel;
@@ -7228,6 +7227,7 @@ class AttributeExternalKey extends AttributeDBFieldVoid
 		return (int)$proposedValue;
 	}
 
+	/** @inheritdoc  @since 3.1 */
 	public function WriteExternalValues(DBObject $oHostObject): void
 	{
 		$sTargetKey = $oHostObject->Get($this->GetCode());

core/dbobject.class.php

@@ -6399,10 +6399,19 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * @param $aContext
+	 * Handle temporary descriptors.
 	 *
 	 * @return void
-	 * @since 3.1.0
+	 *
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
+	 * @throws \OQLException
+	 *
+	 * @experimental do not use, this feature will be part of a future version
+	 *
+	 * @since 3.1
 	 */
 	private function HandleTemporaryDescriptor()
 	{
@@ -6412,7 +6421,13 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+	 * Return context information.
+	 *
 	 * @return array
+	 *
+	 * @experimental do not use, this feature will be part of a future version
+	 *
+	 * @since 3.1
 	 */
 	public function GetContext(): array
 	{
@@ -6425,6 +6440,10 @@ abstract class DBObject implements iDisplay
 	 * @param string $sSection
 	 * @param $value
 	 *
+	 * @experimental do not use, this feature will be part of a future version
+	 *
+	 * @since 3.1
+	 *
 	 */
 	public function SetContextSection(string $sSection, $value)
 	{
@@ -6432,9 +6451,15 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+	 * Get context section data.
+	 *
 	 * @param string $sSection
 	 *
 	 * @return mixed
+	 *
+	 * experimental do not use, this feature will be part of a future version
+	 *
+	 * @since 3.1
 	 */
 	public function GetContextSection(string $sSection)
 	{
@@ -6446,9 +6471,15 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+	 * Test context section existence.
+	 *
 	 * @param string $sSection
 	 *
 	 * @return bool
+	 *
+	 * experimental do not use, this feature will be part of a future version
+	 *
+	 * @since 3.1
 	 */
 	public function HasContextSection(string $sSection): bool
 	{

datamodels/2.x/itop-structure/src/Model/TemporaryObjectDescriptor.php

@@ -5,6 +5,11 @@
  */
 
 /**
+ * Class TemporaryObjectDescriptor
+ *
+ * Descriptor to track a temporary object.
+ *
+ * @experimental do not use, this feature will be part of a future version
  *
  * @since 3.1
  */

sources/Controller/TemporaryObjects/TemporaryObjectController.php

@@ -16,6 +16,8 @@ use utils;
  *
  * Temporary object endpoints.
  *
+ * @experimental do not use, this feature will be part of a future version
+ *
  * @since 3.1
  */
 class TemporaryObjectController extends AbstractController

sources/Service/TemporaryObjects/TemporaryObjectConfig.php

@@ -8,6 +8,15 @@ namespace Combodo\iTop\Service\TemporaryObjects;
 
 use MetaModel;
 
+/**
+ * TemporaryObjectConfig.
+ *
+ * Handle temporary object configuration.
+ *
+ * @experimental do not use, this feature will be part of a future version
+ *
+ * @since 3.1
+ */
 class TemporaryObjectConfig
 {
 

sources/Service/TemporaryObjects/TemporaryObjectGC.php

@@ -13,6 +13,8 @@ use iBackgroundProcess;
  *
  * Background task to collect and garbage expired temporary objects..
  *
+ * @experimental do not use, this feature will be part of a future version
+ *
  * @since 3.1
  */
 class TemporaryObjectGC implements iBackgroundProcess

sources/Service/TemporaryObjects/TemporaryObjectHelper.php

@@ -11,6 +11,8 @@ namespace Combodo\iTop\Service\TemporaryObjects;
  *
  * Helper with useful functions.
  *
+ * @experimental do not use, this feature will be part of a future version
+ *
  * @since 3.1
  */
 class TemporaryObjectHelper

sources/Service/TemporaryObjects/TemporaryObjectManager.php

@@ -21,6 +21,8 @@ use utils;
  *
  * Manager class to perform global temporary objects tasks.
  *
+ * @experimental do not use, this feature will be part of a future version
+ *
  * @since 3.1
  */
 class TemporaryObjectManager

sources/Service/TemporaryObjects/TemporaryObjectRepository.php

@@ -19,6 +19,8 @@ use TemporaryObjectDescriptor;
  *
  * Repository class to perform ORM tasks.
  *
+ * @experimental do not use, this feature will be part of a future version
+ *
  * @since 3.1
  */
 class TemporaryObjectRepository

sources/Service/TemporaryObjects/TemporaryObjectsEvents.php

@@ -11,6 +11,15 @@ use Combodo\iTop\Service\Events\Description\EventDescription;
 use Combodo\iTop\Service\Events\EventService;
 use Combodo\iTop\Service\Events\iEventServiceSetup;
 
+/**
+ * TemporaryObjectsEvents.
+ *
+ * Handle temporary objects events
+ *
+ * @experimental do not use, this feature will be part of a future version
+ *
+ * @since 3.1
+ */
 class TemporaryObjectsEvents implements iEventServiceSetup
 {