config::guestlinks_enabled() - Code Metrics - Inspection of "CONTRIB-8152: add guest access feature" - blindsidenetworks/moodle-mod_bigbluebuttonbn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#289)

unknown

created 2021-03-29 18:54 UTC

config::guestlinks_enabled() A

↳ Parent: config

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * The mod_bigbluebuttonbn locallib/config.
 *
 * @package   mod_bigbluebuttonbn
 * @copyright 2010 onwards, Blindside Networks Inc
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)
 */

namespace mod_bigbluebuttonbn\locallib;

defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/mod/bigbluebuttonbn/locallib.php');

/**
 * Handles the global configuration based on config.php.
 *
 * @copyright 2010 onwards, Blindside Networks Inc
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class config {

    /**
     * Returns moodle version.
     *
     * @return string
     */
    public static function get_moodle_version_major() {
        global $CFG;
        $versionarray = explode('.', $CFG->version);
        return $versionarray[0];
    }

    /**
     * Returns configuration default values.
     *
     * @return array
     */
    public static function defaultvalues() {
        return array(
            'server_url' => (string) BIGBLUEBUTTONBN_DEFAULT_SERVER_URL,
            'shared_secret' => (string) BIGBLUEBUTTONBN_DEFAULT_SHARED_SECRET,
            'voicebridge_editable' => false,
            'importrecordings_enabled' => false,
            'importrecordings_from_deleted_enabled' => false,
            'waitformoderator_default' => false,
            'waitformoderator_editable' => true,
            'waitformoderator_ping_interval' => '10',
            'waitformoderator_cache_ttl' => '60',
            'userlimit_default' => '0',
            'userlimit_editable' => false,
            'preuploadpresentation_enabled' => false,
            'sendnotifications_enabled' => false,
            'recordingready_enabled' => false,
            'recordingstatus_enabled' => false,
            'meetingevents_enabled' => false,
            'participant_moderator_default' => '0',
            'participant_moderatorapproval' => '0',
            'participant_guestlink_enabled' => '1',
            'participant_guestlink_default' => '0',
            'scheduled_duration_enabled' => false,
            'scheduled_duration_compensation' => '10',
            'scheduled_pre_opening' => '10',
            'recordings_enabled' => true,
            'recordings_html_default' => false,
            'recordings_html_editable' => false,
            'recordings_deleted_default' => false,
            'recordings_deleted_editable' => false,
            'recordings_imported_default' => false,
            'recordings_imported_editable' => false,
            'recordings_preview_default' => true,
            'recordings_preview_editable' => false,
            'recordings_validate_url' => true,
            'recording_default' => true,
            'recording_editable' => true,
            'recording_icons_enabled' => true,
            'recording_all_from_start_default' => false,
            'recording_all_from_start_editable' => false,
            'recording_hide_button_default' => false,
            'recording_hide_button_editable' => false,
            'general_warning_message' => '',
            'general_warning_roles' => 'editingteacher,teacher',
            'general_warning_box_type' => 'info',
            'general_warning_button_text' => '',
            'general_warning_button_href' => '',
            'general_warning_button_class' => '',
            'clienttype_enabled' => false,
            'clienttype_default' => '0',
            'clienttype_editable' => true,
            'muteonstart_default' => false,
            'muteonstart_editable' => false,
            'disablecam_default' => false,
            'disablecam_editable' => true,
            'disablemic_default' => false,
            'disablemic_editable' => true,
            'disableprivatechat_default' => false,
            'disableprivatechat_editable' => true,
            'disablepublicchat_default' => false,
            'disablepublicchat_editable' => true,
            'disablenote_default' => false,
            'disablenote_editable' => true,
            'hideuserlist_default' => false,
            'hideuserlist_editable' => true,
            'lockedlayout_default' => false,
            'lockedlayout_editable' => true,
            'lockonjoin_default' => false,
            'lockonjoin_editable' => true,
            'lockonjoinconfigurable_default' => false,
            'lockonjoinconfigurable_editable' => true,
            'welcome_default' => '',
        );
    }

    /**
     * Returns default value for an specific setting.
     *
     * @param string $setting
     * @return string
     */
    public static function defaultvalue($setting) {
        $defaultvalues = self::defaultvalues();
        if (!array_key_exists($setting, $defaultvalues)) {
            return;
        }
        return $defaultvalues[$setting];
    }

    /**
     * Validates if recording settings are enabled.
     *
     * @return boolean
     */
    public static function guestlinks_enabled() {
        return (boolean)self::get('participant_guestlink');
    }

    /**
     * Returns value for an specific setting.
     *
     * @param string $setting
     * @return string
     */
    public static function get($setting) {
        global $CFG;
        if (isset($CFG->bigbluebuttonbn[$setting])) {
            return (string)$CFG->bigbluebuttonbn[$setting];
        }
        if (isset($CFG->{'bigbluebuttonbn_'.$setting})) {
            return (string)$CFG->{'bigbluebuttonbn_'.$setting};
        }
        return self::defaultvalue($setting);
    }

    /**
     * Validates if recording settings are enabled.
     *
     * @return boolean
     */
    public static function recordings_enabled() {
        return (boolean)self::get('recordings_enabled');
    }

    /**
     * Validates if imported recording settings are enabled.
     *
     * @return boolean
     */
    public static function importrecordings_enabled() {
        return (boolean)self::get('importrecordings_enabled');
    }

    /**
     * Validates if clienttype settings are enabled.
     *
     * @return boolean
     */
    public static function clienttype_enabled() {
        return (boolean)self::get('clienttype_enabled');
    }

    /**
     * Wraps current settings in an array.
     *
     * @return array
     */
    public static function get_options() {
        return array(
               'version_major' => self::get_moodle_version_major(),
               'voicebridge_editable' => self::get('voicebridge_editable'),
               'importrecordings_enabled' => self::get('importrecordings_enabled'),
               'importrecordings_from_deleted_enabled' => self::get('importrecordings_from_deleted_enabled'),
               'waitformoderator_default' => self::get('waitformoderator_default'),
               'waitformoderator_editable' => self::get('waitformoderator_editable'),
               'userlimit_default' => self::get('userlimit_default'),
               'userlimit_editable' => self::get('userlimit_editable'),
               'preuploadpresentation_enabled' => self::get('preuploadpresentation_enabled'),
               'sendnotifications_enabled' => self::get('sendnotifications_enabled'),
               'recordings_enabled' => self::get('recordings_enabled'),
               'meetingevents_enabled' => self::get('meetingevents_enabled'),
               'recordings_html_default' => self::get('recordings_html_default'),
               'recordings_html_editable' => self::get('recordings_html_editable'),
               'recordings_deleted_default' => self::get('recordings_deleted_default'),
               'recordings_deleted_editable' => self::get('recordings_deleted_editable'),
               'recordings_imported_default' => self::get('recordings_imported_default'),
               'recordings_imported_editable' => self::get('recordings_imported_editable'),
               'recordings_preview_default' => self::get('recordings_preview_default'),
               'recordings_preview_editable' => self::get('recordings_preview_editable'),
               'recordings_validate_url' => self::get('recordings_validate_url'),
               'recording_default' => self::get('recording_default'),
               'recording_editable' => self::get('recording_editable'),
               'recording_icons_enabled' => self::get('recording_icons_enabled'),
               'recording_all_from_start_default' => self::get('recording_all_from_start_default'),
               'recording_all_from_start_editable' => self::get('recording_all_from_start_editable'),
               'recording_hide_button_default' => self::get('recording_hide_button_default'),
               'recording_hide_button_editable' => self::get('recording_hide_button_editable'),
               'general_warning_message' => self::get('general_warning_message'),
               'general_warning_box_type' => self::get('general_warning_box_type'),
               'general_warning_button_text' => self::get('general_warning_button_text'),
               'general_warning_button_href' => self::get('general_warning_button_href'),
               'general_warning_button_class' => self::get('general_warning_button_class'),
               'clienttype_enabled' => self::get('clienttype_enabled'),
               'clienttype_editable' => self::get('clienttype_editable'),
               'clienttype_default' => self::get('clienttype_default'),
               'muteonstart_editable' => self::get('muteonstart_editable'),
               'muteonstart_default' => self::get('muteonstart_default'),
               'disablecam_editable' => self::get('disablecam_editable'),
               'disablecam_default' => self::get('disablecam_default'),
               'disablemic_editable' => self::get('disablemic_editable'),
               'disablemic_default' => self::get('disablemic_default'),
               'disableprivatechat_editable' => self::get('disableprivatechat_editable'),
               'disableprivatechat_default' => self::get('disableprivatechat_default'),
               'disablepublicchat_editable' => self::get('disablepublicchat_editable'),
               'disablepublicchat_default' => self::get('disablepublicchat_default'),
               'disablenote_editable' => self::get('disablenote_editable'),
               'disablenote_default' => self::get('disablenote_default'),
               'hideuserlist_editable' => self::get('hideuserlist_editable'),
               'hideuserlist_default' => self::get('hideuserlist_default'),
               'lockedlayout_editable' => self::get('lockedlayout_editable'),
               'lockedlayout_default' => self::get('lockedlayout_default'),
               'lockonjoin_editable' => self::get('lockonjoin_editable'),
               'lockonjoin_default' => self::get('lockonjoin_default'),
               'lockonjoinconfigurable_editable' => self::get('lockonjoinconfigurable_editable'),
               'lockonjoinconfigurable_default' => self::get('lockonjoinconfigurable_default'),
               'welcome_default' => self::get('welcome_default'),
          );
    }
}


1			<?php
2			// This file is part of Moodle - http://moodle.org/
3			//
4			// Moodle is free software: you can redistribute it and/or modify
5			// it under the terms of the GNU General Public License as published by
6			// the Free Software Foundation, either version 3 of the License, or
7			// (at your option) any later version.
8			//
9			// Moodle is distributed in the hope that it will be useful,
10			// but WITHOUT ANY WARRANTY; without even the implied warranty of
11			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			// GNU General Public License for more details.
13			//
14			// You should have received a copy of the GNU General Public License
15			// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17			/**
18			* The mod_bigbluebuttonbn locallib/config.
19			*
20			* @package mod_bigbluebuttonbn
21			* @copyright 2010 onwards, Blindside Networks Inc
22			* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23			* @author Jesus Federico (jesus [at] blindsidenetworks [dt] com)
24			*/
25
26			namespace mod_bigbluebuttonbn\locallib;
27
28			defined('MOODLE_INTERNAL') \|\| die();
29
30			require_once($CFG->dirroot . '/mod/bigbluebuttonbn/locallib.php');
31
32			/**
33			* Handles the global configuration based on config.php.
34			*
35			* @copyright 2010 onwards, Blindside Networks Inc
36			* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37			*/
38			class config {
39
40			/**
41			* Returns moodle version.
42			*
43			* @return string
44			*/
45			public static function get_moodle_version_major() {
46			global $CFG;
47			$versionarray = explode('.', $CFG->version);
48			return $versionarray[0];
49			}
50
51			/**
52			* Returns configuration default values.
53			*
54			* @return array
55			*/
56			public static function defaultvalues() {
57			return array(
58			'server_url' => (string) BIGBLUEBUTTONBN_DEFAULT_SERVER_URL,
59			'shared_secret' => (string) BIGBLUEBUTTONBN_DEFAULT_SHARED_SECRET,
60			'voicebridge_editable' => false,
61			'importrecordings_enabled' => false,
62			'importrecordings_from_deleted_enabled' => false,
63			'waitformoderator_default' => false,
64			'waitformoderator_editable' => true,
65			'waitformoderator_ping_interval' => '10',
66			'waitformoderator_cache_ttl' => '60',
67			'userlimit_default' => '0',
68			'userlimit_editable' => false,
69			'preuploadpresentation_enabled' => false,
70			'sendnotifications_enabled' => false,
71			'recordingready_enabled' => false,
72			'recordingstatus_enabled' => false,
73			'meetingevents_enabled' => false,
74			'participant_moderator_default' => '0',
75			'participant_moderatorapproval' => '0',
76			'participant_guestlink_enabled' => '1',
77			'participant_guestlink_default' => '0',
78			'scheduled_duration_enabled' => false,
79			'scheduled_duration_compensation' => '10',
80			'scheduled_pre_opening' => '10',
81			'recordings_enabled' => true,
82			'recordings_html_default' => false,
83			'recordings_html_editable' => false,
84			'recordings_deleted_default' => false,
85			'recordings_deleted_editable' => false,
86			'recordings_imported_default' => false,
87			'recordings_imported_editable' => false,
88			'recordings_preview_default' => true,
89			'recordings_preview_editable' => false,
90			'recordings_validate_url' => true,
91			'recording_default' => true,
92			'recording_editable' => true,
93			'recording_icons_enabled' => true,
94			'recording_all_from_start_default' => false,
95			'recording_all_from_start_editable' => false,
96			'recording_hide_button_default' => false,
97			'recording_hide_button_editable' => false,
98			'general_warning_message' => '',
99			'general_warning_roles' => 'editingteacher,teacher',
100			'general_warning_box_type' => 'info',
101			'general_warning_button_text' => '',
102			'general_warning_button_href' => '',
103			'general_warning_button_class' => '',
104			'clienttype_enabled' => false,
105			'clienttype_default' => '0',
106			'clienttype_editable' => true,
107			'muteonstart_default' => false,
108			'muteonstart_editable' => false,
109			'disablecam_default' => false,
110			'disablecam_editable' => true,
111			'disablemic_default' => false,
112			'disablemic_editable' => true,
113			'disableprivatechat_default' => false,
114			'disableprivatechat_editable' => true,
115			'disablepublicchat_default' => false,
116			'disablepublicchat_editable' => true,
117			'disablenote_default' => false,
118			'disablenote_editable' => true,
119			'hideuserlist_default' => false,
120			'hideuserlist_editable' => true,
121			'lockedlayout_default' => false,
122			'lockedlayout_editable' => true,
123			'lockonjoin_default' => false,
124			'lockonjoin_editable' => true,
125			'lockonjoinconfigurable_default' => false,
126			'lockonjoinconfigurable_editable' => true,
127			'welcome_default' => '',
128			);
129			}
130
131			/**
132			* Returns default value for an specific setting.
133			*
134			* @param string $setting
135			* @return string
136			*/
137			public static function defaultvalue($setting) {
138			$defaultvalues = self::defaultvalues();
139			if (!array_key_exists($setting, $defaultvalues)) {
140			return;
141			}
142			return $defaultvalues[$setting];
143			}
144
145			/**
146			* Validates if recording settings are enabled.
147			*
148			* @return boolean
149			*/
150			public static function guestlinks_enabled() {
151			return (boolean)self::get('participant_guestlink');
152			}
153
154			/**
155			* Returns value for an specific setting.
156			*
157			* @param string $setting
158			* @return string
159			*/
160			public static function get($setting) {
161			global $CFG;
162			if (isset($CFG->bigbluebuttonbn[$setting])) {
163			return (string)$CFG->bigbluebuttonbn[$setting];
164			}
165			if (isset($CFG->{'bigbluebuttonbn_'.$setting})) {
166			return (string)$CFG->{'bigbluebuttonbn_'.$setting};
167			}
168			return self::defaultvalue($setting);
169			}
170
171			/**
172			* Validates if recording settings are enabled.
173			*
174			* @return boolean
175			*/
176			public static function recordings_enabled() {
177			return (boolean)self::get('recordings_enabled');
178			}
179
180			/**
181			* Validates if imported recording settings are enabled.
182			*
183			* @return boolean
184			*/
185			public static function importrecordings_enabled() {
186			return (boolean)self::get('importrecordings_enabled');
187			}
188
189			/**
190			* Validates if clienttype settings are enabled.
191			*
192			* @return boolean
193			*/
194			public static function clienttype_enabled() {
195			return (boolean)self::get('clienttype_enabled');
196			}
197
198			/**
199			* Wraps current settings in an array.
200			*
201			* @return array
202			*/
203			public static function get_options() {
204			return array(
205			'version_major' => self::get_moodle_version_major(),
206			'voicebridge_editable' => self::get('voicebridge_editable'),
207			'importrecordings_enabled' => self::get('importrecordings_enabled'),
208			'importrecordings_from_deleted_enabled' => self::get('importrecordings_from_deleted_enabled'),
209			'waitformoderator_default' => self::get('waitformoderator_default'),
210			'waitformoderator_editable' => self::get('waitformoderator_editable'),
211			'userlimit_default' => self::get('userlimit_default'),
212			'userlimit_editable' => self::get('userlimit_editable'),
213			'preuploadpresentation_enabled' => self::get('preuploadpresentation_enabled'),
214			'sendnotifications_enabled' => self::get('sendnotifications_enabled'),
215			'recordings_enabled' => self::get('recordings_enabled'),
216			'meetingevents_enabled' => self::get('meetingevents_enabled'),
217			'recordings_html_default' => self::get('recordings_html_default'),
218			'recordings_html_editable' => self::get('recordings_html_editable'),
219			'recordings_deleted_default' => self::get('recordings_deleted_default'),
220			'recordings_deleted_editable' => self::get('recordings_deleted_editable'),
221			'recordings_imported_default' => self::get('recordings_imported_default'),
222			'recordings_imported_editable' => self::get('recordings_imported_editable'),
223			'recordings_preview_default' => self::get('recordings_preview_default'),
224			'recordings_preview_editable' => self::get('recordings_preview_editable'),
225			'recordings_validate_url' => self::get('recordings_validate_url'),
226			'recording_default' => self::get('recording_default'),
227			'recording_editable' => self::get('recording_editable'),
228			'recording_icons_enabled' => self::get('recording_icons_enabled'),
229			'recording_all_from_start_default' => self::get('recording_all_from_start_default'),
230			'recording_all_from_start_editable' => self::get('recording_all_from_start_editable'),
231			'recording_hide_button_default' => self::get('recording_hide_button_default'),
232			'recording_hide_button_editable' => self::get('recording_hide_button_editable'),
233			'general_warning_message' => self::get('general_warning_message'),
234			'general_warning_box_type' => self::get('general_warning_box_type'),
235			'general_warning_button_text' => self::get('general_warning_button_text'),
236			'general_warning_button_href' => self::get('general_warning_button_href'),
237			'general_warning_button_class' => self::get('general_warning_button_class'),
238			'clienttype_enabled' => self::get('clienttype_enabled'),
239			'clienttype_editable' => self::get('clienttype_editable'),
240			'clienttype_default' => self::get('clienttype_default'),
241			'muteonstart_editable' => self::get('muteonstart_editable'),
242			'muteonstart_default' => self::get('muteonstart_default'),
243			'disablecam_editable' => self::get('disablecam_editable'),
244			'disablecam_default' => self::get('disablecam_default'),
245			'disablemic_editable' => self::get('disablemic_editable'),
246			'disablemic_default' => self::get('disablemic_default'),
247			'disableprivatechat_editable' => self::get('disableprivatechat_editable'),
248			'disableprivatechat_default' => self::get('disableprivatechat_default'),
249			'disablepublicchat_editable' => self::get('disablepublicchat_editable'),
250			'disablepublicchat_default' => self::get('disablepublicchat_default'),
251			'disablenote_editable' => self::get('disablenote_editable'),
252			'disablenote_default' => self::get('disablenote_default'),
253			'hideuserlist_editable' => self::get('hideuserlist_editable'),
254			'hideuserlist_default' => self::get('hideuserlist_default'),
255			'lockedlayout_editable' => self::get('lockedlayout_editable'),
256			'lockedlayout_default' => self::get('lockedlayout_default'),
257			'lockonjoin_editable' => self::get('lockonjoin_editable'),
258			'lockonjoin_default' => self::get('lockonjoin_default'),
259			'lockonjoinconfigurable_editable' => self::get('lockonjoinconfigurable_editable'),
260			'lockonjoinconfigurable_default' => self::get('lockonjoinconfigurable_default'),
261			'welcome_default' => self::get('welcome_default'),
262			);
263			}
264			}
265

blindsidenetworks / moodle-mod_bigbluebuttonbn

Pull Request — master (#289)

config::guestlinks_enabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like