sunnysideup / silverstripe-simple-template-caching

src/Extensions/SimpleTemplateCachingSiteConfigExtension.php

<?php

namespace Sunnysideup\SimpleTemplateCaching\Extensions;

use SilverStripe\Forms\DatetimeField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\FieldList;

use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordViewer;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\SiteConfig\SiteConfig;

use SilverStripe\Core\Injector\Injector;

use Sunnysideup\SimpleTemplateCaching\Model\ObjectsUpdated;

class SimpleTemplateCachingSiteConfigExtension extends DataExtension
{
    private static $db = [
        'HasCaching' => 'Boolean(1)',
        'RecordCacheUpdates' => 'Boolean(0)',
        'CacheKeyLastEdited' => 'DBDatetime',
        'ClassNameLastEdited' => 'Varchar(200)',
    ];

    public function updateCMSFields(FieldList $fields)
    {
        $name = '';
        if(class_exists($this->getOwner()->ClassNameLastEdited)) {
            $name = Injector::inst()->get($this->getOwner()->ClassNameLastEdited)->i18n_singular_name();
        }
        $fields->addFieldsToTab(
            'Root.Caching',
            [
                CheckboxField::create('HasCaching', 'Use caching'),
                CheckboxField::create('RecordCacheUpdates', 'To work out when the cache is being updated, you can track every change. This will slow down all your edits, so it is recommend only to turn this on temporarily - for tuning purposes.'),
                DatetimeField::create('CacheKeyLastEdited', 'Content Last Edited')
                    ->setRightTitle('The frontend template cache will be invalidated every time this value changes. It changes every time anything is changed in the database.'),
                ReadonlyField::create('ClassNameLastEdited', 'Last class updated')
                    ->setRightTitle('Last object updated. The name of this object is: '.$name),
            ]
        );
        if($this->getOwner()->RecordCacheUpdates) {
            $fields->addFieldsToTab(
                'Root.Caching',
                [
                    GridField::create(
                        'ObjectsUpdated',
                        'Last 1000 objects updated',
                        ObjectsUpdated::get()->limit(1000),
                        GridFieldConfig_RecordViewer::create()
                    )
                ]
            );
        }
    }

    public static function site_cache_key(): string
    {
        $obj = SiteConfig::current_site_config();
        if($obj->HasCaching) {
            return (string) 'ts_'.strtotime($obj->CacheKeyLastEdited);
        } else {
            return  (string) 'ts_'.time();
        }
    }

    public static function update_cache_key(?string $className = '')
    {
        $obj = SiteConfig::current_site_config();
        if($obj->HasCaching) {
            DB::query('
                UPDATE "SiteConfig"
                SET
                    "CacheKeyLastEdited" = \'' . DBDatetime::now()->Rfc2822() . '\',
                    "ClassNameLastEdited" = \'' . addslashes($className). '\'

It seems like $className can also be of type null; however, parameter $string of addslashes() does only seem to accept string, maybe add an additional type check?

                WHERE ID = '.$obj->ID.'
            ;');
        }
        if($obj->RecordCacheUpdates) {
            $record = Injector::inst()

The assignment to $record is dead and can be removed.

                ->create(ObjectsUpdated::class, ['ClassNameLastEdited' => $className])
                ->write();
        }
    }
}