Chamilo\CoreBundle\DataFixtures\SettingsValueTemplateFixtures

Complexity

Total Complexity

8

Size/Duplication

Total Lines	791
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	load()	0	38	6
A	getGroups()	0	3	1
B	getTemplatesGrouped()	0	736	1

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\DataFixtures;

use Chamilo\CoreBundle\Entity\SettingsCurrent;
use Chamilo\CoreBundle\Entity\SettingsValueTemplate;
use Doctrine\Bundle\FixturesBundle\Fixture;
use Doctrine\Bundle\FixturesBundle\FixtureGroupInterface;
use Doctrine\Persistence\ObjectManager;

class SettingsValueTemplateFixtures extends Fixture implements FixtureGroupInterface
{
    public static function getGroups(): array
    {
        return ['settings-value-template'];
    }

    /**
     * Returns the list of JSON templates grouped by category.
     */
    public static function getTemplatesGrouped(): array
    {
        return [
            'platform' => [
                [
                    'name' => 'push_notification_settings',
                    'json_example' => [
                        'gotify_url' => 'http://localhost:8080',
                        'gotify_token' => 'A0yWWfe_8YRLv_B',
                        'enabled' => true,
                        'vapid_public_key' => 'BNg54MTyDZSdyFq99EmppT606jKVDS5o7jGVxMLW3Qir937A98sxtrK4VMt1ddNlK93MUenK0kM3aiAMu9HRcjQ=',
                        'vapid_private_key' => 'UgS5-xSneOcSyNJVq4c9wmEGaCoE1Y8oh-7ZGXPgs8o'
                    ]
                ],
                [
                    'name' => 'proxy_settings',
                    'json_example' => [
                        'stream_context_create' => [
                            'http' => [
                                'proxy' => 'tcp://example.com:8080',
                                'request_fulluri' => true
                            ]
                        ],
                        'curl_setopt_array' => [
                            'CURLOPT_PROXY' => 'http://example.com',
                            'CURLOPT_PROXYPORT' => '8080'
                        ]
                    ]
                ],
                [
                    'name' => 'video_features',
                    'json_example' => [
                        'features' => ['speed']
                    ]
                ],
                [
                    'name' => 'table_row_list',
                    'json_example' => [
                        'options' => [50, 100, 200, 500]
                    ]
                ],
                [
                    'name' => 'extldap_config',
                    'json_example' => [
                        'host' => '',
                        'port' => ''
                    ]
                ],
                [
                    'name' => 'update_student_expiration_x_date',
                    'json_example' => [
                        'days' => 0,
                        'months' => 0
                    ]
                ],
                [
                    'name' => 'user_status_show_option',
                    'json_example' => [
                        'COURSEMANAGER' => true,
                        'STUDENT' => true,
                        'DRH' => false,
                        'SESSIONADMIN' => false,
                        'STUDENT_BOSS' => false,
                        'INVITEE' => false
                    ]
                ],
                [
                    'name' => 'user_number_of_days_for_default_expiration_date_per_role',
                    'json_example' => [
                        'COURSEMANAGER' => 365,
                        'STUDENT' => 31,
                        'DRH' => 31,
                        'SESSIONADMIN' => 60,
                        'STUDENT_BOSS' => 60,
                        'INVITEE' => 31
                    ]
                ],
                [
                    'name' => 'show_tabs_per_role',
                    'json_example' => [
                        'SESSIONADMIN' => ['session_admin', 'my_courses'],
                        'ADMIN' => ['platform_administration']
                    ]
                ],
            ],
            'agenda' => [
                [
                    'name' => 'agenda_legend',
                    'json_example' => [
                        'red' => 'red caption',
                        '#f0f' => 'another caption'
                    ],
                ],
                [
                    'name' => 'agenda_colors',
                    'json_example' => [
                        'platform' => 'red',
                        'course' => '#458B00',
                        'group' => '#A0522D',
                        'session' => '#00496D',
                        'other_session' => '#999',
                        'personal' => 'steel blue',
                        'student_publication' => '#FF8C00',
                    ],
                ],
                [
                    'name' => 'agenda_on_hover_info',
                    'json_example' => [
                        'options' => [
                            'comment' => true,
                            'description' => true,
                        ],
                    ],
                ],
                [
                    'name' => 'fullcalendar_settings',
                    'json_example' => [
                        'settings' => [
                            'businessHours' => [
                                'dow' => [0, 1, 2, 3, 4],
                                'start' => '10:00',
                                'end' => '18:00',
                            ],
                            'firstDay' => 0,
                        ],
                    ],
                ],
            ],
            'admin' => [
                [
                    'name' => 'user_status_option_show_only_for_admin',
                    'json_example' => [
                        'COURSEMANAGER' => false,
                        'STUDENT' => false,
                        'DRH' => false,
                        'SESSIONADMIN' => true,
                        'STUDENT_BOSS' => false,
                        'INVITEE' => false,
                    ],
                ],
            ],
            'aihelpers' => [
                [
                    'name' => 'ai_providers',
                    'json_example' => [
                        'openai' => [
                            'url' => 'https://api.openai.com/v1/chat/completions',
                            'api_key' => 'your-key',
                            'model' => 'gpt-4o',
                            'temperature' => 0.7,
                            'organization_id' => 'org123',
                            'monthly_token_limit' => 10000,
                        ],
                        'deepseek' => [
                            'url' => 'https://api.deepseek.com/chat/completions',
                            'api_key' => 'your-key',
                            'model' => 'deepseek-chat',
                            'temperature' => 0.7,
                            'organization_id' => 'org456',
                            'monthly_token_limit' => 5000,
                        ],
                    ],
                ],
            ],
            'announcement' => [
                [
                    'name' => 'send_all_emails_to',
                    'json_example' => [
                        'emails' => [
                            'admin1@example.com',
                            'admin2@example.com',
                        ],
                    ],
                ],
            ],
            'course' => [
                [
                    'name' => 'course_log_hide_columns',
                    'json_example' => ['columns' => [1, 9]],
                ],
                [
                    'name' => 'course_student_info',
                    'json_example' => [
                        'score' => false,
                        'progress' => false,
                        'certificate' => false,
                    ],
                ],
                [
                    'name' => 'course_catalog_settings',
                    'json_example' => [
                        'link_settings' => [
                            'info_url' => 'course_description_popup',
                            'title_url' => 'course_home',
                            'image_url' => 'course_about',
                        ],
                        'hide_course_title' => false,
                        'redirect_after_subscription' => 'course_home',
                        'extra_fields_in_search_form' => ['variable1', 'variable2'],
                        'extra_fields_in_course_block' => ['variable3', 'variable4'],
                        'standard_sort_options' => [
                            'title' => 1,
                            'creation_date' => -1,
                            'count_users' => -1,
                            'point_info/point_average' => -1,
                            'point_info/total_score' => -1,
                            'point_info/users' => -1,
                        ],
                        'extra_field_sort_options' => [
                            'variable5' => -1,
                            'variable6' => 1,
                        ],
                    ],
                ],
                [
                    'name' => 'course_log_default_extra_fields',
                    'json_example' => ['extra_fields' => ['office_address', 'office_phone_extension']],
                ],
                [
                    'name' => 'courses_catalogue_show_only_category',
                    'json_example' => ['Cat1', 'Cat2'],
                ],
                [
                    'name' => 'course_creation_by_teacher_extra_fields_to_show',
                    'json_example' => ['fields' => ['ExtrafieldLabel1', 'ExtrafieldLabel2']],
                ],
                [
                    'name' => 'course_creation_form_set_extra_fields_mandatory',
                    'json_example' => ['fields' => ['fieldLabel1', 'fieldLabel2']],
                ],
                [
                    'name' => 'course_configuration_tool_extra_fields_to_show_and_edit',
                    'json_example' => ['fields' => ['ExtrafieldLabel1', 'ExtrafieldLabel2']],
                ],
                [
                    'name' => 'course_creation_user_course_extra_field_relation_to_prefill',
                    'json_example' => [
                        'fields' => [
                            'CourseExtrafieldLabel1' => 'UserExtrafieldLabel1',
                            'CourseExtrafieldLabel2' => 'UserExtrafieldLabel2',
                        ],
                    ],
                ],
            ],
            'document' => [
                [
                    'name' => 'compilatio_tool',
                    'json_example' => [
                        'settings' => [
                            'key' => '',
                            'soap_url' => '',
                            'proxy_host' => '',
                            'proxy_port' => '',
                            'max_filesize' => '',
                            'transport_mode' => '',
                            'wget_uri' => '',
                            'wget_login' => '',
                            'wget_password' => '',
                        ],
                    ],
                ],
                [
                    'name' => 'documents_custom_cloud_link_list',
                    'json_example' => [
                        'links' => ['example.com', 'example2.com'],
                    ],
                ],
            ],
            'editor' => [
                [
                    'name' => 'editor_driver_list',
                    'json_example' => ['PersonalDriver', 'CourseDriver'],
                ],
                [
                    'name' => 'editor_settings',
                    'json_example' => [
                        'config' => [
                            'youtube_responsive' => true,
                            'image_responsive' => true,
                        ],
                    ],
                ],
                [
                    'name' => 'video_player_renderers',
                    'json_example' => [
                        'renderers' => ['dailymotion', 'facebook', 'twitch', 'vimeo', 'youtube'],
                    ],
                ],
            ],
            'exercise' => [
                [
                    'name' => 'exercise_additional_teacher_modify_actions',
                    'json_example' => [
                        'myplugin' => ['MyPlugin', 'urlGeneratorCallback'],
                    ],
                ],
                [
                    'name' => 'quiz_image_zoom',
                    'json_example' => [
                        'options' => [
                            'zoomWindowWidth' => 400,
                            'zoomWindowHeight' => 400,
                        ],
                    ],
                ],
                [
                    'name' => 'add_exercise_best_attempt_in_report',
                    'json_example' => [
                        'courses' => [
                            'ABC' => [88, 89],
                        ],
                    ],
                ],
                [
                    'name' => 'exercise_category_report_user_extra_fields',
                    'json_example' => [
                        'fields' => ['skype', 'rssfeeds'],
                    ],
                ],
                [
                    'name' => 'score_grade_model',
                    'json_example' => [
                        'models' => [
                            [
                                'id' => 1,
                                'name' => 'ThisIsMyModel',
                                'score_list' => [
                                    [
                                        'name' => 'VeryBad',
                                        'css_class' => 'btn-danger',
                                        'min' => 0,
                                        'max' => 20,
                                        'score_to_qualify' => 0,
                                    ],
                                    [
                                        'name' => 'Bad',
                                        'css_class' => 'btn-danger',
                                        'min' => 21,
                                        'max' => 50,
                                        'score_to_qualify' => 25,
                                    ],
                                    [
                                        'name' => 'Good',
                                        'css_class' => 'btn-warning',
                                        'min' => 51,
                                        'max' => 70,
                                        'score_to_qualify' => 60,
                                    ],
                                    [
                                        'name' => 'VeryGood',
                                        'css_class' => 'btn-success',
                                        'min' => 71,
                                        'max' => 100,
                                        'score_to_qualify' => 100,
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
                [
                    'name' => 'exercise_embeddable_extra_types',
                    'json_example' => [
                        'types' => [],
                    ],
                ],
            ],
            'gradebook' => [
                [
                    'name' => 'gradebook_dependency_mandatory_courses',
                    'json_example' => [
                        'courses' => [1, 2],
                    ],
                ],
                [
                    'name' => 'gradebook_badge_sidebar',
                    'json_example' => [
                        'gradebooks' => [1, 2, 3],
                    ],
                ],
                [
                    'name' => 'gradebook_flatview_extrafields_columns',
                    'json_example' => [
                        'variables' => [],
                    ],
                ],
                [
                    'name' => 'gradebook_pdf_export_settings',
                    'json_example' => [
                        'hide_score_weight' => true,
                        'hide_feedback_textarea' => true,
                    ],
                ],
                [
                    'name' => 'gradebook_display_extra_stats',
                    'json_example' => [
                        'columns' => [1, 2, 3],
                    ],
                ],
            ],
            'learningpath' => [
                [
                    'name' => 'lp_subscription_settings',
                    'json_example' => [
                        'options' => [
                            'allow_add_users_to_lp' => true,
                            'allow_add_users_to_lp_category' => true,
                        ],
                    ],
                ],
                [
                    'name' => 'lp_view_settings',
                    'json_example' => [
                        'display' => [
                            'show_reporting_icon' => true,
                            'hide_lp_arrow_navigation' => false,
                            'show_toolbar_by_default' => false,
                            'navigation_in_the_middle' => false,
                        ],
                    ],
                ],
                [
                    'name' => 'download_files_after_all_lp_finished',
                    'json_example' => [
                        'courses' => [
                            'ABC' => [1, 100],
                        ],
                    ],
                ],
                [
                    'name' => 'my_progress_course_tools_order',
                    'json_example' => [
                        'order' => ['quizzes', 'learning_paths', 'skills'],
                    ],
                ],
            ],
            'mail' => [
                [
                    'name' => 'cron_notification_help_desk',
                    'json_example' => [
                        'emails' => [
                            'email@example.com',
                            'email2@example.com',
                        ],
                    ],
                ],
                [
                    'name' => 'notifications_extended_footer_message',
                    'json_example' => [
                        'english' => [
                            'paragraphs' => [
                                'Change or delete this paragraph or add another one',
                            ],
                        ],
                    ],
                ],
            ],
            'profile' => [
                [
                    'name' => 'hide_user_field_from_list',
                    'json_example' => [
                        'fields' => ['username'],
                    ],
                ],
                [
                    'name' => 'send_notification_when_user_added',
                    'json_example' => [
                        'admins' => [1],
                    ],
                ],
                [
                    'name' => 'show_conditions_to_user',
                    'json_example' => [
                        'conditions' => [
                            [
                                'variable' => 'gdpr',
                                'display_text' => 'GDPRTitle',
                                'text_area' => 'GDPRTextArea',
                            ],
                            [
                                'variable' => 'my_terms',
                                'display_text' => 'My test conditions',
                                'text_area' => 'This is a long text area, with lot of terms and conditions ... ',
                            ],
                        ],
                    ],
                ],
                [
                    'name' => 'profile_fields_visibility',
                    'json_example' => [
                        'options' => [
                            'vcard' => false,
                            'firstname' => true,
                            'lastname' => true,
                            'photo' => true,
                            'email' => false,
                            'language' => true,
                            'chat' => true,
                            'terms_ville' => true,
                            'terms_datedenaissance' => true,
                            'terms_paysresidence' => false,
                            'filiere_user' => true,
                            'terms_villedustage' => true,
                            'hobbies' => true,
                            'langue_cible' => true,
                        ],
                    ],
                ],
                [
                    'name' => 'user_import_settings',
                    'json_example' => [
                        'options' => [
                            'send_mail_default_option' => '1',
                        ],
                    ],
                ],
                [
                    'name' => 'user_search_on_extra_fields',
                    'json_example' => [
                        'extra_fields' => ['variable1', 'variable2'],
                    ],
                ],
                [
                    'name' => 'community_managers_user_list',
                    'json_example' => [
                        'users' => [1],
                    ],
                ],
                [
                    'name' => 'allow_social_map_fields',
                    'json_example' => [
                        'fields' => ['terms_villedustage', 'terms_ville'],
                    ],
                ],
            ],
            'registration' => [
                [
                    'name' => 'required_extra_fields_in_inscription',
                    'json_example' => [
                        'options' => [
                            'terms_adresse',
                            'terms_codepostal',
                            'terms_ville',
                            'terms_paysresidence',
                            'terms_datedenaissance',
                            'terms_genre',
                            'filiere_user',
                            'terms_formation_niveau',
                            'langue_cible',
                        ],
                    ],
                ],
                [
                    'name' => 'allow_fields_inscription',
                    'json_example' => [
                        'fields' => [
                            'lastname',
                            'firstname',
                            'email',
                            'language',
                            'phone',
                            'address',
                        ],
                        'extra_fields' => [
                            'terms_nationalite',
                            'terms_numeroderue',
                            'terms_nomderue',
                            'terms_codepostal',
                            'terms_paysresidence',
                            'terms_ville',
                            'terms_datedenaissance',
                            'terms_genre',
                            'filiere_user',
                            'terms_formation_niveau',
                            'terms_villedustage',
                            'terms_adresse',
                            'gdpr',
                            'langue_cible',
                        ],
                    ],
                ],
                [
                    'name' => 'redirect_after_login',
                    'json_example' => [
                        'COURSEMANAGER' => '',
                        'STUDENT' => '',
                        'DRH' => '',
                        'SESSIONADMIN' => 'admin-dashboard',
                        'STUDENT_BOSS' => '',
                        'INVITEE' => '',
                        'ADMIN' => 'admin-dashboard',
                    ],
                ],
            ],
            'security' => [
                [
                    'name' => 'password_requirements',
                    'json_example' => [
                        'min' => [
                            'lowercase' => 2,
                            'uppercase' => 2,
                            'numeric' => 2,
                            'length' => 8,
                        ],
                    ],
                ],
                [
                    'name' => 'allow_online_users_by_status',
                    'json_example' => [
                        'status' => [1, 5],
                    ],
                ],
            ],
            'session' => [
                [
                    'name' => 'my_courses_session_order',
                    'json_example' => [
                        'field' => 'end_date',
                        'order' => 'desc',
                    ],
                ],
                [
                    'name' => 'session_import_settings',
                    'json_example' => [
                        'options' => [
                            'session_exists_default_option' => '1',
                            'send_mail_default_option' => '1',
                        ],
                    ],
                ],
                [
                    'name' => 'catalog_settings',
                    'json_example' => [
                        'sessions' => [
                            'by_title' => true,
                            'by_date' => true,
                            'by_tag' => true,
                            'show_session_info' => true,
                            'show_session_date' => true,
                        ],
                        'courses' => [
                            'by_title' => true,
                        ],
                    ],
                ],
                [
                    'name' => 'tracking_columns',
                    'json_example' => [
                        '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,
                        ],
                    ],
                ],
                [
                    'name' => 'session_creation_user_course_extra_field_relation_to_prefill',
                    'json_example' => [
                        'fields' => [
                            'client' => 'client',
                            'region' => 'region',
                        ],
                    ],
                ],
                [
                    'name' => 'session_creation_form_set_extra_fields_mandatory',
                    'json_example' => [
                        'fields' => ['client', 'region'],
                    ],
                ],
            ],
            'skill' => [
                [
                    'name' => 'skill_levels_names',
                    'json_example' => [
                        'levels' => [
                            1 => 'Skills',
                            2 => 'Capability',
                            3 => 'Dimension',
                        ],
                    ],
                ],
            ],
            'survey' => [
                [
                    'name' => 'hide_survey_edition',
                    'json_example' => [
                        'codes' => [],
                    ],
                ],
                [
                    'name' => 'survey_additional_teacher_modify_actions',
                    'json_example' => [
                        'myplugin' => ['MyPlugin', 'urlGeneratorCallback'],
                    ],
                ],
            ],
            'ticket' => [
                [
                    'name' => 'ticket_project_user_roles',
                    'json_example' => [
                        'permissions' => [
                            1 => [17, 1],
                        ],
                    ],
                ],
            ],
        ];
    }

    public function load(ObjectManager $manager): void
    {
        $groupedTemplates = self::getTemplatesGrouped();

        $settingsRepo = $manager->getRepository(SettingsCurrent::class);
        $templateRepo = $manager->getRepository(SettingsValueTemplate::class);

        foreach ($groupedTemplates as $category => $templates) {
            foreach ($templates as $data) {
                // Check if the template already exists
                $template = $templateRepo->findOneBy(['name' => $data['name']]);

                if (!$template) {
                    $template = new SettingsValueTemplate();
                    $template->setCreatedAt(new \DateTime());
                }

                $template
                    ->setName($data['name'])
                    ->setJsonExample(json_encode($data['json_example'], JSON_PRETTY_PRINT))
                    ->setUpdatedAt(new \DateTime());

                $manager->persist($template);
                $manager->flush(); // ensure ID is generated for linking

                // Now update the settings table to link this template
                $settings = $settingsRepo->findBy(['variable' => $data['name']]);

                foreach ($settings as $setting) {
                    if ($setting->getValueTemplate()?->getId() !== $template->getId()) {
                        $setting->setValueTemplate($template);
                        $manager->persist($setting);
                    }
                }
            }
        }

        $manager->flush();
    }
}