Skip to content

Commit cdbc123

Browse files
committed
Updated API for commit 488ace9334528bff89af51d42ff34a6ff7c88e46
1 parent c8c8c8f commit cdbc123

25 files changed

+291
-354
lines changed

docs/classes/CodeIgniter-Cache-CacheInterface.html

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,11 @@ <h2 class="phpdocumentor-content__title">
261261
<aside class="phpdocumentor-element-found-in">
262262
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
263263
:
264-
<span class="phpdocumentor-element-found-in__line">19</span>
264+
<span class="phpdocumentor-element-found-in__line">16</span>
265265

266266
</aside>
267267

268-
<p class="phpdocumentor-summary">Cache interface</p>
269-
268+
270269

271270

272271

@@ -320,7 +319,7 @@ <h4 id="toc-methods">
320319
<dt class="phpdocumentor-table-of-contents__entry -method -public">
321320
<a class="" href="classes/CodeIgniter-Cache-CacheInterface.html#method_get">get()</a>
322321
<span>
323-
&nbsp;: array&lt;string|int, mixed&gt;|bool|float|int|object|string|null </span>
322+
&nbsp;: mixed </span>
324323
</dt>
325324
<dd>Attempts to fetch an item from the cache store.</dd>
326325

@@ -334,7 +333,7 @@ <h4 id="toc-methods">
334333
<dt class="phpdocumentor-table-of-contents__entry -method -public">
335334
<a class="" href="classes/CodeIgniter-Cache-CacheInterface.html#method_getMetaData">getMetaData()</a>
336335
<span>
337-
&nbsp;: array&lt;string|int, mixed&gt;|false|null </span>
336+
&nbsp;: array&lt;string, mixed&gt;|false|null </span>
338337
</dt>
339338
<dd>Returns detailed information about the specific item in the cache.</dd>
340339

@@ -393,7 +392,7 @@ <h4 class="phpdocumentor-element__name" id="method_clean">
393392
<aside class="phpdocumentor-element-found-in">
394393
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
395394
:
396-
<span class="phpdocumentor-element-found-in__line">82</span>
395+
<span class="phpdocumentor-element-found-in__line">79</span>
397396

398397
</aside>
399398

@@ -436,7 +435,7 @@ <h4 class="phpdocumentor-element__name" id="method_decrement">
436435
<aside class="phpdocumentor-element-found-in">
437436
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
438437
:
439-
<span class="phpdocumentor-element-found-in__line">75</span>
438+
<span class="phpdocumentor-element-found-in__line">72</span>
440439

441440
</aside>
442441

@@ -496,7 +495,7 @@ <h4 class="phpdocumentor-element__name" id="method_delete">
496495
<aside class="phpdocumentor-element-found-in">
497496
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
498497
:
499-
<span class="phpdocumentor-element-found-in__line">55</span>
498+
<span class="phpdocumentor-element-found-in__line">52</span>
500499

501500
</aside>
502501

@@ -551,15 +550,15 @@ <h4 class="phpdocumentor-element__name" id="method_get">
551550
<aside class="phpdocumentor-element-found-in">
552551
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
553552
:
554-
<span class="phpdocumentor-element-found-in__line">35</span>
553+
<span class="phpdocumentor-element-found-in__line">32</span>
555554

556555
</aside>
557556

558557
<p class="phpdocumentor-summary">Attempts to fetch an item from the cache store.</p>
559558

560559
<code class="phpdocumentor-code phpdocumentor-signature ">
561560
<span class="phpdocumentor-signature__visibility">public</span>
562-
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|bool|float|int|object|string|null</span></code>
561+
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
563562

564563
<div class="phpdocumentor-label-line">
565564
</div>
@@ -582,11 +581,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
582581

583582

584583

585-
<section>
586-
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
587-
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|bool|float|int|object|string|null</span>
588-
</section>
589-
584+
590585
</article>
591586
<article
592587
class="phpdocumentor-element
@@ -602,7 +597,7 @@ <h4 class="phpdocumentor-element__name" id="method_getCacheInfo">
602597
<aside class="phpdocumentor-element-found-in">
603598
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
604599
:
605-
<span class="phpdocumentor-element-found-in__line">92</span>
600+
<span class="phpdocumentor-element-found-in__line">89</span>
606601

607602
</aside>
608603

@@ -644,15 +639,15 @@ <h4 class="phpdocumentor-element__name" id="method_getMetaData">
644639
<aside class="phpdocumentor-element-found-in">
645640
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
646641
:
647-
<span class="phpdocumentor-element-found-in__line">104</span>
642+
<span class="phpdocumentor-element-found-in__line">100</span>
648643

649644
</aside>
650645

651646
<p class="phpdocumentor-summary">Returns detailed information about the specific item in the cache.</p>
652647

653648
<code class="phpdocumentor-code phpdocumentor-signature ">
654649
<span class="phpdocumentor-signature__visibility">public</span>
655-
<span class="phpdocumentor-signature__name">getMetaData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|false|null</span></code>
650+
<span class="phpdocumentor-signature__name">getMetaData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string, mixed&gt;|false|null</span></code>
656651

657652
<div class="phpdocumentor-label-line">
658653
</div>
@@ -677,7 +672,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
677672

678673
<section>
679674
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
680-
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|false|null</span>
675+
<span class="phpdocumentor-signature__response_type">array&lt;string, mixed&gt;|false|null</span>
681676
&mdash;
682677
<section class="phpdocumentor-description"><p>Returns null if the item does not exist, otherwise array&lt;string, mixed&gt;
683678
with at least the 'expire' key for absolute epoch expiry (or null).
@@ -701,7 +696,7 @@ <h4 class="phpdocumentor-element__name" id="method_increment">
701696
<aside class="phpdocumentor-element-found-in">
702697
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
703698
:
704-
<span class="phpdocumentor-element-found-in__line">65</span>
699+
<span class="phpdocumentor-element-found-in__line">62</span>
705700

706701
</aside>
707702

@@ -761,7 +756,7 @@ <h4 class="phpdocumentor-element__name" id="method_initialize">
761756
<aside class="phpdocumentor-element-found-in">
762757
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
763758
:
764-
<span class="phpdocumentor-element-found-in__line">26</span>
759+
<span class="phpdocumentor-element-found-in__line">23</span>
765760

766761
</aside>
767762

@@ -796,7 +791,7 @@ <h4 class="phpdocumentor-element__name" id="method_isSupported">
796791
<aside class="phpdocumentor-element-found-in">
797792
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
798793
:
799-
<span class="phpdocumentor-element-found-in__line">109</span>
794+
<span class="phpdocumentor-element-found-in__line">105</span>
800795

801796
</aside>
802797

@@ -835,15 +830,15 @@ <h4 class="phpdocumentor-element__name" id="method_save">
835830
<aside class="phpdocumentor-element-found-in">
836831
<abbr class="phpdocumentor-element-found-in__file" title="system/Cache/CacheInterface.php"><a href="files/system-cache-cacheinterface.html"><abbr title="system/Cache/CacheInterface.php">CacheInterface.php</abbr></a></abbr>
837832
:
838-
<span class="phpdocumentor-element-found-in__line">46</span>
833+
<span class="phpdocumentor-element-found-in__line">43</span>
839834

840835
</aside>
841836

842837
<p class="phpdocumentor-summary">Saves an item to the cache store.</p>
843838

844839
<code class="phpdocumentor-code phpdocumentor-signature ">
845840
<span class="phpdocumentor-signature__visibility">public</span>
846-
<span class="phpdocumentor-signature__name">save</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|bool|float|int|object|string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ttl</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">60</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
841+
<span class="phpdocumentor-signature__name">save</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ttl</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">60</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
847842

848843
<div class="phpdocumentor-label-line">
849844
</div>
@@ -862,7 +857,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
862857
</dd>
863858
<dt class="phpdocumentor-argument-list__entry">
864859
<span class="phpdocumentor-signature__argument__name">$value</span>
865-
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|bool|float|int|object|string|null</span>
860+
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
866861
</dt>
867862
<dd class="phpdocumentor-argument-list__definition">
868863
<section class="phpdocumentor-description"><p>The data to save</p>

0 commit comments

Comments
 (0)