en/docs/structure.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Structure - Inphinit PHP</title>
  <meta name="description" content="Get started creating apps with Inphinit.">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <link rel="stylesheet" type="text/css" href="/css/docs.1733459389306.css" media="all">
  <script src="/js/docs.1733459389306.js"></script>
</head>
<body>
  <div id="container">
    <main>
      <h1>Structure</h1>
      <p>The default structure of the Inphinit app provides a simple-to-understand structure for organizing your projects, regardless of size. However, you can modify most of the structure by adjusting the constants.</p>

      <section>
        <h2 id="Folder-structure">
          <a href="#Folder-structure">Folder structure</a>
        </h2>
        <ul class="tree">
          <li>
            <a href="#htaccess-file">.htaccess</a>
          </li>
          <li>
            <a href="#index-php-file">index.php</a>
          </li>
          <li>
            <a href="#server-file">server</a>
          </li>
          <li>
            <a href="#server-bat-file">server.bat</a>
          </li>
          <li>
            <a href="#web-config-file">web.config</a>
          </li>
          <li>
            <a href="#public-folder">public/</a>
            <ul>
              <li>
                <a href="#checkup-php-file">checkup.php</a>
              </li>
            </ul>
          </li>
          <li>
            <a href="#system-folder">system/</a>
            <ul>
              <li>
                <a href="#dev-php-file">dev.php</a>
              </li>
              <li>
                <a href="#errors-php-file">errors.php</a>
              </li>
              <li>
                <a href="#main-php-file">main.php</a>
              </li>
              <li>
                <a href="#boot-folder">boot/</a>

                <ul>
                  <li>
                    <a href="#importpackages-php-file">importpackages.php</a>
                  </li>
                  <li>
                    <a href="#namespaces-php-file">namespaces.php</a>
                  </li>
                </ul>
              </li>
              <li>
                <a href="#configs-folder">configs/</a>
                <ul>
                  <li>
                    <a href="#app-php-file">app.php</a>
                  </li>
                  <li>
                    <a href="#debug-php-file">debug.php</a>
                  </li>
                </ul>
              </li>
              <li>
                <a href="#controllers-folder">controllers/</a>
              </li>
              <li>
                <a href="#storage-folder">storage/</a>
              </li>
              <li>
                <a href="#vendor-folder">vendor/</a>
              </li>
              <li>
                <a href="#views-folder">views/</a>
              </li>
            </ul>
          </li>
        </ul>
      </section>

      <section>
        <h2 id="htaccess-file">
          <a href="#htaccess-file">.htaccess file</a>
        </h2>
        <p><code>.htaccess</code> is used by Apache web servers to configure routes and the main error codes that can be issued by the server, allowing to customize pages or generic error responses.</p>
      </section>
      <section>
        <h2 id="index-php-file">
          <a href="#index-php-file">index.php file</a>
        </h2>
        <p><code>index.php</code> is the script that starts the application. It allows you to configure the autoload system and even change the folder structure, if necessary. Note that changing the folder structure is not recommended. If you want to add other PHP projects, such as a blog or similar, you can place them in the public folder or add a <code>DocumentRoot</code> for each project.</p>
      </section>
      <section>
        <h2 id="server-file">
          <a href="#server-file">server file</a>
        </h2>
        <p><code>server</code> is a shortcut for Unix-like servers, such as macOS and Linux, to start the application on a PHP built-in web server. Before using you must edit the shortcut and adjust the variable values:</p>
        <div class="box">
          <code tabindex="0"><q># Setup PHP and PORT</q>
PHP_BIN=<b>/usr/bin/php</b>
PHP_INI=<b>/etc/php.ini</b>

HOST_ADDR=<b>localhost</b>
HOST_PORT=<i>5000</i></code>
        </div>

        <p>{placeholder}</p>

        <div class="box">
          <code class="lang-terminal" tabindex="0"><span>./server</span>
<span class="output"><i>PHP Development Server (http://localhost:5000) started</i></span></code>
        </div>
      </section>

      <section>
        <h2 id="server-bat-file">
          <a href="#server-bat-file">server.bat file</a>
        </h2>
        <p><code tabindex="0">server.bat</code> is a shortcut for Windows, to start the application on a PHP built-in web server. Before using you must edit the shortcut and adjust the variable values:</p>
        <div class="box">
          <code tabindex="0"><q>rem Setup PHP and PORT</q>
<em>set</em> PHP_BIN=<b>C:\php\php.exe</b>
<em>set</em> PHP_INI=<b>C:\php\php.ini</b>

<em>set</em> HOST_ADDR=<b>localhost</b>
<em>set</em> HOST_PORT=<i>5000</i></code>
        </div>

        <p>{placeholder}</p>

        <div class="box">
          <code class="lang-terminal" tabindex="0"><span>server</span>
<span class="output"><i>PHP Development Server (http://localhost:5000) started</i></span></code>
        </div>
      </section>
      <section>
        <h2 id="web-config-file">
          <a href="#web-config-file">web.config file</a>
        </h2>
        <p><code tabindex="0">web.config</code> is used by IIS web servers to configure routes and the main error codes that can be issued by the server, allowing to customize pages or generic error responses.</p>
      </section>

      <!-- folder -->
      <section>
        <h2 id="public-folder">
          <a href="#public-folder">public folder</a>
        </h2>
        <p>
          <code>public/</code> is the folder where other scripts, PHP applications and static files should be stored to be served without the need for the routing system.
        </p>
      </section>
      <section>
        <h2 id="checkup-php-file">
          <a href="#checkup-php-file">checkup.php file</a>
        </h2>
        <p>
          <code>public/checkup.php</code> is a script used to check the conditions generally required to run your application. See more details in <a rel="help" href="/en/docs/checkup.html">Checkup</a>.
        </p>
      </section>

      <!-- folder -->
      <section>
        <h2 id="system-folder">
          <a href="#system-folder">system folder</a>
        </h2>
        <p><code>system/</code> is folder containing your application.</p>
      </section>
      <section>
        <h2 id="dev-php-file">
          <a href="#dev-php-file">dev.php file</a>
        </h2>
        <p>
          <code>system/dev.php</code> serves the same purpose as <a href="#main-php-file"><code>system/main.php</code></a>, however it only runs in development mode and should not be used for production. You can define routes and other instructions as required for the environment type. See more details in <a rel="help" href="/en/docs/debugging.html">Debugging</a>.
        </p>
        <aside class="info warn">
          <svg viewBox="0 0 24 24" role="img">
            <path fill-rule="evenodd" clip-rule="evenodd" d="M19.5 12C19.5 16.1421 16.1421 19.5 12 19.5C7.85786 19.5 4.5 16.1421 4.5 12C4.5 7.85786 7.85786 4.5 12 4.5C16.1421 4.5 19.5 7.85786 19.5 12ZM21 12C21 16.9706 16.9706 21 12 21C7.02944 21 3 16.9706 3 12C3 7.02944 7.02944 3 12 3C16.9706 3 21 7.02944 21 12ZM11.25 13.5V8.25H12.75V13.5H11.25ZM11.25 15.75V14.25H12.75V15.75H11.25Z"/>
          </svg>
          <p><code>system/main.php</code> script will be executed after <code>system/dev.php</code>, so if you write two identical routes in both scripts, <code>system/main.php</code> will overwrite what was done in <code>system/dev.php</code>.</p>
        </aside>
      </section>
      <section>
        <h2 id="errors-php-file">
          <a href="#errors-php-file">errors.php file</a>
        </h2>
        <p><code>system/errors.php</code> should contain error page settings, such as when a 404 or 405 error occurs, you can call static files or use views. See more details in <a rel="help" href="/en/docs/error-pages.html">Error pages</a>.</p>
      </section>
      <section>
        <h2 id="main-php-file">
          <a href="#main-php-file">main.php file</a>
        </h2>
        <p><code>system/main.php</code> is a script used to define routes, route scopes, implicit controllers and other instructions.</p>
      </section>

      <!-- folder -->
      <section>
        <h2 id="boot-folder">
          <a href="#boot-folder">boot folder</a>
        </h2>
        <p><code>system/boot/</code> is contain settings for <em>inphinit_autoload</em>, similar to <em>composer_autoload</em>.</p>
      </section>
      <section>
        <h2 id="importpackages-php-file">
          <a href="#importpackages-php-file">importpackages.php file</a>
        </h2>
        <p><code>system/boot/importpackages.php</code> is a script used to import packages installed via composer into <em>inphinit_autoload</em>. This script is automatically executed by <code>composer.json</code> on every update, such as when installing or removing packages.</p>
      </section>
      <section>
        <h2 id="namespaces-php-file">
          <a href="#namespaces-php-file">namespaces.php file</a>
        </h2>
        <p><code>system/boot/namespaces.php</code> indexes all packages installed via composer and should not be changed manually, the data in this file is generated by <code>importpackages.php</code>.</p>
      </section>

      <!-- folder -->
      <section>
        <h2 id="configs-folder">
          <a href="#configs-folder">configs folder</a>
        </h2>
        <p>
          <code>system/configs/</code> is contain varied configuration files, it is recommended that you do not version this folder. See more details in <a href="/en/docs/configurations.html" rel="help">Configurations</a>.
        </p>
      </section>
      <section>
        <h2 id="debug-php-file">
          <a href="#debug-php-file">debug.php file</a>
        </h2>
        <p>
          <code>system/configs/debug.php</code> contains settings for the debugging system used by development mode, these settings allow you to configure an editor to open files that cause errors or integrate possible error messages with search engines from other sites. See more details in <a href="/en/docs/debugging.html" rel="help">Debugging</a>.
        </p>
        <aside class="info warn">
          <svg viewBox="0 0 24 24" role="img">
            <path fill-rule="evenodd" clip-rule="evenodd" d="M19.5 12C19.5 16.1421 16.1421 19.5 12 19.5C7.85786 19.5 4.5 16.1421 4.5 12C4.5 7.85786 7.85786 4.5 12 4.5C16.1421 4.5 19.5 7.85786 19.5 12ZM21 12C21 16.9706 16.9706 21 12 21C7.02944 21 3 16.9706 3 12C3 7.02944 7.02944 3 12 3C16.9706 3 21 7.02944 21 12ZM11.25 13.5V8.25H12.75V13.5H11.25ZM11.25 15.75V14.25H12.75V15.75H11.25Z"/>
          </svg>
          <p>Do not add new keys, just change the values of existing ones if necessary</p>
        </aside>
      </section>
      <section>
        <h2 id="app-php-file">
          <a href="#app-php-file">app.php file</a>
        </h2>
        <p><code>system/configs/app.php</code> contains settings for the application is operation, such as enabling or disabling development mode and configuring <code>X-Forwarded-Proto</code> (XFP) and <code>X-Forwarded-Host</code> (XFH). See more details in:</p>

        <ul>
          <li><a href="/en/docs/configurations.html" rel="help">Configurations</a></li>
          <li><a href="/en/docs/debugging.html" rel="help">Debugging</a></li>
          <li><a href="/en/docs/forwarded.html" rel="help">Forwarded</a></li>
          <li><a href="/en/docs/maintenance.html" rel="help">Maintenance</a></li>
        </ul>

        <aside class="info warn">
          <svg viewBox="0 0 24 24" role="img">
            <path fill-rule="evenodd" clip-rule="evenodd" d="M19.5 12C19.5 16.1421 16.1421 19.5 12 19.5C7.85786 19.5 4.5 16.1421 4.5 12C4.5 7.85786 7.85786 4.5 12 4.5C16.1421 4.5 19.5 7.85786 19.5 12ZM21 12C21 16.9706 16.9706 21 12 21C7.02944 21 3 16.9706 3 12C3 7.02944 7.02944 3 12 3C16.9706 3 21 7.02944 21 12ZM11.25 13.5V8.25H12.75V13.5H11.25ZM11.25 15.75V14.25H12.75V15.75H11.25Z"/>
          </svg>
          <p>Do not add new keys, just change the values of existing ones if necessary</p>
        </aside>
      </section>

      <!-- folder -->
      <section>
        <h2 id="controllers-folder">
          <a href="#controllers-folder">controllers folder</a>
        </h2>
        <p><code>system/controllers/</code> is must contain the classes that will be controllers used in the routes. See more details in <a rel="help" href="/en/docs/controllers.html">Controllers</a>.</p>
      </section>

      <!-- folder -->
      <section>
        <h2 id="storage-folder">
          <a href="#storage-folder">storage folder</a>
        </h2>
        <p><code>system/storage/</code> is {placeholder}</p>
      </section>
      <section>
        <h2 id="vendor-folder">
          <a href="#vendor-folder">vendor folder</a>
        </h2>
        <p><code>system/vendor/</code> is contain third-party packages and the framework</p>
      </section>
      <section>
        <h2 id="views-folder">
          <a href="#views-folder">views folder</a>
        </h2>
        <p><code>system/views/</code> is should contain your views</p>
      </section>

      <footer>
        <a href="/en/docs/configurations.html" class="info alt" rel="prev">
          <svg fill="none" viewBox="0 0 24 24" stroke="currentColor" role="img">
            <path id="Icon" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 12H5M5 12L12 19M5 12L12 5"/>
          </svg>
          <p>Configurations</p>
        </a>
        <a href="/en/docs/" class="info" rel="next">
          <svg fill="none" viewBox="0 0 24 24" stroke="currentColor" role="img">
            <path id="Icon" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 12H5M5 12L12 19M5 12L12 5"/>
          </svg>
          <p>Get Started</p>
        </a>
      </footer>
    </main>

    <footer>
      <div>
        <p>Last updated on Dec 25, 2024.</p>
        <p>Content licensed under CC BY-SA.</p>
      </div>
      <div>
        <p>
          Site design by <a href="https://github.com/brcontainer" rel="external" target="_blank">Brcontainer</a>
        </p>
      </div>
    </footer>
  </div>

  <header>
    <a href="/">Go to homepage</a>
    <div>
      <!--
      <form method="get" id="search" action="http://duckduckgo.com/">
        <input type="hidden" name="sites" value="inphinit.github.io"/>
        <input type="hidden" name="k8" value="#444444"/>
        <input type="hidden" name="k9" value="#D51920"/>
        <input type="hidden" name="kt" value="h"/>
        <input type="text" name="q" maxlength="255" placeholder="Search&hellip;"/>
        <input type="submit" value="DuckDuckGo Search" style="visibility: hidden;" />
      </form>
      -->
      <a
        href="https://github.com/inphinit/inphinit"
        rel="external"
        target="_blank"
        aria-label="Access Github for get source">
        <svg
          fill="currentColor"
          viewBox="0 0 24 24"
          role="img"
          class="icon">
          <path d="M12 1.60205C5.9225 1.60205 1 6.41965 1 12.3676C1 17.1314 4.14875 21.155 8.52125 22.5815C9.07125 22.6757 9.2775 22.3527 9.2775 22.0701C9.2775 21.8144 9.26375 20.9666 9.26375 20.065C6.5 20.5629 5.785 19.4056 5.565 18.8001C5.44125 18.4906 4.905 17.5351 4.4375 17.2794C4.0525 17.0776 3.5025 16.5797 4.42375 16.5662C5.29 16.5528 5.90875 17.3467 6.115 17.6697C7.105 19.298 8.68625 18.8404 9.31875 18.5578C9.415 17.8581 9.70375 17.3871 10.02 17.1179C7.5725 16.8488 5.015 15.9203 5.015 11.8024C5.015 10.6317 5.44125 9.66278 6.1425 8.90919C6.0325 8.64005 5.6475 7.53658 6.2525 6.05631C6.2525 6.05631 7.17375 5.77372 9.2775 7.15978C10.1575 6.91756 11.0925 6.79645 12.0275 6.79645C12.9625 6.79645 13.8975 6.91756 14.7775 7.15978C16.8813 5.76026 17.8025 6.05631 17.8025 6.05631C18.4075 7.53658 18.0225 8.64005 17.9125 8.90919C18.6138 9.66278 19.04 10.6182 19.04 11.8024C19.04 15.9337 16.4688 16.8488 14.0213 17.1179C14.42 17.4544 14.7638 18.1003 14.7638 19.1096C14.7638 20.5495 14.75 21.7068 14.75 22.0701C14.75 22.3527 14.9563 22.6891 15.5063 22.5815C17.69 21.86 19.5875 20.4865 20.9318 18.6542C22.2761 16.822 22.9994 14.6233 23 12.3676C23 6.41965 18.0775 1.60205 12 1.60205Z"/>
        </svg>
        <span class="compact">Star us on Github</span>
      </a>
      <div class="btn" id="color-scheme">
        <select aria-label="Color Scheme">
          <option>Auto</option>
          <option>Dark</option>
          <option>Light</option>
        </select>
        <svg
          fill="currentColor"
          viewBox="0 0 20 20"
          role="img"
          class="icon">
          <path d="M10 2a.75.75 0 0 1 .75.75v1.5a.75.75 0 0 1-1.5 0v-1.5A.75.75 0 0 1 10 2ZM10 15a.75.75 0 0 1 .75.75v1.5a.75.75 0 0 1-1.5 0v-1.5A.75.75 0 0 1 10 15ZM10 7a3 3 0 1 0 0 6 3 3 0 0 0 0-6ZM15.657 5.404a.75.75 0 1 0-1.06-1.06l-1.061 1.06a.75.75 0 0 0 1.06 1.06l1.06-1.06ZM6.464 14.596a.75.75 0 1 0-1.06-1.06l-1.06 1.06a.75.75 0 0 0 1.06 1.06l1.06-1.06ZM18 10a.75.75 0 0 1-.75.75h-1.5a.75.75 0 0 1 0-1.5h1.5A.75.75 0 0 1 18 10ZM5 10a.75.75 0 0 1-.75.75h-1.5a.75.75 0 0 1 0-1.5h1.5A.75.75 0 0 1 5 10ZM14.596 15.657a.75.75 0 0 0 1.06-1.06l-1.06-1.061a.75.75 0 1 0-1.06 1.06l1.06 1.06ZM5.404 6.464a.75.75 0 0 0 1.06-1.06l-1.06-1.06a.75.75 0 1 0-1.061 1.06l1.06 1.06Z"/>
        </svg>
      </div>
      <button id="menu-toggle" class="btn" aria-label="Display/Hide menu">
        <svg fill="currentColor" viewBox="0 0 24 24" role="img" class="icon">
          <path d="M21 6H3V5h18v1zm0 5H3v1h18v-1zm0 6H3v1h18v-1z"/>
        </svg>
        <!-- <svg fill="currentColor" viewBox="0 0 24 24" role="img" class="icon">
          <path d="M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z"/>
        </svg> -->
      </button>
    </div>
  </header>

  <nav id="menu" tabindex="-1">
    <a href="/en/docs/">Get started</a>
    <dl>
      <dt>Web server</dt>
      <!-- <dd><a href="/en/docs/web-server/apache.html">Apache</a></dd> -->
      <dd><a href="/en/docs/web-server/nginx.html">NGINX</a></dd>
      <dd><a href="/en/docs/web-server/iis.html">IIS</a></dd>
      <dd><a href="/en/docs/web-server/iis-express.html">IIS Express</a></dd>
    </dl>
    <a href="/en/docs/structure.html" class="current">Structure</a>
    <a href="/en/docs/configurations.html">Configurations</a>
    <a href="/en/docs/checkup.html">Checkup</a>
    <a href="/en/docs/debugging.html">Debugging</a>
    <a href="/en/docs/routing/">Routing</a>
    <dl>
      <dt>Routing features</dt>
      <dd><a href="/en/docs/routing/implicit-route-controllers.html">Implicit route controllers</a></dd>
      <dd><a href="/en/docs/routing/resource.html">Resource routes</a></dd>
    </dl>
    <a href="/en/docs/controllers.html">Controllers</a>
    <a href="/en/docs/views.html">Views</a>
    <a href="/en/docs/http/request.html">HTTP Request</a>
    <a href="/en/docs/http/response.html">HTTP Response</a>
    <dl>
      <dt>HTTP feautures</dt>
      <dd><a href="/en/docs/http/content-negotiation.html">Content Negotiation</a></dd>
    </dl>
    <!-- <a href="/en/docs/storage-and-files.html">Storage and Files</a> -->
    <!-- <a href="/en/docs/cache.html">Cache</a> -->
    <a href="/en/docs/maintenance.html">Maintenance</a>
    <a href="/en/docs/error-pages.html">Error pages</a>
    <a href="/en/docs/dom/">DOM, XML, HTML</a>
    <dl>
      <dt>DOM feautures</dt>
      <dd><a href="/en/docs/dom/css-selector.html">CSS Selector in PHP</a></dd>
      <dd><a href="/en/docs/dom/dom-with-arrays.html">DOM with Arrays</a></dd>
      <dd><a href="/en/docs/dom/errors.html">DOM Errors</a></dd>
    </dl>
    <dl>
      <dt>Specific utilities</dt>
      <dd><a href="/en/docs/utilities/arrays.html">Arrays</a></dd>
      <dd><a href="/en/docs/utilities/strings.html">Strings</a></dd>
      <dd><a href="/en/docs/utilities/url.html">Urls</a></dd>
      <dd><a href="/en/docs/utilities/version.html">Version</a></dd>
    </dl>
    <a href="/en/docs/events.html">Events</a>
    <a href="/en/docs/experimental.html">Experimental</a>
    <a href="/en/docs/about.html">About</a>
    <a href="/en/docs/performance.html">Performance</a>
    <dl>
      <dt>Production</dt>
      <dd><a href="/en/docs/production/forwarded.html">Forwarded</a></dd>
      <dd><a href="/en/docs/production/rate-limiting.html">Rate limiting</a></dd>
      <dd><a href="/en/docs/production/send-file.html">Send file</a></dd>
    </dl>
  </nav>

  <div id="menu-backdrop"></div>
</body>
</html>