DataWrapper::getCopyright() - Code Metrics - Inspection of "Update README" - chadicus/marvel-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Branch — v3.x (aec8e0)

by Chad

created 2017-04-01 18:34 UTC

DataWrapper::getCopyright() A

↳ Parent: DataWrapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Chadicus\Marvel\Api;

use DominionEnterprises\Util;

/**
 * Object representation of the API result data wrapper.
 */
class DataWrapper implements DataWrapperInterface
{
    /**
     * The HTTP status code of the returned result.
     *
     * @var integer
     */
    private $code;

    /**
     * A string description of the call status.
     *
     * @var string
     */
    private $status;

    /**
     * The copyright notice for the returned result.
     *
     * @var string
     */
    private $copyright;

    /**
     * The attribution notice for this result
     *
     * @var string
     */
    private $attributionText;

    /**
     * An HTML representation of the attribution notice for this result.
     *
     * @var string
     */
    private $attributionHTML;

    /**
     * A digest value of the content returned by the call.
     *
     * @var string
     */
    private $etag;

    /**
     * The results returned by the call.
     *
     * @var DataContainer
     */
    private $data;

    /**
     * Create a new DataWrapper instance.
     *
     * @param array $input The data for the DataWrapper.
     */
    public function __construct(array $input)
    {
        $filters = [
            'code' => [['int', true]],
            'status' => [['string', true]],
            'copyright' => [['string', true]],
            'attributionText' => [['string', true]],
            'attributionHTML' => [['string', true]],
            'etag' => [['string', true]],
            'data' => ['default' => [], ['array', 0]],
        ];

        list($success, $filteredInput, $error) = Filterer::filter($filters, $input, ['allowUnknowns' => true]);
        Util::ensure(true, $success, $error);

        foreach ($filteredInput as $key => $value) {
            $this->$key = $value;
        }

        $this->data = new DataContainer($filteredInput['data']);
    }

    /**
     * Construct a DataWrapper from the given JSON string.
     *
     * @param string $json The json encoded data.
     *
     * @return static
     */
    public static function fromJson(string $json)

    {
        return new static(json_decode($json, true));
    }

    /**
     * Returns the HTTP status code of the returned result.
     *
     * @return integer
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Returns A string description of the call status.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Returns the copyright notice for the returned result.
     *
     * @return string
     */
    public function getCopyright()
    {
        return $this->copyright;
    }

    /**
     * Returns the attribution notice for this result
     *
     * @return string
     */
    public function getAttributionText()
    {
        return $this->attributionText;
    }

    /**
     * Returns an HTML representation of the attribution notice for this result.
     *
     * @return string
     */
    public function getAttributionHTML()
    {
        return $this->attributionHTML;
    }

    /**
     * Returns a digest value of the content returned by the call.
     *
     * @return string
     */
    public function getEtag()
    {
        return $this->etag;
    }

    /**
     * Returns the results returned by the call.
     *
     * @return DataContainer
     */
    public function getData()
    {
        return $this->data;
    }
}


1			<?php
2
3			namespace Chadicus\Marvel\Api;
4
5			use DominionEnterprises\Util;
6
7			/**
8			* Object representation of the API result data wrapper.
9			*/
10			class DataWrapper implements DataWrapperInterface
11			{
12			/**
13			* The HTTP status code of the returned result.
14			*
15			* @var integer
16			*/
17			private $code;
18
19			/**
20			* A string description of the call status.
21			*
22			* @var string
23			*/
24			private $status;
25
26			/**
27			* The copyright notice for the returned result.
28			*
29			* @var string
30			*/
31			private $copyright;
32
33			/**
34			* The attribution notice for this result
35			*
36			* @var string
37			*/
38			private $attributionText;
39
40			/**
41			* An HTML representation of the attribution notice for this result.
42			*
43			* @var string
44			*/
45			private $attributionHTML;
46
47			/**
48			* A digest value of the content returned by the call.
49			*
50			* @var string
51			*/
52			private $etag;
53
54			/**
55			* The results returned by the call.
56			*
57			* @var DataContainer
58			*/
59			private $data;
60
61			/**
62			* Create a new DataWrapper instance.
63			*
64			* @param array $input The data for the DataWrapper.
65			*/
66			public function __construct(array $input)
67			{
68			$filters = [
69			'code' => [['int', true]],
70			'status' => [['string', true]],
71			'copyright' => [['string', true]],
72			'attributionText' => [['string', true]],
73			'attributionHTML' => [['string', true]],
74			'etag' => [['string', true]],
75			'data' => ['default' => [], ['array', 0]],
76			];
77
78			list($success, $filteredInput, $error) = Filterer::filter($filters, $input, ['allowUnknowns' => true]);
79			Util::ensure(true, $success, $error);
80
81			foreach ($filteredInput as $key => $value) {
82			$this->$key = $value;
83			}
84
85			$this->data = new DataContainer($filteredInput['data']);
86			}
87
88			/**
89			* Construct a DataWrapper from the given JSON string.
90			*
91			* @param string $json The json encoded data.
92			*
93			* @return static
94			*/
95			public static function fromJson(string $json)
			0 ignored issues – show Coding Style introduced 2017-02-01 17:35 UTC by Report Bug Copy Issue Report Unknown type hint "string" found for $json Loading history...
96			{
97			return new static(json_decode($json, true));
98			}
99
100			/**
101			* Returns the HTTP status code of the returned result.
102			*
103			* @return integer
104			*/
105			public function getCode()
106			{
107			return $this->code;
108			}
109
110			/**
111			* Returns A string description of the call status.
112			*
113			* @return string
114			*/
115			public function getStatus()
116			{
117			return $this->status;
118			}
119
120			/**
121			* Returns the copyright notice for the returned result.
122			*
123			* @return string
124			*/
125			public function getCopyright()
126			{
127			return $this->copyright;
128			}
129
130			/**
131			* Returns the attribution notice for this result
132			*
133			* @return string
134			*/
135			public function getAttributionText()
136			{
137			return $this->attributionText;
138			}
139
140			/**
141			* Returns an HTML representation of the attribution notice for this result.
142			*
143			* @return string
144			*/
145			public function getAttributionHTML()
146			{
147			return $this->attributionHTML;
148			}
149
150			/**
151			* Returns a digest value of the content returned by the call.
152			*
153			* @return string
154			*/
155			public function getEtag()
156			{
157			return $this->etag;
158			}
159
160			/**
161			* Returns the results returned by the call.
162			*
163			* @return DataContainer
164			*/
165			public function getData()
166			{
167			return $this->data;
168			}
169			}
170

chadicus / marvel-api-client

Branch — v3.x (aec8e0)

DataWrapper::getCopyright() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like