24Slides / auth-connector

src/Sync/User.php

<?php

namespace Slides\Connector\Auth\Sync;

use Carbon\Carbon;
use Illuminate\Support\Arr;

/**
 * Class User describes a remote user
 *
 * @package Slides\Connector\Auth\Sync
 */
final class User
{
    /**
     * User's remote ID
     *
     * @var int
     */
    protected $remoteId;

    /**
     * User's name
     *
     * @var string
     */
    protected $name;

    /**
     * User's email
     *
     * @var string
     */
    protected $email;

    /**
     * User's country code
     *
     * @var string
     */
    protected $country;

    /**
     * User's encrypted password
     *
     * @var string
     */
    protected $password;

    /**
     * The date of last update.
     *
     * @var Carbon
     */
    protected $updated;

    /**
     * The creation date.
     *
     * @var Carbon
     */
    protected $created;

    /**
     * The deletion date.
     *
     * @var Carbon|null
     */
    protected $deleted;

    /**
     * The instance of the user locally
     *
     * @var \Illuminate\Contracts\Auth\Authenticatable
     */
    protected $localUser;

    /**
     * Whether a user exist only locally
     *
     * @var bool
     */
    protected $isLocal = false;

    /**
     * The action for a remote sync client
     *
     * @var string
     */
    protected $remoteAction;

    /**
     * User constructor.
     *
     * @param int $remoteId
     * @param string|null $name
     * @param string $email
     * @param string|null $password
     * @param string|null $updated
     * @param string $created
     * @param string|null $country
     * @param string|null $deleted
     * @param string $action
     */
    public function __construct(
        int $remoteId,
        ?string $name,
        string $email,
        ?string $password,
        ?string $updated,
        string $created,
        ?string $deleted,
        ?string $country,
        string $action = null
    )
    {
        $this->remoteId = $remoteId;
        $this->name = $name;
        $this->email = $email;
        $this->password = $password;
        $this->updated = new Carbon($updated);
        $this->created = new Carbon($created);
        $this->country = $country;
        $this->deleted = ($deleted ? new Carbon($deleted) : null);
        $this->remoteAction = $action;
    }

    /**
     * Get user's name
     *
     * @return string|null
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get user's email
     *
     * @return string
     */
    public function getEmail(): string
    {
        return $this->email;
    }

    /**
     * Get user's password
     *
     * @return string|null
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * Get a creation date.
     *
     * @return Carbon
     */
    public function getCreated(): Carbon
    {
        return $this->created;
    }

    /**
     * Get updated_at date
     *
     * @return Carbon|null
     */
    public function getUpdated()
    {
        return $this->updated;
    }

    /**
     * Get remote action
     *
     * @return string|null
     */
    public function getRemoteAction(): ?string
    {
        return $this->remoteAction;
    }

    /**
     * Get remote user ID
     *
     * @return int
     */
    public function getRemoteId(): int
    {
        return $this->remoteId;
    }

    /**
     * Get user's country
     *
     * @return string|null
     */
    public function getCountry()
    {
        return $this->country;
    }

    /**
     * Reset the password.
     *
     * @return void
     */
    public function resetPassword()
    {
        $this->password = null;
    }

    /**
     * Create a user from the response
     *
     * @param array $response
     *
     * @return static
     */
    public static function createFromResponse(array $response)
    {
        $user = Arr::get($response, 'user');

        return new static(
            Arr::get($user, 'id'),

It seems like Illuminate\Support\Arr::get($user, 'id') can also be of type null; however, parameter $remoteId of Slides\Connector\Auth\Sync\User::__construct() does only seem to accept integer, maybe add an additional type check?

            Arr::get($user, 'name'),
            Arr::get($user, 'email'),

It seems like Illuminate\Support\Arr::get($user, 'email') can also be of type null; however, parameter $email of Slides\Connector\Auth\Sync\User::__construct() does only seem to accept string, maybe add an additional type check?

            Arr::get($user, 'password'),
            Arr::get($user, 'updated_at'),
            Arr::get($user, 'created_at'),

It seems like Illuminate\Support\Arr::get($user, 'created_at') can also be of type null; however, parameter $created of Slides\Connector\Auth\Sync\User::__construct() does only seem to accept string, maybe add an additional type check?

            Arr::get($user, 'deleted_at'),
            Arr::get($user, 'country'),
            Arr::get($user, 'action')
        );
    }

    /**
     * Get a deletion date.
     *
     * @return Carbon|null
     */
    public function getDeleted(): ?Carbon
    {
        return $this->deleted;
    }
}