CwpStatsReport::sourceRecords() - Code Metrics - silverstripe/cwp - Measure and Improve Code Quality continuously with Scrutinizer

CwpStatsReport::sourceRecords() A
last analyzed 2021-06-10 01:33 UTC

↳ Parent: CwpStatsReport

Complexity

Conditions	3
Paths	2

Size

Total Lines	59
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	35
nc	2
nop	3
dl	0
loc	59
rs	9.36
c	0
b	0
f	0

How to fix Long Method

<?php

namespace CWP\CWP\Report;

use SilverStripe\Assets\File;
use SilverStripe\Assets\Folder;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\Forms\GridField\GridFieldPrintButton;
use SilverStripe\Forms\GridField\GridFieldSortableHeader;
use SilverStripe\ORM\ArrayList;
use SilverStripe\Reports\Report;
use SilverStripe\Subsites\Model\Subsite;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Versioned\Versioned;

/**
 * Summary report on the page and file counts managed by this CMS.
 */
class CwpStatsReport extends Report
{
    public function title()
    {
        return _t(__CLASS__ . '.Title', 'Summary statistics');
    }

    public function description()
    {
        return _t(
            __CLASS__ . '.Description',
            'This report provides various statistics for this site. The "total live page count" is the number that ' .
                'can be compared against the instance size specifications.'
        );
    }

    public function columns()
    {
        return [
            'Name' => _t(__CLASS__ . '.Name', 'Name'),
            'Count' => _t(__CLASS__ . '.Count', 'Count'),
        ];
    }

    /**
     * Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
     *
     * {@inheritDoc}
     */
    public function sourceRecords($params = [], $sort = null, $limit = null)
    {
        $records = [];

        // Get the query to apply across all variants: looks at all subsites, translations, live stage only.
        $crossVariant = (function ($dataQuery) {
            $params = [
                'Subsite.filter' => false,
                'Versioned.mode' => 'stage',
                'Versioned.stage' => Versioned::LIVE,
            ];

            return $dataQuery->setDataQueryParam($params);
        });

        // Total.
        $records[] = [
            'Name' => _t(
                __CLASS__ . '.TotalPageCount',
                'Total live page count, across all translations and subsites'
            ),
            'Count' => $crossVariant(SiteTree::get())->count(),
        ];

        if (class_exists(Subsite::class)) {
            // Main site.
            $records[] = [
                'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
                'Count' => $crossVariant(SiteTree::get())
                    ->filter(['SubsiteID' => 0])
                    ->count(),
            ];

            // Per subsite.
            $subsites = Subsite::get();
            foreach ($subsites as $subsite) {
                $records[] = [
                    'Name' => _t(
                        __CLASS__ . '.PagesForSubsite',
                        "- in the subsite '{SubsiteTitle}'",
                        ['SubsiteTitle' => $subsite->Title]
                    ),
                    'Count' => $crossVariant(SiteTree::get())
                        ->filter(['SubsiteID' => $subsite->ID])
                        ->count(),
                ];
            }
        }

        // Files.
        $records[] = [
            'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
            'Count' => File::get()
                ->setDataQueryParam('Subsite.filter', false)
                ->filter(['ClassName:not' => Folder::class])
                ->count(),
        ];

        return ArrayList::create($records);
    }

    /**
     * @return GridField
     */
    public function getReportField()
    {
        /** @var GridField $gridField */
        $gridField = parent::getReportField();

        /** @var GridFieldConfig $gridConfig */
        $gridConfig = $gridField->getConfig();
        $gridConfig->removeComponentsByType(GridFieldPrintButton::class);
        $gridConfig->removeComponentsByType(GridFieldExportButton::class);
        $gridConfig->removeComponentsByType(GridFieldSortableHeader::class);

        return $gridField;
    }
}


1			<?php
2
3			namespace CWP\CWP\Report;
4
5			use SilverStripe\Assets\File;
6			use SilverStripe\Assets\Folder;
7			use SilverStripe\CMS\Model\SiteTree;
8			use SilverStripe\Forms\GridField\GridField;
9			use SilverStripe\Forms\GridField\GridFieldConfig;
10			use SilverStripe\Forms\GridField\GridFieldExportButton;
11			use SilverStripe\Forms\GridField\GridFieldPrintButton;
12			use SilverStripe\Forms\GridField\GridFieldSortableHeader;
13			use SilverStripe\ORM\ArrayList;
14			use SilverStripe\Reports\Report;
15			use SilverStripe\Subsites\Model\Subsite;
			0 ignored issues – show Bug introduced 2018-02-13 04:42 UTC by Report Bug Copy Issue Report The type `SilverStripe\Subsites\Model\Subsite` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use SilverStripe\Versioned\Versioned;
17
18			/**
19			* Summary report on the page and file counts managed by this CMS.
20			*/
21			class CwpStatsReport extends Report
22			{
23			public function title()
24			{
25			return _t(__CLASS__ . '.Title', 'Summary statistics');
26			}
27
28			public function description()
29			{
30			return _t(
31			__CLASS__ . '.Description',
32			'This report provides various statistics for this site. The "total live page count" is the number that ' .
33			'can be compared against the instance size specifications.'
34			);
35			}
36
37			public function columns()
38			{
39			return [
40			'Name' => _t(__CLASS__ . '.Name', 'Name'),
41			'Count' => _t(__CLASS__ . '.Count', 'Count'),
42			];
43			}
44
45			/**
46			* Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
47			*
48			* {@inheritDoc}
49			*/
50			public function sourceRecords($params = [], $sort = null, $limit = null)
51			{
52			$records = [];
53
54			// Get the query to apply across all variants: looks at all subsites, translations, live stage only.
55			$crossVariant = (function ($dataQuery) {
56			$params = [
57			'Subsite.filter' => false,
58			'Versioned.mode' => 'stage',
59			'Versioned.stage' => Versioned::LIVE,
60			];
61
62			return $dataQuery->setDataQueryParam($params);
63			});
64
65			// Total.
66			$records[] = [
67			'Name' => _t(
68			__CLASS__ . '.TotalPageCount',
69			'Total live page count, across all translations and subsites'
70			),
71			'Count' => $crossVariant(SiteTree::get())->count(),
72			];
73
74			if (class_exists(Subsite::class)) {
75			// Main site.
76			$records[] = [
77			'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
78			'Count' => $crossVariant(SiteTree::get())
79			->filter(['SubsiteID' => 0])
80			->count(),
81			];
82
83			// Per subsite.
84			$subsites = Subsite::get();
85			foreach ($subsites as $subsite) {
86			$records[] = [
87			'Name' => _t(
88			__CLASS__ . '.PagesForSubsite',
89			"- in the subsite '{SubsiteTitle}'",
90			['SubsiteTitle' => $subsite->Title]
91			),
92			'Count' => $crossVariant(SiteTree::get())
93			->filter(['SubsiteID' => $subsite->ID])
94			->count(),
95			];
96			}
97			}
98
99			// Files.
100			$records[] = [
101			'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
102			'Count' => File::get()
103			->setDataQueryParam('Subsite.filter', false)
104			->filter(['ClassName:not' => Folder::class])
105			->count(),
106			];
107
108			return ArrayList::create($records);
109			}
110
111			/**
112			* @return GridField
113			*/
114			public function getReportField()
115			{
116			/** @var GridField $gridField */
117			$gridField = parent::getReportField();
118
119			/** @var GridFieldConfig $gridConfig */
120			$gridConfig = $gridField->getConfig();
121			$gridConfig->removeComponentsByType(GridFieldPrintButton::class);
122			$gridConfig->removeComponentsByType(GridFieldExportButton::class);
123			$gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
124
125			return $gridField;
126			}
127			}
128

silverstripe / cwp

CwpStatsReport::sourceRecords() A last analyzed 2021-06-10 01:33 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

CwpStatsReport::sourceRecords() A
last analyzed 2021-06-10 01:33 UTC