FileTextCache_SSCache

Complexity

Total Complexity

6

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	3
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	get_cache()	0	7	1
A	getKey()	0	4	1
A	load()	0	6	1
A	save()	0	6	1
A	flush()	0	5	1
A	invalidate()	0	6	1

<?php

interface FileTextCache

Each interface must be in a namespace of at least one level (a top-level vendor name)

{
    /**
     * Save extracted content for a given File entity
     *
     * @param File $file
     * @param string $content
     */
    public function save(File $file, $content);

    /**
     * Return any cached extracted content for a given file entity
     *
     * @param File $file
     */
    public function load(File $file);

    /**
     * Invalidate the cache for a given file.
     * Invoked in onBeforeWrite on the file
     *
     * @param File $file
     */
    public function invalidate(File $file);
}

/**
 * Caches the extracted content on the record for the file.
 * Limits the stored file content by default to avoid hitting query size limits.
 */
class FileTextCache_Database implements FileTextCache

Each interface must be in a file by itself

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public function load(File $file)
    {
        return $file->FileContentCache;

The property FileContentCache does not seem to exist. Did you mean Content?

    }

    public function save(File $file, $content)
    {
        $maxLength = Config::inst()->get('FileTextCache_Database', 'max_content_length');
        $file->FileContentCache = ($maxLength) ? substr($content, 0, $maxLength) : $content;

The property FileContentCache does not seem to exist. Did you mean Content?

        $file->write();
    }

    public function invalidate(File $file)
    {
        // To prevent writing to the cache from invalidating it
        if (!$file->isChanged('FileContentCache')) {
            $file->FileContentCache = '';

The property FileContentCache does not seem to exist. Did you mean Content?

        }
    }
}

/**
 * Uses SS_Cache with a lifetime to cache extracted content
 */
class FileTextCache_SSCache implements FileTextCache, Flushable

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * Lifetime of cache in seconds
     * Null is indefinite
     *
     * @var int|null
     * @config
     */
    private static $lifetime = null;

The property $lifetime is not used and could be removed.

    /**
     * @return SS_Cache
     */
    protected static function get_cache()
    {
        $lifetime = Config::inst()->get(__CLASS__, 'lifetime');
        $cache = SS_Cache::factory(__CLASS__);
        $cache->setLifetime($lifetime);
        return $cache;
    }

    protected function getKey(File $file)
    {
        return md5($file->getFullPath());
    }

    public function load(File $file)
    {
        $key = $this->getKey($file);
        $cache = self::get_cache();
        return $cache->load($key);
    }

    public function save(File $file, $content)
    {
        $key = $this->getKey($file);
        $cache = self::get_cache();
        return $cache->save($content, $key);
    }

    public static function flush()
    {
        $cache = self::get_cache();
        $cache->clean();
    }

    public function invalidate(File $file)
    {
        $key = $this->getKey($file);
        $cache = self::get_cache();
        return $cache->remove($key);
    }
}