en/docs/configurations.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Configurations - 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>Configurations</h1>
      <p>Inphinit has different configurations, from constants to start the application, in addition to the existing configurations located in <code>system/configs/</code>, you can create your own configuration files for your own purposes.</p>

      <section>
        <h2 id="composer-autoload">
          <a href="#autoload">Autoload</a>
        </h2>

        <p><em>Inphinit Autoloader</em> is an optimized loader that allows you to load classes installed via composer. To use <em>Composer Autoloader</em>, change the value <code>INPHINIT_COMPOSER</code> to <code>true</code> in <code>index.php</code>, for example:</p>

        <div class="box">
        <code tabindex="0"><em>define</em>(<b>'INPHINIT_COMPOSER'</b>, <i>true</i>);</code>
        </div>
      </section>

      <section>
        <h2 id="constants">
          <a href="#Constants">Constants</a>
        </h2>

        <p>{placeholder}</p>

        <div class="box">
          <table>
            <thead>
              <th>Constant</th>
              <th>Editable</th>
              <th>Description</th>
            </thead>
            <tbody>
              <tr>
                <td><code>INPHINIT_COMPOSER</code></td>
                <td>
                  ✔️ <div class="sr">is editable</div>
                </td>
                <td>In the <code>index.php</code> file, set this constant to <code>true</code> if you want to use <em>Composer Autoloader</em>, otherwise it will use <em>Inphinit Autoloader</em>.</td>
              </tr>
              <tr>
                <td><code>INPHINIT_ROOT</code></td>
                <td>
                  ✔️ <div class="sr">is editable</div>
                </td>
                <td>It must contain the path of the folder where <code>index.php</code> is located.</td>
              </tr>
              <tr>
                <td><code>INPHINIT_START</code></td>
                <td>
                  ✔️ <div class="sr">is editable</div>
                </td>
                <td>It can be used for simple performance testing, estimating the time for something to execute, from the start of the execution.</td>
              </tr>
              <tr>
                <td><code>INPHINIT_SYSTEM</code></td>
                <td>
                  ✔️ <div class="sr">is editable</div>
                </td>
                <td>It must contain the path of the system folder, this folder contains the project, data and packages.</td>
              </tr>
              <tr>
                <td><code>INPHINIT_PATH</code></td>
                <td>
                  ❌ <div class="sr">no editable</div>
                </td>
                <td>Contains the path of the current URL request. This constant is mainly used by the routing system.</td>
              </tr>
              <tr>
                <td><code>INPHINIT_URL</code></td>
                <td>
                  ❌ <div class="sr">no editable</div>
                </td>
                <td>Contains the URL where the application is located. This constant is mainly used by the route scoping system.</td>
              </tr>
            </tbody>
          </table>
        </div>
      </section>

      <section>
        <h2 id="production-develop-mode">
          <a href="#Production-develop-mode">Production & Develop mode</a>
        </h2>

        <p><code>system/configs/app.php</code></p>

        <div class="box"><code class="lines" tabindex="0"><span>&lt;?php</span>
<span>return <i>array</i>(</span>
<span>    <b>'data_lifetime'</b> => 86400,</span>
<span>    <b>'development'</b> => <i>true</i>,</span>
<span>    <b>'fowarded_proto'</b> => <em>null</em>,</span>
<span>    <b>'fowarded_host'</b> => <em>null</em>,</span>
<span>    <b>'fowarded_port'</b> => <em>null</em>,</span>
<span>    <b>'maintenance'</b> => <i>false</i>,</span>
<span>);</span></code></div>

        <p>Descriptions</p>

        <div class="box">
          <table>
            <thead>
              <th>Constant</th>
              <th>Description</th>
            </thead>
            <tbody>
              <tr>
                <td><code>data_lifetime</code></td>
                <td>Configuration defined for different uses, initially used by sessions as a default value.</td>
              </tr>
              <tr>
                <td><code>development</code></td>
                <td>Set <code>true</code> for development mode, in production set to <code>false</code>. See more details in <a rel="help" href="/en/docs/debugging.html">Debugging</a>.</td>
              </tr>
              <tr>
                <td><code>forwarded_proto</code></td>
                <td>If you are using reverse proxy (load balancers, CDNs) you may not receive the expected protocol, so you can set value in this key, for example using <code>X-Forwarded-Proto</code> (see your hosting/cloud documentation before configuring). See more details in <a rel="help" href="/en/docs/production/forwarded.html">Forwarded</a>.</td>
              </tr>
              <tr>
                <td><code>forwarded_host</code></td>
                <td>If you are using reverse proxy (load balancers, CDNs) you may not receive the expected host, so you can set value in this key, for example using <code>X-Forwarded-Host</code> (see your hosting/cloud documentation before configuring).</td>
              </tr>
              <tr>
                <td><code>forwarded_port</code></td>
                <td>If you are using reverse proxy (load balancers, CDNs) you may not receive the expected port, so you can set value in this key, for example using <code>X-Forwarded-Host</code> (see your hosting/cloud documentation before configuring).</td>
              </tr>
              <tr>
                <td><code>maintenance</code></td>
                <td>Set <code>true</code> to down the application, all HTTP responses will receive code 503 and no routes will be executed. See more details in <a rel="help" href="/en/docs/maintenance.html">Maintenance</a>.</td>
              </tr>
            </tbody>
          </table>
        </div>
      </section>

      <section>
        <h2 id="config-files">
          <a href="#Config-files">Config files</a>
        </h2>

        <p>{placeholder} <code>system/configs/foobar.php</code> {placeholder}</p>
      </section>

      <footer>
        <a href="/en/docs/checkup.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>Checkup</p>
        </a>
        <a href="/en/docs/structure.html" 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>Structure</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">Structure</a>
    <a href="/en/docs/configurations.html" class="current">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>