N°3123 - Refactor Directories

2026-04-23 18:48:51 +02:00 · 2020-12-02 13:18:01 +01:00
parent d1b12ee04b
commit 15aa9e508c
259 changed files with 862 additions and 869 deletions
--- a/sources/application/UI/Base/Layout/iUIContentBlock.php
+++ b/sources/application/UI/Base/Layout/iUIContentBlock.php
@@ -0,0 +1,137 @@
+<?php
+/**
+ * @copyright   Copyright (C) 2010-2020 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout;
+
+use Combodo\iTop\Application\UI\Base\iUIBlock;
+
+/**
+ * Interface iUIContentBlock
+ *
+ * @package Combodo\iTop\Application\UI\Base\Layout
+ * @author  Eric Espie <eric.espie@combodo.com>
+ * @author  Anne-Catherine Cognet <anne-catherine.cognet@combodo.com>
+ * @internal
+ * @since   3.0.0
+ */
+interface iUIContentBlock {
+	/**
+	 * Add raw HTML to the block
+	 *
+	 * @param string $sHtml
+	 *
+	 * @return $this
+	 */
+	public function AddHtml(string $sHtml);
+
+	/**
+	 * Add $oSubBlock, replacing any block with the same ID
+	 *
+	 * @param \Combodo\iTop\Application\UI\Base\iUIBlock $oSubBlock
+	 *
+	 * @return $this
+	 */
+	public function AddSubBlock(iUIBlock $oSubBlock);
+
+	/**
+	 * Remove the sub block identified by $sId.
+	 * Note that if no sub block matches the ID, it proceeds silently.
+	 *
+	 * @param string $sId ID of the sub block to remove
+	 *
+	 * @return $this
+	 */
+	public function RemoveSubBlock(string $sId);
+
+	/**
+	 * Return true if there is a sub block identified by $sId
+	 *
+	 * @param string $sId
+	 *
+	 * @return bool
+	 */
+	public function HasSubBlock(string $sId): bool;
+
+	/**
+	 * Return the sub block identified by $sId or null if not found
+	 *
+	 * @param string $sId
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\iUIBlock|null
+	 */
+	public function GetSubBlock(string $sId): ?iUIBlock;
+
+	/**
+	 * Return an array of all the sub blocks
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\iUIBlock[]
+	 */
+	public function GetSubBlocks(): array;
+
+	/**
+	 * Set all sub blocks at once, replacing all existing ones
+	 *
+	 * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aSubBlocks
+	 *
+	 * @return $this
+	 */
+	public function SetSubBlocks(array $aSubBlocks);
+
+
+	/**
+	 * Add $oDeferredBlock, replacing any block with the same ID
+	 *
+	 * @param \Combodo\iTop\Application\UI\Base\iUIBlock $oDeferredBlock
+	 *
+	 * @return $this
+	 */
+	public function AddDeferredBlock(iUIBlock $oDeferredBlock);
+
+	/**
+	 * Remove the sub block identified by $sId.
+	 * Note that if no sub block matches the ID, it proceeds silently.
+	 *
+	 * @param string $sId ID of the sub block to remove
+	 *
+	 * @return $this
+	 */
+	public function RemoveDeferredBlock(string $sId);
+
+	/**
+	 * Return true if there is a sub block identified by $sId
+	 *
+	 * @param string $sId
+	 *
+	 * @return bool
+	 */
+	public function HasDeferredBlock(string $sId): bool;
+
+	/**
+	 * Return the sub block identified by $sId or null if not found
+	 *
+	 * @param string $sId
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\iUIBlock|null
+	 */
+	public function GetDeferredBlock(string $sId): ?iUIBlock;
+
+	/**
+	 * Return an array of all the sub blocks
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\iUIBlock[]
+	 */
+	public function GetDeferredBlocks(): array;
+
+	/**
+	 * Set all sub blocks at once, replacing all existing ones
+	 *
+	 * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aDeferredBlocks
+	 *
+	 * @return $this
+	 */
+	public function SetDeferredBlocks(array $aDeferredBlocks);
+
+}