TSK\SSO\ThirdParty\ThirdPartyUser

Complexity

Total Complexity

7

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	avatar()	0	3	1
A	id()	0	3	1
A	gender()	0	3	1
A	name()	0	3	1
A	toArray()	0	8	1
A	email()	0	3	1
A	__construct()	0	7	1

<?php
/**
 * @author Tharanga Kothalawala <tharanga.kothalawala@tsk-webdevelopment.com>
 * @date 30-12-2018
 */

namespace TSK\SSO\ThirdParty;

/**
 * @internal
 * @package TSK\SSO\ThirdParty
 *
 * This value object represents a third party user with their basic user data.
 * This object is only created within the library and is readonly.
 */
class ThirdPartyUser
{
    const ID = 'id';

    /**
     * @var string
     */
    private $id;

    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $email;

    /**
     * @var string
     */
    private $avatar;

    /**
     * @var string
     */
    private $gender;

    /**
     * @param string $id vendor unique identifier
     * @param string $name user's name within the vendor platform
     * @param string $email user's email within the vendor platform
     * @param string $avatar [optional] user's profile picture within the vendor platform if any provided
     * @param string $gender [optional] user's gender within the vendor platform if any provided
     */
    public function __construct($id, $name, $email, $avatar = '', $gender = '')
    {
        $this->id = $id;
        $this->name = $name;
        $this->email = $email;
        $this->avatar = $avatar;
        $this->gender = $gender;
    }

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

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

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

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

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

    /**
     * @return array
     */
    public function toArray()
    {
        return array(
            self::ID => $this->id(),
            'name' => $this->name(),
            'email' => $this->email(),
            'avatar' => $this->avatar(),
            'gender' => $this->gender(),
        );
    }
}