NullBackend.php

<?php
declare(strict_types=1);

namespace Neos\Cache\Backend;

/*
 * This file is part of the Neos.Cache package.
 *
 * (c) Contributors of the Neos Project - www.neos.io
 *
 * This package is Open Source Software. For the full copyright and license
 * information, please view the LICENSE file which was distributed with this
 * source code.
 */

// @codeCoverageIgnoreStart

use Neos\Cache\Backend\AbstractBackend as AbstractCacheBackend;

/**
 * A caching backend which forgets everything immediately
 *
 * @api
 */
class NullBackend extends AbstractCacheBackend implements PhpCapableBackendInterface, TaggableBackendInterface
{
    /**
     * Successfully ignore every configured property
     *
     * @param string $propertyName
     * @param mixed $propertyValue
     * @return boolean TRUE
     */
    protected function setProperty(string $propertyName, $propertyValue) : bool
    {
        return true;
    }

    /**
     * Acts as if it would save data
     *
     * @param string $entryIdentifier ignored
     * @param string $data ignored
     * @param array<string> $tags ignored
     * @param ?integer $lifetime ignored
     * @return void
     * @api
     */
    public function set(string $entryIdentifier, string $data, array $tags = [], ?int $lifetime = null): void
    {
    }

    /**
     * Returns False
     *
     * @param string $entryIdentifier ignored
     * @return boolean false
     * @api
     */
    public function get(string $entryIdentifier)
    {
        return false;
    }

    /**
     * Returns False
     *
     * @param string $entryIdentifier ignored
     * @return boolean false
     * @api
     */
    public function has(string $entryIdentifier): bool
    {
        return false;
    }

    /**
     * Does nothing
     *
     * @param string $entryIdentifier ignored
     * @return boolean false
     * @api
     */
    public function remove(string $entryIdentifier): bool
    {
        return false;
    }

    /**
     * Returns an empty array
     *
     * @param string $tag ignored
     * @return string[] An empty array
     * @api
     */
    public function findIdentifiersByTag(string $tag): array
    {
        return [];
    }

    /**
     * Does nothing
     *
     * @return void
     * @api
     */
    public function flush(): void
    {
    }

    /**
     * Does nothing
     *
     * @param string $tag ignored
     * @return integer
     * @api
     */
    public function flushByTag(string $tag): int
    {
        return 0;
    }

    /**
     * Does nothing
     *
     * @param array<string> $tags ignored
     * @return integer
     * @api
     */
    public function flushByTags(array $tags): int
    {
        return 0;
    }

    /**
     * Does nothing
     *
     * @return void
     * @api
     */
    public function collectGarbage(): void
    {
    }

    /**
     * Does nothing
     *
     * @param string $identifier An identifier which describes the cache entry to load
     * @return void
     * @api
     */
    public function requireOnce(string $identifier)
    {
    }
}
// @codeCoverageIgnoreEnd