Slince\ShipmentTracking\Foundation\ShipmentEvent

Complexity

Total Complexity

21

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getDate()	0	4	1
A	setDate()	0	8	2
A	getTime()	0	4	1
A	setTime()	0	8	2
A	getDescription()	0	4	1
A	setDescription()	0	5	1
A	getLocation()	0	4	1
A	setLocation()	0	5	1
A	getStatus()	0	4	1
A	setStatus()	0	5	1
A	fromArray()	0	10	3
A	toArray()	0	15	4
A	jsonSerialize()	0	4	1

<?php
/**
 * Slince shipment tracker library
 * @author Tao <taosikai@yeah.net>
 */
namespace Slince\ShipmentTracking\Foundation;

use Carbon\Carbon;
use Slince\ShipmentTracking\Foundation\Location\LocationInterface;

class ShipmentEvent implements \JsonSerializable
{
    /**
     * @var \DateTime
     * @deprecated
     */
    protected $date;

    /**
     * @var string
     */
    protected $description;

    /**
     * @var string|LocationInterface
     */
    protected $location;

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

    /**
     * @var \DateTime
     */
    protected $time;

    public function __construct(\DateTime $time = null, $description = null, $location = null)
    {
        $this->setTime($time);

It seems like $time defined by parameter $time on line 39 can be null; however, Slince\ShipmentTracking\Foundation\ShipmentEvent::setTime() does not accept null, maybe add an additional type check?

        $this->description = $description;
        $this->location = $location;
    }

    /**
     * @return \DateTime
     * @deprecated
     */
    public function getDate()
    {
        return $this->date;

The property Slince\ShipmentTracking\Foundation\ShipmentEvent::$date has been deprecated.

    }

    /**
     * @param \DateTime $date
     * @return ShipmentEvent
     * @deprecated
     */
    public function setDate($date)
    {
        if (!$date instanceof \DateTime) {
            $date = Carbon::parse($date);
        }
        $this->setTime($date);
        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getTime()
    {
        return $this->time;
    }

    /**
     * @param \DateTime $time
     * @return ShipmentEvent
     */
    public function setTime($time)
    {
        $this->time = $time;
        if ($time) {
            $this->date = $time->format('Y-m-d H:i:s');

It seems like $time->format('Y-m-d H:i:s') of type string is incompatible with the declared type object<DateTime> of property $date.

The property Slince\ShipmentTracking\Foundation\ShipmentEvent::$date has been deprecated.

        }
        return $this;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     * @return ShipmentEvent
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    /**
     * @return string|LocationInterface
     */
    public function getLocation()
    {
        return $this->location;
    }

    /**
     * @param string|LocationInterface $location
     * @return ShipmentEvent
     */
    public function setLocation($location)
    {
        $this->location = $location;
        return $this;
    }

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

    /**
     * @param string $status
     * @return ShipmentEvent
     */
    public function setStatus($status)
    {
        $this->status = $status;
        return $this;
    }

    /**
     * Creates an event from an array
     * @param array $data
     * @return static
     */
    public static function fromArray($data)
    {
        $event = new static();
        foreach ($data as $property => $value) {
            if (method_exists($event, $method = 'set' . ucfirst($property))) {
                $event->$method($value);
            }
        }
        return $event;
    }

    /**
     * Converts the event to array
     * @return array
     */
    public function toArray()
    {
        $methods = get_class_methods($this);
        $data = [];
        foreach ($methods as $method) {
            if (substr($method, 0, 3) == 'get') {
                $property = lcfirst(substr($method, 3));
                $data[$property] = $this->$method();
            } elseif (substr($method, 0, 2) == 'is') {
                $property = lcfirst(substr($method, 2));
                $data[$property] = $this->$method();
            }
        }
        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }
}