Directory structure

Default Structure

Actually in Poirot we don't have a set structure because it's definable and you could easily change the default structure. by the way we have some known directory entity that application needed to startup.

Here you can see recommended structure with associated Constant to that directory.

.                                                (PT_DIR_ROOT)
├── config\                                      (PT_DIR_CONFIG)
│   └── sapi_default.conf.php                      
├── data\                                        (PT_DIR_DATA)
│   └── tmp\                                     (PT_DIR_TMP)
├── html\
│   ├── favicon.ico
│   └── index.php
├── Modules\
│   └── readme.md
├── vendor\
├── poirot
├── .env.php
├── .env.local.php
├── composer.json

config

All application and modules configuration are here. when you want to override a setting from config you can put module config here to merge with default values.

data

Application runtime data include persist data or temprary files meant to write to this directory. this directory should be writable for PHP.

html

Like the name implies, this is the directory that is publicly-accessible. entry-script is also here.

Modules

This is where your project's core code goes. Poirot subscribe to modular design and your application could divide to different functionalities as a module here.

It's changeable to what you want

Directory structure in Poirot framework is flexible and you could define your own structures by overriding constant variables or environments.

Why is needed to make change on directory structures?

• we could use shared modules between similar projects.

• have multiple modules directory.

• have different modules/config/etc. directory for each instance and initial them based on environment variables.

• limit access to unnecessary/limited things for some applications.

• put temp and run-time directory anywhere in system that is more appropriate based on your environment.

• move vendors anywhere.

you can read more about it on this section.

Defined constants