FileFormFactory::getInsertAction() - Code Metrics - Inspection of "API Implement file permission model" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#465)

by Damian

created 2017-05-08 22:02 UTC

FileFormFactory::getInsertAction() A

↳ Parent: FileFormFactory

Complexity

Conditions	4
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	8
rs	9.2
cc	4
eloc	5
nc	2
nop	1

<?php

namespace SilverStripe\AssetAdmin\Forms;

use SilverStripe\Assets\File;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\DatetimeField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\Forms\TextField;

class FileFormFactory extends AssetFormFactory
{
    protected function getFormFieldTabs($record, $context = [])
    {
        // Add extra tab
        $tabs = TabSet::create(
            'Editor',
            $this->getFormFieldDetailsTab($record, $context),
            $this->getFormFieldSecurityTab($record, $context),
            $this->getFormFieldUsageTab($record, $context),
            $this->getFormFieldHistoryTab($record, $context)
        );

        // All non-admin forms are typically readonly
        switch ($this->getFormType($context)) {
            case static::TYPE_INSERT:
                $tabs->setReadonly(true);
                $tabs->unshift($this->getFormFieldAttributesTab($record, $context));
                break;
            case static::TYPE_SELECT:
                $tabs->setReadonly(true);
                break;
        }

        return $tabs;
    }

    /**
     * Build "Usage" tab
     *
     * @param File $record
     * @param array $context
     * @return Tab
     */
    protected function getFormFieldUsageTab($record, $context = [])

    {
        // Add new tab for usage
        return Tab::create(
            'Usage',
            DatetimeField::create("Created", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.CREATED', 'First uploaded'))
                ->setReadonly(true),
            DatetimeField::create("LastEdited", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.LASTEDIT', 'Last changed'))
                ->setReadonly(true)
        );
    }

    protected function getFormFieldDetailsTab($record, $context = [])
    {
        // Update details tab
        $tab = Tab::create(
            'Details',
            TextField::create("Title", File::singleton()->fieldLabel('Title')),
            TextField::create('Name', File::singleton()->fieldLabel('Filename')),
            ReadonlyField::create("Path", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.PATH', 'Path'), $this->getPath($record))
        );

        if ($this->getFormType($context) !== static::TYPE_ADMIN) {
            $tab->push(LiteralField::create(
                'EditLink',
                sprintf(
                    '<a href="%s" class="%s" target="_blank"><i class="%s" />%s</a>',
                    $record->CMSEditLink(),
                    'btn btn-secondary-outline font-icon-edit editor__edit-link',
                    '',
                    _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.EditLink', 'Edit original file')
                )
            ));
        }
        return $tab;
    }

    /**
     * Create tab for file attributes
     *
     * @param File $record
     * @param array $context
     * @return Tab
     */
    protected function getFormFieldAttributesTab($record, $context = [])
    {
        return Tab::create(
            'Placement',
            LiteralField::create(
                'AttributesDescription',
                '<p>'. _t(
                    'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AttributesDescription',
                    'These changes will only affect this particular placement of the file.'
                ) .'</p>'
            ),
            TextField::create('Caption', _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.Caption', 'Caption'))
        );
    }

    protected function getFormFieldHistoryTab($record, $context = [])

    {
        return Tab::create(
            'History',
            HistoryListField::create('HistoryList')
                ->setRecord($record)
        );
    }

    protected function getFormFields(Controller $controller, $name, $context = [])
    {
        /** @var File $record */
        $record = $context['Record'];

        // Add status flag before extensions are triggered
        $this->beforeExtending('updateFormFields', function (FieldList $fields) use ($record) {
            // @todo move specs to a component/class, so it can update specs when a File is replaced
            $fields->insertAfter(
                'TitleHeader',
                LiteralField::create('FileSpecs', $this->getSpecsMarkup($record))
            );
            $fields->push(HiddenField::create('FileFilename'));
            $fields->push(HiddenField::create('FileHash'));
            $fields->push(HiddenField::create('FileVariant'));
        });

        return parent::getFormFields($controller, $name, $context);
    }

    /**
     * Get publish action
     *
     * @param File $record
     * @return FormAction
     */
    protected function getPublishAction($record)
    {
        if (!$record || !$record->canPublish()) {
            return null;
        }

        // Build action
        $publishText = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.PUBLISH_BUTTON', 'Publish');
        return FormAction::create('publish', $publishText)
            ->setIcon('rocket')
            ->setSchemaData(['data' => ['buttonStyle' => 'primary']]);
    }

    protected function getFormActions(Controller $controller, $formName, $context = [])
    {
        $record = $context['Record'];

        if ($this->getFormType($context) !== static::TYPE_ADMIN) {
            $actionItems = array_filter([
                $this->getInsertAction($record),
            ]);
        } else {
            $actionItems = array_filter([
                $this->getSaveAction($record),
                $this->getPublishAction($record)
            ]);
        }

        // Group all actions
        if (count($actionItems) > 1) {
            $actionItems = [
                FieldGroup::create($actionItems)
                    ->setName('Actions')
                    ->addExtraClass('btn-group')
            ];
        }

        // Add popover
        $popover = $this->getPopoverMenu($record);
        if ($popover) {
            $actionItems[] = $popover;
        }

        // Build
        $actions = new FieldList($actionItems);

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

    /**
     * get HTML for status icon
     *
     * @param File $record
     * @return null|string
     */
    protected function getSpecsMarkup($record)
    {
        if (!$record || !$record->exists()) {
            return null;
        }
        return sprintf(
            '<div class="editor__specs">%s %s</div>',
            $record->getSize(),
            $this->getStatusFlagMarkup($record)
        );
    }

    /**
     * Get published status flag
     *
     * @param File $record
     * @return null|string
     */
    protected function getStatusFlagMarkup($record)
    {
        if ($record && ($statusTitle = $record->getStatusTitle())) {
            return "<span class=\"editor__status-flag\">{$statusTitle}</span>";
        }
        return null;
    }

    /**
     * Get user-visible "Path" for this record
     *
     * @param File $record
     * @return string
     */
    protected function getPath($record)
    {
        if ($record && $record->isInDB()) {
            if ($record->ParentID) {
                return $record->Parent()->getFilename();
            } else {
                return '/';
            }
        }
        return null;
    }

    /**
     * Get action for publishing
     *
     * @param File $record
     * @return FormAction
     */
    protected function getUnpublishAction($record)
    {
        // Check if record is unpublishable
        if (!$record || !$record->isPublished() || !$record->canUnpublish()) {
            return null;
        }

        // Build action
        $unpublishText = _t(
            'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.UNPUBLISH_BUTTON',
            'Unpublish'
        );
        return FormAction::create('unpublish', $unpublishText)
            ->setIcon('cancel-circled');
    }

    /**
     * Get actions that go into the Popover menu
     *
     * @param $record
     * @return array
     */
    protected function getPopoverActions($record)
    {
        $this->beforeExtending('updatePopoverActions', function (&$actions, $record) {
            // add the unpublish action to the start of the array
            array_unshift($actions, $this->getUnpublishAction($record));
        });

        return parent::getPopoverActions($record);
    }

    /**
     * @param File $record
     * @return FormAction
     */
    protected function getInsertAction($record)
    {
        if ($record && $record->isInDB() && $record->canEdit()) {
            return FormAction::create('insert', _t(__CLASS__.'.INSERT_FILE', 'Insert file'))
                ->setSchemaData(['data' => ['buttonStyle' => 'primary']]);
        }
        return null;
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Forms;
4
5			use SilverStripe\Assets\File;
6			use SilverStripe\Control\Controller;
7			use SilverStripe\Forms\FieldGroup;
8			use SilverStripe\Forms\DatetimeField;
9			use SilverStripe\Forms\FieldList;
10			use SilverStripe\Forms\FormAction;
11			use SilverStripe\Forms\HiddenField;
12			use SilverStripe\Forms\LiteralField;
13			use SilverStripe\Forms\ReadonlyField;
14			use SilverStripe\Forms\Tab;
15			use SilverStripe\Forms\TabSet;
16			use SilverStripe\Forms\TextField;
17
18			class FileFormFactory extends AssetFormFactory
19			{
20			protected function getFormFieldTabs($record, $context = [])
21			{
22			// Add extra tab
23			$tabs = TabSet::create(
24			'Editor',
25			$this->getFormFieldDetailsTab($record, $context),
26			$this->getFormFieldSecurityTab($record, $context),
27			$this->getFormFieldUsageTab($record, $context),
28			$this->getFormFieldHistoryTab($record, $context)
29			);
30
31			// All non-admin forms are typically readonly
32			switch ($this->getFormType($context)) {
33			case static::TYPE_INSERT:
34			$tabs->setReadonly(true);
35			$tabs->unshift($this->getFormFieldAttributesTab($record, $context));
36			break;
37			case static::TYPE_SELECT:
38			$tabs->setReadonly(true);
39			break;
40			}
41
42			return $tabs;
43			}
44
45			/**
46			* Build "Usage" tab
47			*
48			* @param File $record
49			* @param array $context
50			* @return Tab
51			*/
52			protected function getFormFieldUsageTab($record, $context = [])
			0 ignored issues – show Unused Code introduced 2016-11-17 21:46 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... Unused Code introduced 2017-05-05 02:59 UTC by Report Bug Copy Issue Report The parameter `$record` 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...
53			{
54			// Add new tab for usage
55			return Tab::create(
56			'Usage',
57			DatetimeField::create("Created", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.CREATED', 'First uploaded'))
58			->setReadonly(true),
59			DatetimeField::create("LastEdited", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.LASTEDIT', 'Last changed'))
60			->setReadonly(true)
61			);
62			}
63
64			protected function getFormFieldDetailsTab($record, $context = [])
65			{
66			// Update details tab
67			$tab = Tab::create(
68			'Details',
69			TextField::create("Title", File::singleton()->fieldLabel('Title')),
70			TextField::create('Name', File::singleton()->fieldLabel('Filename')),
71			ReadonlyField::create("Path", _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.PATH', 'Path'), $this->getPath($record))
72			);
73
74			if ($this->getFormType($context) !== static::TYPE_ADMIN) {
75			$tab->push(LiteralField::create(
76			'EditLink',
77			sprintf(
78			'<a href="%s" class="%s" target="_blank"><i class="%s" />%s</a>',
79			$record->CMSEditLink(),
80			'btn btn-secondary-outline font-icon-edit editor__edit-link',
81			'',
82			_t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.EditLink', 'Edit original file')
83			)
84			));
85			}
86			return $tab;
87			}
88
89			/**
90			* Create tab for file attributes
91			*
92			* @param File $record
93			* @param array $context
94			* @return Tab
95			*/
96			protected function getFormFieldAttributesTab($record, $context = [])
97			{
98			return Tab::create(
99			'Placement',
100			LiteralField::create(
101			'AttributesDescription',
102			'<p>'. _t(
103			'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AttributesDescription',
104			'These changes will only affect this particular placement of the file.'
105			) .'</p>'
106			),
107			TextField::create('Caption', _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.Caption', 'Caption'))
108			);
109			}
110
111			protected function getFormFieldHistoryTab($record, $context = [])
			0 ignored issues – show Unused Code introduced 2016-11-17 21:46 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...
112			{
113			return Tab::create(
114			'History',
115			HistoryListField::create('HistoryList')
116			->setRecord($record)
117			);
118			}
119
120			protected function getFormFields(Controller $controller, $name, $context = [])
121			{
122			/** @var File $record */
123			$record = $context['Record'];
124
125			// Add status flag before extensions are triggered
126			$this->beforeExtending('updateFormFields', function (FieldList $fields) use ($record) {
127			// @todo move specs to a component/class, so it can update specs when a File is replaced
128			$fields->insertAfter(
129			'TitleHeader',
130			LiteralField::create('FileSpecs', $this->getSpecsMarkup($record))
131			);
132			$fields->push(HiddenField::create('FileFilename'));
133			$fields->push(HiddenField::create('FileHash'));
134			$fields->push(HiddenField::create('FileVariant'));
135			});
136
137			return parent::getFormFields($controller, $name, $context);
138			}
139
140			/**
141			* Get publish action
142			*
143			* @param File $record
144			* @return FormAction
145			*/
146			protected function getPublishAction($record)
147			{
148			if (!$record \|\| !$record->canPublish()) {
149			return null;
150			}
151
152			// Build action
153			$publishText = _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.PUBLISH_BUTTON', 'Publish');
154			return FormAction::create('publish', $publishText)
155			->setIcon('rocket')
156			->setSchemaData(['data' => ['buttonStyle' => 'primary']]);
157			}
158
159			protected function getFormActions(Controller $controller, $formName, $context = [])
160			{
161			$record = $context['Record'];
162
163			if ($this->getFormType($context) !== static::TYPE_ADMIN) {
164			$actionItems = array_filter([
165			$this->getInsertAction($record),
166			]);
167			} else {
168			$actionItems = array_filter([
169			$this->getSaveAction($record),
170			$this->getPublishAction($record)
171			]);
172			}
173
174			// Group all actions
175			if (count($actionItems) > 1) {
176			$actionItems = [
177			FieldGroup::create($actionItems)
178			->setName('Actions')
179			->addExtraClass('btn-group')
180			];
181			}
182
183			// Add popover
184			$popover = $this->getPopoverMenu($record);
185			if ($popover) {
186			$actionItems[] = $popover;
187			}
188
189			// Build
190			$actions = new FieldList($actionItems);
191
192			// Update
193			$this->invokeWithExtensions('updateFormActions', $actions, $controller, $formName, $context);
194			return $actions;
195			}
196
197			/**
198			* get HTML for status icon
199			*
200			* @param File $record
201			* @return null\|string
202			*/
203			protected function getSpecsMarkup($record)
204			{
205			if (!$record \|\| !$record->exists()) {
206			return null;
207			}
208			return sprintf(
209			'<div class="editor__specs">%s %s</div>',
210			$record->getSize(),
211			$this->getStatusFlagMarkup($record)
212			);
213			}
214
215			/**
216			* Get published status flag
217			*
218			* @param File $record
219			* @return null\|string
220			*/
221			protected function getStatusFlagMarkup($record)
222			{
223			if ($record && ($statusTitle = $record->getStatusTitle())) {
224			return "<span class=\"editor__status-flag\">{$statusTitle}</span>";
225			}
226			return null;
227			}
228
229			/**
230			* Get user-visible "Path" for this record
231			*
232			* @param File $record
233			* @return string
234			*/
235			protected function getPath($record)
236			{
237			if ($record && $record->isInDB()) {
238			if ($record->ParentID) {
239			return $record->Parent()->getFilename();
240			} else {
241			return '/';
242			}
243			}
244			return null;
245			}
246
247			/**
248			* Get action for publishing
249			*
250			* @param File $record
251			* @return FormAction
252			*/
253			protected function getUnpublishAction($record)
254			{
255			// Check if record is unpublishable
256			if (!$record \|\| !$record->isPublished() \|\| !$record->canUnpublish()) {
257			return null;
258			}
259
260			// Build action
261			$unpublishText = _t(
262			'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.UNPUBLISH_BUTTON',
263			'Unpublish'
264			);
265			return FormAction::create('unpublish', $unpublishText)
266			->setIcon('cancel-circled');
267			}
268
269			/**
270			* Get actions that go into the Popover menu
271			*
272			* @param $record
273			* @return array
274			*/
275			protected function getPopoverActions($record)
276			{
277			$this->beforeExtending('updatePopoverActions', function (&$actions, $record) {
278			// add the unpublish action to the start of the array
279			array_unshift($actions, $this->getUnpublishAction($record));
280			});
281
282			return parent::getPopoverActions($record);
283			}
284
285			/**
286			* @param File $record
287			* @return FormAction
288			*/
289			protected function getInsertAction($record)
290			{
291			if ($record && $record->isInDB() && $record->canEdit()) {
292			return FormAction::create('insert', _t(__CLASS__.'.INSERT_FILE', 'Insert file'))
293			->setSchemaData(['data' => ['buttonStyle' => 'primary']]);
294			}
295			return null;
296			}
297			}
298

silverstripe / silverstripe-asset-admin

Pull Request — master (#465)

FileFormFactory::getInsertAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like