N°3517 - Clean-up pass on all block factories

This commit is contained in:
Molkobain
2021-11-10 19:35:50 +01:00
parent fffd4cf962
commit ca2124130f
29 changed files with 146 additions and 4 deletions

View File

@@ -14,6 +14,7 @@ namespace Combodo\iTop\Application\UI\Base;
* @package Combodo\iTop\Application\UI\Base
* @author Eric Espie <eric.espie@combodo.com>
* @since 3.0.0
* @internal
*/
abstract class AbstractUIBlockFactory implements iUIBlockFactory
{

View File

@@ -314,6 +314,7 @@ class ButtonUIBlockFactory extends AbstractUIBlockFactory
return $oButton;
}
//----------------------------------------------------------------------------------------------
// Link buttons, mostly used outside forms, to redirect somewhere whilst keeping a button aspect
//----------------------------------------------------------------------------------------------

View File

@@ -12,7 +12,13 @@ use Combodo\iTop\Application\UI\Base\Component\Html\Html;
use Combodo\iTop\Application\UI\Base\UIBlock;
/**
* Class FieldUIBlockFactory
*
* Use it to make a "field" which is composed of a label and a value (which can be read-only or editable)
*
* @author Pierre Goiffon <pierre.goiffon@combodo.com>
* @since 3.0.0
* @internal
*/
class FieldUIBlockFactory extends AbstractUIBlockFactory
{

View File

@@ -11,6 +11,14 @@ namespace Combodo\iTop\Application\UI\Base\Component\FieldBadge;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use ormStyle;
/**
* Class FieldBadgeUIBlockFactory
*
* @author Eric espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\FieldBadge
* @since 3.0.0
* @internal
*/
class FieldBadgeUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIFieldBadge';

View File

@@ -10,11 +10,24 @@ namespace Combodo\iTop\Application\UI\Base\Component\FieldSet;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class FieldSetUIBlockFactory
*
* @author eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\FieldSet
* @since 3.0.0
*/
class FieldSetUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIFieldSet';
public const UI_BLOCK_CLASS_NAME = FieldSet::class;
/**
* @param string $sLegend
* @param string|null $sId
*
* @return \Combodo\iTop\Application\UI\Base\Component\FieldSet\FieldSet A standard fieldset in which you can add UIBlocks
*/
public static function MakeStandard(string $sLegend, ?string $sId = null): FieldSet
{
return new FieldSet($sLegend, $sId);

View File

@@ -10,11 +10,24 @@ namespace Combodo\iTop\Application\UI\Base\Component\Form;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class FormUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Form
* @since 3.0.0
* @internal
*/
class FormUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIForm';
public const UI_BLOCK_CLASS_NAME = Form::class;
/**
* @param string|null $sId
*
* @return \Combodo\iTop\Application\UI\Base\Component\Form\Form An HTML form in which you can add UIBlocks
*/
public static function MakeStandard(string $sId = null)
{
return new Form($sId);

View File

@@ -10,11 +10,24 @@ namespace Combodo\iTop\Application\UI\Base\Component\Input\FileSelect;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class FileSelectUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Input\FileSelect
* @since 3.0.0
*/
class FileSelectUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIFileSelect';
public const UI_BLOCK_CLASS_NAME = FileSelect::class;
/**
* @param string $sName
* @param string|null $sId
*
* @return \Combodo\iTop\Application\UI\Base\Component\Input\FileSelect\FileSelect A styled file input selector
*/
public static function MakeStandard(string $sName, string $sId = null): FileSelect
{
return new FileSelect($sName, $sId);

View File

@@ -11,6 +11,14 @@ namespace Combodo\iTop\Application\UI\Base\Component\Input;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use Combodo\iTop\Application\UI\Base\Component\Field\Field;
/**
* Class InputUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Input
* @since 3.0.0
* @internal
*/
class InputUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIInput';

View File

@@ -10,6 +10,13 @@ namespace Combodo\iTop\Application\UI\Base\Component\Input\Select;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class SelectOptionUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Input\Select
* @since 3.0.0
*/
class SelectOptionUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UISelectOption';

View File

@@ -11,6 +11,14 @@ namespace Combodo\iTop\Application\UI\Base\Component\Input;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use Combodo\iTop\Application\UI\Base\Component\Input\Select\Select;
/**
* Class SelectUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Input
* @since 3.0.0
* @internal
*/
class SelectUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UISelect';

View File

@@ -42,5 +42,4 @@ class PillFactory
return $oPill;
}
}

View File

@@ -273,5 +273,4 @@ class PopoverMenuFactory
return $oMenu;
}
}

View File

@@ -10,6 +10,13 @@ namespace Combodo\iTop\Application\UI\Base\Component\Spinner;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class SpinnerUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Spinner
* @since 3.0.0
*/
class SpinnerUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UISpinner';

View File

@@ -12,6 +12,14 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use Combodo\iTop\Application\UI\Base\Component\Text\Text;
use Combodo\iTop\Application\UI\Base\UIBlock;
/**
* Class TitleUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Title
* @since 3.0.0
* @internal
*/
class TitleUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UITitle';

View File

@@ -10,6 +10,14 @@ namespace Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarSpacer;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class ToolbarSpacerUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarSpacer
* @since 3.0.0
* @internal
*/
class ToolbarSpacerUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIToolbarSpacer';

View File

@@ -10,6 +10,14 @@ namespace Combodo\iTop\Application\UI\Base\Component\Toolbar;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class ToolbarUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Toolbar
* @since 3.0.0
* @internal
*/
class ToolbarUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIToolbar';

View File

@@ -33,10 +33,10 @@ use ReflectionClass;
/**
* Class ActivityEntryFactory
*
* @internal
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
* @since 3.0.0
* @internal
*/
class ActivityEntryFactory
{

View File

@@ -25,6 +25,8 @@ namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CM
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpAttachmentAddedFactory extends CMDBChangeOpFactory
{

View File

@@ -25,6 +25,8 @@ namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CM
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpAttachmentRemovedFactory extends CMDBChangeOpFactory
{

View File

@@ -25,6 +25,8 @@ namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CM
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpCreateFactory extends CMDBChangeOpFactory {
public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-seedling';

View File

@@ -25,6 +25,8 @@ namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CM
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpDeleteFactory extends CMDBChangeOpFactory {
public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-trash';

View File

@@ -34,6 +34,8 @@ use MetaModel;
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpFactory
{

View File

@@ -32,6 +32,8 @@ use iCMDBChangeOp;
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
* @since 3.0.0
* @internal
*/
class CMDBChangeOpSetAttributeFactory extends CMDBChangeOpFactory
{

View File

@@ -32,6 +32,7 @@ use MetaModel;
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp\Factory
* @since 3.0.0
* @internal
*/
class CMDBChangeOpSetAttributeScalarFactory extends CMDBChangeOpSetAttributeFactory
{

View File

@@ -28,6 +28,7 @@ namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\Ev
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EventNotification
* @since 3.0.0
* @internal
*/
class EventNotificationEmailFactory extends EventNotificationFactory
{

View File

@@ -33,6 +33,7 @@ use EventNotification;
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EventNotification
* @since 3.0.0
* @internal
*/
class EventNotificationFactory
{

View File

@@ -11,6 +11,13 @@ namespace Combodo\iTop\Application\UI\Base\Layout\MultiColumn\Column;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use Combodo\iTop\Application\UI\Base\UIBlock;
/**
* Class ColumnUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\MultiColumn\Column
* @since 3.0.0
*/
class ColumnUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIColumn';

View File

@@ -9,6 +9,13 @@ namespace Combodo\iTop\Application\UI\Base\Layout\MultiColumn;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
/**
* Class MultiColumnUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout\MultiColumn
* @since 3.0.0
*/
class MultiColumnUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIMultiColumn';

View File

@@ -11,6 +11,13 @@ namespace Combodo\iTop\Application\UI\Base\Layout;
use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
use Combodo\iTop\Application\UI\Base\Component\Html\Html;
/**
* Class UIContentBlockUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Layout
* @since 3.0.0
*/
class UIContentBlockUIBlockFactory extends AbstractUIBlockFactory
{
public const TWIG_TAG_NAME = 'UIContentBlock';
@@ -21,7 +28,6 @@ class UIContentBlockUIBlockFactory extends AbstractUIBlockFactory
return new UIContentBlock($sId, $aContainerClasses);
}
/**
* Used to display a block of code like <pre> but allows line break.
* The \n are replaced by <br>