Arcanedev\SpamBlocker\Entities\Spammer

Complexity

Total Complexity

9

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	host()	0	4	1
A	setHost()	0	6	1
A	isBlocked()	0	4	1
A	setBlocked()	0	6	1
A	make()	0	4	1
A	isSameHost()	0	4	1
A	toArray()	0	7	1
A	toJson()	0	4	1

<?php namespace Arcanedev\SpamBlocker\Entities;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

/**
 * Class     Spammer
 *
 * @package  Entities
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Spammer implements Arrayable, Jsonable
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /** @var string */
    protected $host;

    /** @var bool */
    protected $blocked;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Spammer constructor.
     *
     * @param  string  $host
     * @param  bool    $blocked
     */
    public function __construct($host, $blocked)
    {
        $this->setHost($host);
        $this->setBlocked($blocked);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the host url.
     *
     * @return string
     */
    public function host()
    {
        return $this->host;
    }

    /**
     * Set the host url.
     *
     * @param  string  $host
     *
     * @return self
     */
    public function setHost($host)
    {
        $this->host = trim(utf8_encode($host));

        return $this;
    }

    /**
     * Get the blocked status.
     *
     * @return bool
     */
    public function isBlocked()
    {
        return $this->blocked;
    }

    /**
     * Set the blocked status.
     *
     * @param  bool  $blocked
     *
     * @return self
     */
    public function setBlocked($blocked)
    {
        $this->blocked = (bool) $blocked;

        return $this;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make a spammer instance.
     *
     * @param  string  $host
     * @param  bool    $blocked
     *
     * @return self
     */
    public static function make($host, $blocked = true)
    {
        return new static($host, $blocked);
    }

    /**
     * Check if the given host is the same as the spammer host.
     *
     * @param  string  $host
     *
     * @return bool
     */
    public function isSameHost($host)
    {
        return $this->host() === trim(utf8_encode($host));
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'host'    => $this->host,
            'blocked' => $this->blocked,
        ];
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }
}