SilverStripe\VersionedAdmin\Extensions\FileArchiveExtension

Complexity

Total Complexity

4

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getArchiveFieldClass()	0	3	1
A	getArchiveField()	0	38	2
A	isArchiveFieldEnabled()	0	3	1

<?php

namespace SilverStripe\VersionedAdmin\Extensions;

use SilverStripe\Assets\AssetControlExtension;
use SilverStripe\Assets\File;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Versioned\GridFieldRestoreAction;
use SilverStripe\VersionedAdmin\ArchiveAdmin;
use SilverStripe\VersionedAdmin\Forms\GridField\GridFieldFileRestoreAction;
use SilverStripe\VersionedAdmin\Interfaces\ArchiveViewProvider;

/**
 * Adds a archive view for Files
 */
class FileArchiveExtension extends DataExtension implements ArchiveViewProvider
{
    /**
     * @inheritDoc
    */
    public function getArchiveFieldClass()
    {
        return File::class;

The expression return SilverStripe\Assets\File::class returns the type string which is incompatible with the return type mandated by SilverStripe\VersionedAdmin\Interfaces\ArchiveViewProvider::getArchiveFieldClass() of array.

    }

    /**
     * @inheritDoc
    */
    public function getArchiveField()
    {
        $listField = ArchiveAdmin::createArchiveGridField('Files', File::class);

        $list = $listField->getList();
        // Paginator reports all records even if some can't be viewed, so we filter them out here
        $list = $list->filterByCallback(function ($item) {

The method filterByCallback() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Limitable. Are you sure you never get one of those?

            return $item->canView();
        });
        $listField->setList($list);
        $listConfig = $listField->getConfig();
        $listConfig->removeComponentsByType(GridFieldRestoreAction::class);
        $listConfig->addComponent(new GridFieldFileRestoreAction());

        $listColumns = $listField->getConfig()->getComponentByType(GridFieldDataColumns::class);
        $listColumns->setDisplayFields([

The method setDisplayFields() does not exist on SilverStripe\Forms\GridField\GridFieldComponent. It seems like you code against a sub-type of SilverStripe\Forms\GridField\GridFieldComponent such as SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\GridField\GridFieldDataColumns or SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\Tests\GridField\GridField_URLHandlerTest\TestComponent or SilverStripe\Forms\GridField\GridFieldDetailForm.

            'Name' => File::singleton()->fieldLabel('Name'),
            'appCategory' => _t('SilverStripe\\VersionedAdmin\\ArchiveAdmin.COLUMN_TYPE', 'Type'),
            'Versions.first.LastEdited' => _t(
                'SilverStripe\\VersionedAdmin\\ArchiveAdmin.COLUMN_DATEARCHIVED',
                'Date Archived'
            ),
            'Parent.Name' => _t('SilverStripe\\VersionedAdmin\\ArchiveAdmin.COLUMN_ORIGIN', 'Origin'),
            'Versions.first.Author.Name' => _t(
                'SilverStripe\\VersionedAdmin\\ArchiveAdmin.COLUMN_ARCHIVEDBY',
                'Archived By'
            )
        ]);
        $listColumns->setFieldFormatting([

The method setFieldFormatting() does not exist on SilverStripe\Forms\GridField\GridFieldComponent. It seems like you code against a sub-type of SilverStripe\Forms\GridField\GridFieldComponent such as SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\GridField\GridFieldDataColumns or SilverStripe\Forms\GridField\GridFieldPrintButton or SilverStripe\Forms\Tests\GridField\GridField_URLHandlerTest\TestComponent or SilverStripe\Forms\GridField\GridFieldDetailForm.

            'appCategory' => function ($val, $item) {
                return ucfirst($val ?: $item->i18n_singular_name());
            },
            'Versions.first.LastEdited' => function ($val, $item) {

The parameter $item is not used and could be removed.

                return DBDatetime::create_field('Datetime', $val)->Ago();
            },
        ]);

        return $listField;
    }

    /**
     * The files archive is only useful if archived assets are stored
     * so this checks if this option is enabled
     *
     * @return boolean
    */
    public function isArchiveFieldEnabled()
    {
        return Config::inst()->get(AssetControlExtension::class, 'keep_archived_assets');
    }
}