composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-30 14:08:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°2847 - Rework on iUIContentBlock and PageContent

Browse Source 
* Add new Trait tUIContentAreas to handle multiple content areas across UIBlock classes (extracted from PageContent)
* Remove return type hinting in some method when type was "self" or the class itself when it's meant to be overloaded (works only with PHP 7.4+)
* Update some PHPDoc
* Reformat some brackets
This commit is contained in:
Molkobain
2020-09-30 15:25:26 +02:00
parent d49dd8b993
commit ce001a8097
8 changed files with 303 additions and 235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
sources/application/UI/Layout/iUIContentBlock.php
View File

@@ -8,30 +8,25 @@ namespace Combodo\iTop\Application\UI\Layout;
use Combodo\iTop\Application\UI\iUIBlock;
/**
* Interface iUIContentBlock
*
* @package Combodo\iTop\Application\UI\Layout
* @author Eric Espie <eric.espie@combodo.com>
* @author Anne-Catherine Cognet <anne-catherine.cognet@combodo.com>
* @internal
* @since 2.8.0
*/
interface iUIContentBlock
{
public function AddHtml(string $sHtml): iUIBlock;
/**
* @inheritDoc
*/
public function GetSubBlocks(): array;
/**
* @param string $sId
* Add raw HTML to the block
*
* @return \Combodo\iTop\Application\UI\iUIBlock|null
*/
public function GetSubBlock(string $sId): ?iUIBlock;
/**
* Set all sub blocks at once, replacing all existing ones
*
* @param \Combodo\iTop\Application\UI\iUIBlock[] $aSubBlocks
* @param string $sHtml
*
* @return $this
*/
public function SetSubBlocks(array $aSubBlocks): iUIContentBlock;
public function AddHtml(string $sHtml);
/**
* Add $oSubBlock, replacing any block with the same ID
@@ -40,7 +35,7 @@ interface iUIContentBlock
*
* @return $this
*/
public function AddSubBlock(iUIBlock $oSubBlock): iUIContentBlock;
public function AddSubBlock(iUIBlock $oSubBlock);
/**
* Remove the sub block identified by $sId.
@@ -50,7 +45,39 @@ interface iUIContentBlock
*
* @return $this
*/
public function RemoveSubBlock(string $sId): iUIContentBlock;
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\iUIBlock|null
*/
public function GetSubBlock(string $sId): ?iUIBlock;
/**
* Return an array of all the sub blocks
*
* @return \Combodo\iTop\Application\UI\iUIBlock[]
*/
public function GetSubBlocks(): array;
/**
* Set all sub blocks at once, replacing all existing ones
*
* @param \Combodo\iTop\Application\UI\iUIBlock[] $aSubBlocks
*
* @return $this
*/
public function SetSubBlocks(array $aSubBlocks);
}