Skip to content

Commit aa5e9a5

Browse files
committed
Updated API for commit 2ec5effab749fa27abe87dfa3728e0e92a730a4f
1 parent 75633b9 commit aa5e9a5

6 files changed

+119
-12
lines changed

docs/classes/CodeIgniter-Debug-Toolbar-Collectors-Routes.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ <h4 id="toc-methods">
366366
<dt class="phpdocumentor-table-of-contents__entry -method -public">
367367
<a class="" href="classes/CodeIgniter-Debug-Toolbar-Collectors-Routes.html#method_display">display()</a>
368368
<span>
369-
&nbsp;: array{matchedRoute: array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}[], routes: list<array{method: string, route: string, handler: string}>} </span>
369+
&nbsp;: array{matchedRoute: list<array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}>, routes: list<array{method: string, route: string, handler: string}>} </span>
370370
</dt>
371371
<dd>Returns the data of this collector to be formatted in the toolbar</dd>
372372

@@ -764,7 +764,7 @@ <h4 class="phpdocumentor-element__name" id="method_display">
764764

765765
<code class="phpdocumentor-code phpdocumentor-signature ">
766766
<span class="phpdocumentor-signature__visibility">public</span>
767-
<span class="phpdocumentor-signature__name">display</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array{matchedRoute: array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}[], routes: list<array{method: string, route: string, handler: string}>}</span></code>
767+
<span class="phpdocumentor-signature__name">display</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array{matchedRoute: list<array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}>, routes: list<array{method: string, route: string, handler: string}>}</span></code>
768768

769769
<div class="phpdocumentor-label-line">
770770
</div>
@@ -792,7 +792,7 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
792792

793793
<section>
794794
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
795-
<span class="phpdocumentor-signature__response_type">array{matchedRoute: array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}[], routes: list<array{method: string, route: string, handler: string}>}</span>
795+
<span class="phpdocumentor-signature__response_type">array{matchedRoute: list<array{directory: string, controller: string, method: string, paramCount: int, truePCount: int, params: list<array{name: string, value: mixed}>}>, routes: list<array{method: string, route: string, handler: string}>}</span>
796796
</section>
797797

798798
</article>

docs/classes/CodeIgniter-Email-Email.html

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ <h4 id="toc-properties">
626626
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
627627
<a class="" href="classes/CodeIgniter-Email-Email.html#property_SMTPConnect">$SMTPConnect</a>
628628
<span>
629-
&nbsp;: resource|null </span>
629+
&nbsp;: false|resource|null </span>
630630
</dt>
631631
<dd>SMTP Connection socket placeholder</dd>
632632

@@ -909,6 +909,13 @@ <h4 id="toc-methods">
909909
&nbsp;: string </span>
910910
</dt>
911911

912+
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
913+
<a class="" href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected">isSMTPConnected()</a>
914+
<span>
915+
&nbsp;: bool </span>
916+
</dt>
917+
<dd>Checks if there is an active SMTP connection.</dd>
918+
912919
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
913920
<a class="" href="classes/CodeIgniter-Email-Email.html#method_mimeTypes">mimeTypes()</a>
914921
<span>
@@ -2907,7 +2914,7 @@ <h4 class="phpdocumentor-element__name" id="property_SMTPConnect">
29072914

29082915
<code class="phpdocumentor-code phpdocumentor-signature ">
29092916
<span class="phpdocumentor-signature__visibility">protected</span>
2910-
<span class="phpdocumentor-signature__type">resource|null</span>
2917+
<span class="phpdocumentor-signature__type">false|resource|null</span>
29112918
<span class="phpdocumentor-signature__name">$SMTPConnect</span>
29122919
</code>
29132920

@@ -4954,6 +4961,49 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
49544961
<span class="phpdocumentor-signature__response_type">string</span>
49554962
</section>
49564963

4964+
</article>
4965+
<article
4966+
class="phpdocumentor-element
4967+
-method
4968+
-protected
4969+
"
4970+
>
4971+
<h4 class="phpdocumentor-element__name" id="method_isSMTPConnected">
4972+
isSMTPConnected()
4973+
<a href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected" class="headerlink"><i class="fas fa-link"></i></a>
4974+
4975+
</h4>
4976+
<aside class="phpdocumentor-element-found-in">
4977+
<abbr class="phpdocumentor-element-found-in__file" title="system/Email/Email.php"><a href="files/system-email-email.html"><abbr title="system/Email/Email.php">Email.php</abbr></a></abbr>
4978+
:
4979+
<span class="phpdocumentor-element-found-in__line">2293</span>
4980+
4981+
</aside>
4982+
4983+
<p class="phpdocumentor-summary">Checks if there is an active SMTP connection.</p>
4984+
4985+
<code class="phpdocumentor-code phpdocumentor-signature ">
4986+
<span class="phpdocumentor-signature__visibility">protected</span>
4987+
<span class="phpdocumentor-signature__name">isSMTPConnected</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
4988+
4989+
<div class="phpdocumentor-label-line">
4990+
</div>
4991+
4992+
4993+
4994+
4995+
4996+
4997+
4998+
<section>
4999+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
5000+
<span class="phpdocumentor-signature__response_type">bool</span>
5001+
&mdash;
5002+
<section class="phpdocumentor-description"><p>True if SMTP connection is established and open, false otherwise</p>
5003+
</section>
5004+
5005+
</section>
5006+
49575007
</article>
49585008
<article
49595009
class="phpdocumentor-element
@@ -6229,6 +6279,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
62296279
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getMimeMessage">getMimeMessage()</a></li>
62306280
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getProtocol">getProtocol()</a></li>
62316281
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getSMTPData">getSMTPData()</a></li>
6282+
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected">isSMTPConnected()</a></li>
62326283
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_mimeTypes">mimeTypes()</a></li>
62336284
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_prepQEncoding">prepQEncoding()</a></li>
62346285
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_prepQuotedPrintable">prepQuotedPrintable()</a></li>

docs/classes/CodeIgniter-Router-RouteCollection.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -907,7 +907,7 @@ <h4 id="toc-methods">
907907
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
908908
<a class="" href="classes/CodeIgniter-Router-RouteCollection.html#method_loadRoutesOptions">loadRoutesOptions()</a>
909909
<span>
910-
&nbsp;: array&lt;string, array{filter?: string|list<string>, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt; </span>
910+
&nbsp;: array&lt;string, array{filter?: list<string>|string, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt; </span>
911911
</dt>
912912
<dd>Load routes options based on verb</dd>
913913

@@ -4898,7 +4898,7 @@ <h4 class="phpdocumentor-element__name" id="method_loadRoutesOptions">
48984898

48994899
<code class="phpdocumentor-code phpdocumentor-signature ">
49004900
<span class="phpdocumentor-signature__visibility">protected</span>
4901-
<span class="phpdocumentor-signature__name">loadRoutesOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$verb</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">array&lt;string, array{filter?: string|list<string>, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt;</span></code>
4901+
<span class="phpdocumentor-signature__name">loadRoutesOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$verb</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">array&lt;string, array{filter?: list<string>|string, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt;</span></code>
49024902

49034903
<div class="phpdocumentor-label-line">
49044904
</div>
@@ -4921,7 +4921,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
49214921

49224922
<section>
49234923
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
4924-
<span class="phpdocumentor-signature__response_type">array&lt;string, array{filter?: string|list<string>, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt;</span>
4924+
<span class="phpdocumentor-signature__response_type">array&lt;string, array{filter?: list<string>|string, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int}&gt;</span>
49254925
</section>
49264926

49274927
</article>

docs/classes/CodeIgniter-Test-Mock-MockConnection.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ <h4 id="toc-properties">
572572
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
573573
<a class="" href="classes/CodeIgniter-Test-Mock-MockConnection.html#property_returnValues">$returnValues</a>
574574
<span>
575-
&nbsp;: array{connect?: object|resource|false|list<object|resource|false>, execute?: object|resource|false} </span>
575+
&nbsp;: array{connect?: false|list<false|object|resource>|object|resource, execute?: false|object|resource} </span>
576576
</dt>
577577

578578
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
@@ -2671,7 +2671,7 @@ <h4 class="phpdocumentor-element__name" id="property_returnValues">
26712671

26722672
<code class="phpdocumentor-code phpdocumentor-signature ">
26732673
<span class="phpdocumentor-signature__visibility">protected</span>
2674-
<span class="phpdocumentor-signature__type">array{connect?: object|resource|false|list<object|resource|false>, execute?: object|resource|false}</span>
2674+
<span class="phpdocumentor-signature__type">array{connect?: false|list<false|object|resource>|object|resource, execute?: false|object|resource}</span>
26752675
<span class="phpdocumentor-signature__name">$returnValues</span>
26762676
= <span class="phpdocumentor-signature__default-value">[]</span></code>
26772677

docs/classes/CodeIgniter-Test-Mock-MockEmail.html

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@ <h4 id="toc-properties">
622622
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
623623
<a class="" href="classes/CodeIgniter-Email-Email.html#property_SMTPConnect">$SMTPConnect</a>
624624
<span>
625-
&nbsp;: resource|null </span>
625+
&nbsp;: false|resource|null </span>
626626
</dt>
627627
<dd>SMTP Connection socket placeholder</dd>
628628

@@ -898,6 +898,13 @@ <h4 id="toc-methods">
898898
&nbsp;: string </span>
899899
</dt>
900900

901+
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
902+
<a class="" href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected">isSMTPConnected()</a>
903+
<span>
904+
&nbsp;: bool </span>
905+
</dt>
906+
<dd>Checks if there is an active SMTP connection.</dd>
907+
901908
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
902909
<a class="" href="classes/CodeIgniter-Email-Email.html#method_mimeTypes">mimeTypes()</a>
903910
<span>
@@ -2928,7 +2935,7 @@ <h4 class="phpdocumentor-element__name" id="property_SMTPConnect">
29282935

29292936
<code class="phpdocumentor-code phpdocumentor-signature ">
29302937
<span class="phpdocumentor-signature__visibility">protected</span>
2931-
<span class="phpdocumentor-signature__type">resource|null</span>
2938+
<span class="phpdocumentor-signature__type">false|resource|null</span>
29322939
<span class="phpdocumentor-signature__name">$SMTPConnect</span>
29332940
</code>
29342941

@@ -4936,6 +4943,49 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
49364943
<span class="phpdocumentor-signature__response_type">string</span>
49374944
</section>
49384945

4946+
</article>
4947+
<article
4948+
class="phpdocumentor-element
4949+
-method
4950+
-protected
4951+
"
4952+
>
4953+
<h4 class="phpdocumentor-element__name" id="method_isSMTPConnected">
4954+
isSMTPConnected()
4955+
<a href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected" class="headerlink"><i class="fas fa-link"></i></a>
4956+
4957+
</h4>
4958+
<aside class="phpdocumentor-element-found-in">
4959+
<abbr class="phpdocumentor-element-found-in__file" title="system/Email/Email.php"><a href="files/system-email-email.html"><abbr title="system/Email/Email.php">Email.php</abbr></a></abbr>
4960+
:
4961+
<span class="phpdocumentor-element-found-in__line">2293</span>
4962+
4963+
</aside>
4964+
4965+
<p class="phpdocumentor-summary">Checks if there is an active SMTP connection.</p>
4966+
4967+
<code class="phpdocumentor-code phpdocumentor-signature ">
4968+
<span class="phpdocumentor-signature__visibility">protected</span>
4969+
<span class="phpdocumentor-signature__name">isSMTPConnected</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
4970+
4971+
<div class="phpdocumentor-label-line">
4972+
</div>
4973+
4974+
4975+
4976+
4977+
4978+
4979+
4980+
<section>
4981+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
4982+
<span class="phpdocumentor-signature__response_type">bool</span>
4983+
&mdash;
4984+
<section class="phpdocumentor-description"><p>True if SMTP connection is established and open, false otherwise</p>
4985+
</section>
4986+
4987+
</section>
4988+
49394989
</article>
49404990
<article
49414991
class="phpdocumentor-element
@@ -6172,6 +6222,7 @@ <h4 class="phpdocumentor-element__name" id="method_writeHeaders">
61726222
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getMimeMessage">getMimeMessage()</a></li>
61736223
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getProtocol">getProtocol()</a></li>
61746224
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_getSMTPData">getSMTPData()</a></li>
6225+
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_isSMTPConnected">isSMTPConnected()</a></li>
61756226
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_mimeTypes">mimeTypes()</a></li>
61766227
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_prepQEncoding">prepQEncoding()</a></li>
61776228
<li class=""><a href="classes/CodeIgniter-Email-Email.html#method_prepQuotedPrintable">prepQuotedPrintable()</a></li>

docs/js/searchIndex.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12835,6 +12835,11 @@ Search.appendIndex(
1283512835
"name": "setArchiveValues",
1283612836
"summary": "Determines\u0020the\u0020values\u0020that\u0020should\u0020be\u0020stored\u0020in\u0020\u0024archive.",
1283712837
"url": "classes/CodeIgniter-Email-Email.html#method_setArchiveValues"
12838+
}, {
12839+
"fqsen": "\\CodeIgniter\\Email\\Email\u003A\u003AisSMTPConnected\u0028\u0029",
12840+
"name": "isSMTPConnected",
12841+
"summary": "Checks\u0020if\u0020there\u0020is\u0020an\u0020active\u0020SMTP\u0020connection.",
12842+
"url": "classes/CodeIgniter-Email-Email.html#method_isSMTPConnected"
1283812843
}, {
1283912844
"fqsen": "\\CodeIgniter\\Email\\Email\u003A\u003A\u0024archive",
1284012845
"name": "archive",

0 commit comments

Comments
 (0)