Skip to content
Snippets Groups Projects
Select Git revision
  • 3105ea4b8cc57c73f6c4507a86a07dd3e9a17352
  • main default protected
  • 5.5 protected
  • atlantis
  • 5.3 protected
  • 5.0 protected
  • issue-23
  • issue8-seat-logging-and-export
  • ticket-216
  • tickets-215-216-241-242
10 results

StudipCache.class.php

Blame
  • Forked from Stud.IP / Stud.IP
    Source project has a limited visibility.
    Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    StudipCache.class.php 2.39 KiB
    <?php
    /**
     * An interface which has to be implemented by instances returned from
     * StudipCacheFactory#getCache
     *
     * @package    studip
     * @subpackage lib
     *
     * @author     Marco Diedrich (mdiedric@uos)
     * @author     Marcus Lunzenauer (mlunzena@uos.de)
     * @copyright  (c) Authors
     * @since      1.6
     * @license    GPL2 or any later version
     */
    
    interface StudipCache
    {
        const DEFAULT_EXPIRATION = 12 * 60 * 60; // 12 hours
    
        /**
         * Expire item from the cache.
         *
         * Example:
         *
         *   # expires foo
         *   $cache->expire('foo');
         *
         * @param string $arg a single key
         */
        public function expire($arg);
    
        /**1
         * Expire all items from the cache.
         */
        public function flush();
    
        /**
         * Retrieve item from the server.
         *
         * Example:
         *
         *   # reads foo
         *   $foo = $cache->reads('foo');
         *
         * @param string $arg a single key
         *
         * @return mixed    the previously stored data if an item with such a key
         *                  exists on the server or FALSE on failure.
         */
        public function read($arg);
    
        /**
         * Store data at the server.
         *
         * @param string $name     the item's key.
         * @param mixed  $content  the item's content (will be serialized if necessary).
         * @param int    $expires  the item's expiry time in seconds. Optional, defaults to 12h.
         *
         * @return bool     returns TRUE on success or FALSE on failure.
         */
        public function write($name, $content, $expires = self::DEFAULT_EXPIRATION);
    
        /**
         * @return string A translateable display name for this cache class.
         */
        public static function getDisplayName(): string;
    
        /**
         * Get some statistics from cache, like number of entries, hit rate or
         * whatever the underlying cache provides.
         * Results are returned in form of an array like
         *      "[
         *          [
         *              'name' => <displayable name>
         *              'value' => <value of the current stat>
         *          ]
         *      ]"
         *
         * @return array
         */
        public function getStats(): array;
    
        /**
         * Return the Vue component name and props that handle configuration.
         * The associative array is of the form
         *  [
         *      'component' => <Vue component name>,
         *      'props' => <Properties for component>
         *  ]
         *
         * @return array
         */
        public static function getConfig(): array;
    }