BenatEspina\StackExchangeApiClient\Model\Notification

Complexity

Total Complexity

21

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	2

14 Methods

Rating	Name	Duplication	Size	Complexity
A	fromProperties()	0	19	1
B	fromJson()	0	17	7
A	setBody()	0	6	1
A	getBody()	0	4	1
A	setCreationDate()	0	6	1
A	getCreationDate()	0	4	1
A	setUnread()	0	6	1
A	isUnread()	0	4	1
A	setNotificationType()	0	8	2
A	getNotificationType()	0	4	1
A	setPostId()	0	6	1
A	getPostId()	0	4	1
A	setSite()	0	6	1
A	getSite()	0	4	1

<?php

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

namespace BenatEspina\StackExchangeApiClient\Model;

/**
 * The notification model class.
 *
 * @author Beñat Espiña <benatespina@gmail.com>
 */
class Notification implements Model
{
    const NOTIFICATION_TYPES = [
        'accounts_associated',
        'badge_earned',
        'bounty_expired',
        'bounty_expires_in_one_day',
        'bounty_expires_in_three_days',
        'bounty_period_started',
        'edit_suggested',
        'generic',
        'moderator_message',
        'new_privileges',
        'post_migrated',
        'profile_activity',
        'registration_reminder',
        'reputation_bonus',
        'substantive_edit',
    ];

    protected $body;
    protected $creationDate;
    protected $isUnread;
    protected $notificationType;
    protected $postId;
    protected $site;

    public static function fromProperties(
        $body,
        $creationDate,
        $isUnread,
        $notificationType,
        $postId,
        Site $site
    ) {
        $instance = new self();
        $instance
            ->setBody($body)
            ->setCreationDate($creationDate)
            ->setUnread($isUnread)
            ->setNotificationType($notificationType)
            ->setPostId($postId)
            ->setSite($site);

        return $instance;
    }

    public static function fromJson(array $data)
    {
        $instance = new self();
        $instance
            ->setBody(array_key_exists('body', $data) ? $data['body'] : null)
            ->setCreationDate(
                array_key_exists('creation_date', $data)
                    ? new \DateTimeImmutable('@' . $data['creation_date'])
                    : null
            )
            ->setUnread(array_key_exists('is_unread', $data) ? $data['is_unread'] : null)
            ->setNotificationType(array_key_exists('notification_type', $data) ? $data['notification_type'] : null)
            ->setPostId(array_key_exists('post_id', $data) ? $data['post_id'] : null)
            ->setSite(array_key_exists('site', $data) ? Site::fromJson($data['site']) : null);

It seems like array_key_exists('site', $data) ? \BenatEspina\StackExchangeApiClient\Model\Site::fromJson($data['site']) : null can also be of type object<BenatEspina\StackExchangeApiClient\Model\Model>; however, BenatEspina\StackExchangeApiClient\Model\Notification::setSite() does only seem to accept null|object<BenatEspina\StackExchangeApiClient\Model\Site>, maybe add an additional type check?

        return $instance;
    }

    public function setBody($body)
    {
        $this->body = $body;

        return $this;
    }

    public function getBody()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->body;
    }

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

        return $this;
    }

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

    public function setUnread($isUnread)
    {
        $this->isUnread = $isUnread;

        return $this;
    }

    public function isUnread()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->isUnread;
    }

    public function setNotificationType($notificationType)
    {
        if (in_array($notificationType, self::NOTIFICATION_TYPES, true)) {
            $this->notificationType = $notificationType;
        }

        return $this;
    }

    public function getNotificationType()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->notificationType;
    }

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

        return $this;
    }

    public function getPostId()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->postId;
    }

    public function setSite(Site $site = null)
    {
        $this->site = $site;

        return $this;
    }

    public function getSite()
    {
        return $this->site;
    }
}