Update User Guide

This commit is contained in:
MGatner 2021-05-01 17:21:39 +00:00
parent 0063eaecd5
commit 3c3ada31ca
3 changed files with 6 additions and 4 deletions

View File

@ -373,6 +373,7 @@
<li><p><code class="docutils literal notranslate"><span class="pre">Entity::mutateDate</span></code> uses external cast handler <code class="docutils literal notranslate"><span class="pre">DatetimeCast::get</span></code>.</p></li>
<li><p>In order for <code class="docutils literal notranslate"><span class="pre">Config\**</span></code> classes to get their respective properties values from the <code class="docutils literal notranslate"><span class="pre">.env</span></code>, it is now necessary to namespace the property with the name of the class. Previously, the property names are enough but now disallowed because it can get system environment variables, like <code class="docutils literal notranslate"><span class="pre">PATH</span></code>.</p></li>
<li><p>The array helper <code class="docutils literal notranslate"><span class="pre">_array_search_dot</span></code> is now marked for <code class="docutils literal notranslate"><span class="pre">&#64;internal</span></code> use. As this is used by <code class="docutils literal notranslate"><span class="pre">dot_array_search</span></code>, users should not use <code class="docutils literal notranslate"><span class="pre">_array_search_dot</span></code> directly in their code.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">CacheInterface::getMetaData()</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code> for misses, or an array with at least the “expires” key set to the absolute epoch expiration, or <code class="docutils literal notranslate"><span class="pre">null</span></code> for “never expires”. The File, Memcached, and Wincache Handlers still return <code class="docutils literal notranslate"><span class="pre">false</span></code> which will become <code class="docutils literal notranslate"><span class="pre">null</span></code> in a future release.</p></li>
</ul>
<p>Deprecations:</p>
<ul class="simple">

View File

@ -672,10 +672,10 @@ on which adapter is being used.</p>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Metadata for the cached item</p>
<dd class="field-even"><p>Metadata for the cached item. <code class="docutils literal notranslate"><span class="pre">null</span></code> for missing items, or an array with at least the “expire” key for absolute epoch expiry (<code class="docutils literal notranslate"><span class="pre">null</span></code> for never expires).</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>mixed</p>
<dd class="field-odd"><p>array|null</p>
</dd>
</dl>
<p>This method will return detailed information on a specific item in the
@ -689,7 +689,8 @@ cache.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The information returned and the structure of the data is dependent
on which adapter is being used.</p>
on which adapter is being used. Some adapters (File, Memcached, Wincache)
still return <code class="docutils literal notranslate"><span class="pre">false</span></code> for missing items.</p>
</div>
</div>
<div class="section" id="drivers">

File diff suppressed because one or more lines are too long