Greenmine/folders

This is currently being revised a bit; documentation is not correct anymore. 2020-11-10

Entries marked CANON are canonical/official sub-paths; the rest are mainly as examples for clarity.

1. $home/public_html
   1. index.php - link to
   2. $home/site
      1. $home/site/config
         1. $home/site/config/greenmine
            1. $home/site/config/greenmine/portable - CANON
               1. $home/site/config/greenmine/portable/defaults.php - CANON: THIS FILE (link to git version, or copy)
               2. $home/site/config/greenmine/local - CANON
               3. $home/site/config/greenmine/local/creds.php - CANON: database credentials, adapted from git/greenmine/config/examples/creds.php
      2. $home/site/git
         1. $home/site/git/ferreteria - ferreteria CANON
         2. $home/site/git/greenmine - CANON
            1. $home/site/git/greenmine/config/ - CANON: greenmine site config folder
               1. $home/site/git/greenmine/config/portable - CANON: config files which (usually) can be used as-is
                  1. $home/site/git/greenmine/config/portable/defaults.php - CANON: default global values, and abstracts which need setting locally
                  2. $home/site/git/greenmine/config/portable/www/ - CANON: stuff which gets linked from public_html
                  3. $home/site/git/greenmine/config/portable/www/index.php - CANON: link from public_html
                  4. $home/site/git/greenmine/config/portable/www/.htaccess - CANON: link from public_html
               2. $home/site/git/greenmine/config/examples - CANON: files which will need configuration for local instance
                  1. $home/site/git/greenmine/config/examples/creds.php - CANON: database credentials (to be configured)

Dependency Chaining

• $home/public_html/index.php - entry point (obviously)
  • defines $kfpConfigGreenmine
  • calls $home/site/config/greenmine/portable/defaults.php
    • uses $kfpConfigGreenmine
    • calls $home/site/config/greenmine/local/globals.php
      • uses \greenmine\cGlobals - defined in $home/site/config/greenmine/portable/defaults.php