eye4web / zf2-site-config
Site-configuration module for Zend Framework 2
Installs: 21 888
Dependents: 1
Suggesters: 0
Security: 0
Stars: 7
Watchers: 7
Forks: 4
Open Issues: 0
Requires
- php: >=5.5
- ocramius/proxy-manager: ~1.0|~2.0
- zendframework/zend-config: ~2.3|~3.0
- zendframework/zend-servicemanager: ~2.3|~3.0
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- container-interop/container-interop: ^1.1
- phpunit/phpunit: 4.*
- ramsey/uuid: 2.7.3
- squizlabs/php_codesniffer: 1.5.*
- zendframework/zend-captcha: ~2.1
- zendframework/zendframework: ~2.3
This package is not auto-updated.
Last update: 2024-12-19 16:47:25 UTC
README
Introduction
This modules allows you to easily get site config in all of your files. The module can, out-of-the-box, read config values from the following:
- DoctrineORM
- Files(supported by
\Zend\Config\Reader
)- ini
- json
- xml
- yaml
- javaproperties
- php array
Note: This module does not help you write the config, you have to take care of that yourself.
Installation
-
Run the followng composer command:
$ composer require eye4web/zf2-site-config:dev-master
-
Enable it in your
application.config.php
file.<?php return array( 'modules' => array( // ... 'Eye4web\SiteConfig' ), // ... );
-
Copy
config/eye4web.siteconfig.global.php.dist
toconfig/autoload/eye4web.siteconfig.global.php
-
Edit the config to fit your needs
Usage
It is very easy to get config values, anywhere in your files.
View
To get a config value in a view-file(or layout): $this->siteConfig($configKey, $default)
$default
is optional
Controller
To get a config value in a controller: $this->siteConfig($configKey, $default)
$default
is optional
Any file from service-manager
This module comes with an initializer, so to get the SiteConfigService
into a file, all you have to do is
- Make your file implement
Eye4web\SiteConfig\Service\SiteConfigAwareInterface
- Use the trait
Eye4web\SiteConfig\Service\SiteConfigAwareTrait
namespace YourModule\Service; use Eye4web\SiteConfig\Service\SiteConfigAwareTrait; use Eye4web\SiteConfig\Service\SiteConfigAwareInterface; class YourAwesomeService implements SiteConfigAwareInterface { use SiteConfigAwareTrait; }
- Now you can do
$this->getSiteConfigService()->get($configKey, $default)
,$default
is optional
Configuration
See config/eye4web.siteconfig.global.php.dist
for configurable values
Readers
The modules supports many different readers, by deault it uses DoctrineORMReader
DoctrineORM
This reader reads config values from your database. This module is setup to use DoctrineORM by default, so all you have to do is
- Create schema
- Use the doctrine script:
php ./vendor/bin/doctrine-module orm:schema-tool:update --force
or - Create the table yourself, see
data/sql
folder for schema
- Use the doctrine script:
- Add your config values to the database. You only have to fill
key
andvalue
, the rest of the fields are just convenience fields
Files
This module uses Zend\Config
to read config from files. It can read config from the following file types:
- ini
- json
- xml
- yaml
- javaproperties
- php array
To read config from a file, all you have to do is:
- Create your file and add your config values
- Edit
eye4web.siteconfig.global.php
and set the path to your config file
You can read config from a single file, but you can also read from multiple files, just use an array of file names instead of a single string
Create-your-own
It is very easy to create your own reader, just follow these steps:
- Create your reader. It must implement
Eye4web\SiteConfig\Reader\ReaderInterface
- Add your reader to the service-manager
- Edit
eye4web.siteconfig.global.php
and set the name of your reader - Make a pull-request so others can benefit from your reader ;)