Greenmine/folders: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
(Created page with "Copied directly from code comment; needs minor updating, formating: <pre> FOLDER LAYOUT: Lines marked CANON are canonical; the rest are mainly as examples for clarity $h...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Copied directly from code comment; needs minor updating, formating:
{{hilite|This is currently being revised a bit; documentation is not correct anymore. 2020-11-10}}
<pre>
 
  FOLDER LAYOUT: Lines marked CANON are canonical; the rest are mainly as examples for clarity
Entries marked CANON are canonical/official sub-paths; the rest are mainly as examples for clarity.
    $home/public_html
# <code>$home/public_html</code>
    $home/site
## <code>index.php</code> - link to
      $home/site/config
## <code>$home/site</code>
        $home/site/config/greenmine
### <code>$home/site/config</code>
          $home/site/config/greenmine/portable - CANON:
#### <code>$home/site/config/greenmine</code>
          $home/site/config/greenmine/portable/defaults.php - CANON: THIS FILE (link to git version, or copy)
##### <code>$home/site/config/greenmine/portable</code> - CANON
          $home/site/config/greenmine/local/creds.php - CANON: database credentials, adapted from git/greenmine/config/examples/creds.php
###### <code>$home/site/config/greenmine/portable/defaults.php</code> - CANON: THIS FILE (link to git version, or copy)
      $home/site/git
###### <code>$home/site/config/greenmine/local</code> - CANON
        $home/site/git/ferreteria
###### <code>$home/site/config/greenmine/local/creds.php</code> - CANON: database credentials, adapted from git/greenmine/config/examples/creds.php
        $home/site/git/greenmine  - CANON
### <code>$home/site/git</code>
          $home/site/git/greenmine/config/portable - CANON: config files which (usually) can be used as-is
#### <code>$home/site/git/ferreteria</code> - [[ferreteria]] CANON
            $home/site/git/greenmine/config/portable/defaults.php - CANON: THIS FILE (git version)
#### <code>$home/site/git/greenmine</code> - CANON
          $home/site/git/greenmine/config/examples - CANON: files which will need configuration for local instance
##### <code>$home/site/git/greenmine/config/</code> - CANON: greenmine site config folder
            $home/site/git/greenmine/config/examples/creds.php - CANON: database credentials (to be configured)
###### <code>$home/site/git/greenmine/config/portable</code> - CANON: config files which (usually) can be used as-is
</pre>
####### <code>$home/site/git/greenmine/config/portable/defaults.php</code> - CANON: default global values, and abstracts which need setting locally
####### <code>$home/site/git/greenmine/config/portable/www/</code> - CANON: stuff which gets linked from <code>public_html</code>
####### <code>$home/site/git/greenmine/config/portable/www/index.php</code> - CANON: link from <code>public_html</code>
####### <code>$home/site/git/greenmine/config/portable/www/.htaccess</code> - CANON: link from <code>public_html</code>
###### <code>$home/site/git/greenmine/config/examples</code> - CANON: files which will need configuration for local instance
####### <code>$home/site/git/greenmine/config/examples/creds.php</code> - CANON: database credentials (to be configured)
==Dependency Chaining==
* <code>$home/public_html/index.php</code> - entry point (obviously)
** defines <code>$kfpConfigGreenmine</code>
** calls <code>$home/site/config/greenmine/portable/defaults.php</code>
*** uses <code>$kfpConfigGreenmine</code>
*** calls <code>$home/site/config/greenmine/local/globals.php</code>
**** uses <code>\greenmine\cGlobals</code> - defined in <code>$home/site/config/greenmine/portable/defaults.php</code>

Latest revision as of 13:14, 10 November 2020

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
Retrieved from "https://wooz.dev/mw/index.php?title=Greenmine/folders&oldid=692"