SessionSettingsSchema::settingArrayHelpValue() - Code Metrics - Inspection of "Course home: Fix bug in button Hide all preventing..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9d97a9...43700c )

by Yannick

created 2025-07-13 23:53 UTC

SessionSettingsSchema::settingArrayHelpValue() A

↳ Parent: SessionSettingsSchema

Complexity

Conditions	2
Paths	2

Size

Total Lines	89
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	11
nc	2
nop	1
dl	0
loc	89
rs	9.9
c	1
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CoreBundle\Settings;

use Chamilo\CoreBundle\Form\Type\YesNoType;
use Sylius\Bundle\SettingsBundle\Schema\AbstractSettingsBuilder;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class SessionSettingsSchema extends AbstractSettingsSchema
{
    public function buildSettings(AbstractSettingsBuilder $builder): void
    {
        $builder
            ->setDefaults(
                [
                    'add_users_by_coach' => 'false',
                    'extend_rights_for_coach' => 'false',
                    'show_session_coach' => 'false',
                    'show_session_data' => 'false',
                    'allow_coach_to_edit_course_session' => 'true',
                    'show_groups_to_users' => 'false',
                    'hide_courses_in_sessions' => 'false',
                    'allow_session_admins_to_manage_all_sessions' => 'false',
                    'allow_teachers_to_create_sessions' => 'false',
                    'prevent_session_admins_to_manage_all_users' => 'false',
                    'session_course_ordering' => 'false',
                    'limit_session_admin_role' => 'false',
                    'allow_tutors_to_assign_students_to_session' => 'false',
                    'drh_can_access_all_session_content' => 'true',
                    'catalog_allow_session_auto_subscription' => 'false',
                    'allow_session_course_copy_for_teachers' => 'false',
                    'my_courses_view_by_session' => 'false',
                    'session_days_after_coach_access' => '',
                    'session_days_before_coach_access' => '',
                    'show_session_description' => 'false',
                    'remove_session_url' => 'false',
                    'hide_tab_list' => '',
                    'session_admins_edit_courses_content' => 'false',
                    'allow_session_admin_login_as_teacher' => 'false',
                    'allow_search_diagnostic' => 'false',
                    'allow_redirect_to_session_after_inscription_about' => 'false',
                    'session_list_show_count_users' => 'false',
                    'session_admins_access_all_content' => 'false',
                    'limit_session_admin_list_users' => 'false',
                    'hide_search_form_in_session_list' => 'false',
                    'allow_delete_user_for_session_admin' => 'false',
                    'allow_disable_user_for_session_admin' => 'false',
                    'session_multiple_subscription_students_list_avoid_emptying' => 'false',
                    'hide_reporting_session_list' => 'false',
                    'allow_session_admin_read_careers' => 'false',
                    'session_list_order' => 'false',
                    'allow_user_session_collapsable' => 'false',
                    'catalog_course_subscription_in_user_s_session' => 'false',
                    'default_session_list_view' => 'all',
                    'session_automatic_creation_user_id' => '1',
                    'user_s_session_duration' => '1095',
                    'my_courses_session_order' => '',
                    'session_courses_read_only_mode' => 'false',
                    'session_import_settings' => '',
                    'catalog_settings' => '',
                    'tracking_columns' => '',
                    'my_progress_session_show_all_courses' => 'false',
                    'assignment_base_course_teacher_access_to_all_session' => 'false',
                    'allow_session_admin_extra_access' => 'false',
                    'hide_session_graph_in_my_progress' => 'false',
                    'show_users_in_active_sessions_in_tracking' => 'false',
                    'session_coach_access_after_duration_end' => 'false',
                    'session_course_users_subscription_limited_to_session_users' => 'false',
                    'session_classes_tab_disable' => 'false',
                    'email_template_subscription_to_session_confirmation_username' => 'false',
                    'email_template_subscription_to_session_confirmation_lost_password' => 'false',
                    'session_creation_user_course_extra_field_relation_to_prefill' => '',
                    'session_creation_form_set_extra_fields_mandatory' => '',
                    'session_model_list_field_ordered_by_id' => 'false',
                    'duplicate_specific_session_content_on_session_copy' => 'false',
                    'enable_auto_reinscription' => 'false',
                    'enable_session_replication' => 'false',
                    'session_list_view_remaining_days' => 'false',
                    'user_session_display_mode' => 'card',
                ]
            )
        ;

        $allowedTypes = [
            'add_users_by_coach' => ['string'],
        ];
        $this->setMultipleAllowedTypes($allowedTypes, $builder);
    }

    public function buildForm(FormBuilderInterface $builder): void
    {
        $builder
            ->add('add_users_by_coach', YesNoType::class)
            ->add('extend_rights_for_coach', YesNoType::class)
            ->add('show_session_coach', YesNoType::class)
            ->add('show_session_data', YesNoType::class)
            ->add('allow_coach_to_edit_course_session', YesNoType::class)
            ->add('show_groups_to_users', YesNoType::class)
            ->add('hide_courses_in_sessions', YesNoType::class)
            ->add('allow_session_admins_to_manage_all_sessions', YesNoType::class)
            ->add('allow_teachers_to_create_sessions', YesNoType::class)
            ->add('prevent_session_admins_to_manage_all_users', YesNoType::class)
            ->add('session_course_ordering', TextType::class)
            ->add('limit_session_admin_role', YesNoType::class)
            ->add('allow_tutors_to_assign_students_to_session', YesNoType::class)
            ->add('drh_can_access_all_session_content', YesNoType::class)
            ->add('catalog_allow_session_auto_subscription', YesNoType::class)
            ->add('allow_session_course_copy_for_teachers', YesNoType::class)
            ->add('my_courses_view_by_session', YesNoType::class)
            ->add('session_days_after_coach_access')
            ->add('session_days_before_coach_access')
            ->add('show_session_description', YesNoType::class)
            ->add('remove_session_url', YesNoType::class)
            ->add('hide_tab_list')
            ->add('session_admins_edit_courses_content', YesNoType::class)
            ->add('allow_session_admin_login_as_teacher', YesNoType::class)
            ->add('allow_search_diagnostic', YesNoType::class)
            ->add('allow_redirect_to_session_after_inscription_about', YesNoType::class)
            ->add('session_list_show_count_users', YesNoType::class)
            ->add('session_admins_access_all_content', YesNoType::class)
            ->add('limit_session_admin_list_users', YesNoType::class)
            ->add('hide_search_form_in_session_list', YesNoType::class)
            ->add('allow_delete_user_for_session_admin', YesNoType::class)
            ->add('allow_disable_user_for_session_admin', YesNoType::class)
            ->add('session_multiple_subscription_students_list_avoid_emptying', YesNoType::class)
            ->add('hide_reporting_session_list', YesNoType::class)
            ->add('allow_session_admin_read_careers', YesNoType::class)
            ->add('session_list_order', YesNoType::class)
            ->add('allow_user_session_collapsable', YesNoType::class)
            ->add('catalog_course_subscription_in_user_s_session', YesNoType::class)
            ->add('default_session_list_view', ChoiceType::class, [
                'choices' => [
                    'All' => 'all',
                    'Close' => 'close',
                    'Active' => 'active',
                    'Custom' => 'custom',
                ],
            ])
            ->add('session_automatic_creation_user_id', TextType::class)
            ->add('user_s_session_duration', TextType::class)
            ->add('my_courses_session_order', TextareaType::class)
            ->add('session_courses_read_only_mode', YesNoType::class)
            ->add('session_import_settings', TextareaType::class)
            ->add('catalog_settings', TextareaType::class)
            ->add('tracking_columns', TextareaType::class)
            ->add('my_progress_session_show_all_courses', YesNoType::class)
            ->add('assignment_base_course_teacher_access_to_all_session', YesNoType::class)
            ->add('allow_session_admin_extra_access', YesNoType::class)
            ->add('hide_session_graph_in_my_progress', YesNoType::class)
            ->add('show_users_in_active_sessions_in_tracking', YesNoType::class)
            ->add('session_coach_access_after_duration_end', YesNoType::class)
            ->add('session_course_users_subscription_limited_to_session_users', YesNoType::class)
            ->add('email_template_subscription_to_session_confirmation_username', YesNoType::class)
            ->add('email_template_subscription_to_session_confirmation_lost_password', YesNoType::class)
            ->add('session_creation_user_course_extra_field_relation_to_prefill', TextareaType::class)
            ->add('session_creation_form_set_extra_fields_mandatory', TextareaType::class)
            ->add('session_model_list_field_ordered_by_id', YesNoType::class)
            ->add('duplicate_specific_session_content_on_session_copy', YesNoType::class)
            ->add('session_list_view_remaining_days', YesNoType::class)
            ->add('user_session_display_mode', ChoiceType::class, [
                'choices' => [
                    'Card (visual blocks)' => 'card',
                    'List (classic)' => 'list',
                ],
            ])
        ;

        $this->updateFormFieldsFromSettingsInfo($builder);
    }

    private function settingArrayHelpValue(string $variable): string

    {
        $values = [
            'my_courses_session_order' => '<pre>
                ["field" => "end_date", "order" => "desc"]
                </pre>',
            'session_import_settings' => "<pre>
                [
                    'options' =>  [
                        'session_exists_default_option' => '1',
                        'send_mail_default_option' => '1',
                    ]
                ]
                </pre>",
            'catalog_settings' => "<pre>
                [
                    'sessions' => [
                        'by_title' => true,
                        'by_date' => true,
                        'by_tag' => true,
                        'show_session_info' => true,
                        'show_session_date' => true,
                    ],
                    'courses' => [
                        'by_title' => true,
                    ],
                ]
                </pre>",
            'tracking_columns' => "<pre>
                [
                    'course_session' => [
                        'course_title' => true,
                        'published_exercises' => true,
                        'new_exercises' => true,
                        'my_average' => true,
                        'average_exercise_result' => true,
                        'time_spent' => true,
                        'lp_progress' => true,
                        'score' => true,
                        'best_score' => true,
                        'last_connection' => true,
                        'details' => true,
                    ],
                    'my_students_lp' => [
                        'lp' => true,
                        'time' => true,
                        'best_score' => true,
                        'latest_attempt_avg_score' => true,
                        'progress' => true,
                        'last_connection' => true,
                    ],
                    'my_progress_lp' => [
                        'lp' => true,
                        'time' => true,
                        'progress' => true,
                        'score' => true,
                        'best_score' => true,
                        'last_connection' => true,
                    ],
                    'my_progress_courses' => [
                        'course_title' => true,
                        'time_spent' => true,
                        'progress' => true,
                        'best_score_in_lp' => true,
                        'best_score_not_in_lp' => true,
                        'latest_login' => true,
                        'details' => true
                    ]
                ]
                </pre>",
            'session_creation_user_course_extra_field_relation_to_prefill' => "<pre>
                [
                    'fields' => [
                        'client' => 'client',
                        'region' => 'region',
                    ]
                ]
                </pre>",
            'session_creation_form_set_extra_fields_mandatory' => "<pre>
                ['fields' => ['client','region']]
                </pre>",
        ];

        $returnValue = [];
        if (isset($values[$variable])) {
            $returnValue = $values[$variable];
        }

        return $returnValue;

    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Settings;
8
9			use Chamilo\CoreBundle\Form\Type\YesNoType;
10			use Sylius\Bundle\SettingsBundle\Schema\AbstractSettingsBuilder;
11			use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
12			use Symfony\Component\Form\Extension\Core\Type\TextareaType;
13			use Symfony\Component\Form\Extension\Core\Type\TextType;
14			use Symfony\Component\Form\FormBuilderInterface;
15
16			class SessionSettingsSchema extends AbstractSettingsSchema
17			{
18			public function buildSettings(AbstractSettingsBuilder $builder): void
19			{
20			$builder
21			->setDefaults(
22			[
23			'add_users_by_coach' => 'false',
24			'extend_rights_for_coach' => 'false',
25			'show_session_coach' => 'false',
26			'show_session_data' => 'false',
27			'allow_coach_to_edit_course_session' => 'true',
28			'show_groups_to_users' => 'false',
29			'hide_courses_in_sessions' => 'false',
30			'allow_session_admins_to_manage_all_sessions' => 'false',
31			'allow_teachers_to_create_sessions' => 'false',
32			'prevent_session_admins_to_manage_all_users' => 'false',
33			'session_course_ordering' => 'false',
34			'limit_session_admin_role' => 'false',
35			'allow_tutors_to_assign_students_to_session' => 'false',
36			'drh_can_access_all_session_content' => 'true',
37			'catalog_allow_session_auto_subscription' => 'false',
38			'allow_session_course_copy_for_teachers' => 'false',
39			'my_courses_view_by_session' => 'false',
40			'session_days_after_coach_access' => '',
41			'session_days_before_coach_access' => '',
42			'show_session_description' => 'false',
43			'remove_session_url' => 'false',
44			'hide_tab_list' => '',
45			'session_admins_edit_courses_content' => 'false',
46			'allow_session_admin_login_as_teacher' => 'false',
47			'allow_search_diagnostic' => 'false',
48			'allow_redirect_to_session_after_inscription_about' => 'false',
49			'session_list_show_count_users' => 'false',
50			'session_admins_access_all_content' => 'false',
51			'limit_session_admin_list_users' => 'false',
52			'hide_search_form_in_session_list' => 'false',
53			'allow_delete_user_for_session_admin' => 'false',
54			'allow_disable_user_for_session_admin' => 'false',
55			'session_multiple_subscription_students_list_avoid_emptying' => 'false',
56			'hide_reporting_session_list' => 'false',
57			'allow_session_admin_read_careers' => 'false',
58			'session_list_order' => 'false',
59			'allow_user_session_collapsable' => 'false',
60			'catalog_course_subscription_in_user_s_session' => 'false',
61			'default_session_list_view' => 'all',
62			'session_automatic_creation_user_id' => '1',
63			'user_s_session_duration' => '1095',
64			'my_courses_session_order' => '',
65			'session_courses_read_only_mode' => 'false',
66			'session_import_settings' => '',
67			'catalog_settings' => '',
68			'tracking_columns' => '',
69			'my_progress_session_show_all_courses' => 'false',
70			'assignment_base_course_teacher_access_to_all_session' => 'false',
71			'allow_session_admin_extra_access' => 'false',
72			'hide_session_graph_in_my_progress' => 'false',
73			'show_users_in_active_sessions_in_tracking' => 'false',
74			'session_coach_access_after_duration_end' => 'false',
75			'session_course_users_subscription_limited_to_session_users' => 'false',
76			'session_classes_tab_disable' => 'false',
77			'email_template_subscription_to_session_confirmation_username' => 'false',
78			'email_template_subscription_to_session_confirmation_lost_password' => 'false',
79			'session_creation_user_course_extra_field_relation_to_prefill' => '',
80			'session_creation_form_set_extra_fields_mandatory' => '',
81			'session_model_list_field_ordered_by_id' => 'false',
82			'duplicate_specific_session_content_on_session_copy' => 'false',
83			'enable_auto_reinscription' => 'false',
84			'enable_session_replication' => 'false',
85			'session_list_view_remaining_days' => 'false',
86			'user_session_display_mode' => 'card',
87			]
88			)
89			;
90
91			$allowedTypes = [
92			'add_users_by_coach' => ['string'],
93			];
94			$this->setMultipleAllowedTypes($allowedTypes, $builder);
95			}
96
97			public function buildForm(FormBuilderInterface $builder): void
98			{
99			$builder
100			->add('add_users_by_coach', YesNoType::class)
101			->add('extend_rights_for_coach', YesNoType::class)
102			->add('show_session_coach', YesNoType::class)
103			->add('show_session_data', YesNoType::class)
104			->add('allow_coach_to_edit_course_session', YesNoType::class)
105			->add('show_groups_to_users', YesNoType::class)
106			->add('hide_courses_in_sessions', YesNoType::class)
107			->add('allow_session_admins_to_manage_all_sessions', YesNoType::class)
108			->add('allow_teachers_to_create_sessions', YesNoType::class)
109			->add('prevent_session_admins_to_manage_all_users', YesNoType::class)
110			->add('session_course_ordering', TextType::class)
111			->add('limit_session_admin_role', YesNoType::class)
112			->add('allow_tutors_to_assign_students_to_session', YesNoType::class)
113			->add('drh_can_access_all_session_content', YesNoType::class)
114			->add('catalog_allow_session_auto_subscription', YesNoType::class)
115			->add('allow_session_course_copy_for_teachers', YesNoType::class)
116			->add('my_courses_view_by_session', YesNoType::class)
117			->add('session_days_after_coach_access')
118			->add('session_days_before_coach_access')
119			->add('show_session_description', YesNoType::class)
120			->add('remove_session_url', YesNoType::class)
121			->add('hide_tab_list')
122			->add('session_admins_edit_courses_content', YesNoType::class)
123			->add('allow_session_admin_login_as_teacher', YesNoType::class)
124			->add('allow_search_diagnostic', YesNoType::class)
125			->add('allow_redirect_to_session_after_inscription_about', YesNoType::class)
126			->add('session_list_show_count_users', YesNoType::class)
127			->add('session_admins_access_all_content', YesNoType::class)
128			->add('limit_session_admin_list_users', YesNoType::class)
129			->add('hide_search_form_in_session_list', YesNoType::class)
130			->add('allow_delete_user_for_session_admin', YesNoType::class)
131			->add('allow_disable_user_for_session_admin', YesNoType::class)
132			->add('session_multiple_subscription_students_list_avoid_emptying', YesNoType::class)
133			->add('hide_reporting_session_list', YesNoType::class)
134			->add('allow_session_admin_read_careers', YesNoType::class)
135			->add('session_list_order', YesNoType::class)
136			->add('allow_user_session_collapsable', YesNoType::class)
137			->add('catalog_course_subscription_in_user_s_session', YesNoType::class)
138			->add('default_session_list_view', ChoiceType::class, [
139			'choices' => [
140			'All' => 'all',
141			'Close' => 'close',
142			'Active' => 'active',
143			'Custom' => 'custom',
144			],
145			])
146			->add('session_automatic_creation_user_id', TextType::class)
147			->add('user_s_session_duration', TextType::class)
148			->add('my_courses_session_order', TextareaType::class)
149			->add('session_courses_read_only_mode', YesNoType::class)
150			->add('session_import_settings', TextareaType::class)
151			->add('catalog_settings', TextareaType::class)
152			->add('tracking_columns', TextareaType::class)
153			->add('my_progress_session_show_all_courses', YesNoType::class)
154			->add('assignment_base_course_teacher_access_to_all_session', YesNoType::class)
155			->add('allow_session_admin_extra_access', YesNoType::class)
156			->add('hide_session_graph_in_my_progress', YesNoType::class)
157			->add('show_users_in_active_sessions_in_tracking', YesNoType::class)
158			->add('session_coach_access_after_duration_end', YesNoType::class)
159			->add('session_course_users_subscription_limited_to_session_users', YesNoType::class)
160			->add('email_template_subscription_to_session_confirmation_username', YesNoType::class)
161			->add('email_template_subscription_to_session_confirmation_lost_password', YesNoType::class)
162			->add('session_creation_user_course_extra_field_relation_to_prefill', TextareaType::class)
163			->add('session_creation_form_set_extra_fields_mandatory', TextareaType::class)
164			->add('session_model_list_field_ordered_by_id', YesNoType::class)
165			->add('duplicate_specific_session_content_on_session_copy', YesNoType::class)
166			->add('session_list_view_remaining_days', YesNoType::class)
167			->add('user_session_display_mode', ChoiceType::class, [
168			'choices' => [
169			'Card (visual blocks)' => 'card',
170			'List (classic)' => 'list',
171			],
172			])
173			;
174
175			$this->updateFormFieldsFromSettingsInfo($builder);
176			}
177
178			private function settingArrayHelpValue(string $variable): string
			0 ignored issues – show Unused Code introduced 2025-07-13 23:55 UTC by Report Bug Copy Issue Report The method `settingArrayHelpValue()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
179			{
180			$values = [
181			'my_courses_session_order' => '<pre>
182			["field" => "end_date", "order" => "desc"]
183			</pre>',
184			'session_import_settings' => "<pre>
185			[
186			'options' => [
187			'session_exists_default_option' => '1',
188			'send_mail_default_option' => '1',
189			]
190			]
191			</pre>",
192			'catalog_settings' => "<pre>
193			[
194			'sessions' => [
195			'by_title' => true,
196			'by_date' => true,
197			'by_tag' => true,
198			'show_session_info' => true,
199			'show_session_date' => true,
200			],
201			'courses' => [
202			'by_title' => true,
203			],
204			]
205			</pre>",
206			'tracking_columns' => "<pre>
207			[
208			'course_session' => [
209			'course_title' => true,
210			'published_exercises' => true,
211			'new_exercises' => true,
212			'my_average' => true,
213			'average_exercise_result' => true,
214			'time_spent' => true,
215			'lp_progress' => true,
216			'score' => true,
217			'best_score' => true,
218			'last_connection' => true,
219			'details' => true,
220			],
221			'my_students_lp' => [
222			'lp' => true,
223			'time' => true,
224			'best_score' => true,
225			'latest_attempt_avg_score' => true,
226			'progress' => true,
227			'last_connection' => true,
228			],
229			'my_progress_lp' => [
230			'lp' => true,
231			'time' => true,
232			'progress' => true,
233			'score' => true,
234			'best_score' => true,
235			'last_connection' => true,
236			],
237			'my_progress_courses' => [
238			'course_title' => true,
239			'time_spent' => true,
240			'progress' => true,
241			'best_score_in_lp' => true,
242			'best_score_not_in_lp' => true,
243			'latest_login' => true,
244			'details' => true
245			]
246			]
247			</pre>",
248			'session_creation_user_course_extra_field_relation_to_prefill' => "<pre>
249			[
250			'fields' => [
251			'client' => 'client',
252			'region' => 'region',
253			]
254			]
255			</pre>",
256			'session_creation_form_set_extra_fields_mandatory' => "<pre>
257			['fields' => ['client','region']]
258			</pre>",
259			];
260
261			$returnValue = [];
262			if (isset($values[$variable])) {
263			$returnValue = $values[$variable];
264			}
265
266			return $returnValue;
			0 ignored issues – show Bug Best Practice introduced 2023-04-17 22:24 UTC by Report Bug Copy Issue Report The expression `return $returnValue` could return the type `array` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
267			}
268			}
269

chamilo / chamilo-lms

Push — master ( 9d97a9...43700c )

SessionSettingsSchema::settingArrayHelpValue() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like