kirby-phpdotenv
A simple wrapper around vlucas' PHP dotenv library for Kirby CMS.
Why?
I've been using .env in my Kirby projects for a while, but I got tired of pasting in the env() function for every new site. So, I created this package instead.
Quick Example
# .env
APP_DEBUG=true
# site/config/config.php
c::set('debug', env('APP_DEBUG', false));
# elsewhere
c::get('debug'); // true
Install
Install via composer
composer require jevets/kirby-phpdotenv
Usage
1. Instantiate
In your site's index.php file (or in site.php file), load Composer's autoloader.
require_once 'path/to/vendor/autoload.php';
Then instantiate with:
- The path where dotenv can find your
.envfile - A file name other than
.env
new Jevets\Kirby\Dotenv\Dotenv(__DIR__ . DS, '.env');
Note: Jevets\Kirby\Dotenv\Dotenv will instantiate and run [dotenv]->load() for you.
2. Create your .env file
KIRBY_LICENSE=1234-12345-123456
APP_MODE=production
APP_DEBUG=true
3. Use in config.php file(s)
c::set('license', env('KIRBY_LICENSE', 'put your license in .env'));
c::set('debug', env('APP_DEBUG', false));
c::get('license'); // "1234-12345-123456"
c::get('debug'); // true
This library loads a global helper function:
function env($key, $default = '') {...}
Note function env() declaration is wrapped in if (!function_exists('env')) so you can override it or use your own method.
Customized folder setup
In my Kirby projects, I usually keep this folder structure:
project/
.env
.env.example
.gitignore
package.json
composer.json
site/
accounts/
blueprints/
cache/
config/
snippets/
templates/
public/
kirby/
toolkit/
panel/
content/
assets/
thumbs/
index.php
site.php
src/
vendor/
And here's my typical site.php
# Composer autoload
require __DIR__ . DS . '..' . DS . 'vendor' . DS . 'autoload.php';
# DotEnv
new Jevets\Kirby\Dotenv\Dotenv(__DIR__ . DS . '..');
# Setup Kirby
$kirby = kirby();
$kirby->roots()->site = __DIR__ . DS . '..' . DS . 'site';
ChangeLog
0.0.3
- Rename class alias in helpers.php from
StringtoStrfor PHP7 compatibility
0.0.2
- Initial release
Collaborating
Pull requests and suggestions are quite welcome!
Credits
- All credit for dotenv goes to vlucas for his great work on PHP dotenv. I just wrapped it up in a package to speed up development of Kirby-based sites.
- I stole Taylor Otwell's
env()function from Laravel 5.1, with a couple tweaks to get it working with Kirby.
Bugs/Issues
Please use the issue tracker on the GitHub repo.
68 Dec 21, 2022
8 Nov 27, 2022
41 Nov 19, 2022
13 Nov 21, 2022
2 Oct 11, 2021
4 Mar 19, 2022
10 Nov 20, 2022
36 Dec 28, 2022
4 Jan 15, 2022
6 May 31, 2023
845 Dec 13, 2022
8 Apr 25, 2022
113 Dec 27, 2022
0 Jul 28, 2022
1.7k Dec 24, 2022
36 Nov 29, 2022
3 Nov 24, 2022