leocata\M1\Methods\StateMethods

Complexity

Total Complexity

5

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	away()	0	3	1
A	offline()	0	3	1
A	online()	0	3	1
A	getMandatoryFields()	0	3	1
A	busy()	0	3	1

<?php

namespace leocata\M1\Methods;

use leocata\M1\Abstracts\Methods;

abstract class StateMethods extends Methods
{

    const OFFLINE = 0;
    const ONLINE = 1;
    const AWAY = 2;
    const BUSY = 3;

    /**
     * State:
     * 0 "offline" offline
     * 1 "online" online
     * 2 "away" absent (can receive calls, but shan't receive messages)
     * 3 "busy" busy (can receive messages, but shan’t receive calls)
     * @var integer
     */
    public $state;

    /**
     * User message.
     * @var string
     */
    public $note;

    /**
     * Set state online
     */
    public function online()
    {
        $this->state = self::ONLINE;
    }

    /**
     * Set state offline
     */
    public function offline()
    {
        $this->state = self::OFFLINE;
    }

    /**
     * Set state away
     */
    public function away()
    {
        $this->state = self::AWAY;
    }

    /**
     * Set state busy
     */
    public function busy()
    {
        $this->state = self::BUSY;
    }

    /**
     * Set Mandatory Fields for all methods
     * @return array
     */
    public function getMandatoryFields(): array
    {
        return ['state'];
    }
}