ShippoClient\Entity\TrackingStatus

Complexity

Total Complexity

7

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	7
Bugs	1	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getObjectCreated()	0	4	1
A	getObjectUpdated()	0	4	1
A	getStatusDate()	0	4	1
A	getObjectId()	0	4	1
A	getStatus()	0	4	1
A	getLocation()	0	5	1
A	toArray()	0	12	1

<?php

namespace ShippoClient\Entity;

use TurmericSpice\ReadableAttributes;

class TrackingStatus
{
    use ReadableAttributes {
        mayHaveAsString as public getStatusDetails;
        toArray as __toArray;
    }

    /**
     * Date and time of object creation.
     *
     * @return \DateTime
     */
    public function getObjectCreated()
    {
        return $this->attributes->mayHave('object_created')->asInstanceOf('\\DateTime');

The property attributes does not exist. Did you maybe forget to declare it?

    }

    /**
     * Date and time of last object update.
     *
     * @return \DateTime
     */
    public function getObjectUpdated()
    {
        return $this->attributes->mayHave('object_updated')->asInstanceOf('\\DateTime');
    }

    /**
     * Date and time when the carrier has scanned this tracking event.
     *
     * @return \DateTime
     */
    public function getStatusDate()
    {
        return $this->attributes->mayHave('status_date')->asInstanceOf('\\DateTime');
    }

    /**
     * Unique identifier of the given object.
     *
     * @return string
     */
    public function getObjectId()
    {
        return $this->attributes->mayHave('object_id')->asString();
    }

    /**
     * Package status.
     *  - "UNKNOWN"   The package has not been found via the carrier's tracking system,
     *                or it has been found but not yet scanned by the carrier.
     *  - "TRANSIT"   The package has been scanned by the carrier and is in transit.
     *  - "DELIVERED" The package has been successfully delivered.
     *  - "RETURNED"  The package is en route to be returned to the sender, or has been returned successfully.
     *  - "FAILURE"   The carrier indicated that there has been an issue with the delivery.
     *                This can happen for various reasons and depends on the carrier.
     *                This status does not indicate a technical error, but rather a delivery issue.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->attributes->mayHave('status')->asString();
    }

    /**
     * @return Location
     */
    public function getLocation()
    {
        $attributes = $this->attributes->mayHave('location')->asArray();
        return new Location($attributes);
    }

    public function toArray()
    {
        return [
            'object_created' => $this->getObjectCreated(),
            'object_updated' => $this->getObjectUpdated(),
            'object_id'      => $this->getObjectId(),
            'status'         => $this->getStatus(),
            'status_date'    => $this->getStatusDate(),
            'status_details' => $this->getStatusDetails(),
            'location'       => $this->getLocation()->toArray(),
        ];
    }
}