Skip to content

Commit 4774ae8

Browse files
committed
Updated API for commit 4c74f2d846978fc6e8fddac3f1d8276507aea4a5
1 parent c7db453 commit 4774ae8

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

docs/classes/CodeIgniter-Commands-Encryption-GenerateKey.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,10 @@ <h4 id="toc-methods">
441441
<span>
442442
&nbsp;: string </span>
443443
</dt>
444-
<dd>Get the regex of the current encryption key.</dd>
444+
<dd>Returns the regex used to locate an active `encryption.key = ...` setting in the `.env`
445+
contents. The single capture group spans everything up to (and including) the `=` and any
446+
separating whitespace, so a `preg_replace` substitution preserves an optional `export`
447+
prefix while rewriting only the value.</dd>
445448

446449
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
447450
<a class="" href="classes/CodeIgniter-Commands-Encryption-GenerateKey.html#method_setNewEncryptionKey">setNewEncryptionKey()</a>
@@ -1358,11 +1361,14 @@ <h4 class="phpdocumentor-element__name" id="method_keyPattern">
13581361
<aside class="phpdocumentor-element-found-in">
13591362
<abbr class="phpdocumentor-element-found-in__file" title="system/Commands/Encryption/GenerateKey.php"><a href="files/system-commands-encryption-generatekey.html"><abbr title="system/Commands/Encryption/GenerateKey.php">GenerateKey.php</abbr></a></abbr>
13601363
:
1361-
<span class="phpdocumentor-element-found-in__line">196</span>
1364+
<span class="phpdocumentor-element-found-in__line">207</span>
13621365

13631366
</aside>
13641367

1365-
<p class="phpdocumentor-summary">Get the regex of the current encryption key.</p>
1368+
<p class="phpdocumentor-summary">Returns the regex used to locate an active `encryption.key = ...` setting in the `.env`
1369+
contents. The single capture group spans everything up to (and including) the `=` and any
1370+
separating whitespace, so a `preg_replace` substitution preserves an optional `export`
1371+
prefix while rewriting only the value.</p>
13661372

13671373
<code class="phpdocumentor-code phpdocumentor-signature ">
13681374
<span class="phpdocumentor-signature__visibility">protected</span>
@@ -1371,7 +1377,10 @@ <h4 class="phpdocumentor-element__name" id="method_keyPattern">
13711377
<div class="phpdocumentor-label-line">
13721378
</div>
13731379

1374-
1380+
<section class="phpdocumentor-description"><p>The <code class="prettyprint">$oldKey</code> parameter is retained for backward compatibility with subclasses that
1381+
override this method; it is no longer consulted because the pattern matches any value.</p>
1382+
</section>
1383+
13751384
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
13761385
<dl class="phpdocumentor-argument-list">
13771386
<dt class="phpdocumentor-argument-list__entry">

docs/js/searchIndex.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3428,7 +3428,7 @@ Search.appendIndex(
34283428
}, {
34293429
"fqsen": "\\CodeIgniter\\Commands\\Encryption\\GenerateKey\u003A\u003AkeyPattern\u0028\u0029",
34303430
"name": "keyPattern",
3431-
"summary": "Get\u0020the\u0020regex\u0020of\u0020the\u0020current\u0020encryption\u0020key.",
3431+
"summary": "Returns\u0020the\u0020regex\u0020used\u0020to\u0020locate\u0020an\u0020active\u0020\u0060encryption.key\u0020\u003D\u0020...\u0060\u0020setting\u0020in\u0020the\u0020\u0060.env\u0060\ncontents.\u0020The\u0020single\u0020capture\u0020group\u0020spans\u0020everything\u0020up\u0020to\u0020\u0028and\u0020including\u0029\u0020the\u0020\u0060\u003D\u0060\u0020and\u0020any\nseparating\u0020whitespace,\u0020so\u0020a\u0020\u0060preg_replace\u0060\u0020substitution\u0020preserves\u0020an\u0020optional\u0020\u0060export\u0060\nprefix\u0020while\u0020rewriting\u0020only\u0020the\u0020value.",
34323432
"url": "classes/CodeIgniter-Commands-Encryption-GenerateKey.html#method_keyPattern"
34333433
}, {
34343434
"fqsen": "\\CodeIgniter\\Commands\\Encryption\\GenerateKey\u003A\u003A\u0024group",

0 commit comments

Comments
 (0)