app\models\Device

Complexity

Total Complexity

17

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	tableName()	0	4	1
A	rules()	0	10	1
A	attributeLabels()	0	10	1
A	setAuthenticated()	0	5	1
A	getLastId()	0	4	1
A	getDeviceHasScreens()	0	4	1
A	getScreens()	0	4	1
A	canViewScreen()	0	10	3
B	getNextScreen()	0	26	7

<?php

namespace app\models;

use Yii;
use yii\db\Expression;

/**
 * This is the model class for table "device".
 *
 * @property int $id
 * @property string $name
 * @property string $description
 * @property string $last_auth
 * @property bool $enabled
 * @property int $lastId
 * @property DeviceHasScreen[] $deviceHasScreens
 * @property Screen[] $screens
 */
class Device extends \yii\db\ActiveRecord
{
    /**
     * {@inheritdoc}
     */
    public static function tableName()
    {
        return 'device';
    }

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [['name'], 'required'],
            [['last_auth'], 'safe'],
            [['enabled'], 'boolean'],
            [['name'], 'string', 'max' => 64],
            [['description'], 'string', 'max' => 1024],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('app', 'ID'),
            'name' => Yii::t('app', 'Name'),
            'description' => Yii::t('app', 'Description'),
            'last_auth' => Yii::t('app', 'Last connection'),
            'enabled' => Yii::t('app', 'Enabled'),
        ];
    }

    /**
     * Update last_auth field to indicate screen last connexion.
     */
    public function setAuthenticated()
    {
        $this->last_auth = new Expression('NOW()');
        $this->save();
    }

    /**
     * Get last inserted AUTO_INCREMENT id from database.
     *
     * @return int last insert id
     */
    public function getLastId()
    {
        return $this->getDb()->getLastInsertID();
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getDeviceHasScreens()
    {
        return $this->hasMany(DeviceHasScreen::class, ['device_id' => 'id']);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getScreens()
    {
        return $this->hasMany(Screen::class, ['id' => 'screen_id'])->viaTable('device_has_screen', ['device_id' => 'id']);
    }

    /**
     * Check if device still has rights to view screen.
     *
     * @param int $id screen id
     *
     * @return bool can view screen
     */
    public function canViewScreen($id)
    {
        foreach ($this->screens as $s) {
            if ($id === $s->id) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get next screen for this device.
     *
     * @param int $currentScreenId
     *
     * @return \app\models\Screen|null next screen
     */
    public function getNextScreen($currentScreenId = null)
    {
        // No screen available, bail out
        if (count($this->screens) === 0) {
            return;
        }

        $firstScreen = $this->screens[0];
        if ($currentScreenId === null) {
            return $firstScreen;
        }

        $foundCurrent = false;
        foreach ($this->screens as $s) {
            if ($foundCurrent) {
                return $s;
            }

            if ($currentScreenId === $s->id) {
                $foundCurrent = true; // Pick next screen after current
            }
        }

        // Return first screen if reached end of array
        return $currentScreenId != $firstScreen->id ? $firstScreen : null;
    }
}