JoinMeetingParameters::setRedirect() - Code Metrics - Inspection of "Intoduce native php enums" - bigbluebutton/bigbluebutton-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#248)

unknown
created 2024-05-05 05:35 UTC
JoinMeetingParameters::setRedirect() A

↳ Parent: JoinMeetingParameters
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	1
Metric	Value
eloc	2
c	2
b	0
f	1
dl	0
loc	5
rs	10
cc	1
nc	1
nop	1
<?php

/*
 * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
 *
 * Copyright (c) 2016-2024 BigBlueButton Inc. and by respective authors (see below).
 *
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 3.0 of the License, or (at your option) any later
 * version.
 *
 * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along
 * with BigBlueButton; if not, see <https://www.gnu.org/licenses/>.
 */

namespace BigBlueButton\Parameters;

use BigBlueButton\Enum\MeetingLayout;
use BigBlueButton\Enum\Role;

/**
 * Class JoinMeetingParametersTest.
 */
class JoinMeetingParameters extends UserDataParameters
{
    private ?string $meetingId;

    private ?string $username;

    /**
     * @deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
     */
    private ?string $password = null;

    private ?string $userId = null;

    private ?string $webVoiceConf = null;

    private ?float $creationTime = null;

    private ?string $avatarURL = null;

    private ?bool $redirect = null;

    /**
     * @var array<string, string>
     */
    private array $customParameters;

    private ?Role $role = null;

    private ?bool $excludeFromDashboard = null;

    private ?bool $guest = null;

    private ?MeetingLayout $defaultLayout = null;

    /**
     * @param mixed $passwordOrRole
     * @param mixed $meetingId
     * @param mixed $username
     */
    public function __construct($meetingId = null, $username = null, $passwordOrRole = null)
    {
        $this->meetingId = $meetingId;
        $this->username  = $username;

        if (Role::MODERATOR === $passwordOrRole || Role::VIEWER === $passwordOrRole) {
            $this->role = $passwordOrRole;
        } else {
            $this->password = $passwordOrRole;
            /** @scrutinizer ignore-deprecated */ $this->password = $passwordOrRole;
        }
        $this->customParameters = [];
    }

    public function getMeetingId(): ?string
    {
        return $this->meetingId;
    }

    public function setMeetingId(string $meetingId): JoinMeetingParameters
    {
        $this->meetingId = $meetingId;

        return $this;
    }

    public function getUsername(): ?string
    {
        return $this->username;
    }

    public function setUsername(string $username): self
    {
        $this->username = $username;

        return $this;
    }

    /**
     * @deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
     */
    public function getPassword(): ?string
    {
        return $this->password;
        return /** @scrutinizer ignore-deprecated */ $this->password;
    }

    /**
     *@deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
     */
    public function setPassword(string $password): self
    {
        $this->password = $password;
        /** @scrutinizer ignore-deprecated */ $this->password = $password;

        return $this;
    }

    public function getUserId(): ?string
    {
        return $this->userId;
    }

    public function setUserId(string $userId): self
    {
        $this->userId = $userId;

        return $this;
    }

    public function getWebVoiceConf(): ?string
    {
        return $this->webVoiceConf;
    }

    public function setWebVoiceConf(string $webVoiceConf): self
    {
        $this->webVoiceConf = $webVoiceConf;

        return $this;
    }

    public function getCreationTime(): ?float
    {
        return $this->creationTime;
    }

    public function setCreationTime(float $creationTime): self
    {
        $this->creationTime = $creationTime;

        return $this;
    }

    public function getAvatarURL(): ?string
    {
        return $this->avatarURL;
    }

    public function setAvatarURL(string $avatarURL): self
    {
        $this->avatarURL = $avatarURL;

        return $this;
    }

    public function isRedirect(): ?bool
    {
        return $this->redirect;
    }

    public function setRedirect(bool $redirect): self
    {
        $this->redirect = $redirect;

        return $this;
    }

    public function getRole(): ?Role
    {
        return $this->role;
    }

    public function setRole(Role $role): self
    {
        $this->role = $role;

        return $this;
    }

    public function isExcludeFromDashboard(): ?bool
    {
        return $this->excludeFromDashboard;
    }

    public function setExcludeFromDashboard(bool $excludeFromDashboard): self
    {
        $this->excludeFromDashboard = $excludeFromDashboard;

        return $this;
    }

    public function isGuest(): ?bool
    {
        return $this->guest;
    }

    public function setGuest(bool $guest): self
    {
        $this->guest = $guest;

        return $this;
    }

    public function getDefaultLayout(): ?MeetingLayout
    {
        return $this->defaultLayout;
    }

    public function setDefaultLayout(MeetingLayout $defaultLayout): self
    {
        $this->defaultLayout = $defaultLayout;

        return $this;
    }

    public function setCustomParameter(string $paramName, string $paramValue): self
    {
        $this->customParameters[$paramName] = $paramValue;

        return $this;
    }

    public function getHTTPQuery(): string
    {
        $queries = [
            'meetingID'            => $this->meetingId,
            'fullName'             => $this->username,
            'password'             => $this->password,
            'password'             => /** @scrutinizer ignore-deprecated */ $this->password,
            'userID'               => $this->userId,
            'webVoiceConf'         => $this->webVoiceConf,
            'createTime'           => $this->creationTime,
            'role'                 => is_null($this->role) ? null : $this->role->value,
            'excludeFromDashboard' => !is_null($this->excludeFromDashboard) ? ($this->excludeFromDashboard ? 'true' : 'false') : $this->excludeFromDashboard,
            'avatarURL'            => $this->avatarURL,
            'redirect'             => !is_null($this->redirect) ? ($this->redirect ? 'true' : 'false') : $this->redirect,
            'guest'                => !is_null($this->guest) ? ($this->guest ? 'true' : 'false') : $this->guest,
            'defaultLayout'        => is_null($this->defaultLayout) ? null : $this->defaultLayout->value,
        ];

        foreach ($this->customParameters as $key => $value) {
            $queries[$key] = $value;
        }

        $this->buildUserData($queries);

        return $this->buildHTTPQuery($queries);
    }
}

bigbluebutton / bigbluebutton-api-php

Pull Request — master (#248)

JoinMeetingParameters::setRedirect() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
