Jerodev\PhpIrcClient\IrcChannel

Complexity

Total Complexity

7

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setUsers()	0	3	1
A	__construct()	0	7	2
A	getUsers()	0	3	1
A	getName()	0	3	1
A	setTopic()	0	3	1
A	getTopic()	0	3	1

<?php

namespace Jerodev\PhpIrcClient;

class IrcChannel
{
    /** @var string */
    private $name;

    /** @var null|string */
    private $topic;

    /** @var string[] */
    private $users;

    public function __construct(string $name)
    {
        if ($name[0] !== '#') {
            $name = "#$name";
        }
        $this->name = $name;
        $this->users = [];
    }

    /** 
     *  Fetch the name of the channel, including the `#`
     *
     *  @return string
     */
    public function getName(): string
    {
        return $this->name;
    }
    
    /**
     *  Get the current channel topic.
     *
     *  @return null|string
     */
    public function getTopic()
    {
        return $this->topic;
    }

    /**
     *  Fetch the list of users currently on this channel.
     *
     *  @return string[]
     */
    public function getUsers(): array
    {
        return $this->users;
    }

    /**
     *  Set the current channel topic.
     *
     *  @param string $topic The topic
     */
    public function setTopic(string $topic): void
    {
        $this->topic = $topic;
    }

    /**
     *  Set the list of active users on the channel.
     *
     *  @param string[] $users An array of user names.
     */
    public function setUsers(array $users): void
    {
        $this->users = $users;
    }
}