N°3526 - Clean up pass on UIBlockFactories

- 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

View File

@@ -13,10 +13,10 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class ToolbarSeparatorUIBlockFactory
*
* @api
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @since 3.0.0
* @package Combodo\iTop\Application\UI\Base\Component\Toolbar\Separator
* @since 3.0.0
* @api
*/
class ToolbarSeparatorUIBlockFactory extends AbstractUIBlockFactory
{

View File

@@ -20,7 +20,9 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
*/
class ToolbarSpacerUIBlockFactory extends AbstractUIBlockFactory
{
/** @inheritDoc */
public const TWIG_TAG_NAME = 'UIToolbarSpacer';
/** @inheritDoc */
public const UI_BLOCK_CLASS_NAME = ToolbarSpacer::class;
/**
@@ -28,7 +30,7 @@ class ToolbarSpacerUIBlockFactory extends AbstractUIBlockFactory
*
* @return \Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarSpacer\ToolbarSpacer
*/
public static function MakeStandard(string $sId = null): ToolbarSpacer
public static function MakeStandard(string $sId = null)
{
return new ToolbarSpacer($sId);
}

View File

@@ -20,20 +20,22 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
*/
class ToolbarUIBlockFactory extends AbstractUIBlockFactory
{
/** @inheritDoc */
public const TWIG_TAG_NAME = 'UIToolbar';
/** @inheritDoc */
public const UI_BLOCK_CLASS_NAME = Toolbar::class;
public static function MakeForAction(string $sId = null): Toolbar
public static function MakeForAction(string $sId = null)
{
return new Toolbar($sId, ['ibo-toolbar--action']);
}
public static function MakeStandard(string $sId = null, array $aContainerClasses = []): Toolbar
public static function MakeStandard(string $sId = null, array $aContainerClasses = [])
{
return new Toolbar($sId, $aContainerClasses);
}
public static function MakeForButton(string $sId = null, array $aContainerClasses = []): Toolbar
public static function MakeForButton(string $sId = null, array $aContainerClasses = [])
{
return new Toolbar($sId, array_merge($aContainerClasses, ['ibo-toolbar--button']));
}