Project Paths Documentation

Overview

This documentation outlines the purpose of various path constants defined in the project, making it easier to reference directories and files across the application.

Location ./settings/paths.php

Path Definitions

SETTINGS_PATH
The absolute path to the settings or configuration directory.
PUBLIC_PATH
Points to the public directory accessible by the web server, containing client-accessible assets.
PRISMA_LIB_PATH
The location of the Prisma library within the project, assuming Prisma is a custom or third-party library used.
SRC_PATH
Root directory for all source code in the project.
APP_PATH
Defines the path to the application's main directory within the source code.
LIB_PATH
Points to a general library directory for reusable code components.
DOCUMENT_PATH
Intended as a path to the document root or project root directory, though it currently mirrors SETTINGS_PATH.

Example Usage

<?php
    // Load path definitions
    require_once SETTINGS_PATH . '/paths.php';
    
    // Load a library file
    require_once LIB_PATH . '/utils.php';
    
    // Load a configuration file
    require_once SETTINGS_PATH . '/config.php';
    
    // Include a file from the application directory
    require_once APP_PATH . '/app-helper.php';
  ?>