Skip to content

Commit dbaf6be

Browse files
actions-useractions-user
committed
Updated API for commit c2f9731f8a7ca87dbc99bbf8d2efa6f6955151af
1 parent da14c15 commit dbaf6be

File tree

5 files changed

+80
-74
lines changed

5 files changed

+80
-74
lines changed

‎docs/classes/CodeIgniter-Autoloader-Autoloader.html‎

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -351,28 +351,28 @@ <h4 id="toc-properties">
351351
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
352352
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#property_classmap">$classmap</a>
353353
<span>
354-
&nbsp;: array&lt;class-string, string&gt; </span>
354+
&nbsp;: array&lt;class-string, non-empty-string&gt; </span>
355355
</dt>
356356
<dd>Stores class name as key, and path as values.</dd>
357357

358358
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
359359
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#property_files">$files</a>
360360
<span>
361-
&nbsp;: array&lt;int, string&gt; </span>
361+
&nbsp;: array&lt;int, non-empty-string&gt; </span>
362362
</dt>
363363
<dd>Stores files as a list.</dd>
364364

365365
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
366366
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#property_helpers">$helpers</a>
367367
<span>
368-
&nbsp;: array&lt;int, string&gt; </span>
368+
&nbsp;: array&lt;int, non-empty-string&gt; </span>
369369
</dt>
370370
<dd>Stores helper list.</dd>
371371

372372
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
373373
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#property_prefixes">$prefixes</a>
374374
<span>
375-
&nbsp;: array&lt;string, array&lt;int, string&gt;&gt; </span>
375+
&nbsp;: array&lt;non-empty-string, array&lt;int, non-empty-string&gt;&gt; </span>
376376
</dt>
377377
<dd>Stores namespaces as key, and path as values.</dd>
378378

@@ -425,7 +425,8 @@ <h4 id="toc-methods">
425425
<span>
426426
&nbsp;: void </span>
427427
</dt>
428-
<dd>Register the loader with the SPL autoloader stack.</dd>
428+
<dd>Register the loader with the SPL autoloader stack
429+
in the following order:</dd>
429430

430431
<dt class="phpdocumentor-table-of-contents__entry -method -public">
431432
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#method_removeNamespace">removeNamespace()</a>
@@ -446,7 +447,7 @@ <h4 id="toc-methods">
446447
<span>
447448
&nbsp;: void </span>
448449
</dt>
449-
<dd>Unregister autoloader.</dd>
450+
<dd>Unregisters the autoloader from the SPL autoload stack.</dd>
450451

451452
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
452453
<a class="-deprecated" href="classes/CodeIgniter-Autoloader-Autoloader.html#method_discoverComposerNamespaces">discoverComposerNamespaces()</a>
@@ -458,14 +459,14 @@ <h4 id="toc-methods">
458459
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
459460
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#method_includeFile">includeFile()</a>
460461
<span>
461-
&nbsp;: false|string </span>
462+
&nbsp;: false|non-empty-string </span>
462463
</dt>
463464
<dd>A central way to include a file. Split out primarily for testing purposes.</dd>
464465

465466
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
466467
<a class="" href="classes/CodeIgniter-Autoloader-Autoloader.html#method_loadInNamespace">loadInNamespace()</a>
467468
<span>
468-
&nbsp;: false|string </span>
469+
&nbsp;: false|non-empty-string </span>
469470
</dt>
470471
<dd>Loads the class file for a given class name.</dd>
471472

@@ -532,7 +533,7 @@ <h4 class="phpdocumentor-element__name" id="property_classmap">
532533

533534
<code class="phpdocumentor-code phpdocumentor-signature ">
534535
<span class="phpdocumentor-signature__visibility">protected</span>
535-
<span class="phpdocumentor-signature__type">array&lt;class-string, string&gt;</span>
536+
<span class="phpdocumentor-signature__type">array&lt;class-string, non-empty-string&gt;</span>
536537
<span class="phpdocumentor-signature__name">$classmap</span>
537538
= <span class="phpdocumentor-signature__default-value">[]</span></code>
538539

@@ -569,7 +570,7 @@ <h4 class="phpdocumentor-element__name" id="property_files">
569570

570571
<code class="phpdocumentor-code phpdocumentor-signature ">
571572
<span class="phpdocumentor-signature__visibility">protected</span>
572-
<span class="phpdocumentor-signature__type">array&lt;int, string&gt;</span>
573+
<span class="phpdocumentor-signature__type">array&lt;int, non-empty-string&gt;</span>
573574
<span class="phpdocumentor-signature__name">$files</span>
574575
= <span class="phpdocumentor-signature__default-value">[]</span></code>
575576

@@ -606,7 +607,7 @@ <h4 class="phpdocumentor-element__name" id="property_helpers">
606607

607608
<code class="phpdocumentor-code phpdocumentor-signature ">
608609
<span class="phpdocumentor-signature__visibility">protected</span>
609-
<span class="phpdocumentor-signature__type">array&lt;int, string&gt;</span>
610+
<span class="phpdocumentor-signature__type">array&lt;int, non-empty-string&gt;</span>
610611
<span class="phpdocumentor-signature__name">$helpers</span>
611612
= <span class="phpdocumentor-signature__default-value">[&#039;url&#039;]</span></code>
612613

@@ -645,7 +646,7 @@ <h4 class="phpdocumentor-element__name" id="property_prefixes">
645646

646647
<code class="phpdocumentor-code phpdocumentor-signature ">
647648
<span class="phpdocumentor-signature__visibility">protected</span>
648-
<span class="phpdocumentor-signature__type">array&lt;string, array&lt;int, string&gt;&gt;</span>
649+
<span class="phpdocumentor-signature__type">array&lt;non-empty-string, array&lt;int, non-empty-string&gt;&gt;</span>
649650
<span class="phpdocumentor-signature__name">$prefixes</span>
650651
= <span class="phpdocumentor-signature__default-value">[]</span></code>
651652

@@ -678,15 +679,15 @@ <h4 class="phpdocumentor-element__name" id="method_addNamespace">
678679
<aside class="phpdocumentor-element-found-in">
679680
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
680681
:
681-
<span class="phpdocumentor-element-found-in__line">194</span>
682+
<span class="phpdocumentor-element-found-in__line">193</span>
682683

683684
</aside>
684685

685686
<p class="phpdocumentor-summary">Registers namespaces with the autoloader.</p>
686687

687688
<code class="phpdocumentor-code phpdocumentor-signature ">
688689
<span class="phpdocumentor-signature__visibility">public</span>
689-
<span class="phpdocumentor-signature__name">addNamespace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string, array&lt;int, string&gt;|string&gt;|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$namespace</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
690+
<span class="phpdocumentor-signature__name">addNamespace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;non-empty-string, array&lt;int, non-empty-string&gt;|non-empty-string&gt;|non-empty-string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$namespace</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
690691

691692
<div class="phpdocumentor-label-line">
692693
</div>
@@ -696,7 +697,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
696697
<dl class="phpdocumentor-argument-list">
697698
<dt class="phpdocumentor-argument-list__entry">
698699
<span class="phpdocumentor-signature__argument__name">$namespace</span>
699-
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string, array&lt;int, string&gt;|string&gt;|string</span>
700+
: <span class="phpdocumentor-signature__argument__return-type">array&lt;non-empty-string, array&lt;int, non-empty-string&gt;|non-empty-string&gt;|non-empty-string</span>
700701
</dt>
701702
<dd class="phpdocumentor-argument-list__definition">
702703

@@ -734,7 +735,7 @@ <h4 class="phpdocumentor-element__name" id="method_getNamespace">
734735
<aside class="phpdocumentor-element-found-in">
735736
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
736737
:
737-
<span class="phpdocumentor-element-found-in__line">224</span>
738+
<span class="phpdocumentor-element-found-in__line">223</span>
738739

739740
</aside>
740741

@@ -918,11 +919,12 @@ <h4 class="phpdocumentor-element__name" id="method_register">
918919
<aside class="phpdocumentor-element-found-in">
919920
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
920921
:
921-
<span class="phpdocumentor-element-found-in__line">162</span>
922+
<span class="phpdocumentor-element-found-in__line">167</span>
922923

923924
</aside>
924925

925-
<p class="phpdocumentor-summary">Register the loader with the SPL autoloader stack.</p>
926+
<p class="phpdocumentor-summary">Register the loader with the SPL autoloader stack
927+
in the following order:</p>
926928

927929
<code class="phpdocumentor-code phpdocumentor-signature ">
928930
<span class="phpdocumentor-signature__visibility">public</span>
@@ -931,7 +933,13 @@ <h4 class="phpdocumentor-element__name" id="method_register">
931933
<div class="phpdocumentor-label-line">
932934
</div>
933935

934-
936+
<section class="phpdocumentor-description"><ol>
937+
<li>Classmap loader</li>
938+
<li>PSR-4 autoloader</li>
939+
<li>Non-class files</li>
940+
</ol>
941+
</section>
942+
935943

936944

937945

@@ -953,7 +961,7 @@ <h4 class="phpdocumentor-element__name" id="method_removeNamespace">
953961
<aside class="phpdocumentor-element-found-in">
954962
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
955963
:
956-
<span class="phpdocumentor-element-found-in__line">238</span>
964+
<span class="phpdocumentor-element-found-in__line">237</span>
957965

958966
</aside>
959967

@@ -1068,11 +1076,11 @@ <h4 class="phpdocumentor-element__name" id="method_unregister">
10681076
<aside class="phpdocumentor-element-found-in">
10691077
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
10701078
:
1071-
<span class="phpdocumentor-element-found-in__line">181</span>
1079+
<span class="phpdocumentor-element-found-in__line">180</span>
10721080

10731081
</aside>
10741082

1075-
<p class="phpdocumentor-summary">Unregister autoloader.</p>
1083+
<p class="phpdocumentor-summary">Unregisters the autoloader from the SPL autoload stack.</p>
10761084

10771085
<code class="phpdocumentor-code phpdocumentor-signature ">
10781086
<span class="phpdocumentor-signature__visibility">public</span>
@@ -1081,9 +1089,7 @@ <h4 class="phpdocumentor-element__name" id="method_unregister">
10811089
<div class="phpdocumentor-label-line">
10821090
</div>
10831091

1084-
<section class="phpdocumentor-description"><p>This method is for testing.</p>
1085-
</section>
1086-
1092+
10871093

10881094

10891095

@@ -1155,7 +1161,7 @@ <h4 class="phpdocumentor-element__name" id="method_includeFile">
11551161

11561162
<code class="phpdocumentor-code phpdocumentor-signature ">
11571163
<span class="phpdocumentor-signature__visibility">protected</span>
1158-
<span class="phpdocumentor-signature__name">includeFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">false|string</span></code>
1164+
<span class="phpdocumentor-signature__name">includeFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">false|non-empty-string</span></code>
11591165

11601166
<div class="phpdocumentor-label-line">
11611167
</div>
@@ -1178,7 +1184,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
11781184

11791185
<section>
11801186
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
1181-
<span class="phpdocumentor-signature__response_type">false|string</span>
1187+
<span class="phpdocumentor-signature__response_type">false|non-empty-string</span>
11821188
&mdash;
11831189
<section class="phpdocumentor-description"><p>The filename on success, false if the file is not loaded</p>
11841190
</section>
@@ -1200,15 +1206,15 @@ <h4 class="phpdocumentor-element__name" id="method_loadInNamespace">
12001206
<aside class="phpdocumentor-element-found-in">
12011207
<abbr class="phpdocumentor-element-found-in__file" title="system/Autoloader/Autoloader.php"><a href="files/system-autoloader-autoloader.html"><abbr title="system/Autoloader/Autoloader.php">Autoloader.php</abbr></a></abbr>
12021208
:
1203-
<span class="phpdocumentor-element-found-in__line">280</span>
1209+
<span class="phpdocumentor-element-found-in__line">281</span>
12041210

12051211
</aside>
12061212

12071213
<p class="phpdocumentor-summary">Loads the class file for a given class name.</p>
12081214

12091215
<code class="phpdocumentor-code phpdocumentor-signature ">
12101216
<span class="phpdocumentor-signature__visibility">protected</span>
1211-
<span class="phpdocumentor-signature__name">loadInNamespace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">false|string</span></code>
1217+
<span class="phpdocumentor-signature__name">loadInNamespace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">class-string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">false|non-empty-string</span></code>
12121218

12131219
<div class="phpdocumentor-label-line">
12141220
</div>
@@ -1218,10 +1224,10 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
12181224
<dl class="phpdocumentor-argument-list">
12191225
<dt class="phpdocumentor-argument-list__entry">
12201226
<span class="phpdocumentor-signature__argument__name">$class</span>
1221-
: <span class="phpdocumentor-signature__argument__return-type">string</span>
1227+
: <span class="phpdocumentor-signature__argument__return-type">class-string</span>
12221228
</dt>
12231229
<dd class="phpdocumentor-argument-list__definition">
1224-
<section class="phpdocumentor-description"><p>The fully-qualified class name</p>
1230+
<section class="phpdocumentor-description"><p>The fully qualified class name.</p>
12251231
</section>
12261232

12271233
</dd>
@@ -1233,7 +1239,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
12331239

12341240
<section>
12351241
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
1236-
<span class="phpdocumentor-signature__response_type">false|string</span>
1242+
<span class="phpdocumentor-signature__response_type">false|non-empty-string</span>
12371243
&mdash;
12381244
<section class="phpdocumentor-description"><p>The mapped file name on success, or boolean false on fail</p>
12391245
</section>

0 commit comments

Comments
 (0)