<?php
/**
* PHP version 7.1.1
* @author Hannes Kindströmmer <hannes@kindstrommer.se>
* @copyright 2017 iP.1 Networks AB
* @license https://www.gnu.org/licenses/lgpl-3.0.txt LGPL-3.0
* @version 0.3.0-beta
* @since File available since Release 0.1.0-beta
* @link http://api.ip1sms.com/Help
* @link https://github.com/iP1SMS/ip1-php-sdk
*/
namespace IP1\RESTClient\Recipient;

use IP1\RESTClient\Core\UpdatableComponentInterface;
use IP1\RESTClient\Recipient\Membership;
use IP1\RESTClient\Recipient\RecipientFactory;
use IP1\RESTClient\Recipient\MembershipRelationInterface;
use IP1\RESTClient\Core\Communicator;
use IP1\RESTClient\Core\ClassValidationArray;
use IP1\RESTClient\Core\OwnableInterface;

/**
* A Contact that has been added to the API. Has all the options that a normal Contact has.
*/
class ProcessedContact extends Contact implements
    UpdatableComponentInterface,
    MembershipRelationInterface,
    OwnableInterface
{
    /**
    * The ID of the Contact given by the API.
    * @var integer $contactID
    */
    private $contactID;
    /**
    * When the Contact was created.
    * @var \DateTime $created
    */
    private $created;
    /**
    * When the Contact was last updated.
    * @var \DateTime $updated
    */
    private $updated;

    /**
    * The Account ID  of the Contact's owner.
    * @var string $ownerID
    */
    private $ownerID;
    /**
    * An array of Memberships that the Group has.
    *
    * It is empty by default but is filled when the function getMemberships() is called if a Communicator is given
    *   as an argument.
    *
    * @var array $membership
    */
    protected $memberships = [];
    /**
    * Tells whether memberships has been fetched from the API.
    * @var boolean $fetchedMemberships Defaults to false.
    */
    protected $fetchedMemberships = false;
    /**
    * An array of Group that the Contact is a member of.
    *
    * It is empty by default but is filled when the function getGroups() is called if a Communicator is given
    *   as an argument.
    *
    * @var array $groups Default empty array.
    */
    protected $groups = [];
    /**
    * Tells wheter Groups has been fetched from the API.
    * @var boolean $groupsFetched Defaults to false.
    */
    protected $groupsFetched = false;
    const IS_READ_ONLY = false;
    /**
    * The ProcessedContact constructor
    *
    * @param string     $firstName    The first name of the contact in question.
    * @param string     $phoneNumber  Contact phone number: with country code and without spaces and dashes.
    * @param integer    $contactID    Contact ID.
    * @param string     $ownerID      ID of account owning the Contact.
    * @param ?string    $lastName     Contact last name.
    * @param ?string    $title        The contacts title.
    * @param ?string    $organization Contact company or other organization.
    * @param ?string    $email        Contact email address.
    * @param ?string    $notes        Contact notes.
    * @param ?\DateTime $created      Date/time of when the contact was added.
    * @param ?\DateTime $updated      Date/time of when the contact was last updated/modified.
    */
    public function __construct(
        string $firstName,
        string $phoneNumber,
        int $contactID,
        string $ownerID,
        ?string $lastName,
        ?string $title,
        ?string $organization,
        ?string $email,
        ?string $notes,
        ?\DateTime $created = null,
        ?\DateTime $updated = null
    ) {
        parent::__construct($firstName, $phoneNumber, $lastName, $title, $organization, $email, $notes);
        $this->ownerID = $ownerID;
        $this->contactID = $contactID;
        $this->created = $created ?? null;
        $this->updated = $updated ?? null;
        $this->memberships = new ClassValidationArray();
        $this->groups = new ClassValidationArray();
    }
    /**
      * Returns an array of all the memberships the group is referenced in.
      * If a communicator is not provided it will not fetch memberships from the API
      *               but return those that has been fetched, if any.
      * @param Communicator $communicator Used to fetch memberships from the API.
      * @return ClassValidationArray An array of Membership objects.
      */
    public function getMemberships(Communicator $communicator = null): ClassValidationArray
    {
        if ($communicator !== null) {
            $membershipJSON = $communicator->get("api/contacts/".$this->contactID."/memberships");
            $membershipStd = json_decode($membershipJSON);
            $memberships = new ClassValidationArray();
            foreach ($membershipStd as $value) {
                $memberships[] = RecipientFactory::createProcessedMembershipFromStdClass($value);
            }
            $this->memberships = $memberships;
            $this->fetchedMemberships = true;
        }
        return $this->memberships;
    }
    /**
    * Returns an array of all the Groups the group is referenced in.
    * If a communicator is not provided it will not fetch memberships from the API
    *               but return those that has been fetched, if any.
    * @param Communicator $communicator Used to fetch Groups from the API.
    * @return ClassValidationArray An array of Group objects.
    */
    public function getGroups(Communicator $communicator = null): ClassValidationArray
    {
        if ($communicator !== null) {
            $groupsJSON = $communicator->get('api/contacts/'.$this->contactID. '/groups');
            $groupStd = json_decode($groupsJSON);
            $groups = RecipientFactory::createProcessedGroupsFromStdClassArray($groupStd);
            $this->groups = $groups;
            $this->fetchedGroups = true;
        }
        return $this->groups;
    }
    /**
    * Adds the contact to the given group and returns the membership.
    * @param Communicator   $communicator Used to fetch Groups from the API.
    * @param ProcessedGroup $group        The group the contact should be added to.
    * @return ProcessedMembership
    */
    public function addGroup(Communicator $communicator, ProcessedGroup $group): ProcessedMembership
    {
        $response = $communicator->post('api/memberships', new Membership($group->getID(), $this->contactID));
        $returnValue =  RecipientFactory::createProcessedMembershipFromJSON($response);
        if ($this->memberShipsFetched) {
            $this->memberships[] = $returnValue;
        }
        return $returnValue;
    }
    /**
    * Tells whether Groups has been fetched from the API or not.
    * @return boolean Whether the Groups has been fetched from the API or not.
    */
    public function isGroupsFetched(): bool
    {
        return $this->groupsFetched;
    }
    /**
    * Tells whether Memberships has been fetched from the API or not.
    * @return boolean Whether the Memberships has been fetched from the API or not.
    */
    public function memberShipsFetched(): bool
    {
        return $this->fetchedMemberships;
    }
    /**
    * Returns when the component was updated last.
    * @param  \DateTimeZone $timezone The timezone that the user wants to get the DateTime in.
    *               Default is UTC.
    * @return \DateTime When the contact was updated/modified last.
    */
    public function getUpdated(\DateTimeZone $timezone = null): ?\DateTime
    {
        if (!is_null($timezone)) {
            $returnDate = clone $this->updated;
            $returnDate->setTimeZone($timezone);
            return $returnDate;
        }
        return $this->updated ?? null;
    }
    /**
    * @return boolean Whether the object is read only or not.
    */
    public function isReadOnly(): bool
    {
        return self::IS_READ_ONLY;
    }
    /**
    * @param  \DateTimeZone $timezone The timezone that the user wants to get the DateTime in. Default is UTC.
    * @return ?\DateTime When the Contact was added.
    */
    public function getCreated(\DateTimeZone $timezone = null): ?\DateTime
    {
        if (!is_null($timezone)) {
            $returnDate = clone $this->created;
            $returnDate->setTimeZone($timezone);
            return $returnDate;
        }
        return $this->created ?? null;
    }
    /**
    * @return integer Contact ID.
    */
    public function getID():int
    {
        return $this->contactID;
    }
    /**
    * @return string OwnerID
    */
    public function getOwnerID(): string
    {
        return $this->ownerID;
    }
    /**
     * Serializes the object to a value that can be serialized natively by json_encode().
     * @return array Associative.
     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
     */
    public function jsonSerialize(): array
    {
        $contactArray = parent::jsonSerialize();
        $contactArray['ID'] = $this->contactID;
        $contactArray['OwnerID'] = $this->ownerID;
        $contactArray['Modified'] = isset($this->created) ? $this->updated->format("Y-m-d\TH:i:s.").
            substr($this->updated->format('u'), 0, 3) : null;
        $contactArray['Created'] = isset($this->created) ? $this->created->format("Y-m-d\TH:i:s.").
            substr($this->updated->format('u'), 0, 3) : null;

        return array_filter($contactArray);
    }
    /**
    * Takes the given argument and replaces strings such as {id} to an actual value.
    * @param string $endPoint The endpoint to be corrected.
    * @return void
    */
    public function fillEndPoint(string &$endPoint): void
    {
        $endPoint = str_replace("{contact}", $this->contactID, $endPoint);
    }
}