Функции cot_rc_add_standard в Cotonti

Разберем функцию cot_rc_add_standard, включая её назначение, рекомендации по применению и подробные комментарии внутри кода.

Назначение функции
Функция cot_rc_add_standard регистрирует стандартные ресурсы JavaScript для использования на сайте. Она добавляет ссылки на базовые скрипты, такие как jQuery, а также дополнительные ресурсы, зависящие от настроек сайта.

Подробный разбор функции
Глобальная переменная $cfg
Используется для доступа к настройкам сайта.
Например:

$cfg['jquery'] — включает или отключает использование jQuery.
$cfg['jquery_cdn'] — определяет, загружается ли jQuery с CDN.
$cfg['turnajax'] — включает или отключает поддержку AJAX.

Проверка на использование jQuery
Если jQuery включён ($cfg['jquery']) и не используется CDN (!$cfg['jquery_cdn']), то добавляется локальный файл jQuery:

Resources::addFile(Resources::jQuery, 'js', 30);

Добавление файла jqModal.min.js
Если включён jQuery, добавляется модуль jqModal.

Resources::addFile('js/jqModal.min.js');

Подключение основного JavaScript файла
В зависимости от режима (отладки или обычного):

Если включён режим отладки (debug_mode) или разработки (devmode), подключается неминифицированный файл:

Resources::addFile('js/base.js');

В остальных случаях подключается минифицированная версия:

Resources::addFile('js/base.min.js');

Поддержка AJAX
Если включены и jQuery, и AJAX ($cfg['turnajax']), подключается файл ajax_on.js:

Resources::addFile('js/ajax_on.js');

Пример использования
Функция вызывается автоматически или вручную для регистрации стандартных ресурсов перед генерацией страницы. Например:

cot_rc_add_standard();

Рекомендации по применению
Используйте в инициализации сайта.
Рекомендуется вызывать эту функцию в начале обработки страницы, чтобы все ресурсы были зарегистрированы до рендеринга.

Настройте конфигурацию сайта.
Проверьте настройки, такие как $cfg['jquery'] и $cfg['turnajax'], чтобы включить только те ресурсы, которые действительно используются.

Избегайте лишних подключений.
Если ваш проект не использует jQuery или AJAX, отключите соответствующие настройки в конфигурации сайта, чтобы уменьшить нагрузку.

Полный комментарий внутри функции

/**
 * Регистрирует стандартные ресурсы JavaScript для сайта.
 *
 * Эта функция добавляет ссылки на базовые JavaScript-скрипты, такие как jQuery,
 * и дополнительные файлы в зависимости от настроек сайта.
 *
 * @global array $cfg Глобальная конфигурация сайта.
 */
function cot_rc_add_standard()
{
    global $cfg;

    // Проверяем, включён ли jQuery, и добавляем локальный файл, если CDN не используется
    if ($cfg['jquery'] && !$cfg['jquery_cdn']) {
        // Добавляет стандартный файл jQuery из локального ресурса
        Resources::addFile(Resources::jQuery, 'js', 30);
    }

    // Если jQuery включён, добавляем файл jqModal
    if ($cfg['jquery']) {
        Resources::addFile('js/jqModal.min.js');
    }

    // Проверяем режимы отладки или разработки, чтобы добавить подходящий файл
    if (Cot::$cfg['debug_mode'] || Cot::$cfg['devmode']) {
        // Добавляем неминифицированный файл в режиме отладки/разработки
        Resources::addFile('js/base.js');
    } else {
        // Добавляем минифицированный файл в обычном режиме
        Resources::addFile('js/base.min.js');
    }

    // Если включены jQuery и AJAX, добавляем файл ajax_on.js
    if ($cfg['jquery'] && $cfg['turnajax']) {
        Resources::addFile('js/ajax_on.js');
    }
}