AssetFormFactory::getFormFields() - Code Metrics - Inspection of "Move create folder to right editor panel" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#415)

unknown

created 2017-04-07 03:37 UTC

AssetFormFactory::getFormFields() B

↳ Parent: AssetFormFactory

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	24
rs	8.6845
cc	4
eloc	15
nc	4
nop	3

<?php

namespace SilverStripe\AssetAdmin\Forms;

use InvalidArgumentException;
use SilverStripe\Assets\File;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\FormFactory;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\PopoverField;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\Forms\TextField;

abstract class AssetFormFactory implements FormFactory
{
    use Extensible;
    use Injectable;
    use Configurable;

    /**
     * Insert into HTML content area
     */
    const TYPE_INSERT = 'insert';

    /**
     * Select file by ID only
     */
    const TYPE_SELECT = 'select';

    /**
     * Edit form: Default
     */
    const TYPE_ADMIN = 'admin';

    public function __construct()
    {
        $this->constructExtensions();
    }

    public function getForm(Controller $controller, $name = FormFactory::DEFAULT_NAME, $context = [])
    {
        // Validate context
        foreach ($this->getRequiredContext() as $required) {
            if (!isset($context[$required])) {
                throw new InvalidArgumentException("Missing required context $required");
            }
        }

        $fields = $this->getFormFields($controller, $name, $context);
        $actions = $this->getFormActions($controller, $name, $context);
        $validator = $this->getValidator($controller, $name, $context);
        $form = Form::create($controller, $name, $fields, $actions, $validator);

        // Extend form
        $this->invokeWithExtensions('updateForm', $form, $controller, $name, $context);

        // Populate form from record
        if (isset($context['Record'])) {
            $form->loadDataFrom($context['Record']);
        }

        return $form;
    }
    
    /**
     * Get the validator for the form to be built
     *
     * @param $controller
     * @param $formName
     * @param $context
     * @return RequiredFields
     */
    protected function getValidator(Controller $controller, $formName, $context = [])

    {
        $validator = new RequiredFields('Name');
        
        return $validator;
    }

    /**
     * Get form type from 'type' context
     *
     * @param array $context
     * @return string
     */
    protected function getFormType($context)
    {
        return empty($context['Type']) ? static::TYPE_ADMIN : $context['Type'];
    }

    /**
     * Gets the main tabs for the file edit form
     *
     * @param File $record
     * @return TabSet
     */
    protected function getFormFieldTabs($record, $context = [])
    {
        $tabs = TabSet::create('Editor', $this->getFormFieldDetailsTab($record));

        return $tabs;
    }

    /**
     * @param File $record
     * @return FormAction
     */
    protected function getSaveAction($record)

    {
        if ($record && $record->isInDB() && $record->canEdit()) {
            return FormAction::create('save', _t('CMSMain.SAVE', 'Save'))
                ->setIcon('save');
        }
        return null;
    }

    /**
     * Get delete action, if this record is deletable
     *
     * @param File $record
     * @return FormAction
     */
    protected function getDeleteAction($record)

    {
        // Delete action
        if ($record && $record->isInDB() && $record->canDelete()) {
            $deleteText = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.DELETE_BUTTON', 'Delete');
            return FormAction::create('delete', $deleteText)
                ->setIcon('trash-bin');
        }
        return null;
    }
    
    /**
     * @param Controller $controller
     * @param $formName
     * @param array $context
     * @return FieldList
     */
    protected function getFormActions(Controller $controller, $formName, $context = [])
    {
        $record = isset($context['Record']) ? $context['Record'] : null;

        $actions = new FieldList();
        if ($saveAction = $this->getSaveAction($record)) {
            $actions->push($saveAction);
        }
        $menu = $this->getPopoverMenu($record);
        if ($menu && $menu->FieldList()->count()) {
            $actions->push($menu);
        }

        $this->invokeWithExtensions('updateFormActions', $actions, $controller, $formName, $context);
        return $actions;
    }

    /**
     * Get fields for this form
     *
     * @param Controller $controller
     * @param string $formName
     * @param array $context
     * @return FieldList
     */
    protected function getFormFields(Controller $controller, $formName, $context = [])
    {
        $record = isset($context['Record']) ? $context['Record'] : null;

        // Build standard fields for all folders / files
        /** @var File $record */
        $fields = new FieldList(
            HeaderField::create('TitleHeader', $record ? $record->Title : null, 1)
                ->addExtraClass('editor__heading'),
            $this->getFormFieldTabs($record, $context)
        );
        if ($record) {
            $fields->push(HiddenField::create('ID', $record->ID));
            $fields->insertAfter(
                'TitleHeader',
                PreviewImageField::create('PreviewImage')
                    ->setRecordID($record->ID)
                    ->addExtraClass('editor__file-preview')
            );
        }

        $this->invokeWithExtensions('updateFormFields', $fields, $controller, $formName, $context);
        return $fields;
    }
    
    /**
     * Build popup menu
     *
     * @param File $record
     * @return PopoverField
     */
    protected function getPopoverMenu($record)
    {
        // Build popover actions
        $popoverActions = $this->getPopoverActions($record);
        if ($popoverActions) {

            return PopoverField::create($popoverActions)
                ->setPlacement('top')
                ->setButtonTooltip(_t(
                    'SilverStripe\\AssetAdmin\\Forms\\FileFormFactory.OTHER_ACTIONS',
                    'Other actions'
                ));
        }
        return null;
    }
    
    /**
     * Get actions that go into the Popover menu
     *
     * @param $record
     * @return array
     */
    protected function getPopoverActions($record)
    {
        return array_filter([
            $this->getDeleteAction($record)
        ]);
    }
    
    /**
     * Build "details" formfield tab
     *
     * @param File $record
     * @param array $context
     * @return Tab
     */
    protected function getFormFieldDetailsTab($record, $context = [])
    {
        return Tab::create(
            'Details',
            TextField::create('Name', File::singleton()->fieldLabel('Filename'))
        );
    }

    public function getRequiredContext()
    {
        return ['Record'];
    }
}


1		<?php
2
3		namespace SilverStripe\AssetAdmin\Forms;
4
5		use InvalidArgumentException;
6		use SilverStripe\Assets\File;
7		use SilverStripe\Control\Controller;
8		use SilverStripe\Core\Config\Configurable;
9		use SilverStripe\Core\Extensible;
10		use SilverStripe\Core\Injector\Injectable;
11		use SilverStripe\Forms\FieldList;
12		use SilverStripe\Forms\Form;
13		use SilverStripe\Forms\FormAction;
14		use SilverStripe\Forms\FormFactory;
15		use SilverStripe\Forms\HeaderField;
16		use SilverStripe\Forms\HiddenField;
17		use SilverStripe\Forms\PopoverField;
18		use SilverStripe\Forms\RequiredFields;
19		use SilverStripe\Forms\Tab;
20		use SilverStripe\Forms\TabSet;
21		use SilverStripe\Forms\TextField;
22
23		abstract class AssetFormFactory implements FormFactory
24		{
25		use Extensible;
26		use Injectable;
27		use Configurable;
28
29		/**
30		* Insert into HTML content area
31		*/
32		const TYPE_INSERT = 'insert';
33
34		/**
35		* Select file by ID only
36		*/
37		const TYPE_SELECT = 'select';
38
39		/**
40		* Edit form: Default
41		*/
42		const TYPE_ADMIN = 'admin';
43
44		public function __construct()
45		{
46		$this->constructExtensions();
47		}
48
49		public function getForm(Controller $controller, $name = FormFactory::DEFAULT_NAME, $context = [])
50		{
51		// Validate context
52		foreach ($this->getRequiredContext() as $required) {
53		if (!isset($context[$required])) {
54		throw new InvalidArgumentException("Missing required context $required");
55		}
56		}
57
58		$fields = $this->getFormFields($controller, $name, $context);
59		$actions = $this->getFormActions($controller, $name, $context);
60		$validator = $this->getValidator($controller, $name, $context);
61		$form = Form::create($controller, $name, $fields, $actions, $validator);
62
63		// Extend form
64		$this->invokeWithExtensions('updateForm', $form, $controller, $name, $context);
65
66		// Populate form from record
67		if (isset($context['Record'])) {
68		$form->loadDataFrom($context['Record']);
69		}
70
71		return $form;
72		}
73
74		/**
75		* Get the validator for the form to be built
76		*
77		* @param $controller
78		* @param $formName
79		* @param $context
80		* @return RequiredFields
81		*/
82		protected function getValidator(Controller $controller, $formName, $context = [])
		0 ignored issues – show Unused Code introduced 2017-04-04 04:07 UTC by Report Bug Copy Issue Report The parameter `$controller` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-04-07 03:08 UTC by Report Bug Copy Issue Report The parameter `$formName` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-04-04 04:07 UTC by Report Bug Copy Issue Report The parameter `$context` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
83		{
84		$validator = new RequiredFields('Name');
85
86		return $validator;
87		}
88
89		/**
90		* Get form type from 'type' context
91		*
92		* @param array $context
93		* @return string
94		*/
95		protected function getFormType($context)
96		{
97		return empty($context['Type']) ? static::TYPE_ADMIN : $context['Type'];
98		}
99
100		/**
101		* Gets the main tabs for the file edit form
102		*
103		* @param File $record
104		* @return TabSet
105		*/
106		protected function getFormFieldTabs($record, $context = [])
107		{
108		$tabs = TabSet::create('Editor', $this->getFormFieldDetailsTab($record));
109
110		return $tabs;
111		}
112
113		/**
114		* @param File $record
115		* @return FormAction
116		*/
117	View Code Duplication	protected function getSaveAction($record)
		0 ignored issues – show Duplication introduced 2016-10-19 02:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118		{
119		if ($record && $record->isInDB() && $record->canEdit()) {
120		return FormAction::create('save', _t('CMSMain.SAVE', 'Save'))
121		->setIcon('save');
122		}
123		return null;
124		}
125
126		/**
127		* Get delete action, if this record is deletable
128		*
129		* @param File $record
130		* @return FormAction
131		*/
132	View Code Duplication	protected function getDeleteAction($record)
		0 ignored issues – show Duplication introduced 2016-10-17 01:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
133		{
134		// Delete action
135		if ($record && $record->isInDB() && $record->canDelete()) {
136		$deleteText = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.DELETE_BUTTON', 'Delete');
137		return FormAction::create('delete', $deleteText)
138		->setIcon('trash-bin');
139		}
140		return null;
141		}
142
143		/**
144		* @param Controller $controller
145		* @param $formName
146		* @param array $context
147		* @return FieldList
148		*/
149		protected function getFormActions(Controller $controller, $formName, $context = [])
150		{
151		$record = isset($context['Record']) ? $context['Record'] : null;
152
153		$actions = new FieldList();
154		if ($saveAction = $this->getSaveAction($record)) {
155		$actions->push($saveAction);
156		}
157		$menu = $this->getPopoverMenu($record);
158		if ($menu && $menu->FieldList()->count()) {
159		$actions->push($menu);
160		}
161
162		$this->invokeWithExtensions('updateFormActions', $actions, $controller, $formName, $context);
163		return $actions;
164		}
165
166		/**
167		* Get fields for this form
168		*
169		* @param Controller $controller
170		* @param string $formName
171		* @param array $context
172		* @return FieldList
173		*/
174		protected function getFormFields(Controller $controller, $formName, $context = [])
175		{
176		$record = isset($context['Record']) ? $context['Record'] : null;
177
178		// Build standard fields for all folders / files
179		/** @var File $record */
180		$fields = new FieldList(
181		HeaderField::create('TitleHeader', $record ? $record->Title : null, 1)
182		->addExtraClass('editor__heading'),
183		$this->getFormFieldTabs($record, $context)
184		);
185		if ($record) {
186		$fields->push(HiddenField::create('ID', $record->ID));
187		$fields->insertAfter(
188		'TitleHeader',
189		PreviewImageField::create('PreviewImage')
190		->setRecordID($record->ID)
191		->addExtraClass('editor__file-preview')
192		);
193		}
194
195		$this->invokeWithExtensions('updateFormFields', $fields, $controller, $formName, $context);
196		return $fields;
197		}
198
199		/**
200		* Build popup menu
201		*
202		* @param File $record
203		* @return PopoverField
204		*/
205		protected function getPopoverMenu($record)
206		{
207		// Build popover actions
208		$popoverActions = $this->getPopoverActions($record);
209		if ($popoverActions) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-04 04:07 UTC by Report Bug Copy Issue Report The expression `$popoverActions` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
210		return PopoverField::create($popoverActions)
211		->setPlacement('top')
212		->setButtonTooltip(_t(
213		'SilverStripe\\AssetAdmin\\Forms\\FileFormFactory.OTHER_ACTIONS',
214		'Other actions'
215		));
216		}
217		return null;
218		}
219
220		/**
221		* Get actions that go into the Popover menu
222		*
223		* @param $record
224		* @return array
225		*/
226		protected function getPopoverActions($record)
227		{
228		return array_filter([
229		$this->getDeleteAction($record)
230		]);
231		}
232
233		/**
234		* Build "details" formfield tab
235		*
236		* @param File $record
237		* @param array $context
238		* @return Tab
239		*/
240		protected function getFormFieldDetailsTab($record, $context = [])
241		{
242		return Tab::create(
243		'Details',
244		TextField::create('Name', File::singleton()->fieldLabel('Filename'))
245		);
246		}
247
248		public function getRequiredContext()
249		{
250		return ['Record'];
251		}
252		}
253

silverstripe / silverstripe-asset-admin

Pull Request — master (#415)

AssetFormFactory::getFormFields() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like