Result::jsonSerialize() - Code Metrics - Inspection of "notification, message and adapter parameter consta..." - juliangut/tify - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 2.x (c99d86)

by Julián

created 2016-10-12 17:02 UTC

Result::jsonSerialize() A

↳ Parent: Result

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0

<?php

/*
 * Unified push notification services abstraction (http://github.com/juliangut/tify).
 *
 * @license BSD-3-Clause
 * @link https://github.com/juliangut/tify
 * @author Julián Gutiérrez <[email protected]>
 */

namespace Jgut\Tify;

/**
 * Push result abstraction.
 */
class Result implements \JsonSerializable
{
    const STATUS_SUCCESS = 'success';
    const STATUS_INVALID_DEVICE = 'invalidDevice';
    const STATUS_INVALID_MESSAGE = 'invalidMessage';
    const STATUS_RATE_ERROR = 'rateError';
    const STATUS_AUTH_ERROR = 'authError';
    const STATUS_SERVER_ERROR = 'serverError';
    const STATUS_UNKNOWN_ERROR = 'unknownError';

    /**
     * Device token.
     *
     * @var string
     */
    protected $token;

    /**
     * Result time.
     *
     * @var \DateTime
     */
    protected $date;

    /**
     * Result status.
     *
     * @var string
     */
    protected $status;

    /**
     * Result status message.
     *
     * @var string
     */
    protected $statusMessage;

    /**
     * @param string    $token
     * @param \DateTime $date
     * @param string    $status
     * @param string    $statusMessage

     *
     * @throws \InvalidArgumentException
     */
    public function __construct(
        $token,
        \DateTime $date,
        $status = self::STATUS_SUCCESS,
        $statusMessage = null
    ) {
        $this->token = $token;
        $this->setDate($date);
        $this->setStatus($status);
        $this->setStatusMessage($statusMessage);
    }

    /**
     * Retrieve result device token.
     *
     * @return string
     */
    public function getToken()
    {
        return $this->token;
    }

    /**
     * Set result device token.
     *
     * @param string $token
     *
     * @return $this
     */
    public function setToken($token)
    {
        $this->token = trim($token);

        return $this;
    }

    /**
     * Retrieve result time.
     *
     * @return \DateTime
     */
    public function getDate()
    {
        return $this->date;
    }

    /**
     * Set result time.
     *
     * @param \DateTime $date
     *
     * @return $this
     */
    public function setDate(\DateTime $date)
    {
        $this->date = clone $date;

        return $this;
    }

    /**
     * Retrieve result status.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Check successful status.
     *
     * @return bool
     */
    public function isSuccess()
    {
        return $this->status === static::STATUS_SUCCESS;
    }

    /**
     * Check error status.
     *
     * @return bool
     */
    public function isError()
    {
        return $this->status !== static::STATUS_SUCCESS;
    }

    /**
     * Set result status.
     *
     * @param string $status
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setStatus($status)
    {
        $self = new \ReflectionClass(static::class);
        if (!in_array($status, $self->getConstants())) {
            throw new \InvalidArgumentException(sprintf('"%s" is not a valid status', $status));
        }

        $this->status = $status;

        return $this;
    }

    /**
     * Retrieve result status message.
     *
     * @return string
     */
    public function getStatusMessage()
    {
        return $this->statusMessage;
    }

    /**
     * Check successful status message.
     *
     * @param string $statusMessage

     *
     * @return $this
     */
    public function setStatusMessage($statusMessage = null)
    {
        $this->statusMessage = $statusMessage !== null ? trim($statusMessage) : null;

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @return string[]

     */
    public function jsonSerialize()
    {
        return [
            'token' => $this->token,
            'date' => $this->date->format('c'),
            'status' => $this->status,
            'statusMessage' => $this->statusMessage,
        ];
    }
}


1			<?php
2
3			/*
4			* Unified push notification services abstraction (http://github.com/juliangut/tify).
5			*
6			* @license BSD-3-Clause
7			* @link https://github.com/juliangut/tify
8			* @author Julián Gutiérrez <[email protected]>
9			*/
10
11			namespace Jgut\Tify;
12
13			/**
14			* Push result abstraction.
15			*/
16			class Result implements \JsonSerializable
17			{
18			const STATUS_SUCCESS = 'success';
19			const STATUS_INVALID_DEVICE = 'invalidDevice';
20			const STATUS_INVALID_MESSAGE = 'invalidMessage';
21			const STATUS_RATE_ERROR = 'rateError';
22			const STATUS_AUTH_ERROR = 'authError';
23			const STATUS_SERVER_ERROR = 'serverError';
24			const STATUS_UNKNOWN_ERROR = 'unknownError';
25
26			/**
27			* Device token.
28			*
29			* @var string
30			*/
31			protected $token;
32
33			/**
34			* Result time.
35			*
36			* @var \DateTime
37			*/
38			protected $date;
39
40			/**
41			* Result status.
42			*
43			* @var string
44			*/
45			protected $status;
46
47			/**
48			* Result status message.
49			*
50			* @var string
51			*/
52			protected $statusMessage;
53
54			/**
55			* @param string $token
56			* @param \DateTime $date
57			* @param string $status
58			* @param string $statusMessage
			0 ignored issues – show Documentation introduced 2016-05-05 11:59 UTC by Report Bug Copy Issue Report Should the type for parameter `$statusMessage` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
59			*
60			* @throws \InvalidArgumentException
61			*/
62			public function __construct(
63			$token,
64			\DateTime $date,
65			$status = self::STATUS_SUCCESS,
66			$statusMessage = null
67			) {
68			$this->token = $token;
69			$this->setDate($date);
70			$this->setStatus($status);
71			$this->setStatusMessage($statusMessage);
72			}
73
74			/**
75			* Retrieve result device token.
76			*
77			* @return string
78			*/
79			public function getToken()
80			{
81			return $this->token;
82			}
83
84			/**
85			* Set result device token.
86			*
87			* @param string $token
88			*
89			* @return $this
90			*/
91			public function setToken($token)
92			{
93			$this->token = trim($token);
94
95			return $this;
96			}
97
98			/**
99			* Retrieve result time.
100			*
101			* @return \DateTime
102			*/
103			public function getDate()
104			{
105			return $this->date;
106			}
107
108			/**
109			* Set result time.
110			*
111			* @param \DateTime $date
112			*
113			* @return $this
114			*/
115			public function setDate(\DateTime $date)
116			{
117			$this->date = clone $date;
118
119			return $this;
120			}
121
122			/**
123			* Retrieve result status.
124			*
125			* @return string
126			*/
127			public function getStatus()
128			{
129			return $this->status;
130			}
131
132			/**
133			* Check successful status.
134			*
135			* @return bool
136			*/
137			public function isSuccess()
138			{
139			return $this->status === static::STATUS_SUCCESS;
140			}
141
142			/**
143			* Check error status.
144			*
145			* @return bool
146			*/
147			public function isError()
148			{
149			return $this->status !== static::STATUS_SUCCESS;
150			}
151
152			/**
153			* Set result status.
154			*
155			* @param string $status
156			*
157			* @throws \InvalidArgumentException
158			*
159			* @return $this
160			*/
161			public function setStatus($status)
162			{
163			$self = new \ReflectionClass(static::class);
164			if (!in_array($status, $self->getConstants())) {
165			throw new \InvalidArgumentException(sprintf('"%s" is not a valid status', $status));
166			}
167
168			$this->status = $status;
169
170			return $this;
171			}
172
173			/**
174			* Retrieve result status message.
175			*
176			* @return string
177			*/
178			public function getStatusMessage()
179			{
180			return $this->statusMessage;
181			}
182
183			/**
184			* Check successful status message.
185			*
186			* @param string $statusMessage
			0 ignored issues – show Documentation introduced 2016-10-12 17:10 UTC by Report Bug Copy Issue Report Should the type for parameter `$statusMessage` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
187			*
188			* @return $this
189			*/
190			public function setStatusMessage($statusMessage = null)
191			{
192			$this->statusMessage = $statusMessage !== null ? trim($statusMessage) : null;
193
194			return $this;
195			}
196
197			/**
198			* {@inheritdoc}
199			*
200			* @return string[]
			0 ignored issues – show Documentation introduced 2016-07-08 06:14 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
201			*/
202			public function jsonSerialize()
203			{
204			return [
205			'token' => $this->token,
206			'date' => $this->date->format('c'),
207			'status' => $this->status,
208			'statusMessage' => $this->statusMessage,
209			];
210			}
211			}
212

juliangut / tify

Branch — 2.x (c99d86)

Result::jsonSerialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like