Skip to content

Commit

Permalink
Updated API for commit 27ae8bb0ae04cf8adae274c6a6cf6e5503765bd2
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Nov 17, 2024
1 parent 46a8783 commit 26fe9f6
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 41 deletions.
19 changes: 13 additions & 6 deletions docs/classes/CodeIgniter-Exceptions-DownloadException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ <h4 id="toc-methods">
</dt>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a>
<a class="-deprecated" href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a>
<span>
&nbsp;: static </span>
</dt>
Expand Down Expand Up @@ -476,7 +476,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
class="phpdocumentor-element
-method
-public
-static "
-deprecated -static "
>
<h4 class="phpdocumentor-element__name" id="method_forCannotSetCache">
forCannotSetCache()
Expand All @@ -486,17 +486,24 @@ <h4 class="phpdocumentor-element__name" id="method_forCannotSetCache">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">52</span>
<span class="phpdocumentor-element-found-in__line">54</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<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>

<div class="phpdocumentor-label-line">
</div>
<div class="phpdocumentor-admonition">
<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>
<article>
<p>Since v4.5.6</p>

</article>
</div>



Expand Down Expand Up @@ -572,7 +579,7 @@ <h4 class="phpdocumentor-element__name" id="method_forCannotSetStatusCode">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<span class="phpdocumentor-element-found-in__line">62</span>

</aside>

Expand Down Expand Up @@ -766,7 +773,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/CodeIgniter-Exceptions-DebugTraceableTrait.html#method___construct">__construct()</a></li>
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetBinary">forCannotSetBinary()</a></li>
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a></li>
<li class="-deprecated"><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache">forCannotSetCache()</a></li>
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetFilePath">forCannotSetFilePath()</a></li>
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetStatusCode">forCannotSetStatusCode()</a></li>
<li class=""><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forNotFoundDownloadSource">forNotFoundDownloadSource()</a></li>
Expand Down
66 changes: 37 additions & 29 deletions docs/classes/CodeIgniter-HTTP-DownloadResponse.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -707,11 +707,12 @@ <h4 id="toc-methods">
<dd>Sets the body of the current message.</dd>

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

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setContentType">setContentType()</a>
Expand Down Expand Up @@ -1843,7 +1844,7 @@ <h4 class="phpdocumentor-element__name" id="method_buildHeaders">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">283</span>
<span class="phpdocumentor-element-found-in__line">273</span>

</aside>

Expand Down Expand Up @@ -3045,7 +3046,7 @@ <h4 class="phpdocumentor-element__name" id="method_inline">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">354</span>
<span class="phpdocumentor-element-found-in__line">342</span>

</aside>

Expand Down Expand Up @@ -3349,7 +3350,7 @@ <h4 class="phpdocumentor-element__name" id="method_send">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">262</span>
<span class="phpdocumentor-element-found-in__line">252</span>

</aside>

Expand Down Expand Up @@ -3404,7 +3405,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBody">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">306</span>
<span class="phpdocumentor-element-found-in__line">294</span>

</aside>

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

</h4>
<aside class="phpdocumentor-element-found-in">
<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>
<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>
:
<span class="phpdocumentor-element-found-in__line">250</span>
<span class="phpdocumentor-element-found-in__line">305</span>

</aside>

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

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Expand All @@ -3604,7 +3606,28 @@ <h4 class="phpdocumentor-element__name" id="method_setCache">
<div class="phpdocumentor-label-line">
</div>


<section class="phpdocumentor-description"><p>The options array is used to provide the cache-control directives
for the header. It might look something like:</p>
<pre class="prettyprint"><code class="prettyprint"> $options = [
'max-age' =&gt; 300,
's-maxage' =&gt; 900
'etag' =&gt; 'abcde',
];
</code></pre>
<p>Typical options are:</p>
<ul>
<li>etag</li>
<li>last-modified</li>
<li>max-age</li>
<li>s-maxage</li>
<li>private</li>
<li>public</li>
<li>must-revalidate</li>
<li>proxy-revalidate</li>
<li>no-transform</li>
</ul>
</section>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand All @@ -3617,21 +3640,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CodeIgniter-Exceptions-DownloadException.html"><abbr title="\CodeIgniter\Exceptions\DownloadException">DownloadException</abbr></a></span>


</dd>
</dl>



Expand Down Expand Up @@ -4919,7 +4927,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBodyByBinary">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">342</span>
<span class="phpdocumentor-element-found-in__line">330</span>

</aside>

Expand Down Expand Up @@ -4958,7 +4966,7 @@ <h4 class="phpdocumentor-element__name" id="method_sendBodyByFilePath">
<aside class="phpdocumentor-element-found-in">
<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>
:
<span class="phpdocumentor-element-found-in__line">324</span>
<span class="phpdocumentor-element-found-in__line">312</span>

</aside>

Expand Down Expand Up @@ -5190,7 +5198,7 @@ <h4 class="phpdocumentor-element__name" id="method_setContentTypeByMimeType">
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_sendHeaders">sendHeaders()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setBinary">setBinary()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-MessageTrait.html#method_setBody">setBody()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache">setCache()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCache">setCache()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-DownloadResponse.html#method_setContentType">setContentType()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setCookie">setCookie()</a></li>
<li class=""><a href="classes/CodeIgniter-HTTP-ResponseTrait.html#method_setDate">setDate()</a></li>
Expand Down
5 changes: 0 additions & 5 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15805,11 +15805,6 @@ Search.appendIndex(
"name": "noCache",
"summary": "Sets\u0020the\u0020appropriate\u0020headers\u0020to\u0020ensure\u0020this\u0020response\nis\u0020not\u0020cached\u0020by\u0020the\u0020browsers.",
"url": "classes/CodeIgniter-HTTP-DownloadResponse.html#method_noCache"
}, {
"fqsen": "\\CodeIgniter\\HTTP\\DownloadResponse\u003A\u003AsetCache\u0028\u0029",
"name": "setCache",
"summary": "Disables\u0020cache\u0020configuration.",
"url": "classes/CodeIgniter-HTTP-DownloadResponse.html#method_setCache"
}, {
"fqsen": "\\CodeIgniter\\HTTP\\DownloadResponse\u003A\u003Asend\u0028\u0029",
"name": "send",
Expand Down
18 changes: 18 additions & 0 deletions docs/reports/deprecated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,9 @@ <h3>Table of Contents</h3>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Entity/Entity.php">system/Entity/Entity.php</a></td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Exceptions/DownloadException.php">system/Exceptions/DownloadException.php</a></td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#system/Exceptions/FrameworkException.php">system/Exceptions/FrameworkException.php</a></td>
Expand Down Expand Up @@ -932,6 +935,21 @@ <h3><abbr title="system/Entity/Entity.php">Entity.php</abbr></h3>
<td class="phpdocumentor-cell">323</td>
<td class="phpdocumentor-cell"><a href="classes/CodeIgniter-Entity-Entity.html#method_setAttributes"><abbr title="\CodeIgniter\Entity\Entity::setAttributes()">Entity::setAttributes()</abbr></a></td>
<td class="phpdocumentor-cell"><p>Use injectRawData() instead.</p>
</td>
</tr>
</table>
<a id="system/Exceptions/DownloadException.php"></a>
<h3><abbr title="system/Exceptions/DownloadException.php">DownloadException.php</abbr></h3>
<table>
<tr>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Element</th>
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">54</td>
<td class="phpdocumentor-cell"><a href="classes/CodeIgniter-Exceptions-DownloadException.html#method_forCannotSetCache"><abbr title="\CodeIgniter\Exceptions\DownloadException::forCannotSetCache()">DownloadException::forCannotSetCache()</abbr></a></td>
<td class="phpdocumentor-cell"><p>Since v4.5.6</p>
</td>
</tr>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/reports/markers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ <h3><abbr title="system/HTTP/DownloadResponse.php">DownloadResponse.php</abbr></
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">262</td>
<td class="phpdocumentor-cell">252</td>
<td class="phpdocumentor-cell">Do downloads need CSP or Cookies? Compare with ResponseTrait::send()</td>
</tr>
</tbody>
Expand Down

0 comments on commit 26fe9f6

Please sign in to comment.