PeekAndPoke\Component\Slumber\Data\Addon\UserRecord\UserRecord

Complexity

Total Complexity

13

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

63.16%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	14	1
A	getUserId()	0	4	1
A	setUserId()	0	6	1
A	getName()	0	4	1
A	setName()	0	6	1
A	getRole()	0	4	1
A	setRole()	0	6	1
A	getIp()	0	4	1
A	setIp()	0	6	1
A	getUserAgent()	0	4	1
A	setUserAgent()	0	6	1
A	getSessionHash()	0	4	1
A	setSessionHash()	0	6	1

<?php
/**
 * File was created 26.04.2016 17:55
 */

namespace PeekAndPoke\Component\Slumber\Data\Addon\UserRecord;

use PeekAndPoke\Component\Slumber\Annotation\Slumber;

/**
 * @author Karsten J. Gerber <kontakt@karsten-gerber.de>
 */
class UserRecord
{
    /**
     * @var string
     *
     * @Slumber\AsString()
     */
    private $userId;

    /**
     * @var string
     *
     * @Slumber\AsString()
     */
    private $name;

    /**
     * @var string
     *
     * @Slumber\AsString()
     */
    private $role;

    /**
     * @var string
     *
     * @Slumber\AsString()
     */
    private $ip;

    /**
     * @var string
     *
     * @Slumber\AsString()
     */
    private $userAgent;

    /**
     * Use this to store a hashed version of the users session id.
     *
     * For security reason it is HIGHLY recommended to NOT store the real session id.
     *
     * @var string
     *
     * @Slumber\AsString()
     */
    private $sessionHash;

    /**
     * @return string
     */
    public function __toString()
    {
        /** @noinspection MagicMethodsValidityInspection */
        return implode(
            ', ',
            [
                $this->name,
                $this->userId,
                $this->role,
                $this->ip,
                $this->userAgent,
            ]
        );
    }

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

    /**
     * @param string $userId
     *
     * @return $this
     */
    public function setUserId($userId)
    {
        $this->userId = $userId;

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * @param string $role
     *
     * @return $this
     */
    public function setRole($role)
    {
        $this->role = $role;

        return $this;
    }

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

    /**
     * @param string $ip
     *
     * @return $this
     */
    public function setIp($ip)
    {
        $this->ip = $ip;

        return $this;
    }

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

    /**
     * @param string $userAgent
     *
     * @return $this
     */
    public function setUserAgent($userAgent)
    {
        $this->userAgent = $userAgent;

        return $this;
    }

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

    /**
     * @param string $sessionHash
     *
     * @return $this
     */
    public function setSessionHash(string $sessionHash)
    {
        $this->sessionHash = $sessionHash;

        return $this;
    }
}