D3strukt0r\VotifierClient\VoteType\ClassicVote

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getServiceName()	0	3	1
A	getAddress()	0	3	1
A	getUsername()	0	3	1
A	getTimestamp()	0	7	2
A	setTimestamp()	0	5	2
A	__construct()	0	7	1

<?php

/**
 * Votifier PHP Client
 *
 * @package   VotifierClient
 * @author    Manuele Vaccari <manuele.vaccari@gmail.com>
 * @copyright Copyright (c) 2017-2020 Manuele Vaccari <manuele.vaccari@gmail.com>
 * @license   https://github.com/D3strukt0r/votifier-client-php/blob/master/LICENSE.txt GNU General Public License v3.0
 * @link      https://github.com/D3strukt0r/votifier-client-php
 */

namespace D3strukt0r\VotifierClient\VoteType;

use DateTime;

/**
 * The classic vote package can be used by most plugins.
 */
class ClassicVote implements VoteInterface
{
    /**
     * @var string the name of the list/service
     */
    private $serviceName;

    /**
     * @var string the username who wants to receive the rewards
     */
    private $username;

    /**
     * @var string the IP Address of the user
     */
    private $address;

    /**
     * @var DateTime|null the time when the vote will be sent
     */
    private $timestamp;

    /**
     * Creates the ClassicVote object.
     *
     * @param string        $username    (Required) The username who wants to receive the rewards
     * @param string        $serviceName (Required) The name of the list/service
     * @param string        $address     (Required) The IP Address of the user
     * @param DateTime|null $timestamp   (Optional) The time when the vote will be sent
     */
    public function __construct(string $username, string $serviceName, string $address, DateTime $timestamp = null)
    {
        // Replace username to letters, numbers and "_"
        $this->username = preg_replace('/[^A-Za-z0-9_]+/', '', $username);
        $this->serviceName = $serviceName;
        $this->address = $address;
        $this->timestamp = $timestamp;
    }

    /**
     * {@inheritdoc}
     */
    public function getServiceName(): string
    {
        return $this->serviceName;
    }

    /**
     * {@inheritdoc}
     */
    public function getUsername(): string
    {
        return $this->username;
    }

    /**
     * {@inheritdoc}
     */
    public function getAddress(): string
    {
        return $this->address;
    }

    /**
     * {@inheritdoc}
     */
    public function getTimestamp(): ?int
    {
        if (null !== $this->timestamp) {
            return $this->timestamp->getTimestamp();
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function setTimestamp(DateTime $timestamp = null): self
    {
        $this->timestamp = $timestamp ?: new DateTime();

        return $this;
    }
}