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

N°3526 - Clean up pass on UIBlockFactories

Browse Source 
- Add PHPDoc
- Remove (Object) return type hint on overloadable methods
This commit is contained in:
Molkobain
2021-11-11 15:21:47 +01:00
parent 249fa6ca93
commit a9b30e160f
24 changed files with 130 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
sources/application/UI/Base/Layout/MultiColumn/Column/ColumnUIBlockFactory.php
View File

@@ -17,20 +17,23 @@ use Combodo\iTop\Application\UI\Base\UIBlock;
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\MultiColumn\Column
* @since 3.0.0
* @api
*/
class ColumnUIBlockFactory extends AbstractUIBlockFactory
{
/** @inheritDoc */
public const TWIG_TAG_NAME = 'UIColumn';
/** @inheritDoc */
public const UI_BLOCK_CLASS_NAME = Column::class;
public static function MakeStandard(?string $sId = null): Column
public static function MakeStandard(?string $sId = null)
{
$oInput = new Column($sId);
return $oInput;
}
public static function MakeForBlock(UIBlock $oBlock, ?string $sId = null): Column
public static function MakeForBlock(UIBlock $oBlock, ?string $sId = null)
{
$oInput = new Column($sId);
$oInput->AddSubBlock($oBlock);

5
sources/application/UI/Base/Layout/MultiColumn/MultiColumnUIBlockFactory.php
View File

@@ -15,13 +15,16 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\MultiColumn
* @since 3.0.0
* @api
*/
class MultiColumnUIBlockFactory extends AbstractUIBlockFactory
{
/** @inheritDoc */
public const TWIG_TAG_NAME = 'UIMultiColumn';
/** @inheritDoc */
public const UI_BLOCK_CLASS_NAME = MultiColumn::class;
public static function MakeStandard(?string $sId = null): MultiColumn
public static function MakeStandard(?string $sId = null)
{
$oInput = new MultiColumn($sId);

20
sources/application/UI/Base/Layout/UIContentBlockUIBlockFactory.php
View File

@@ -20,9 +20,19 @@ use Combodo\iTop\Application\UI\Base\Component\Html\Html;
*/
class UIContentBlockUIBlockFactory extends AbstractUIBlockFactory
{
/** @inheritDoc */
public const TWIG_TAG_NAME = 'UIContentBlock';
/** @inheritDoc */
public const UI_BLOCK_CLASS_NAME = UIContentBlock::class;
/**
* Make an empty UIContentBlock which can be used to embed anything or to surround another block with specific CSS classes.
*
* @param string|null $sId
* @param array $aContainerClasses
*
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
*/
public static function MakeStandard(string $sId = null, array $aContainerClasses = [])
{
return new UIContentBlock($sId, $aContainerClasses);
@@ -34,6 +44,8 @@ class UIContentBlockUIBlockFactory extends AbstractUIBlockFactory
*
* @param string $sCode
* @param string|null $sId
*
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
*/
public static function MakeForCode(string $sCode, string $sId = null)
{
@@ -44,6 +56,14 @@ class UIContentBlockUIBlockFactory extends AbstractUIBlockFactory
return $oCode;
}
/**
* Used to display a block of preformatted text in a <pre> tag.
*
* @param string $sCode
* @param string|null $sId
*
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
*/
public static function MakeForPreformatted(string $sCode, string $sId = null)
{
$sCode = '<pre>'.$sCode.'</pre>';