Update User Guide

Author: actions-user

general/managing_apps.html

@@ -308,7 +308,7 @@ <h1>Managing your Applications<a class="headerlink" href="#managing-your-applica
 <p>If you would like to rename your application directory or even move
 it to a different location on your server, other than your project root, open
 your main <strong>app/Config/Paths.php</strong> and set a <em>full server path</em> in the
-<code class="docutils literal notranslate"><span class="pre">$appDirectory</span></code> variable (at about line 44):</p>
+<code class="docutils literal notranslate"><span class="pre">$appDirectory</span></code> variable (at about line 45):</p>
 <div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
 
 <span class="k">namespace</span> <span class="nx">Config</span><span class="p">;</span>
@@ -317,7 +317,7 @@ <h1>Managing your Applications<a class="headerlink" href="#managing-your-applica
 <span class="p">{</span>
     <span class="c1">// ...</span>
 
-    <span class="k">public</span> <span class="nv">$appDirectory</span> <span class="o">=</span> <span class="s1">&#39;/path/to/your/app&#39;</span><span class="p">;</span>
+    <span class="k">public</span> <span class="nx">string</span> <span class="nv">$appDirectory</span> <span class="o">=</span> <span class="s1">&#39;/path/to/your/app&#39;</span><span class="p">;</span>
 
     <span class="c1">// ...</span>
 <span class="p">}</span>
@@ -345,23 +345,23 @@ <h1>Managing your Applications<a class="headerlink" href="#managing-your-applica
 <p>If you would like to share a common CodeIgniter framework installation, to manage
 several different applications, simply put all of the directories located
 inside your application directory into their own (sub)-directory.</p>
-<p>For example, let’s say you want to create two applications, named <strong>foo</strong>
-and <strong>bar</strong>. You could structure your application project directories like this:</p>
-<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>foo/
+<p>For example, let’s say you want to create two applications, named <strong>blog</strong>
+and <strong>shop</strong>. You could structure your application project directories like this:</p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>blog/
     app/
     public/
     tests/
     writable/
     env
-    phpunit.xml.dist
+    phpunit.dist.xml
     spark
-bar/
+shop/
     app/
     public/
     tests/
     writable/
     env
-    phpunit.xml.dist
+    phpunit.dist.xml
     spark
 vendor/
     autoload.php
@@ -373,13 +373,13 @@ <h1>Managing your Applications<a class="headerlink" href="#managing-your-applica
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If you install CodeIgniter from the Zip file, the directory structure would be following:</p>
-<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>foo/
-bar/
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>blog/
+shop/
 codeigniter4/system/
 </pre></div>
 </div>
 </div>
-<p>This would have two apps, <strong>foo</strong> and <strong>bar</strong>, both having standard application directories
+<p>This would have two apps, <strong>blog</strong> and <strong>shop</strong>, both having standard application directories
 and a <strong>public</strong> folder, and sharing a common <strong>codeigniter4/framework</strong>.</p>
 <p>The <code class="docutils literal notranslate"><span class="pre">$systemDirectory</span></code> variable in <strong>app/Config/Paths.php</strong> inside each
 of those would be set to refer to the shared common <strong>codeigniter4/framework</strong> folder:</p>
@@ -397,17 +397,18 @@ <h1>Managing your Applications<a class="headerlink" href="#managing-your-applica
 <span class="p">}</span>
 </pre></div>
 </div>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>If you install CodeIgniter from the Zip file, the <code class="docutils literal notranslate"><span class="pre">$systemDirectory</span></code> would be <code class="docutils literal notranslate"><span class="pre">__DIR__</span> <span class="pre">.</span> <span class="pre">'/../../../codeigniter4/system'</span></code>.</p>
-</div>
 <p>And modify the <code class="docutils literal notranslate"><span class="pre">COMPOSER_PATH</span></code> constant in <strong>app/Config/Constants.php</strong> inside each
 of those:</p>
 <div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
 
 <span class="nb">defined</span><span class="p">(</span><span class="s1">&#39;COMPOSER_PATH&#39;</span><span class="p">)</span> <span class="o">||</span> <span class="nb">define</span><span class="p">(</span><span class="s1">&#39;COMPOSER_PATH&#39;</span><span class="p">,</span> <span class="nx">ROOTPATH</span> <span class="o">.</span> <span class="s1">&#39;../vendor/autoload.php&#39;</span><span class="p">);</span>
 </pre></div>
 </div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>If you install CodeIgniter from the Zip file, the <code class="docutils literal notranslate"><span class="pre">$systemDirectory</span></code> would be <code class="docutils literal notranslate"><span class="pre">__DIR__</span> <span class="pre">.</span> <span class="pre">'/../../../codeigniter4/system'</span></code>.
+If you don’t use Composer, you don’t have to edit the <code class="docutils literal notranslate"><span class="pre">COMPOSER_PATH</span></code>.</p>
+</div>
 <p>Only when you change the Application Directory, see <a class="reference internal" href="#renaming-app-directory"><span class="std std-ref">Renaming or Relocating the Application Directory</span></a> and modify the paths in the <strong>index.php</strong> and <strong>spark</strong>.</p>
 </section>
 <section id="changing-the-location-of-the-env-file">

installation/installing_composer.html

@@ -460,10 +460,13 @@ <h3><a class="toc-backref" href="#id15" role="doc-backlink">Structure</a><a clas
 <span id="switch-to-dev-version"></span><h3><a class="toc-backref" href="#id16" role="doc-backlink">Latest Dev</a><a class="headerlink" href="#latest-dev" title="Link to this heading"></a></h3>
 <p>The App Starter repo comes with a <code class="docutils literal notranslate"><span class="pre">builds</span></code> scripts to switch Composer sources between the
 current stable release and the latest development branch of the framework. Use this script
-for a developer who is willing to live with the latest unreleased changes, which may be unstable.</p>
+for a developer who is willing to live with the latest unreleased changes, which may be unstable.
+This way you can help find bugs and improve new features.</p>
 <p>The <a class="reference external" href="https://codeigniter4.github.io/CodeIgniter4/">development user guide</a> is accessible online.
 Note that this differs from the released user guide, and will pertain to the
 develop branch explicitly.</p>
+<p>Before running the script, check <code class="docutils literal notranslate"><span class="pre">$files</span></code>, which is the list of files to be changed.
+This is useful if you have additional places in the code that mention the directory with the framework.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You should not rely on the version of the framework in your project
@@ -531,7 +534,7 @@ <h3><a class="toc-backref" href="#id19" role="doc-backlink">Setting Up</a><a cla
 <blockquote>
 <div><ol class="arabic simple">
 <li><p>Copy the <strong>app</strong>, <strong>public</strong>, <strong>tests</strong> and <strong>writable</strong> folders from <strong>vendor/codeigniter4/framework</strong> to your project root</p></li>
-<li><p>Copy the <strong>env</strong>, <strong>phpunit.xml.dist</strong> and <strong>spark</strong> files, from <strong>vendor/codeigniter4/framework</strong> to your project root</p></li>
+<li><p>Copy the <strong>env</strong>, <strong>phpunit.dist.xml</strong> and <strong>spark</strong> files, from <strong>vendor/codeigniter4/framework</strong> to your project root</p></li>
 <li><p>You will have to adjust the <code class="docutils literal notranslate"><span class="pre">$systemDirectory</span></code> property in <strong>app/Config/Paths.php</strong> to refer to the vendor one, e.g., <code class="docutils literal notranslate"><span class="pre">__DIR__</span> <span class="pre">.</span> <span class="pre">'/../../vendor/codeigniter4/framework/system'</span></code>.</p></li>
 </ol>
 </div></blockquote>
@@ -595,7 +598,8 @@ <h2><a class="toc-backref" href="#id25" role="doc-backlink">Translations Install
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">composer require codeigniter4/translations</span>
 </pre></div>
 </div>
-<p>These will be updated along with the framework whenever you do a <code class="docutils literal notranslate"><span class="pre">composer</span> <span class="pre">update</span></code>.</p>
+<p>Copy the <strong>vendor/codeigniter4/translations/Language</strong> folder contents in it to your <strong>app/Language</strong> folder.
+These will be updated along with the framework whenever you do a <code class="docutils literal notranslate"><span class="pre">composer</span> <span class="pre">update</span></code>.</p>
 </section>
 </section>
 

installation/worker_mode.html

@@ -432,6 +432,10 @@ <h3><a class="toc-backref" href="#id5" role="doc-backlink">Installation</a><a cl
 <li><p>Configure your worker settings in <strong>app/Config/WorkerMode.php</strong> if needed.
 The defaults are recommended for most applications.</p></li>
 </ol>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>When changing the project directory, see the section <a class="reference internal" href="../general/managing_apps.html#renaming-app-directory"><span class="std std-ref">Renaming or Relocating the Application Directory</span></a> and update your <strong>public/frankenphp-worker.php</strong>.</p>
+</div>
 </section>
 <section id="running-the-worker">
 <h3><a class="toc-backref" href="#id6" role="doc-backlink">Running the Worker</a><a class="headerlink" href="#running-the-worker" title="Link to this heading"></a></h3>

searchindex.js

@@ -367,7 +367,7 @@ <h4><a class="toc-backref" href="#id4" role="doc-backlink">Phar</a><a class="hea
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Testing Your Application</a><a class="headerlink" href="#testing-your-application" title="Link to this heading"></a></h2>
 <section id="phpunit-configuration">
 <h3><a class="toc-backref" href="#id6" role="doc-backlink">PHPUnit Configuration</a><a class="headerlink" href="#phpunit-configuration" title="Link to this heading"></a></h3>
-<p>In your CodeIgniter project root, there is the <code class="docutils literal notranslate"><span class="pre">phpunit.xml.dist</span></code> file. This
+<p>In your CodeIgniter project root, there is the <code class="docutils literal notranslate"><span class="pre">phpunit.dist.xml</span></code> file. This
 controls unit testing of your application. If you provide your own <code class="docutils literal notranslate"><span class="pre">phpunit.xml</span></code>,
 it will over-ride this.</p>
 <p>By default, test files are placed under the <strong>tests</strong> directory in the project root.</p>