Drush: includes/cache.inc Source File

  1. 7.x doxygen/html/includes_2cache_8inc_source.html
  2. master doxygen/html/includes_2cache_8inc_source.html
Go to the documentation of this file.
1 <?php
2 
3 /**
4  * @file
5  * Drush cache API
6  *
7  * Provides a cache API for drush core and commands, forked from Drupal 7.
8  *
9  * The default storage backend uses the plain text files to store serialized php
10  * objects, which can be extended or replaced by setting the cache-default-class
11  * option in drushrc.php.
12  */
13 
14 /**
15  * Indicates that the item should never be removed unless explicitly selected.
16  *
17  * The item may be removed using cache_clear_all() with a cache ID.
18  */
19 define('DRUSH_CACHE_PERMANENT', 0);
20 
21 /**
22  * Indicates that the item should be removed at the next general cache wipe.
23  */
24 define('DRUSH_CACHE_TEMPORARY', -1);
25 
26 /**
27  * Get the cache object for a cache bin.
28  *
29  * By default, this returns an instance of the \Drush\Cache\FileCache class.
30  * Classes implementing \Drush\Cache\CacheInterface can register themselves
31  * both as a default implementation and for specific bins.
32  *
34  *
35  * @param string $bin
36  * The cache bin for which the cache object should be returned.
37  *
39  * The cache object associated with the specified bin.
40  */
41 function _drush_cache_get_object($bin) {
42  static $cache_objects;
43 
44  if (!isset($cache_objects[$bin])) {
45  $class = drush_get_option('cache-class-' . $bin, NULL);
46  if (!isset($class)) {
47  $class = drush_get_option('cache-default-class', '\Drush\Cache\JSONCache');
48  }
49  $cache_objects[$bin] = new $class($bin);
50  }
51  return $cache_objects[$bin];
52 }
53 
54 /**
55  * Return data from the persistent cache.
56  *
57  * Data may be stored as either plain text or as serialized data.
58  * _drush_cache_get() will automatically return unserialized
59  * objects and arrays.
60  *
61  * @param string $cid
62  * The cache ID of the data to retrieve.
63  * @param string $bin
64  * The cache bin to store the data in.
65  *
66  * @return
67  * The cache or FALSE on failure.
68  *
69  */
70 function drush_cache_get($cid, $bin = 'default') {
71  $ret = _drush_cache_get_object($bin)->get($cid);
72  $mess = $ret ? "HIT" : "MISS";
73  drush_log(dt("Cache !mess cid: !cid", array('!mess' => $mess, '!cid' => $cid)), 'debug');
74  return $ret;
75 }
76 
77 /**
78  * Return data from the persistent cache when given an array of cache IDs.
79  *
80  * @param array $cids
81  * An array of cache IDs for the data to retrieve. This is passed by
82  * reference, and will have the IDs successfully returned from cache removed.
83  * @param string $bin
84  * The cache bin where the data is stored.
85  *
86  * @return
87  * An array of the items successfully returned from cache indexed by cid.
88  */
89 function drush_cache_get_multiple(array &$cids, $bin = 'default') {
90  return _drush_cache_get_object($bin)->getMultiple($cids);
91 }
92 
93 /**
94  * Store data in the persistent cache.
95  *
96  * @param string $cid
97  * The cache ID of the data to store.
98  *
99  * @param $data
100  * The data to store in the cache.
101  * @param string $bin
102  * The cache bin to store the data in.
103  * @param $expire
104  * One of the following values:
105  * - DRUSH_CACHE_PERMANENT: Indicates that the item should never be removed
106  * unless explicitly told to using cache_clear_all() with a cache ID.
107  * - DRUSH_CACHE_TEMPORARY: Indicates that the item should be removed at
108  * the next general cache wipe.
109  * - A Unix timestamp: Indicates that the item should be kept at least until
110  * the given time, after which it behaves like DRUSH_CACHE_TEMPORARY.
111  *
112  * @return bool
113  */
114 function drush_cache_set($cid, $data, $bin = 'default', $expire = DRUSH_CACHE_PERMANENT) {
115  $ret = _drush_cache_get_object($bin)->set($cid, $data, $expire);
116  if ($ret) drush_log(dt("Cache SET cid: !cid", array('!cid' => $cid)), 'debug');
117  return $ret;
118 }
119 
120 /**
121  * Expire data from the cache.
122  *
123  * If called without arguments, expirable entries will be cleared from all known
124  * cache bins.
125  *
126  * @param string $cid
127  * If set, the cache ID to delete. Otherwise, all cache entries that can
128  * expire are deleted.
129  * @param string $bin
130  * If set, the bin $bin to delete from. Mandatory
131  * argument if $cid is set.
132  * @param bool $wildcard
133  * If $wildcard is TRUE, cache IDs starting with $cid are deleted in
134  * addition to the exact cache ID specified by $cid. If $wildcard is
135  * TRUE and $cid is '*' then the entire bin $bin is emptied.
136  */
137 function drush_cache_clear_all($cid = NULL, $bin = 'default', $wildcard = FALSE) {
138  if (!isset($cid) && !isset($bin)) {
139  foreach (drush_cache_get_bins() as $bin) {
140  _drush_cache_get_object($bin)->clear();
141  }
142  return;
143  }
144  return _drush_cache_get_object($bin)->clear($cid, $wildcard);
145 }
146 
147 /**
148  * Check if a cache bin is empty.
149  *
150  * A cache bin is considered empty if it does not contain any valid data for any
151  * cache ID.
152  *
153  * @param $bin
154  * The cache bin to check.
155  *
156  * @return
157  * TRUE if the cache bin specified is empty.
158  */
159 function _drush_cache_is_empty($bin) {
160  return _drush_cache_get_object($bin)->isEmpty();
161 }
162 
163 /**
164  * Return drush cache bins and any bins added by hook_drush_flush_caches().
165  */
167  $drush = array('default');
168  return array_merge(drush_command_invoke_all('drush_flush_caches'), $drush);
169 }
170 
171 /**
172  * Create a cache id from a given prefix, contexts, and additional parameters.
173  *
174  * @param prefix
175  * A human readable cid prefix that will not be hashed.
176  * @param contexts
177  * Array of drush contexts that will be used to build a unique hash.
178  * @param params
179  * Array of any addition parameters to be hashed.
180  *
181  * @return
182  * A cache id string.
183  */
184 function drush_get_cid($prefix, $contexts = array(), $params = array()) {
185  $cid = array();
186 
187  foreach ($contexts as $context) {
188  $c = drush_get_context($context);
189  if (!empty($c)) {
190  $cid[] = is_scalar($c) ? $c : serialize($c);
191  }
192  }
193 
194  foreach ($params as $param) {
195  $cid[] = $param;
196  }
197 
198  return DRUSH_VERSION . '-' . $prefix . '-' . md5(implode("", $cid));
199 }

File

doxygen/html/includes_2cache_8inc_source.html
View source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: includes/cache.inc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_09e761304027c904456130627fd4dcf5.html">includes</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">cache.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="includes_2cache_8inc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php</div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Drush cache API</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Provides a cache API for drush core and commands, forked from Drupal 7.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * The default storage backend uses the plain text files to store serialized php</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * objects, which can be extended or replaced by setting the cache-default-class</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * option in drushrc.php.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * Indicates that the item should never be removed unless explicitly selected.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * The item may be removed using cache_clear_all() with a cache ID.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a9f0a518bb0b1e6c3397756383fc72316">   19</a></span>&#160;define(<span class="stringliteral">&#39;DRUSH_CACHE_PERMANENT&#39;</span>, 0);</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * Indicates that the item should be removed at the next general cache wipe.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a594d24dfbddcc6a2c2200ce328d5a8d2">   24</a></span>&#160;define(<span class="stringliteral">&#39;DRUSH_CACHE_TEMPORARY&#39;</span>, -1);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * Get the cache object for a cache bin.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * By default, this returns an instance of the \Drush\Cache\FileCache class.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * Classes implementing \Drush\Cache\CacheInterface can register themselves</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> * both as a default implementation and for specific bins.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> * @see \Drush\Cache\CacheInterface</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * @param string $bin</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> *   The cache bin for which the cache object should be returned.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"> * @return \Drush\Cache\CacheInterface</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"> *   The cache object associated with the specified bin.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">   41</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin) {</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="keyword">static</span> $cache_objects;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="keywordflow">if</span> (!isset($cache_objects[$bin])) {</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    $class = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;cache-class-&#39;</span> . $bin, NULL);</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keywordflow">if</span> (!isset($class)) {</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;      $class = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;cache-default-class&#39;</span>, <span class="stringliteral">&#39;\Drush\Cache\JSONCache&#39;</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    }</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    $cache_objects[$bin] = <span class="keyword">new</span> $class($bin);</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  }</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="keywordflow">return</span> $cache_objects[$bin];</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;}</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> * Return data from the persistent cache.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * Data may be stored as either plain text or as serialized data.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * _drush_cache_get() will automatically return unserialized</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> * objects and arrays.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> * @param string $cid</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> *   The cache ID of the data to retrieve.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param string $bin</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> *   The cache bin to store the data in.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> *   The cache or FALSE on failure.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#adc36ac3b562c67cbf1d7aab89c029694">   70</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#adc36ac3b562c67cbf1d7aab89c029694">drush_cache_get</a>($cid, $bin = <span class="stringliteral">&#39;default&#39;</span>) {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  $ret = <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;get($cid);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  $mess = $ret ? <span class="stringliteral">&quot;HIT&quot;</span> : <span class="stringliteral">&quot;MISS&quot;</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Cache !mess cid: !cid&quot;</span>, array(<span class="stringliteral">&#39;!mess&#39;</span> =&gt; $mess, <span class="stringliteral">&#39;!cid&#39;</span> =&gt; $cid)), <span class="stringliteral">&#39;debug&#39;</span>);</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  <span class="keywordflow">return</span> $ret;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;}</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * Return data from the persistent cache when given an array of cache IDs.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * @param array $cids</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> *   An array of cache IDs for the data to retrieve. This is passed by</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> *   reference, and will have the IDs successfully returned from cache removed.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * @param string $bin</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> *   The cache bin where the data is stored.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *   An array of the items successfully returned from cache indexed by cid.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#afebdecedf322982f12726c31fd525f11">   89</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#afebdecedf322982f12726c31fd525f11">drush_cache_get_multiple</a>(array &amp;$cids, $bin = <span class="stringliteral">&#39;default&#39;</span>) {</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;getMultiple($cids);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;}</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * Store data in the persistent cache.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * @param string $cid</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> *   The cache ID of the data to store.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @param $data</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> *   The data to store in the cache.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * @param string $bin</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> *   The cache bin to store the data in.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * @param $expire</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> *   One of the following values:</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *   - DRUSH_CACHE_PERMANENT: Indicates that the item should never be removed</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> *     unless explicitly told to using cache_clear_all() with a cache ID.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> *   - DRUSH_CACHE_TEMPORARY: Indicates that the item should be removed at</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> *     the next general cache wipe.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> *   - A Unix timestamp: Indicates that the item should be kept at least until</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> *     the given time, after which it behaves like DRUSH_CACHE_TEMPORARY.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> * @return bool</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a27a40af68c2a61fdf94b980b953236bf">  114</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a27a40af68c2a61fdf94b980b953236bf">drush_cache_set</a>($cid, $data, $bin = <span class="stringliteral">&#39;default&#39;</span>, $expire = <a class="code" href="includes_2cache_8inc.html#a9f0a518bb0b1e6c3397756383fc72316">DRUSH_CACHE_PERMANENT</a>) {</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  $ret = <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;set($cid, $data, $expire);</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  <span class="keywordflow">if</span> ($ret) <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Cache SET cid: !cid&quot;</span>, array(<span class="stringliteral">&#39;!cid&#39;</span> =&gt; $cid)), <span class="stringliteral">&#39;debug&#39;</span>);</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="keywordflow">return</span> $ret;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;}</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * Expire data from the cache.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * If called without arguments, expirable entries will be cleared from all known</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * cache bins.</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> * @param string $cid</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"> *   If set, the cache ID to delete. Otherwise, all cache entries that can</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> *   expire are deleted.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> * @param string $bin</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> *   If set, the bin $bin to delete from. Mandatory</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"> *   argument if $cid is set.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * @param bool $wildcard</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> *   If $wildcard is TRUE, cache IDs starting with $cid are deleted in</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> *   addition to the exact cache ID specified by $cid.  If $wildcard is</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> *   TRUE and $cid is &#39;*&#39; then the entire bin $bin is emptied.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a320b19400992c01f88bd71db140da5bc">  137</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a320b19400992c01f88bd71db140da5bc">drush_cache_clear_all</a>($cid = NULL, $bin = <span class="stringliteral">&#39;default&#39;</span>, $wildcard = FALSE) {</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  <span class="keywordflow">if</span> (!isset($cid) &amp;&amp; !isset($bin)) {</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    <span class="keywordflow">foreach</span> (<a class="code" href="includes_2cache_8inc.html#a4338413ce68582b943bb07b81da7af7a">drush_cache_get_bins</a>() as $bin) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;      <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;clear();</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    }</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;  }</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;clear($cid, $wildcard);</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;}</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * Check if a cache bin is empty.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> * A cache bin is considered empty if it does not contain any valid data for any</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> * cache ID.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> * @param $bin</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> *   The cache bin to check.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> *   TRUE if the cache bin specified is empty.</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a6da367571968d842a0cda8b61d969441">  159</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a6da367571968d842a0cda8b61d969441">_drush_cache_is_empty</a>($bin) {</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="includes_2cache_8inc.html#a80d986947415d49a2b3324018a0beb1e">_drush_cache_get_object</a>($bin)-&gt;isEmpty();</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;}</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * Return drush cache bins and any bins added by hook_drush_flush_caches().</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a4338413ce68582b943bb07b81da7af7a">  166</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a4338413ce68582b943bb07b81da7af7a">drush_cache_get_bins</a>() {</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;  $drush = array(<span class="stringliteral">&#39;default&#39;</span>);</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;  <span class="keywordflow">return</span> array_merge(<a class="code" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9">drush_command_invoke_all</a>(<span class="stringliteral">&#39;drush_flush_caches&#39;</span>), $drush);</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;}</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment"> * Create a cache id from a given prefix, contexts, and additional parameters.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> * @param prefix</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> *   A human readable cid prefix that will not be hashed.</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> * @param contexts</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> *   Array of drush contexts that will be used to build a unique hash.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment"> * @param params</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> *   Array of any addition parameters to be hashed.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> *   A cache id string.</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="code" href="includes_2cache_8inc.html#a70613777c5e1a0e258bd0d8e213e0156">  184</a></span>&#160;<span class="keyword">function</span> <a class="code" href="includes_2cache_8inc.html#a70613777c5e1a0e258bd0d8e213e0156">drush_get_cid</a>($prefix, $contexts = array(), $params = array()) {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;  $cid = array();</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;  <span class="keywordflow">foreach</span> ($contexts as $context) {</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    $c = <a class="code" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5">drush_get_context</a>($context);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;    <span class="keywordflow">if</span> (!empty($c)) {</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;      $cid[] = is_scalar($c) ? $c : serialize($c);</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    }</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;  }</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;  <span class="keywordflow">foreach</span> ($params as $param) {</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;    $cid[] = $param;</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;  }</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;  <span class="keywordflow">return</span> DRUSH_VERSION . <span class="charliteral">&#39;-&#39;</span> . $prefix . <span class="charliteral">&#39;-&#39;</span> . md5(implode(<span class="stringliteral">&quot;&quot;</span>, $cid));</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:53 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>