Skip to content

Commit 26fe9f6

Browse files
actions-useractions-user
committed
Updated API for commit 27ae8bb0ae04cf8adae274c6a6cf6e5503765bd2
1 parent 46a8783 commit 26fe9f6

File tree

5 files changed

+69
-41
lines changed

5 files changed

+69
-41
lines changed

‎docs/classes/CodeIgniter-Exceptions-DownloadException.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ <h4 id="toc-methods">
337337
</dt>
338338

339339
<dt class="phpdocumentor-table-of-contents__entry -method -public">
340-
<a class="" href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a>
340+
<a class="-deprecated" href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a>
341341
<span>
342342
&nbsp;: static </span>
343343
</dt>
@@ -476,7 +476,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
476476
class="phpdocumentor-element
477477
-method
478478
-public
479-
-static "
479+
-deprecated -static "
480480
>
481481
<h4 class="phpdocumentor-element__name" id="method_forCannotSetCache">
482482
forCannotSetCache()
@@ -486,17 +486,24 @@ <h4 class="phpdocumentor-element__name" id="method_forCannotSetCache">
486486
<aside class="phpdocumentor-element-found-in">
487487
<abbr class="phpdocumentor-element-found-in__file" title="system/Exceptions/DownloadException.php"><a href="files/system-exceptions-downloadexception.html"><abbr title="system/Exceptions/DownloadException.php">DownloadException.php</abbr></a></abbr>
488488
:
489-
<span class="phpdocumentor-element-found-in__line">52</span>
489+
<span class="phpdocumentor-element-found-in__line">54</span>
490490

491491
</aside>
492492

493493

494-
<code class="phpdocumentor-code phpdocumentor-signature ">
494+
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
495495
<span class="phpdocumentor-signature__visibility">public</span>
496496
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">forCannotSetCache</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
497497

498498
<div class="phpdocumentor-label-line">
499499
</div>
500+
<div class="phpdocumentor-admonition">
501+
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
502+
<article>
503+
<p>Since v4.5.6</p>
504+
505+
</article>
506+
</div>
500507

501508

502509

@@ -572,7 +579,7 @@ <h4 class="phpdocumentor-element__name" id="method_forCannotSetStatusCode">
572579
<aside class="phpdocumentor-element-found-in">
573580
<abbr class="phpdocumentor-element-found-in__file" title="system/Exceptions/DownloadException.php"><a href="files/system-exceptions-downloadexception.html"><abbr title="system/Exceptions/DownloadException.php">DownloadException.php</abbr></a></abbr>
574581
:
575-
<span class="phpdocumentor-element-found-in__line">60</span>
582+
<span class="phpdocumentor-element-found-in__line">62</span>
576583

577584
</aside>
578585

@@ -766,7 +773,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
766773
<ul class="phpdocumentor-list -clean">
767774
<li class=""><a href="classes/CodeIgniter-Exceptions-DebugTraceableTrait.html#method___construct">__construct()</a></li>
768775
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetBinary">forCannotSetBinary()</a></li>
769-
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a></li>
776+
<li class="-deprecated"><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a></li>
770777
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetFilePath">forCannotSetFilePath()</a></li>
771778
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetStatusCode">forCannotSetStatusCode()</a></li>
772779
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forNotFoundDownloadSource">forNotFoundDownloadSource()</a></li>

‎docs/classes/CodeIgniter-HTTP-DownloadResponse.html‎

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -707,11 +707,12 @@ <h4 id="toc-methods">
707707
<dd>Sets the body of the current message.</dd>
708708

709709
<dt class="phpdocumentor-table-of-contents__entry -method -public">
710-
<a class="" href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache">setCache()</a>
710+
<a class="" href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCache">setCache()</a>
711711
<span>
712712
&nbsp;: $this </span>
713713
</dt>
714-
<dd>Disables cache configuration.</dd>
714+
<dd>A shortcut method that allows the developer to set all of the
715+
cache-control headers in one method call.</dd>
715716

716717
<dt class="phpdocumentor-table-of-contents__entry -method -public">
717718
<a class="" href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setContentType">setContentType()</a>
@@ -1843,7 +1844,7 @@ <h4 class="phpdocumentor-element__name" id="method_buildHeaders">
18431844
<aside class="phpdocumentor-element-found-in">
18441845
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
18451846
:
1846-
<span class="phpdocumentor-element-found-in__line">283</span>
1847+
<span class="phpdocumentor-element-found-in__line">273</span>
18471848

18481849
</aside>
18491850

@@ -3045,7 +3046,7 @@ <h4 class="phpdocumentor-element__name" id="method_inline">
30453046
<aside class="phpdocumentor-element-found-in">
30463047
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
30473048
:
3048-
<span class="phpdocumentor-element-found-in__line">354</span>
3049+
<span class="phpdocumentor-element-found-in__line">342</span>
30493050

30503051
</aside>
30513052

@@ -3349,7 +3350,7 @@ <h4 class="phpdocumentor-element__name" id="method_send">
33493350
<aside class="phpdocumentor-element-found-in">
33503351
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
33513352
:
3352-
<span class="phpdocumentor-element-found-in__line">262</span>
3353+
<span class="phpdocumentor-element-found-in__line">252</span>
33533354

33543355
</aside>
33553356

@@ -3404,7 +3405,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBody">
34043405
<aside class="phpdocumentor-element-found-in">
34053406
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
34063407
:
3407-
<span class="phpdocumentor-element-found-in__line">306</span>
3408+
<span class="phpdocumentor-element-found-in__line">294</span>
34083409

34093410
</aside>
34103411

@@ -3585,17 +3586,18 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
35853586
>
35863587
<h4 class="phpdocumentor-element__name" id="method_setCache">
35873588
setCache()
3588-
<a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache" class="headerlink"><i class="fas fa-link"></i></a>
3589+
<a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCache" class="headerlink"><i class="fas fa-link"></i></a>
35893590

35903591
</h4>
35913592
<aside class="phpdocumentor-element-found-in">
3592-
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
3593+
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/ResponseTrait.php"><a href="files/system-http-responsetrait.html"><abbr title="system/HTTP/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
35933594
:
3594-
<span class="phpdocumentor-element-found-in__line">250</span>
3595+
<span class="phpdocumentor-element-found-in__line">305</span>
35953596

35963597
</aside>
35973598

3598-
<p class="phpdocumentor-summary">Disables cache configuration.</p>
3599+
<p class="phpdocumentor-summary">A shortcut method that allows the developer to set all of the
3600+
cache-control headers in one method call.</p>
35993601

36003602
<code class="phpdocumentor-code phpdocumentor-signature ">
36013603
<span class="phpdocumentor-signature__visibility">public</span>
@@ -3604,7 +3606,28 @@ <h4 class="phpdocumentor-element__name" id="method_setCache">
36043606
<div class="phpdocumentor-label-line">
36053607
</div>
36063608

3607-
3609+
<section class="phpdocumentor-description"><p>The options array is used to provide the cache-control directives
3610+
for the header. It might look something like:</p>
3611+
<pre class="prettyprint"><code class="prettyprint"> $options = [
3612+
'max-age' =&gt; 300,
3613+
's-maxage' =&gt; 900
3614+
'etag' =&gt; 'abcde',
3615+
];
3616+
</code></pre>
3617+
<p>Typical options are:</p>
3618+
<ul>
3619+
<li>etag</li>
3620+
<li>last-modified</li>
3621+
<li>max-age</li>
3622+
<li>s-maxage</li>
3623+
<li>private</li>
3624+
<li>public</li>
3625+
<li>must-revalidate</li>
3626+
<li>proxy-revalidate</li>
3627+
<li>no-transform</li>
3628+
</ul>
3629+
</section>
3630+
36083631
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
36093632
<dl class="phpdocumentor-argument-list">
36103633
<dt class="phpdocumentor-argument-list__entry">
@@ -3617,21 +3640,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
36173640
</dl>
36183641

36193642

3620-
<h5 class="phpdocumentor-tag-list__heading" id="tags">
3621-
Tags
3622-
<a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache#tags" class="headerlink"><i class="fas fa-link"></i></a>
3623-
3624-
</h5>
3625-
<dl class="phpdocumentor-tag-list">
3626-
<dt class="phpdocumentor-tag-list__entry">
3627-
<span class="phpdocumentor-tag__name">throws</span>
3628-
</dt>
3629-
<dd class="phpdocumentor-tag-list__definition">
3630-
<span class="phpdocumentor-tag-link"><a href="classes/CodeIgniter-Exceptions-DownloadException.html"><abbr title="\CodeIgniter\Exceptions\DownloadException">DownloadException</abbr></a></span>
3631-
3632-
3633-
</dd>
3634-
</dl>
36353643

36363644

36373645

@@ -4919,7 +4927,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBodyByBinary">
49194927
<aside class="phpdocumentor-element-found-in">
49204928
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
49214929
:
4922-
<span class="phpdocumentor-element-found-in__line">342</span>
4930+
<span class="phpdocumentor-element-found-in__line">330</span>
49234931

49244932
</aside>
49254933

@@ -4958,7 +4966,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBodyByFilePath">
49584966
<aside class="phpdocumentor-element-found-in">
49594967
<abbr class="phpdocumentor-element-found-in__file" title="system/HTTP/DownloadResponse.php"><a href="files/system-http-downloadresponse.html"><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></a></abbr>
49604968
:
4961-
<span class="phpdocumentor-element-found-in__line">324</span>
4969+
<span class="phpdocumentor-element-found-in__line">312</span>
49624970

49634971
</aside>
49644972

@@ -5190,7 +5198,7 @@ <h4 class="phpdocumentor-element__name" id="method_setContentTypeByMimeType">
51905198
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_sendHeaders">sendHeaders()</a></li>
51915199
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setBinary">setBinary()</a></li>
51925200
<li class=""><a href="classes/CodeIgniter-HTTP-MessageTrait.html#method_setBody">setBody()</a></li>
5193-
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache">setCache()</a></li>
5201+
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCache">setCache()</a></li>
51945202
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setContentType">setContentType()</a></li>
51955203
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCookie">setCookie()</a></li>
51965204
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setDate">setDate()</a></li>

‎docs/js/searchIndex.js‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15805,11 +15805,6 @@ Search.appendIndex(
1580515805
"name": "noCache",
1580615806
"summary": "Sets\u0020the\u0020appropriate\u0020headers\u0020to\u0020ensure\u0020this\u0020response\nis\u0020not\u0020cached\u0020by\u0020the\u0020browsers.",
1580715807
"url": "classes/CodeIgniter-HTTP-DownloadResponse.html#method_noCache"
15808-
}, {
15809-
"fqsen": "\\CodeIgniter\\HTTP\\DownloadResponse\u003A\u003AsetCache\u0028\u0029",
15810-
"name": "setCache",
15811-
"summary": "Disables\u0020cache\u0020configuration.",
15812-
"url": "classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache"
1581315808
}, {
1581415809
"fqsen": "\\CodeIgniter\\HTTP\\DownloadResponse\u003A\u003Asend\u0028\u0029",
1581515810
"name": "send",

‎docs/reports/deprecated.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,9 @@ <h3>Table of Contents</h3>
317317
</tr>
318318
<tr>
319319
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Entity/Entity.php">system/Entity/Entity.php</a></td>
320+
</tr>
321+
<tr>
322+
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Exceptions/DownloadException.php">system/Exceptions/DownloadException.php</a></td>
320323
</tr>
321324
<tr>
322325
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Exceptions/FrameworkException.php">system/Exceptions/FrameworkException.php</a></td>
@@ -932,6 +935,21 @@ <h3><abbr title="system/Entity/Entity.php">Entity.php</abbr></h3>
932935
<td class="phpdocumentor-cell">323</td>
933936
<td class="phpdocumentor-cell"><a href="classes/CodeIgniter-Entity-Entity.html#method_setAttributes"><abbr title="\CodeIgniter\Entity\Entity::setAttributes()">Entity::setAttributes()</abbr></a></td>
934937
<td class="phpdocumentor-cell"><p>Use injectRawData() instead.</p>
938+
</td>
939+
</tr>
940+
</table>
941+
<a id="system/Exceptions/DownloadException.php"></a>
942+
<h3><abbr title="system/Exceptions/DownloadException.php">DownloadException.php</abbr></h3>
943+
<table>
944+
<tr>
945+
<th class="phpdocumentor-heading">Line</th>
946+
<th class="phpdocumentor-heading">Element</th>
947+
<th class="phpdocumentor-heading">Reason</th>
948+
</tr>
949+
<tr>
950+
<td class="phpdocumentor-cell">54</td>
951+
<td class="phpdocumentor-cell"><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache"><abbr title="\CodeIgniter\Exceptions\DownloadException::forCannotSetCache()">DownloadException::forCannotSetCache()</abbr></a></td>
952+
<td class="phpdocumentor-cell"><p>Since v4.5.6</p>
935953
</td>
936954
</tr>
937955
</table>

‎docs/reports/markers.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ <h3><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></
412412
<tbody>
413413
<tr>
414414
<td class="phpdocumentor-cell">TODO</td>
415-
<td class="phpdocumentor-cell">262</td>
415+
<td class="phpdocumentor-cell">252</td>
416416
<td class="phpdocumentor-cell">Do downloads need CSP or Cookies? Compare with ResponseTrait::send()</td>
417417
</tr>
418418
</tbody>

0 commit comments

Comments
 (0)