SilverStripe\AssetAdmin\Forms\FileSearchFormFactory

Complexity

Total Complexity

4

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	getFormFields()	0	44	1
A	getRequiredContext()	0	4	1
A	getForm()	0	10	1

<?php


namespace SilverStripe\AssetAdmin\Forms;

use SilverStripe\Control\Controller;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\DateField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormFactory;

/**
 * Scaffolds a form for searching files
 */
class FileSearchFormFactory implements FormFactory
{
    use Extensible;
    use Injectable;

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

    /**
     * Generates the form
     *
     * @param Controller $controller Parent controller
     * @param string $name
     * @param array $context List of properties which may influence form scaffolding.
     * E.g. 'Record' if building a form for a record.
     * Custom factories may support more advanced parameters.
     * @return Form
     */
    public function getForm(Controller $controller, $name = FormFactory::DEFAULT_NAME, $context = [])
    {
        $fields = $this->getFormFields($controller, $name, $context);
        $actions = FieldList::create();
        $form = Form::create($controller, $name, $fields, $actions);
        $form->disableSecurityToken(); // not posted back, so unnecessary
        $form->addExtraClass('form--no-dividers');
        $this->invokeWithExtensions('updateForm', $form, $controller, $name, $context);
        return $form;
    }

    /**
     *
     * @param Controller $controller
     * @param $name
     * @param array $context
     * @return FieldList
     */
    protected function getFormFields(Controller $controller, $name, $context = [])
    {
        // Note: "Name" field is excluded as it is baked directly into the Search.js react component

        /** @skipUpgrade */
        // File type field
        $appCategories = array(
            'ARCHIVE' => _t(
                'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AppCategoryArchive',
                'Archive'
            ),
            'AUDIO' => _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AppCategoryAudio', 'Audio'),
            'DOCUMENT' => _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AppCategoryDocument', 'Document'),
            'IMAGE' => _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AppCategoryImage', 'Image'),
            'VIDEO' => _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.AppCategoryVideo', 'Video'),
        );
        $typeDropdown = DropdownField::create(
            'appCategory',
            _t('SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.Filetype', 'File type'),
            $appCategories
        )->setEmptyString(_t('Enum.ANY', 'Any'));

        // Limit to current folder
        $limitCheckbox = CheckboxField::create('currentFolderOnly', _t(
            'SilverStripe\\AssetAdmin\\Controller\\AssetAdmin.CurrentFolderOnly',
            'Limit to current folder and its sub-folders?'
        ));

        // Last updated range field
        $dateFrom = DateField::create('createdFrom', _t('CMSSearch.FILTERDATEFROM', 'From'))
            ->setConfig('showcalendar', true);
        $dateTo = DateField::create('createdTo', _t('CMSSearch.FILTERDATETO', 'To'))
            ->setConfig('showcalendar', true);
        $dateGroup = FieldGroup::create(
            _t('AssetTableField.LASTEDIT', 'Last changed'),
            [$dateFrom, $dateTo]
        )->setName('LastChanged');

        // Build form with these fields
        $fields = FieldList::create($typeDropdown, $dateGroup, $limitCheckbox);

        $this->invokeWithExtensions('updateFormFields', $fields, $controller, $name, $context);
        return $fields;
    }


    /**
     * Return list of mandatory context keys
     *
     * @return mixed
     */
    public function getRequiredContext()
    {
        return [];
    }
}