SilverStripe\i18n\Messages\Symfony\FlushInvalidatedResource

Complexity

Total Complexity

9

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	4	1
A	getResource()	0	5	1
A	isFresh()	0	12	2
A	serialize()	0	4	1
A	unserialize()	0	4	1
A	flush()	0	5	1
A	canary()	0	4	1
A	touch()	0	4	1

<?php

namespace SilverStripe\i18n\Messages\Symfony;

use SilverStripe\Core\Flushable;
use Symfony\Component\Config\Resource\DirectoryResource;
use Symfony\Component\Config\Resource\SelfCheckingResourceInterface;

/**
 * Some arbitrary resource which expires when flush is invoked.
 * Uses a canary file to mark future freshness requests as stale.
 *
 * @link https://media.giphy.com/media/fRRD3T37DeY6Y/giphy.gif for use case
 * @see DirectoryResource
 */
class FlushInvalidatedResource implements SelfCheckingResourceInterface, \Serializable, Flushable
{

    public function __toString()
    {
        return md5(__CLASS__);
    }

    public function getResource()
    {
        // @deprecated at 3.0, do nothing
        return null;
    }

    public function isFresh($timestamp)
    {
        // Check mtime of canary
        $canary = static::canary();
        if (file_exists($canary)) {
            return filemtime($canary) < $timestamp;
        }

        // Rebuild canary
        static::touch();
        return false;
    }

    public function serialize()
    {
        return '';
    }

    public function unserialize($serialized)
    {
        // no-op
    }

    public static function flush()
    {
        // Mark canary as dirty
        static::touch();
    }

    /**
     * Path to i18n canary
     *
     * @return string
     */
    protected static function canary()
    {
        return TEMP_FOLDER . '/catalog.i18n_canary';
    }

    /**
     * Touch the canary
     */
    protected static function touch()
    {
        touch(static::canary());
    }
}