SiteSummary::getReportField() - Code Metrics - Inspection of "NEW Upgrading to SS4" - bringyourownideas/silverstripe-maintenance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#78)

unknown

created 2018-05-31 05:40 UTC

SiteSummary::getReportField() A

↳ Parent: SiteSummary

Complexity

Conditions	1
Paths	1

Size

Total Lines	60
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	37
nc	1
nop	0
dl	0
loc	60
rs	9.5555
c	0
b	0
f	0

How to fix Long Method

<?php

namespace BringYourOwnIdeas\Maintenance\Reports;

use BringYourOwnIdeas\Maintenance\Model\Package;
use SilverStripe\Core\Config\Config;
use BringYourOwnIdeas\Maintenance\Tasks\UpdatePackageInfoTask;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\View\Requirements;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\View\ArrayData;
use SilverStripe\Core\Injector\Injector;
use BringYourOwnIdeas\Maintenance\Forms\GridFieldDropdownFilter;
use BringYourOwnIdeas\Maintenance\Forms\GridFieldRefreshButton;
use BringYourOwnIdeas\Maintenance\Forms\GridFieldLinkButton;
use BringYourOwnIdeas\Maintenance\Forms\GridFieldHtmlFragment;
use SilverStripe\Forms\GridField\GridFieldPaginator;
use SilverStripe\Reports\Report;

/**
 * A report listing all installed modules used in this site (from a cache).
 */
class SiteSummary extends Report
{
    public function title()
    {
        return _t(__CLASS__ . '.TITLE', 'Installed modules');
    }

    public function sourceRecords()
    {
        $packageList = Package::get();
        $typeFilters = Config::inst()->get(UpdatePackageInfoTask::class, 'allowed_types');

        if (!empty($typeFilters)) {
            $packageList = $packageList->filter('Type', $typeFilters);
        }

        $this->extend('updateSourceRecords', $packageList);

        return $packageList;
    }

    /**
     * Provide column selection and formatting rules for the CMS report. You can extend data columns by extending
     * {@link Package::summary_fields}, or you can extend this method to adjust the formatting rules, or to provide
     * composite fields (such as Summary below) for the CMS report but not the CSV export.
     *
     * {@inheritDoc}
     */
    public function columns()
    {
        $columns = Package::create()->summaryFields();

        // Remove the default Title and Description and create Summary as a composite of both for the CMS report only
        unset($columns['Title'], $columns['Description']);
        $columns = ['Summary' => 'Summary'] + $columns;

        $this->extend('updateColumns', $columns);

        return $columns;
    }

    /**
     * Add a button row, including link out to the SilverStripe addons repository, and export button
     *
     * {@inheritdoc}
     */
    public function getReportField()
    {
        Requirements::css('bringyourownideas/silverstripe-maintenance: css/sitesummary.css');

        /** @var GridField $grid */
        $grid = parent::getReportField();

        /** @var GridFieldConfig $config */
        $config = $grid->getConfig();

        $grid->addExtraClass('package-summary');

        /** @var GridFieldExportButton $exportButton */
        $exportButton = $config->getComponentByType(GridFieldExportButton::class);
        $exportButton->setExportColumns(Package::create()->summaryFields());

        $versionHtml = ArrayData::create([
            'Title' => _t(__CLASS__ . '.VERSION', 'Version'),
            'Version' => $this->resolveCmsVersion(),
        ])->renderWith('SiteSummary_VersionHeader');

        /** @var GridFieldDropdownFilter $dropdownFilter */
        $dropdownFilter = Injector::inst()->create(
            GridFieldDropdownFilter::class,
            'addonFilter',
            'buttons-before-right',
            _t(__CLASS__ . '.ShowAllModules', 'Show all modules')
        );

        $dropdownFilter->addFilterOption(
            'supported',
            _t(__CLASS__ . '.FilterSupported', 'Supported modules'),
            ['Supported' => true]
        );
        $dropdownFilter->addFilterOption(
            'unsupported',
            _t(__CLASS__ . '.FilterUnsupported', 'Unsupported modules'),
            ['Supported' => false]
        );

        $this->extend('updateDropdownFilterOptions', $dropdownFilter);

        $config->addComponents(
            Injector::inst()->create(GridFieldRefreshButton::class, 'buttons-before-left'),
            Injector::inst()->create(
                GridFieldLinkButton::class,
                'https://addons.silverstripe.org',
                _t(__CLASS__ . '.LINK_TO_ADDONS', 'Explore Addons'),
                'buttons-before-left'
            ),
            $dropdownFilter,
            Injector::inst()->create(GridFieldHtmlFragment::class, 'header', $versionHtml)
        );

        // Re-order the paginator to ensure it counts correctly.
        $paginator = $config->getComponentByType(GridFieldPaginator::class);
        $config->removeComponent($paginator);
        $config->addComponent($paginator);

        return $grid;
    }

    /**
     * Extract CMS and Framework version details from the records in the report
     *
     * @return string
     */
    protected function resolveCmsVersion()
    {
        $versionModules = [
            'silverstripe/framework' => 'Framework',
            'silverstripe/cms' => 'CMS',
        ];
        $this->extend('updateVersionModules', $versionModules);

        $records = $this->sourceRecords()->filter('Name', array_keys($versionModules));
        $versionParts = [];

        foreach ($versionModules as $name => $label) {
            $record = $records->find('Name', $name);
            if (!$record) {
                $version = _t(__CLASS__.'.VersionUnknown', 'Unknown');
            } else {
                $version = $record->Version;
            }

            $versionParts[] = "$label $version";
        }

        return implode(', ', $versionParts);
    }
}


1			<?php
2
3			namespace BringYourOwnIdeas\Maintenance\Reports;
4
5			use BringYourOwnIdeas\Maintenance\Model\Package;
6			use SilverStripe\Core\Config\Config;
7			use BringYourOwnIdeas\Maintenance\Tasks\UpdatePackageInfoTask;
8			use SilverStripe\Forms\GridField\GridField;
9			use SilverStripe\Forms\GridField\GridFieldConfig;
10			use SilverStripe\View\Requirements;
11			use SilverStripe\Forms\GridField\GridFieldExportButton;
12			use SilverStripe\View\ArrayData;
13			use SilverStripe\Core\Injector\Injector;
14			use BringYourOwnIdeas\Maintenance\Forms\GridFieldDropdownFilter;
15			use BringYourOwnIdeas\Maintenance\Forms\GridFieldRefreshButton;
16			use BringYourOwnIdeas\Maintenance\Forms\GridFieldLinkButton;
17			use BringYourOwnIdeas\Maintenance\Forms\GridFieldHtmlFragment;
18			use SilverStripe\Forms\GridField\GridFieldPaginator;
19			use SilverStripe\Reports\Report;
20
21			/**
22			* A report listing all installed modules used in this site (from a cache).
23			*/
24			class SiteSummary extends Report
25			{
26			public function title()
27			{
28			return _t(__CLASS__ . '.TITLE', 'Installed modules');
29			}
30
31			public function sourceRecords()
32			{
33			$packageList = Package::get();
34			$typeFilters = Config::inst()->get(UpdatePackageInfoTask::class, 'allowed_types');
35
36			if (!empty($typeFilters)) {
37			$packageList = $packageList->filter('Type', $typeFilters);
38			}
39
40			$this->extend('updateSourceRecords', $packageList);
41
42			return $packageList;
43			}
44
45			/**
46			* Provide column selection and formatting rules for the CMS report. You can extend data columns by extending
47			* {@link Package::summary_fields}, or you can extend this method to adjust the formatting rules, or to provide
48			* composite fields (such as Summary below) for the CMS report but not the CSV export.
49			*
50			* {@inheritDoc}
51			*/
52			public function columns()
53			{
54			$columns = Package::create()->summaryFields();
55
56			// Remove the default Title and Description and create Summary as a composite of both for the CMS report only
57			unset($columns['Title'], $columns['Description']);
58			$columns = ['Summary' => 'Summary'] + $columns;
59
60			$this->extend('updateColumns', $columns);
61
62			return $columns;
63			}
64
65			/**
66			* Add a button row, including link out to the SilverStripe addons repository, and export button
67			*
68			* {@inheritdoc}
69			*/
70			public function getReportField()
71			{
72			Requirements::css('bringyourownideas/silverstripe-maintenance: css/sitesummary.css');
73
74			/** @var GridField $grid */
75			$grid = parent::getReportField();
76
77			/** @var GridFieldConfig $config */
78			$config = $grid->getConfig();
79
80			$grid->addExtraClass('package-summary');
81
82			/** @var GridFieldExportButton $exportButton */
83			$exportButton = $config->getComponentByType(GridFieldExportButton::class);
84			$exportButton->setExportColumns(Package::create()->summaryFields());
85
86			$versionHtml = ArrayData::create([
87			'Title' => _t(__CLASS__ . '.VERSION', 'Version'),
88			'Version' => $this->resolveCmsVersion(),
89			])->renderWith('SiteSummary_VersionHeader');
90
91			/** @var GridFieldDropdownFilter $dropdownFilter */
92			$dropdownFilter = Injector::inst()->create(
93			GridFieldDropdownFilter::class,
94			'addonFilter',
95			'buttons-before-right',
96			_t(__CLASS__ . '.ShowAllModules', 'Show all modules')
97			);
98
99			$dropdownFilter->addFilterOption(
100			'supported',
101			_t(__CLASS__ . '.FilterSupported', 'Supported modules'),
102			['Supported' => true]
103			);
104			$dropdownFilter->addFilterOption(
105			'unsupported',
106			_t(__CLASS__ . '.FilterUnsupported', 'Unsupported modules'),
107			['Supported' => false]
108			);
109
110			$this->extend('updateDropdownFilterOptions', $dropdownFilter);
111
112			$config->addComponents(
113			Injector::inst()->create(GridFieldRefreshButton::class, 'buttons-before-left'),
114			Injector::inst()->create(
115			GridFieldLinkButton::class,
116			'https://addons.silverstripe.org',
117			_t(__CLASS__ . '.LINK_TO_ADDONS', 'Explore Addons'),
118			'buttons-before-left'
119			),
120			$dropdownFilter,
121			Injector::inst()->create(GridFieldHtmlFragment::class, 'header', $versionHtml)
122			);
123
124			// Re-order the paginator to ensure it counts correctly.
125			$paginator = $config->getComponentByType(GridFieldPaginator::class);
126			$config->removeComponent($paginator);
127			$config->addComponent($paginator);
128
129			return $grid;
130			}
131
132			/**
133			* Extract CMS and Framework version details from the records in the report
134			*
135			* @return string
136			*/
137			protected function resolveCmsVersion()
138			{
139			$versionModules = [
140			'silverstripe/framework' => 'Framework',
141			'silverstripe/cms' => 'CMS',
142			];
143			$this->extend('updateVersionModules', $versionModules);
144
145			$records = $this->sourceRecords()->filter('Name', array_keys($versionModules));
146			$versionParts = [];
147
148			foreach ($versionModules as $name => $label) {
149			$record = $records->find('Name', $name);
150			if (!$record) {
151			$version = _t(__CLASS__.'.VersionUnknown', 'Unknown');
152			} else {
153			$version = $record->Version;
154			}
155
156			$versionParts[] = "$label $version";
157			}
158
159			return implode(', ', $versionParts);
160			}
161			}
162

bringyourownideas / silverstripe-maintenance

Pull Request — master (#78)

SiteSummary::getReportField() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like