QuestionTimeline::getOwner() - Code Metrics - Inspection of "Fixed typo" - benatespina/StackExchangeApiClient - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v2 ( 9b4b78...68097e )

by Beñat

created 2016-09-12 15:40 UTC

QuestionTimeline::getOwner() A

↳ Parent: QuestionTimeline

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
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the Stack Exchange Api Client library.
 *
 * Copyright (c) 2014-2016 Beñat Espiña <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace BenatEspina\StackExchangeApiClient\Model;

/**
 * Class question timeline model class.
 *
 * @author Beñat Espiña <[email protected]>
 */
class QuestionTimeline implements Model
{
    const TIMELINE_TYPES = [
        'accepted_answer',
        'answer',
        'comment',
        'post_state_changed',
        'question',
        'revision',
        'unaccepted_answer',
        'vote_aggregate',
    ];

    protected $downVoteCount;
    protected $upVoteCount;
    protected $commentId;
    protected $creationDate;
    protected $owner;
    protected $postId;
    protected $questionId;
    protected $revisionGuid;
    protected $timelineType;
    protected $user;

    public static function fromJson(array $data)
    {
        $instance = new self();
        $instance
            ->setDownVoteCount(array_key_exists('down_vote_count', $data) ? $data['down_vote_count'] : null)
            ->setUpVoteCount(array_key_exists('up_vote_count', $data) ? $data['up_vote_count'] : null)
            ->setCommentId(array_key_exists('comment_id', $data) ? $data['comment_id'] : null)
            ->setCreationDate(
                array_key_exists('creation_date', $data)
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                    ? new \DateTimeImmutable('@' . $data['creation_date'])
                    : null
            )
            ->setOwner(array_key_exists('owner', $data) ? $data['owner'] : null)
            ->setPostId(array_key_exists('post_id', $data) ? $data['post_id'] : null)
            ->setQuestionId(array_key_exists('question_id', $data) ? $data['question_id'] : null)
            ->setRevisionGuid(array_key_exists('revision_guid', $data) ? $data['revision_guid'] : null)
            ->setTimelineType(array_key_exists('timeline_type', $data) ? $data['timeline_type'] : null)
            ->setUser(array_key_exists('user', $data) ? $data['user'] : null);

        return $instance;
    }

    public static function fromProperties(
        $downVoteCount,
        $upVoteCount,
        $commentId,
        \DateTimeInterface $creationDate,
        ShallowUser $owner,
        $postId,
        $questionId,
        $revisionGuid,
        $timelineType,
        ShallowUser $user
    ) {
        $instance = new self();
        $instance
            ->setDownVoteCount($downVoteCount)
            ->setUpVoteCount($upVoteCount)
            ->setCommentId($commentId)
            ->setCreationDate($creationDate)
            ->setOwner($owner)
            ->setPostId($postId)
            ->setQuestionId($questionId)
            ->setRevisionGuid($revisionGuid)
            ->setTimelineType($timelineType)
            ->setUser($user);

        return $instance;
    }

    public function setDownVoteCount($downVoteCount)
    {
        $this->downVoteCount = $downVoteCount;

        return $this;
    }

    public function getDownVoteCount()

    {
        return $this->downVoteCount;
    }

    public function setUpVoteCount($upVoteCount)
    {
        $this->upVoteCount = $upVoteCount;

        return $this;
    }

    public function getUpVoteCount()

    {
        return $this->upVoteCount;
    }

    public function setCommentId($commentId)
    {
        $this->commentId = $commentId;

        return $this;
    }

    public function getCommentId()

    {
        return $this->commentId;
    }

    public function setCreationDate(\DateTimeInterface $creationDate)
    {
        $this->creationDate = $creationDate;

        return $this;
    }

    public function getCreationDate()
    {
        return $this->creationDate;
    }

    public function setOwner(ShallowUser $owner)
    {
        $this->owner = $owner;

        return $this;
    }

    public function getOwner()
    {
        return $this->owner;
    }

    public function setPostId($postId)
    {
        $this->postId = $postId;

        return $this;
    }

    public function getPostId()

    {
        return $this->postId;
    }

    public function setQuestionId($questionId)
    {
        $this->questionId = $questionId;

        return $this;
    }

    public function getQuestionId()

    {
        return $this->questionId;
    }

    public function setRevisionGuid($revisionGuid)
    {
        $this->revisionGuid = $revisionGuid;

        return $this;
    }

    public function getRevisionGuid()

    {
        return $this->revisionGuid;
    }

    public function setTimelineType($timelineType)
    {
        if (in_array($timelineType, self::TIMELINE_TYPES, true)) {
            $this->timelineType = $timelineType;
        }

        return $this;
    }

    public function getTimelineType()

    {
        return $this->timelineType;
    }

    public function setUser(ShallowUser $user)
    {
        $this->user = $user;

        return $this;
    }

    public function getUser()
    {
        return $this->user;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Stack Exchange Api Client library.
5			*
6			* Copyright (c) 2014-2016 Beñat Espiña <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace BenatEspina\StackExchangeApiClient\Model;
13
14			/**
15			* Class question timeline model class.
16			*
17			* @author Beñat Espiña <[email protected]>
18			*/
19			class QuestionTimeline implements Model
20			{
21			const TIMELINE_TYPES = [
22			'accepted_answer',
23			'answer',
24			'comment',
25			'post_state_changed',
26			'question',
27			'revision',
28			'unaccepted_answer',
29			'vote_aggregate',
30			];
31
32			protected $downVoteCount;
33			protected $upVoteCount;
34			protected $commentId;
35			protected $creationDate;
36			protected $owner;
37			protected $postId;
38			protected $questionId;
39			protected $revisionGuid;
40			protected $timelineType;
41			protected $user;
42
43			public static function fromJson(array $data)
44			{
45			$instance = new self();
46			$instance
47			->setDownVoteCount(array_key_exists('down_vote_count', $data) ? $data['down_vote_count'] : null)
48			->setUpVoteCount(array_key_exists('up_vote_count', $data) ? $data['up_vote_count'] : null)
49			->setCommentId(array_key_exists('comment_id', $data) ? $data['comment_id'] : null)
50			->setCreationDate(
51			array_key_exists('creation_date', $data)
			0 ignored issues – show Bug introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report It seems like `array_key_exists('creati...creation_date']) : null` can be `null`; however, `setCreationDate()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
52			? new \DateTimeImmutable('@' . $data['creation_date'])
53			: null
54			)
55			->setOwner(array_key_exists('owner', $data) ? $data['owner'] : null)
56			->setPostId(array_key_exists('post_id', $data) ? $data['post_id'] : null)
57			->setQuestionId(array_key_exists('question_id', $data) ? $data['question_id'] : null)
58			->setRevisionGuid(array_key_exists('revision_guid', $data) ? $data['revision_guid'] : null)
59			->setTimelineType(array_key_exists('timeline_type', $data) ? $data['timeline_type'] : null)
60			->setUser(array_key_exists('user', $data) ? $data['user'] : null);
61
62			return $instance;
63			}
64
65			public static function fromProperties(
66			$downVoteCount,
67			$upVoteCount,
68			$commentId,
69			\DateTimeInterface $creationDate,
70			ShallowUser $owner,
71			$postId,
72			$questionId,
73			$revisionGuid,
74			$timelineType,
75			ShallowUser $user
76			) {
77			$instance = new self();
78			$instance
79			->setDownVoteCount($downVoteCount)
80			->setUpVoteCount($upVoteCount)
81			->setCommentId($commentId)
82			->setCreationDate($creationDate)
83			->setOwner($owner)
84			->setPostId($postId)
85			->setQuestionId($questionId)
86			->setRevisionGuid($revisionGuid)
87			->setTimelineType($timelineType)
88			->setUser($user);
89
90			return $instance;
91			}
92
93			public function setDownVoteCount($downVoteCount)
94			{
95			$this->downVoteCount = $downVoteCount;
96
97			return $this;
98			}
99
100			public function getDownVoteCount()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
101			{
102			return $this->downVoteCount;
103			}
104
105			public function setUpVoteCount($upVoteCount)
106			{
107			$this->upVoteCount = $upVoteCount;
108
109			return $this;
110			}
111
112			public function getUpVoteCount()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
113			{
114			return $this->upVoteCount;
115			}
116
117			public function setCommentId($commentId)
118			{
119			$this->commentId = $commentId;
120
121			return $this;
122			}
123
124			public function getCommentId()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
125			{
126			return $this->commentId;
127			}
128
129			public function setCreationDate(\DateTimeInterface $creationDate)
130			{
131			$this->creationDate = $creationDate;
132
133			return $this;
134			}
135
136			public function getCreationDate()
137			{
138			return $this->creationDate;
139			}
140
141			public function setOwner(ShallowUser $owner)
142			{
143			$this->owner = $owner;
144
145			return $this;
146			}
147
148			public function getOwner()
149			{
150			return $this->owner;
151			}
152
153			public function setPostId($postId)
154			{
155			$this->postId = $postId;
156
157			return $this;
158			}
159
160			public function getPostId()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
161			{
162			return $this->postId;
163			}
164
165			public function setQuestionId($questionId)
166			{
167			$this->questionId = $questionId;
168
169			return $this;
170			}
171
172			public function getQuestionId()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
173			{
174			return $this->questionId;
175			}
176
177			public function setRevisionGuid($revisionGuid)
178			{
179			$this->revisionGuid = $revisionGuid;
180
181			return $this;
182			}
183
184			public function getRevisionGuid()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
185			{
186			return $this->revisionGuid;
187			}
188
189			public function setTimelineType($timelineType)
190			{
191			if (in_array($timelineType, self::TIMELINE_TYPES, true)) {
192			$this->timelineType = $timelineType;
193			}
194
195			return $this;
196			}
197
198			public function getTimelineType()
			0 ignored issues – show Documentation introduced 2016-09-12 15:44 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
199			{
200			return $this->timelineType;
201			}
202
203			public function setUser(ShallowUser $user)
204			{
205			$this->user = $user;
206
207			return $this;
208			}
209
210			public function getUser()
211			{
212			return $this->user;
213			}
214			}
215

benatespina / StackExchangeApiClient

Push — v2 ( 9b4b78...68097e )

QuestionTimeline::getOwner() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like