Comic::findAll() - Code Metrics - Inspection of "Attempt to get phpcs working properly with scrutin..." - chadicus/marvel-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — v3.x ( a479f4...cb2cf1 )

by Chad

created 2017-04-20 01:29 UTC

Comic::findAll() A

↳ Parent: Comic

Complexity

Conditions	3
Paths	2

Size

Total Lines	64
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	64
c	0
b	0
f	0
rs	9.3956
cc	3
eloc	46
nc	2
nop	2

How to fix Long Method

<?php

namespace Chadicus\Marvel\Api\Entities;

use Chadicus\Marvel\Api;
use DominionEnterprises\Util;

/**
 * Represents a Marvel API Comic Entity
 *
 * @property-read integer $id The unique ID of the comic resource.
 * @property-read integer $digitalId The ID of the digital comic representation of this comic. Will be if the comic is
 *                                   not available digitally.
 * @property-read string $title The canonical title of the comic.
 * @property-read string $issueNumber The number of the issue in the series (will generally be for collection formats).
 * @property-read string $variantDescription If the issue is a variant (e.g. an alternate cover, second printing, or
 *                                           director's cut), a text description of the variant.
 * @property-read string $description The preferred description of the comic.
 * @property-read DateTime $modified The date the resource was most recently modified.
 * @property-read string $isbn The ISBN for the comic (generally only populated for collection formats).
 * @property-read string $upc The UPC barcode number for the comic (generally only populated for periodical formats).
 * @property-read string $diamondCode The Diamond code for the comic.
 * @property-read string $ean The EAN barcode for the comic.
 * @property-read string $issn The ISSN barcode for the comic.
 * @property-read string $format The publication format of the comic e.g. comic, hardcover, trade paperback.
 * @property-read integer $pageCount The number of story pages in the comic.
 * @property-read TextObject[] $textObjects A set of descriptive text blurbs for the comic.
 * @property-read string $resourceURI The canonical URL identifier for this resource.
 * @property-read Url[] $urls A set of public web site URLs for the resource.
 * @property-read Summary $series A summary representation of the series to which this comic belongs.
 * @property-read Summary[] $variants A list of variant issues for this comic (includes the "original" issue if the
 *                                    current issue is a variant).
 * @property-read Summary[] $collections A list of collections which include this comic (will generally be empty if the
 *                                       comic's format is a collection).
 * @property-read Summary[] $collectedIssues A list of issues collected in this comic (will generally be empty for
 *                                           periodical formats such as "comic" or "magazine").
 * @property-read Date[] $dates A list of key dates for this comic.
 * @property-read Price[] $prices A list of prices for this comic.
 * @property-read Image $thumbnail The representative image for this comic.
 * @property-read Image[] $images A list of promotional images associated with this comic.
 * @property-read ResourceList $creators A resource list containing the creators associated with this comic.
 * @property-read ResourceList $characters A resource list containing the characters which appear in this comic.
 * @property-read ResourceList $stories A resource list containing the stories which appear in this comic.
 * @property-read ResourceList $events A resource list containing the events in which this comic appears.
 */
class Comic extends AbstractEntity
{
    /**
     * The name of the comic API resource
     *
     * @const string
     */
    const API_RESOURCE = 'comics';

    /**
     * @see AbstractEntity::getFilters()
     *
     * @return array
     */
    final protected function getFilters() : array
    {
        return [
            'id' => [['int', true]],
            'digitalId' => [['int', true]],
            'title' => [['string', true, 0]],
            'issueNumber' => [['strval'], ['string', true, 0]],
            'variantDescription' => [['string', true, 0]],
            'description' => [['string', true, 0]],
            'modified' => [['date', true]],
            'isbn' => [['string', true, 0]],
            'upc' => [['string', true, 0]],
            'diamondCode' => [['string', true, 0]],
            'ean' => [['string', true, 0]],
            'issn' => [['string', true, 0]],
            'format' => [['string', true, 0]],
            'pageCount' => [['int', true]],
            'textObjects' => ['default' => [], ['text-objects']],
            'resourceURI' => [['string', true, 0]],
            'urls' => ['default' => [], ['_urls']],
            'series' => ['default' => new Summary(), ['summary']],
            'variants' => ['default' => [], ['summaries']],
            'collections' => ['default' => [], ['summaries']],
            'collectedIssues' => ['default' => [], ['summaries']],
            'dates' => ['default' => [], ['_dates']],
            'prices' => ['default' => [], ['prices']],
            'thumbnail' => ['default' => new Image(), ['image']],
            'images' => ['default' => [], ['images']],
            'creators' => ['default' => new ResourceList(), ['resource-list']],
            'characters' => ['default' => new ResourceList(), ['resource-list']],
            'stories' => ['default' => new ResourceList(), ['resource-list']],
            'events' => ['default' => new ResourceList(), ['resource-list']],
        ];
    }

    /**
     * Returns a collection containing all Comics which match the given criteria.
     *
     * @param Api\Client $client   The API Client.
     * @param array      $criteria The criteria for searching.
     *
     * @return Api\Collection
     */
    final public static function findAll(Api\Client $client, array $criteria = []) : Api\Collection

    {
        $filters = [
            'format' => [
                [
                    'in',
                    [
                        'comic',
                        'hardcover',
                        'trade paperback',
                        'magazine',
                        'digest',
                        'graphic novel',
                        'digital comic',
                        'infinite comic',
                    ]
                ],
            ],
            'formatType' => [['in', ['comic', 'collection']]],
            'noVariants' => [['bool'], ['bool-convert']],
            'dateDescriptor' => [['in', ['lastWeek', 'thisWeek', 'nextWeek', 'thisMonth']]],
            'fromDate' => [['date', true]],
            'toDate' => [['date', true]],
            'hasDigitalIssue' => [['bool'], ['bool-convert']],
            'modifiedSince' => [['date', true], ['date-format', 'c']],
            'creators' => [['ofScalars', [['uint']]], ['implode', ',']],
            'characters' => [['ofScalars', [['uint']]], ['implode', ',']],
            'series' => [['ofScalars', [['uint']]], ['implode', ',']],
            'events' => [['ofScalars', [['uint']]], ['implode', ',']],
            'stories' => [['ofScalars', [['uint']]], ['implode', ',']],
            'sharedAppearances' => [['ofScalars', [['uint']]], ['implode', ',']],
            'collaborators' => [['ofScalars', [['uint']]], ['implode', ',']],
            'orderBy' => [
                [
                    'in',
                    [
                        'focDate',
                        'onsaleDate',
                        'title',
                        'issueNumber',
                        'modified',
                        '-focDate',
                        '-onsaleDate',
                        '-title',
                        '-issueNumber',
                        '-modified',
                    ],
                ]
            ],

        ];

        list($success, $filteredCriteria, $error) = Api\Filterer::filter($filters, $criteria);
        Util::ensure(true, $success, $error);

        $toDate = Util\Arrays::get($filteredCriteria, 'toDate');
        $fromDate = Util\Arrays::get($filteredCriteria, 'fromDate');
        if ($toDate !== null && $fromDate !== null) {
            unset($filteredCriteria['toDate'], $filteredCriteria['fromDate']);
            $filteredCriteria['dateRange'] = "{$fromDate->format('c')},{$toDate->format('c')}";
        }

        return new Api\Collection($client, self::API_RESOURCE, $filteredCriteria);
    }
}


1			<?php
2
3			namespace Chadicus\Marvel\Api\Entities;
4
5			use Chadicus\Marvel\Api;
6			use DominionEnterprises\Util;
7
8			/**
9			* Represents a Marvel API Comic Entity
10			*
11			* @property-read integer $id The unique ID of the comic resource.
12			* @property-read integer $digitalId The ID of the digital comic representation of this comic. Will be if the comic is
13			* not available digitally.
14			* @property-read string $title The canonical title of the comic.
15			* @property-read string $issueNumber The number of the issue in the series (will generally be for collection formats).
16			* @property-read string $variantDescription If the issue is a variant (e.g. an alternate cover, second printing, or
17			* director's cut), a text description of the variant.
18			* @property-read string $description The preferred description of the comic.
19			* @property-read DateTime $modified The date the resource was most recently modified.
20			* @property-read string $isbn The ISBN for the comic (generally only populated for collection formats).
21			* @property-read string $upc The UPC barcode number for the comic (generally only populated for periodical formats).
22			* @property-read string $diamondCode The Diamond code for the comic.
23			* @property-read string $ean The EAN barcode for the comic.
24			* @property-read string $issn The ISSN barcode for the comic.
25			* @property-read string $format The publication format of the comic e.g. comic, hardcover, trade paperback.
26			* @property-read integer $pageCount The number of story pages in the comic.
27			* @property-read TextObject[] $textObjects A set of descriptive text blurbs for the comic.
28			* @property-read string $resourceURI The canonical URL identifier for this resource.
29			* @property-read Url[] $urls A set of public web site URLs for the resource.
30			* @property-read Summary $series A summary representation of the series to which this comic belongs.
31			* @property-read Summary[] $variants A list of variant issues for this comic (includes the "original" issue if the
32			* current issue is a variant).
33			* @property-read Summary[] $collections A list of collections which include this comic (will generally be empty if the
34			* comic's format is a collection).
35			* @property-read Summary[] $collectedIssues A list of issues collected in this comic (will generally be empty for
36			* periodical formats such as "comic" or "magazine").
37			* @property-read Date[] $dates A list of key dates for this comic.
38			* @property-read Price[] $prices A list of prices for this comic.
39			* @property-read Image $thumbnail The representative image for this comic.
40			* @property-read Image[] $images A list of promotional images associated with this comic.
41			* @property-read ResourceList $creators A resource list containing the creators associated with this comic.
42			* @property-read ResourceList $characters A resource list containing the characters which appear in this comic.
43			* @property-read ResourceList $stories A resource list containing the stories which appear in this comic.
44			* @property-read ResourceList $events A resource list containing the events in which this comic appears.
45			*/
46			class Comic extends AbstractEntity
47			{
48			/**
49			* The name of the comic API resource
50			*
51			* @const string
52			*/
53			const API_RESOURCE = 'comics';
54
55			/**
56			* @see AbstractEntity::getFilters()
57			*
58			* @return array
59			*/
60			final protected function getFilters() : array
61			{
62			return [
63			'id' => [['int', true]],
64			'digitalId' => [['int', true]],
65			'title' => [['string', true, 0]],
66			'issueNumber' => [['strval'], ['string', true, 0]],
67			'variantDescription' => [['string', true, 0]],
68			'description' => [['string', true, 0]],
69			'modified' => [['date', true]],
70			'isbn' => [['string', true, 0]],
71			'upc' => [['string', true, 0]],
72			'diamondCode' => [['string', true, 0]],
73			'ean' => [['string', true, 0]],
74			'issn' => [['string', true, 0]],
75			'format' => [['string', true, 0]],
76			'pageCount' => [['int', true]],
77			'textObjects' => ['default' => [], ['text-objects']],
78			'resourceURI' => [['string', true, 0]],
79			'urls' => ['default' => [], ['_urls']],
80			'series' => ['default' => new Summary(), ['summary']],
81			'variants' => ['default' => [], ['summaries']],
82			'collections' => ['default' => [], ['summaries']],
83			'collectedIssues' => ['default' => [], ['summaries']],
84			'dates' => ['default' => [], ['_dates']],
85			'prices' => ['default' => [], ['prices']],
86			'thumbnail' => ['default' => new Image(), ['image']],
87			'images' => ['default' => [], ['images']],
88			'creators' => ['default' => new ResourceList(), ['resource-list']],
89			'characters' => ['default' => new ResourceList(), ['resource-list']],
90			'stories' => ['default' => new ResourceList(), ['resource-list']],
91			'events' => ['default' => new ResourceList(), ['resource-list']],
92			];
93			}
94
95			/**
96			* Returns a collection containing all Comics which match the given criteria.
97			*
98			* @param Api\Client $client The API Client.
99			* @param array $criteria The criteria for searching.
100			*
101			* @return Api\Collection
102			*/
103			final public static function findAll(Api\Client $client, array $criteria = []) : Api\Collection
			0 ignored issues – show introduced 2017-02-01 00:10 UTC by Report Bug Copy Issue Report Method's length (62) exceeds 50, consider refactoring Loading history...
104			{
105			$filters = [
106			'format' => [
107			[
108			'in',
109			[
110			'comic',
111			'hardcover',
112			'trade paperback',
113			'magazine',
114			'digest',
115			'graphic novel',
116			'digital comic',
117			'infinite comic',
118			]
119			],
120			],
121			'formatType' => [['in', ['comic', 'collection']]],
122			'noVariants' => [['bool'], ['bool-convert']],
123			'dateDescriptor' => [['in', ['lastWeek', 'thisWeek', 'nextWeek', 'thisMonth']]],
124			'fromDate' => [['date', true]],
125			'toDate' => [['date', true]],
126			'hasDigitalIssue' => [['bool'], ['bool-convert']],
127			'modifiedSince' => [['date', true], ['date-format', 'c']],
128			'creators' => [['ofScalars', [['uint']]], ['implode', ',']],
129			'characters' => [['ofScalars', [['uint']]], ['implode', ',']],
130			'series' => [['ofScalars', [['uint']]], ['implode', ',']],
131			'events' => [['ofScalars', [['uint']]], ['implode', ',']],
132			'stories' => [['ofScalars', [['uint']]], ['implode', ',']],
133			'sharedAppearances' => [['ofScalars', [['uint']]], ['implode', ',']],
134			'collaborators' => [['ofScalars', [['uint']]], ['implode', ',']],
135			'orderBy' => [
136			[
137			'in',
138			[
139			'focDate',
140			'onsaleDate',
141			'title',
142			'issueNumber',
143			'modified',
144			'-focDate',
145			'-onsaleDate',
146			'-title',
147			'-issueNumber',
148			'-modified',
149			],
150			]
151			],
152
153			];
154
155			list($success, $filteredCriteria, $error) = Api\Filterer::filter($filters, $criteria);
156			Util::ensure(true, $success, $error);
157
158			$toDate = Util\Arrays::get($filteredCriteria, 'toDate');
159			$fromDate = Util\Arrays::get($filteredCriteria, 'fromDate');
160			if ($toDate !== null && $fromDate !== null) {
161			unset($filteredCriteria['toDate'], $filteredCriteria['fromDate']);
162			$filteredCriteria['dateRange'] = "{$fromDate->format('c')},{$toDate->format('c')}";
163			}
164
165			return new Api\Collection($client, self::API_RESOURCE, $filteredCriteria);
166			}
167			}
168

chadicus / marvel-api-client

Push — v3.x ( a479f4...cb2cf1 )

Comic::findAll() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like