Passed
Push — master ( 985b98...22eb23 )
by Angel Fernando Quiroz
19:12
created

CourseSettingsSchema::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 0

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 0
nc 1
nop 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
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\Entity\Course;
10
use Chamilo\CoreBundle\Form\DataTransformer\ResourceToIdentifierTransformer;
11
use Chamilo\CoreBundle\Form\Type\YesNoType;
12
use Chamilo\CoreBundle\Repository\Node\CourseRepository;
13
use Chamilo\CoreBundle\Tool\AbstractTool;
14
use Chamilo\CoreBundle\Tool\ToolChain;
15
use Chamilo\CoreBundle\Transformer\ArrayToIdentifierTransformer;
16
use Sylius\Bundle\SettingsBundle\Schema\AbstractSettingsBuilder;
17
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
18
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
19
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
20
use Symfony\Component\Form\Extension\Core\Type\TextType;
21
use Symfony\Component\Form\Extension\Core\Type\UrlType;
22
use Symfony\Component\Form\FormBuilderInterface;
23
24
class CourseSettingsSchema extends AbstractSettingsSchema
25
{
26
    protected ToolChain $toolChain;
27
28
    public function __construct(
29
        private readonly CourseRepository $courseRepository,
30
    ) {}
31
32
    public function getProcessedToolChain(): array
33
    {
34
        $tools = [];
35
36
        /** @var AbstractTool $tool */
37
        foreach ($this->toolChain->getTools() as $tool) {
38
            $name = $tool->getTitle();
39
            $tools[$name] = $name;
40
        }
41
42
        return $tools;
43
    }
44
45
    public function setToolChain(ToolChain $tools): void
46
    {
47
        $this->toolChain = $tools;
48
    }
49
50
    public function buildSettings(AbstractSettingsBuilder $builder): void
51
    {
52
        $tools = $this->getProcessedToolChain();
53
54
        $builder
55
            ->setDefaults(
56
                [
57
                    // @todo check default value?
58
                    'active_tools_on_create' => $tools,
59
                    'display_coursecode_in_courselist' => 'false',
60
                    'display_teacher_in_courselist' => 'true',
61
                    'student_view_enabled' => 'true',
62
                    'go_to_course_after_login' => 'false',
63
                    'show_navigation_menu' => 'false',
64
                    'enable_tool_introduction' => 'false',
65
                    'breadcrumbs_course_homepage' => 'course_title',
66
                    'example_material_course_creation' => 'true',
67
                    'allow_course_theme' => 'true',
68
                    'allow_users_to_create_courses' => 'true',
69
                    'show_courses_descriptions_in_catalog' => 'true',
70
                    'send_email_to_admin_when_create_course' => 'false',
71
                    'allow_user_course_subscription_by_course_admin' => 'true',
72
                    'course_validation' => 'false',
73
                    'course_validation_terms_and_conditions_url' => '',
74
                    'course_hide_tools' => [],
75
                    'scorm_cumulative_session_time' => 'true',
76
                    'courses_default_creation_visibility' => '2',
77
                    // COURSE_VISIBILITY_OPEN_PLATFORM
78
                    'allow_public_certificates' => 'false',
79
                    'allow_lp_return_link' => 'true',
80
                    'course_creation_use_template' => null,
81
                    'hide_scorm_export_link' => 'false',
82
                    'hide_scorm_copy_link' => 'false',
83
                    'hide_scorm_pdf_link' => 'true',
84
                    'course_catalog_published' => 'false',
85
                    'course_images_in_courses_list' => 'true',
86
                    'teacher_can_select_course_template' => 'true',
87
                    'show_toolshortcuts' => '',
88
                    'enable_record_audio' => 'false',
89
                    'lp_show_reduced_report' => 'false',
90
                    'course_creation_splash_screen' => 'true',
91
                    'block_registered_users_access_to_open_course_contents' => 'false',
92
                    'enable_bootstrap_in_documents_html' => 'false',
93
                    'view_grid_courses' => 'true',
94
                    'show_simple_session_info' => 'true',
95
                    'my_courses_show_courses_in_user_language_only' => 'false',
96
                    'allow_public_course_with_no_terms_conditions' => 'false',
97
                    'show_all_sessions_on_my_course_page' => 'true',
98
                    'disabled_edit_session_coaches_course_editing_course' => 'false',
99
                    'allow_base_course_category' => 'false',
100
                    'hide_course_sidebar' => 'true',
101
                    'allow_course_extra_field_in_catalog' => 'false',
102
                    'multiple_access_url_show_shared_course_marker' => 'false',
103
                    'course_category_code_to_use_as_model' => 'MY_CATEGORY',
104
                    'enable_unsubscribe_button_on_my_course_page' => 'false',
105
                    'course_creation_donate_message_show' => 'false',
106
                    'course_creation_donate_link' => '<some donate button html>',
107
                    'courses_list_session_title_link' => '1',
108
                    'hide_course_rating' => 'false',
109
                    'course_log_hide_columns' => '',
110
                    'course_student_info' => '',
111
                    'course_catalog_settings' => '',
112
                    'resource_sequence_show_dependency_in_course_intro' => 'false',
113
                    'course_catalog_display_in_home' => 'false',
114
                    'course_creation_form_set_course_category_mandatory' => 'false',
115
                    'course_creation_form_hide_course_code' => 'false',
116
                    'course_about_teacher_name_hide' => 'false',
117
                    'course_visibility_change_only_admin' => 'false',
118
                    'catalog_hide_public_link' => 'false',
119
                    'course_log_default_extra_fields' => '',
120
                    'show_courses_in_catalogue' => 'false',
121
                    'courses_catalogue_show_only_category' => '',
122
                    'course_creation_by_teacher_extra_fields_to_show' => '',
123
                    'course_creation_form_set_extra_fields_mandatory' => '',
124
                    'course_configuration_tool_extra_fields_to_show_and_edit' => '',
125
                    'course_creation_user_course_extra_field_relation_to_prefill' => '',
126
                    'allow_edit_tool_visibility_in_session' => 'true',
127
                    'show_course_duration' => 'false',
128
                ]
129
            )
130
            ->setTransformer(
131
                'active_tools_on_create',
132
                new ArrayToIdentifierTransformer()
133
            )
134
            ->setTransformer(
135
                'course_hide_tools',
136
                new ArrayToIdentifierTransformer()
137
            )
138
            ->setTransformer(
139
                'course_creation_use_template',
140
                new ResourceToIdentifierTransformer($this->courseRepository, 'id')
141
            )
142
        ;
143
144
        $allowedTypes = [
145
            'active_tools_on_create' => ['array'],
146
            'course_hide_tools' => ['array'],
147
            'display_coursecode_in_courselist' => ['string'],
148
            'display_teacher_in_courselist' => ['string'],
149
            'student_view_enabled' => ['string'],
150
        ];
151
152
        $this->setMultipleAllowedTypes($allowedTypes, $builder);
153
    }
154
155
    public function buildForm(FormBuilderInterface $builder): void
156
    {
157
        $tools = $this->getProcessedToolChain();
158
159
        $builder
160
            ->add(
161
                'active_tools_on_create',
162
                ChoiceType::class,
163
                [
164
                    'choices' => $tools,
165
                    'multiple' => true,
166
                    'expanded' => true,
167
                ]
168
            )
169
            ->add('display_coursecode_in_courselist', YesNoType::class)
170
            ->add('display_teacher_in_courselist', YesNoType::class)
171
            ->add('student_view_enabled', YesNoType::class)
172
            ->add('go_to_course_after_login', YesNoType::class)
173
            ->add(
174
                'show_navigation_menu',
175
                ChoiceType::class,
176
                [
177
                    'choices' => [
178
                        'No' => 'false',
179
                        'Icons only' => 'icons',
180
                        'Text only' => 'text',
181
                        'Icons text' => 'iconstext',
182
                    ],
183
                ]
184
            )
185
            ->add('enable_tool_introduction', YesNoType::class)
186
            ->add(
187
                'breadcrumbs_course_homepage',
188
                ChoiceType::class,
189
                [
190
                    'choices' => [
191
                        'Course homepage' => 'course_home',
192
                        'Course code' => 'course_code',
193
                        'Course title' => 'course_title',
194
                        'Session name and course title' => 'session_name_and_course_title',
195
                    ],
196
                ]
197
            )
198
            ->add('example_material_course_creation', YesNoType::class)
199
            ->add('allow_course_theme', YesNoType::class)
200
            ->add('allow_users_to_create_courses', YesNoType::class)
201
            ->add('show_courses_descriptions_in_catalog', YesNoType::class)
202
            ->add('send_email_to_admin_when_create_course', YesNoType::class)
203
            ->add('allow_user_course_subscription_by_course_admin', YesNoType::class)
204
            ->add('course_validation', YesNoType::class)
205
            ->add('course_validation_terms_and_conditions_url', UrlType::class)
206
            ->add(
207
                'course_hide_tools',
208
                ChoiceType::class,
209
                [
210
                    'choices' => $tools,
211
                    'multiple' => true,
212
                    'expanded' => true,
213
                ]
214
            )
215
            ->add('scorm_cumulative_session_time', YesNoType::class)
216
            ->add(
217
                'courses_default_creation_visibility',
218
                ChoiceType::class,
219
                [
220
                    'choices' => [
221
                        'Public' => '3',
222
                        'Open' => '2',
223
                        'Private' => '1',
224
                        'Closed' => '0',
225
                    ],
226
                ]
227
            )
228
            ->add('allow_public_certificates', YesNoType::class)
229
            ->add('allow_lp_return_link', YesNoType::class)
230
            ->add(
231
                'course_creation_use_template',
232
                EntityType::class,
233
                [
234
                    'class' => Course::class,
235
                    'placeholder' => 'Choose ...',
236
                    'empty_data' => null,
237
                    'choice_label' => 'title',
238
                    'choice_value' => 'id',
239
                    'required' => false,
240
                ]
241
            )
242
            ->add('hide_scorm_export_link', YesNoType::class)
243
            ->add('hide_scorm_copy_link', YesNoType::class)
244
            ->add('hide_scorm_pdf_link', YesNoType::class)
245
            ->add('course_catalog_published', YesNoType::class)
246
            ->add('course_images_in_courses_list', YesNoType::class)
247
            ->add('teacher_can_select_course_template', YesNoType::class)
248
            ->add('show_toolshortcuts', YesNoType::class)
249
            ->add('enable_record_audio', YesNoType::class)
250
            ->add('lp_show_reduced_report', YesNoType::class)
251
            ->add('course_creation_splash_screen', YesNoType::class)
252
            ->add('block_registered_users_access_to_open_course_contents', YesNoType::class)
253
            ->add('enable_bootstrap_in_documents_html', YesNoType::class)
254
            ->add('view_grid_courses', YesNoType::class)
255
            ->add('show_simple_session_info', YesNoType::class)
256
            ->add('my_courses_show_courses_in_user_language_only', YesNoType::class)
257
            ->add('allow_public_course_with_no_terms_conditions', YesNoType::class)
258
            ->add('show_all_sessions_on_my_course_page', YesNoType::class)
259
            ->add('disabled_edit_session_coaches_course_editing_course', YesNoType::class)
260
            ->add('allow_base_course_category', YesNoType::class)
261
            ->add('hide_course_sidebar', YesNoType::class)
262
            ->add('allow_course_extra_field_in_catalog', YesNoType::class)
263
            ->add('multiple_access_url_show_shared_course_marker', YesNoType::class)
264
            ->add(
265
                'course_category_code_to_use_as_model',
266
                TextType::class,
267
                [
268
                    'label' => 'CourseCategoryCodeToUseAsModelTitle',
269
                    'help' => 'CourseCategoryCodeToUseAsModelComment',
270
                ]
271
            )
272
            ->add('enable_unsubscribe_button_on_my_course_page', YesNoType::class)
273
            ->add('course_creation_donate_message_show', YesNoType::class)
274
            ->add(
275
                'course_creation_donate_link',
276
                TextType::class,
277
                [
278
                    'label' => 'CourseCreationDonateLinkTitle',
279
                    'help' => 'CourseCreationDonateLinkComment',
280
                ]
281
            )
282
            ->add(
283
                'courses_list_session_title_link',
284
                ChoiceType::class,
285
                [
286
                    'choices' => [
287
                        'No link' => '0',
288
                        'Default' => '1',
289
                        'Link' => '2',
290
                        'Session link' => '3',
291
                    ],
292
                ]
293
            )
294
            ->add('hide_course_rating', YesNoType::class)
295
            ->add(
296
                'course_log_hide_columns',
297
                TextareaType::class,
298
                [
299
                    'help_html' => true,
300
                    'help' => $this->settingArrayHelpValue('course_log_hide_columns'),
301
                ]
302
            )
303
            ->add(
304
                'course_student_info',
305
                TextareaType::class,
306
                [
307
                    'help_html' => true,
308
                    'help' => $this->settingArrayHelpValue('course_student_info'),
309
                ]
310
            )
311
            ->add(
312
                'course_catalog_settings',
313
                TextareaType::class,
314
                [
315
                    'help_html' => true,
316
                    'help' => $this->settingArrayHelpValue('course_catalog_settings'),
317
                ]
318
            )
319
            ->add('resource_sequence_show_dependency_in_course_intro', YesNoType::class)
320
            ->add('course_catalog_display_in_home', YesNoType::class)
321
            ->add('course_creation_form_set_course_category_mandatory', YesNoType::class)
322
            ->add('course_creation_form_hide_course_code', YesNoType::class)
323
            ->add('course_about_teacher_name_hide', YesNoType::class)
324
            ->add('course_visibility_change_only_admin', YesNoType::class)
325
            ->add('catalog_hide_public_link', YesNoType::class)
326
            ->add(
327
                'course_log_default_extra_fields',
328
                TextareaType::class,
329
                [
330
                    'help_html' => true,
331
                    'help' => $this->settingArrayHelpValue('course_log_default_extra_fields'),
332
                ]
333
            )
334
            ->add('show_courses_in_catalogue', YesNoType::class)
335
            ->add(
336
                'courses_catalogue_show_only_category',
337
                TextareaType::class,
338
                [
339
                    'help_html' => true,
340
                    'help' => $this->settingArrayHelpValue('courses_catalogue_show_only_category'),
341
                ]
342
            )
343
            ->add(
344
                'course_creation_by_teacher_extra_fields_to_show',
345
                TextareaType::class,
346
                [
347
                    'help_html' => true,
348
                    'help' => $this->settingArrayHelpValue('course_creation_by_teacher_extra_fields_to_show'),
349
                ]
350
            )
351
            ->add(
352
                'course_creation_form_set_extra_fields_mandatory',
353
                TextareaType::class,
354
                [
355
                    'help_html' => true,
356
                    'help' => $this->settingArrayHelpValue('course_creation_form_set_extra_fields_mandatory'),
357
                ]
358
            )
359
            ->add(
360
                'course_configuration_tool_extra_fields_to_show_and_edit',
361
                TextareaType::class,
362
                [
363
                    'help_html' => true,
364
                    'help' => $this->settingArrayHelpValue('course_configuration_tool_extra_fields_to_show_and_edit'),
365
                ]
366
            )
367
            ->add(
368
                'course_creation_user_course_extra_field_relation_to_prefill',
369
                TextareaType::class,
370
                [
371
                    'help_html' => true,
372
                    'help' => $this->settingArrayHelpValue('course_creation_user_course_extra_field_relation_to_prefill'),
373
                ]
374
            )
375
            ->add('allow_edit_tool_visibility_in_session', YesNoType::class)
376
            ->add('show_course_duration', YesNoType::class)
377
        ;
378
379
        $this->updateFormFieldsFromSettingsInfo($builder);
380
    }
381
382
    private function settingArrayHelpValue(string $variable): string
383
    {
384
        $values = [
385
            'course_log_hide_columns' => "<pre>
386
                ['columns' => [1, 9]]
387
                </pre>",
388
            'course_student_info' => "<pre>
389
                [
390
                    'score' => false,
391
                    'progress' => false,
392
                    'certificate' => false,
393
                ]
394
                </pre>",
395
            'course_catalog_settings' => "<pre>
396
                [
397
                    'link_settings' => [
398
                        'info_url' => 'course_description_popup', // course description popup page
399
                        'title_url' => 'course_home', // Course home URL
400
                        'image_url' => 'course_about', // Course about URL
401
                    ],
402
                    'hide_course_title' => false,
403
                    'redirect_after_subscription' => 'course_home', // or 'course_catalog' to stay in the page
404
                    'extra_fields_in_search_form' => ['variable1', 'variable2'],
405
                    'extra_fields_in_course_block' => ['variable3', 'variable4'],
406
                    'standard_sort_options' => [
407
                        //  1 means allow sorting in ascending order
408
                        // -1 means allow sorting in descending order
409
                        'title' => 1,
410
                        'creation_date' => -1,
411
                        'count_users' => -1, // subscription count
412
                        'point_info/point_average' => -1, // average score
413
                        'point_info/total_score' => -1, // score sum
414
                        'point_info/users' => -1, // vote count
415
                    ],
416
                    'extra_field_sort_options' => [
417
                        'variable5' => -1,
418
                        'variable6' => 1,
419
                    ],
420
                ]
421
                </pre>",
422
            'course_log_default_extra_fields' => "<pre>
423
                ['extra_fields' => ['office_address', 'office_phone_extension']]
424
                </pre>",
425
            'courses_catalogue_show_only_category' => "<pre>
426
                ['Cat1','Cat2']
427
                </pre>",
428
            'course_creation_by_teacher_extra_fields_to_show' => "<pre>
429
                ['fields' => ['ExtrafieldLabel1', 'ExtrafieldLabel2']]
430
                </pre>",
431
            'course_creation_form_set_extra_fields_mandatory' => "<pre>
432
                ['fields' => ['fieldLabel1','fieldLabel2']]
433
                </pre>",
434
            'course_configuration_tool_extra_fields_to_show_and_edit' => "<pre>
435
                ['fields' => ['ExtrafieldLabel1', 'ExtrafieldLabel2']]
436
                </pre>",
437
            'course_creation_user_course_extra_field_relation_to_prefill' => "<pre>
438
                [
439
                    'fields' => [
440
                        'CourseExtrafieldLabel1' => 'UserExtrafieldLabel1',
441
                        'CourseExtrafieldLabel2' => 'UserExtrafieldLabel2',
442
                    ]
443
                ]
444
                </pre>",
445
        ];
446
447
        $returnValue = [];
448
        if (isset($values[$variable])) {
449
            $returnValue = $values[$variable];
450
        }
451
452
        return $returnValue;
0 ignored issues
show
Bug Best Practice introduced by
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...
453
    }
454
}
455