Автоматическая смена версии стилей при очистке кэша в MODX

Решил поделиться своим решением версионирования файлов стилей. Зачем нужно версионирование, я, наверное не буду объяснять. Вообще смена версий не такой частый процесс и зачастую он нужен не только для того, чтобы браузеры подхватывали измерения в стилях, но и для отслеживания версий сайта. Вариантов как это реализовать масса. Я состряпал наиболее подходящее для меня и решил поделиться им.

К слову, пока писал этот пост, в телеграм канале как раз подняли эту тему. :-)

Шаг 1

Для начала создадим контекстную настройку, запускаем скрипт в консоли:

$contextKey = 'style_version';
if (!$contextSetting = $modx->getObject('modContextSetting', array('key' => $contextKey))) {
  $contextSetting = $modx->newObject('modContextSetting');
}
$contextSetting->set('context_key', 'web');
$contextSetting->set('key', 'style_version');
$contextSetting->set('value', '');
$contextSetting->set('xtype', 'textfield');
$contextSetting->set('namespace', 'core');
$contextSetting->set('area', 'Site');
$contextSetting->save();

// Clear the cache:
$modx->cacheManager->refresh(array(
   'context_settings' => array('contexts' => array('web'))
));

Шаг 2

Далее создаем плагин и вешаем его на событие OnBeforeCacheUpdate. Я использую версионирование с текущей датой, мне так проще.

if ($modx->event->name == 'OnBeforeCacheUpdate') {

    // Version as current date
    $today = date("dmY");

    // Check if we have context with key style_version
    if (!$contextSetting = $modx->getObject('modContextSetting', array('key' => 'style_version', 'context_key' => 'web'))) {
        return;
    }

    $contextSetting->set('value', $today);
    $contextSetting->save();

    // clear context cache
//    $modx->cacheManager->refresh(array(
//        'context_settings' => array('contexts' => array('web'))
//    ));

}

После фидбэка от Василия Наумкина, сделал вариант плагина который проверяет изменения в указанных файлах и при наличии таковых, заменяет версию. В плагине укажите пути к своим файлам стилей, которые необходимо проверять на наличие изменений.

<?php
if ($modx->event->name == 'OnBeforeCacheUpdate') {

    // which files we must check
    $files = [
        'public/template/css/styles.css',
        'public/template/js/scripts.min.js'
    ];

    $lastChangeTime = 0;

    // check every file
    foreach($files as $file){
        $filepath = MODX_BASE_PATH.$file;
        if (file_exists($filepath) && filemtime($filepath) > $lastChangeTime) {
            $lastChangeTime = filemtime($filepath);
        }
    }
    
    // Show result as date/month/year/hour/minutes/seconds
    $lastChangeTime = date('dmYHis', $lastChangeTime);

    // Check if we have context with key style_version
    if (!$contextSetting = $modx->getObject('modContextSetting', array('key' => 'style_version', 'context_key' => 'web'))) {
        return;
    }

    $contextSetting->set('value', $lastChangeTime);
    $contextSetting->save();

    // clear context cache
//    $modx->cacheManager->refresh(array(
//        'context_settings' => array('contexts' => array('web'))
//    ));

}

У меня так же есть версия плагина с рандомной строкой, если нужно могу скинуть.

Шаг 3

Ну и к стилям дописываем вывод значения настройки:

<link rel="stylesheet" href="public/template/css/styles.css?v={$_modx->config.style_version}" type="text/css"/>
<script src="public/template/js/scripts.min.js?v={$_modx->config.style_version}" type="text/javascript"></script>

Конечно кто-то скажет что вариант слишком громоздкий. Но меня он вполне устраивает. Если кто-то поделится своим решением, более цивилизованным — то будет круто. Каждый подберет для себя более оптимальное решение.

$today = date("d-m-Y");
$today = trim(preg_replace('/[^0-9]+/', ' ', $today));
$today = str_replace(' ', '', $today);

$today = date("dmY");

<?php
switch($scriptProperties['options']['type']) {
    case 'script':
        echo '<script src="'.$input.'?v='.filemtime($_SERVER['DOCUMENT_ROOT'] .'/'. $input).'"></script>';
        break;

    case 'stylesheet':
        echo '<link rel="stylesheet" type="text/css" href="'.$input.'?v='.filemtime($_SERVER['DOCUMENT_ROOT'] .'/'. $input).'">';
        break;
}

{'assets/css/main.min.css'| includeFile : ['type' => 'stylesheet']}

if ($modx->event->name == 'pdoToolsOnFenomInit') {

	// return file version
	$fenom->addModifier('version', function ($input) use ($modx) {
		$output = $input;

		$file = MODX_BASE_PATH.$input;

		if (file_exists($file)) {
			$output = $input.'?v='.filemtime($file);
		}

		return $output;
	});
	
}