ClassLoaderBackend.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Cache\Backend;

use TYPO3\CMS\Core\Utility\PathUtility;

class ClassLoaderBackend extends SimpleFileBackend {

    protected $requireFileTemplate = '<?php require \'%s\';';

    public function setLinkToPhpFile($entryIdentifier, $filePath) {
        if ($entryIdentifier === '') {
            throw new \InvalidArgumentException('The specified entry identifier must not be empty.', 1364205170);
        }
        if (!PathUtility::isAbsolutePath($filePath)) {
            throw new \InvalidArgumentException('Only absolute paths are allowed for the class loader, given path was: ' . $filePath, 1381923089);
        }
        if (!@file_exists($filePath)) {
            throw new \InvalidArgumentException('The specified file path (' . $filePath . ') must exist.', 1364205235);
        }
        if (strtolower(substr($filePath, -4)) !== '.php') {
            throw new \InvalidArgumentException('The specified file (' . $filePath . ') must be a php file.', 1364205377);
        }
        if ($entryIdentifier !== basename($entryIdentifier)) {
            throw new \InvalidArgumentException('The specified entry identifier (' . $entryIdentifier . ') must not contain a path segment.', 1364205166);
        }

        $this->set($entryIdentifier, sprintf($this->requireFileTemplate, $filePath));
    }

    public function setLinkToOtherCacheEntry($entryIdentifier, $otherEntryIdentifier) {
        $otherCacheEntryPathAndFilename = $this->cacheDirectory . $otherEntryIdentifier . $this->cacheEntryFileExtension;
        $this->setLinkToPhpFile($entryIdentifier, $otherCacheEntryPathAndFilename);
    }

    public function get($entryIdentifier) {
        if ($entryIdentifier !== basename($entryIdentifier)) {
            throw new \InvalidArgumentException('The specified entry identifier must not contain a path segment.', 1334756880);
        }
        $pathAndFilename = $this->cacheDirectory . $entryIdentifier . $this->cacheEntryFileExtension;
        if (!@file_exists($pathAndFilename)) {
            return FALSE;
        }
        return file_get_contents($pathAndFilename);
    }

    public function getPathOfRequiredFileInCacheEntry($entryIdentifier) {
        $result = FALSE;

        $fileContent = $this->get($entryIdentifier);
        if ($fileContent !== FALSE) {
            $pattern = '!^' . sprintf(preg_quote($this->requireFileTemplate), '(.+)') . '!i';
            $matches = array();
            if (preg_match($pattern, $fileContent, $matches) === 1) {
                $requireString = $matches[1];
                $result = $requireString;
            }
        }
        return $result;
    }

    public function has($entryIdentifier) {
        if ($entryIdentifier !== basename($entryIdentifier)) {
            throw new \InvalidArgumentException('The specified entry identifier must not contain a path segment.', 1334756879);
        }
        $pathAndFilename = $this->cacheDirectory . $entryIdentifier . $this->cacheEntryFileExtension;
        return @file_exists($pathAndFilename);
    }

    protected function isCacheFileExpired($cacheEntryPathAndFilename) {
        return @file_exists($cacheEntryPathAndFilename) === FALSE;
    }

    protected function findCacheFilesByIdentifier($entryIdentifier) {
        $pathAndFilename = $this->cacheDirectory . $entryIdentifier . $this->cacheEntryFileExtension;
        return @file_exists($pathAndFilename) ? array($pathAndFilename) : FALSE;
    }

    public function requireOnce($entryIdentifier) {
        $pathAndFilename = $this->cacheDirectory . $entryIdentifier . $this->cacheEntryFileExtension;
        return @file_exists($pathAndFilename) ? require_once $pathAndFilename : FALSE;
    }

}