Skip to content

Commit b02eeee

Browse files
committed
Updated API for commit e4bbe321b1dbbba2ebc3243ac79165214e8a62e7
1 parent 81c57a8 commit b02eeee

32 files changed

+229
-212
lines changed

docs/classes/CodeIgniter-DataCaster-DataCaster.html

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -272,14 +272,46 @@ <h2 class="phpdocumentor-content__title">
272272
<aside class="phpdocumentor-element-found-in">
273273
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
274274
:
275-
<span class="phpdocumentor-element-found-in__line">31</span>
275+
<span class="phpdocumentor-element-found-in__line">37</span>
276276

277277
</aside>
278278

279279

280280

281281

282282

283+
<h5 class="phpdocumentor-tag-list__heading" id="tags">
284+
Tags
285+
<a href="classes/CodeIgniter-DataCaster-DataCaster.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
286+
287+
</h5>
288+
<dl class="phpdocumentor-tag-list">
289+
<dt class="phpdocumentor-tag-list__entry">
290+
<span class="phpdocumentor-tag__name">phpstan-type</span>
291+
</dt>
292+
<dd class="phpdocumentor-tag-list__definition">
293+
294+
<section class="phpdocumentor-description"><p>cast_handlers array&lt;string, class-string&lt;EntityCastInterface|CastInterface&gt;&gt;</p>
295+
</section>
296+
297+
</dd>
298+
<dt class="phpdocumentor-tag-list__entry">
299+
<span class="phpdocumentor-tag__name">see</span>
300+
</dt>
301+
<dd class="phpdocumentor-tag-list__definition">
302+
<span class="phpdocumentor-tag-link"><abbr title="\CodeIgniter\DataCaster\CodeIgniter\DataCaster\DataCasterTest">DataCasterTest</abbr></span>
303+
304+
305+
</dd>
306+
<dt class="phpdocumentor-tag-list__entry">
307+
<span class="phpdocumentor-tag__name">see</span>
308+
</dt>
309+
<dd class="phpdocumentor-tag-list__definition">
310+
<span class="phpdocumentor-tag-link"><abbr title="\CodeIgniter\DataCaster\CodeIgniter\Entity\EntityTest">EntityTest</abbr></span>
311+
312+
313+
</dd>
314+
</dl>
283315

284316

285317

@@ -306,9 +338,9 @@ <h4 id="toc-properties">
306338
<dt class="phpdocumentor-table-of-contents__entry -property -private">
307339
<a class="" href="classes/CodeIgniter-DataCaster-DataCaster.html#property_castHandlers">$castHandlers</a>
308340
<span>
309-
&nbsp;: array&lt;string, class-string&gt; </span>
341+
&nbsp;: <abbr title="\CodeIgniter\DataCaster\cast_handlers">cast_handlers</abbr> </span>
310342
</dt>
311-
<dd>Convert handlers</dd>
343+
<dd>Convert handlers.</dd>
312344

313345
<dt class="phpdocumentor-table-of-contents__entry -property -private">
314346
<a class="" href="classes/CodeIgniter-DataCaster-DataCaster.html#property_helper">$helper</a>
@@ -380,16 +412,16 @@ <h4 class="phpdocumentor-element__name" id="property_castHandlers">
380412
<aside class="phpdocumentor-element-found-in">
381413
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
382414
:
383-
<span class="phpdocumentor-element-found-in__line">45</span>
415+
<span class="phpdocumentor-element-found-in__line">51</span>
384416

385417
</aside>
386418

387-
<p class="phpdocumentor-summary">Convert handlers</p>
419+
<p class="phpdocumentor-summary">Convert handlers.</p>
388420

389421

390422
<code class="phpdocumentor-code phpdocumentor-signature ">
391423
<span class="phpdocumentor-signature__visibility">private</span>
392-
<span class="phpdocumentor-signature__type">array&lt;string, class-string&gt;</span>
424+
<span class="phpdocumentor-signature__type"><abbr title="\CodeIgniter\DataCaster\cast_handlers">cast_handlers</abbr></span>
393425
<span class="phpdocumentor-signature__name">$castHandlers</span>
394426
= <span class="phpdocumentor-signature__default-value">[&#039;array&#039; =&gt; \CodeIgniter\DataCaster\Cast\ArrayCast::class, &#039;bool&#039; =&gt; \CodeIgniter\DataCaster\Cast\BooleanCast::class, &#039;boolean&#039; =&gt; \CodeIgniter\DataCaster\Cast\BooleanCast::class, &#039;csv&#039; =&gt; \CodeIgniter\DataCaster\Cast\CSVCast::class, &#039;datetime&#039; =&gt; \CodeIgniter\DataCaster\Cast\DatetimeCast::class, &#039;double&#039; =&gt; \CodeIgniter\DataCaster\Cast\FloatCast::class, &#039;float&#039; =&gt; \CodeIgniter\DataCaster\Cast\FloatCast::class, &#039;int&#039; =&gt; \CodeIgniter\DataCaster\Cast\IntegerCast::class, &#039;integer&#039; =&gt; \CodeIgniter\DataCaster\Cast\IntegerCast::class, &#039;int-bool&#039; =&gt; \CodeIgniter\DataCaster\Cast\IntBoolCast::class, &#039;json&#039; =&gt; \CodeIgniter\DataCaster\Cast\JsonCast::class, &#039;timestamp&#039; =&gt; \CodeIgniter\DataCaster\Cast\TimestampCast::class, &#039;uri&#039; =&gt; \CodeIgniter\DataCaster\Cast\URICast::class]</span></code>
395427

@@ -420,7 +452,7 @@ <h4 class="phpdocumentor-element__name" id="property_helper">
420452
<aside class="phpdocumentor-element-found-in">
421453
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
422454
:
423-
<span class="phpdocumentor-element-found-in__line">70</span>
455+
<span class="phpdocumentor-element-found-in__line">76</span>
424456

425457
</aside>
426458

@@ -457,7 +489,7 @@ <h4 class="phpdocumentor-element__name" id="property_strict">
457489
<aside class="phpdocumentor-element-found-in">
458490
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
459491
:
460-
<span class="phpdocumentor-element-found-in__line">71</span>
492+
<span class="phpdocumentor-element-found-in__line">77</span>
461493

462494
</aside>
463495

@@ -494,7 +526,7 @@ <h4 class="phpdocumentor-element__name" id="property_types">
494526
<aside class="phpdocumentor-element-found-in">
495527
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
496528
:
497-
<span class="phpdocumentor-element-found-in__line">38</span>
529+
<span class="phpdocumentor-element-found-in__line">44</span>
498530

499531
</aside>
500532

@@ -539,14 +571,14 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
539571
<aside class="phpdocumentor-element-found-in">
540572
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
541573
:
542-
<span class="phpdocumentor-element-found-in__line">67</span>
574+
<span class="phpdocumentor-element-found-in__line">73</span>
543575

544576
</aside>
545577

546578

547579
<code class="phpdocumentor-code phpdocumentor-signature ">
548580
<span class="phpdocumentor-signature__visibility">public</span>
549-
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__type">array&lt;string, class-string&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$castHandlers</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">array&lt;string, string&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$types</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">object|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$helper</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$strict</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
581+
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__type"><abbr title="\CodeIgniter\DataCaster\cast_handlers">cast_handlers</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$castHandlers</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">array&lt;string, string&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$types</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">object|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$helper</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$strict</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
550582

551583
<div class="phpdocumentor-label-line">
552584
</div>
@@ -556,7 +588,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
556588
<dl class="phpdocumentor-argument-list">
557589
<dt class="phpdocumentor-argument-list__entry">
558590
<span class="phpdocumentor-argument-list__argument__name">$castHandlers</span>
559-
: <span class="phpdocumentor-argument-list__argument__type">array&lt;string, class-string&gt;|null</span>
591+
: <span class="phpdocumentor-argument-list__argument__type"><abbr title="\CodeIgniter\DataCaster\cast_handlers">cast_handlers</abbr>|null</span>
560592
= <span class="phpdocumentor-argument-list__argument__default-value">null</span> </dt>
561593
<dd class="phpdocumentor-argument-list__definition">
562594
<section class="phpdocumentor-description"><p>Custom convert handlers</p>
@@ -586,7 +618,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
586618
: <span class="phpdocumentor-argument-list__argument__type">bool</span>
587619
= <span class="phpdocumentor-argument-list__argument__default-value">true</span> </dt>
588620
<dd class="phpdocumentor-argument-list__definition">
589-
<section class="phpdocumentor-description"><p>Strict mode? Set to false for casts for Entity.</p>
621+
<section class="phpdocumentor-description"><p>Strict mode? Set to <code class="prettyprint">false</code> for casts for Entity.</p>
590622
</section>
591623

592624
</dd>
@@ -612,15 +644,15 @@ <h4 class="phpdocumentor-element__name" id="method_castAs">
612644
<aside class="phpdocumentor-element-found-in">
613645
<abbr class="phpdocumentor-element-found-in__file" title="system/DataCaster/DataCaster.php"><a href="files/system-datacaster-datacaster.html"><abbr title="system/DataCaster/DataCaster.php">DataCaster.php</abbr></a></abbr>
614646
:
615-
<span class="phpdocumentor-element-found-in__line">120</span>
647+
<span class="phpdocumentor-element-found-in__line">126</span>
616648

617649
</aside>
618650

619651
<p class="phpdocumentor-summary">Provides the ability to cast an item as a specific data type.</p>
620652

621653
<code class="phpdocumentor-code phpdocumentor-signature ">
622654
<span class="phpdocumentor-signature__visibility">public</span>
623-
<span class="phpdocumentor-signature__name">castAs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">"get"|"set"&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'get'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
655+
<span class="phpdocumentor-signature__name">castAs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'get'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
624656

625657
<div class="phpdocumentor-label-line">
626658
</div>
@@ -651,7 +683,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
651683
</dd>
652684
<dt class="phpdocumentor-argument-list__entry">
653685
<span class="phpdocumentor-argument-list__argument__name">$method</span>
654-
: <span class="phpdocumentor-argument-list__argument__type">"get"|"set"</span>
686+
: <span class="phpdocumentor-argument-list__argument__type">string</span>
655687
= <span class="phpdocumentor-argument-list__argument__default-value">'get'</span> </dt>
656688
<dd class="phpdocumentor-argument-list__definition">
657689
<section class="phpdocumentor-description"><p>Allowed to &quot;get&quot; and &quot;set&quot;</p>

docs/classes/CodeIgniter-Entity-Cast-ArrayCast.html

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -274,12 +274,11 @@ <h2 class="phpdocumentor-content__title">
274274
<aside class="phpdocumentor-element-found-in">
275275
<abbr class="phpdocumentor-element-found-in__file" title="system/Entity/Cast/ArrayCast.php"><a href="files/system-entity-cast-arraycast.html"><abbr title="system/Entity/Cast/ArrayCast.php">ArrayCast.php</abbr></a></abbr>
276276
:
277-
<span class="phpdocumentor-element-found-in__line">19</span>
277+
<span class="phpdocumentor-element-found-in__line">16</span>
278278

279279
</aside>
280280

281-
<p class="phpdocumentor-summary">Class ArrayCast</p>
282-
281+
283282

284283

285284

@@ -312,14 +311,14 @@ <h4 id="toc-methods">
312311
<span>
313312
&nbsp;: array&lt;string|int, mixed&gt;|bool|float|int|object|string|null </span>
314313
</dt>
315-
<dd>Get</dd>
314+
<dd>Takes a raw value from Entity, returns its value for PHP.</dd>
316315

317316
<dt class="phpdocumentor-table-of-contents__entry -method -public">
318317
<a class="" href="classes/CodeIgniter-Entity-Cast-ArrayCast.html#method_set">set()</a>
319318
<span>
320319
&nbsp;: array&lt;string|int, mixed&gt;|bool|float|int|object|string|null </span>
321320
</dt>
322-
<dd>Set</dd>
321+
<dd>Takes a PHP value, returns its raw value for Entity.</dd>
323322

324323
</dl>
325324

@@ -349,11 +348,11 @@ <h4 class="phpdocumentor-element__name" id="method_get">
349348
<aside class="phpdocumentor-element-found-in">
350349
<abbr class="phpdocumentor-element-found-in__file" title="system/Entity/Cast/ArrayCast.php"><a href="files/system-entity-cast-arraycast.html"><abbr title="system/Entity/Cast/ArrayCast.php">ArrayCast.php</abbr></a></abbr>
351350
:
352-
<span class="phpdocumentor-element-found-in__line">24</span>
351+
<span class="phpdocumentor-element-found-in__line">18</span>
353352

354353
</aside>
355354

356-
<p class="phpdocumentor-summary">Get</p>
355+
<p class="phpdocumentor-summary">Takes a raw value from Entity, returns its value for PHP.</p>
357356

358357
<code class="phpdocumentor-code phpdocumentor-signature ">
359358
<span class="phpdocumentor-signature__visibility">public</span>
@@ -409,11 +408,11 @@ <h4 class="phpdocumentor-element__name" id="method_set">
409408
<aside class="phpdocumentor-element-found-in">
410409
<abbr class="phpdocumentor-element-found-in__file" title="system/Entity/Cast/ArrayCast.php"><a href="files/system-entity-cast-arraycast.html"><abbr title="system/Entity/Cast/ArrayCast.php">ArrayCast.php</abbr></a></abbr>
411410
:
412-
<span class="phpdocumentor-element-found-in__line">36</span>
411+
<span class="phpdocumentor-element-found-in__line">27</span>
413412

414413
</aside>
415414

416-
<p class="phpdocumentor-summary">Set</p>
415+
<p class="phpdocumentor-summary">Takes a PHP value, returns its raw value for Entity.</p>
417416

418417
<code class="phpdocumentor-code phpdocumentor-signature ">
419418
<span class="phpdocumentor-signature__visibility">public</span>

0 commit comments

Comments
 (0)