Blame view

framework/thirdparty/Zend/Cache/Backend/ExtendedInterface.php 3.94 KB
0084d336   Administrator   Importers CRUD
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
  <?php
  /**
   * Zend Framework
   *
   * LICENSE
   *
   * This source file is subject to the new BSD license that is bundled
   * with this package in the file LICENSE.txt.
   * It is also available through the world-wide-web at this URL:
   * http://framework.zend.com/license/new-bsd
   * If you did not receive a copy of the license and are unable to
   * obtain it through the world-wide-web, please send an email
   * to license@zend.com so we can send you a copy immediately.
   *
   * @category   Zend
   * @package    Zend_Cache
   * @subpackage Zend_Cache_Backend
   * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
   * @license    http://framework.zend.com/license/new-bsd     New BSD License
   * @version    $Id: ExtendedInterface.php 23775 2011-03-01 17:25:24Z ralph $
   */
  
  /**
   * @see Zend_Cache_Backend_Interface
   */
  require_once 'Zend/Cache/Backend/Interface.php';
  
  /**
   * @package    Zend_Cache
   * @subpackage Zend_Cache_Backend
   * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
   * @license    http://framework.zend.com/license/new-bsd     New BSD License
   */
  interface Zend_Cache_Backend_ExtendedInterface extends Zend_Cache_Backend_Interface
  {
  
      /**
       * Return an array of stored cache ids
       *
       * @return array array of stored cache ids (string)
       */
      public function getIds();
  
      /**
       * Return an array of stored tags
       *
       * @return array array of stored tags (string)
       */
      public function getTags();
  
      /**
       * Return an array of stored cache ids which match given tags
       *
       * In case of multiple tags, a logical AND is made between tags
       *
       * @param array $tags array of tags
       * @return array array of matching cache ids (string)
       */
      public function getIdsMatchingTags($tags = array());
  
      /**
       * Return an array of stored cache ids which don't match given tags
       *
       * In case of multiple tags, a logical OR is made between tags
       *
       * @param array $tags array of tags
       * @return array array of not matching cache ids (string)
       */
      public function getIdsNotMatchingTags($tags = array());
  
      /**
       * Return an array of stored cache ids which match any given tags
       *
       * In case of multiple tags, a logical AND is made between tags
       *
       * @param array $tags array of tags
       * @return array array of any matching cache ids (string)
       */
      public function getIdsMatchingAnyTags($tags = array());
  
      /**
       * Return the filling percentage of the backend storage
       *
       * @return int integer between 0 and 100
       */
      public function getFillingPercentage();
  
      /**
       * Return an array of metadatas for the given cache id
       *
       * The array must include these keys :
       * - expire : the expire timestamp
       * - tags : a string array of tags
       * - mtime : timestamp of last modification time
       *
       * @param string $id cache id
       * @return array array of metadatas (false if the cache id is not found)
       */
      public function getMetadatas($id);
  
      /**
       * Give (if possible) an extra lifetime to the given cache id
       *
       * @param string $id cache id
       * @param int $extraLifetime
       * @return boolean true if ok
       */
      public function touch($id, $extraLifetime);
  
      /**
       * Return an associative array of capabilities (booleans) of the backend
       *
       * The array must include these keys :
       * - automatic_cleaning (is automating cleaning necessary)
       * - tags (are tags supported)
       * - expired_read (is it possible to read expired cache records
       *                 (for doNotTestCacheValidity option for example))
       * - priority does the backend deal with priority when saving
       * - infinite_lifetime (is infinite lifetime can work with this backend)
       * - get_list (is it possible to get the list of cache ids and the complete list of tags)
       *
       * @return array associative of with capabilities
       */
      public function getCapabilities();
  
  }