Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,22 @@ All notable changes to this project will be documented in this file, in reverse

- Nothing.

## 1.4.1 - 2020-09-02

### Release Notes for [1.4.1](https://github.com/laminas/laminas-config-aggregator-parameters/milestone/2)

1.4.x bugfix release (patch)

### 1.4.1

- Total issues resolved: **0**
- Total pull requests resolved: **1**
- Total contributors: **1**

#### Documentation,Enhancement

- [5: Updates version hints, headline and line length in documentation](https://github.com/laminas/laminas-config-aggregator-parameters/pull/5) thanks to @froschdesign

## 1.4.0 - 2020-09-02

### Added
Expand Down
16 changes: 11 additions & 5 deletions docs/book/usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Usage
# Basic Usage

This package supplies a [laminas-config-aggregator post processor](https://docs.laminas.dev/laminas-config-aggregator/config-post-processors/)
that consumes the [Symfony DependencyInjection ParameterBag](https://symfony.com/doc/current/configuration/using_parameters_in_dic.html)
Expand All @@ -15,8 +15,9 @@ Parameters may be defined as nested associative arrays as well; in such cases, a
`.` character references an additional layer of hierarchy to dereference:
`%foo.bar%` refers to the paramter found at `'foo' => [ 'bar' => 'value' ]`.

> Starting in version 1.1.0, you can use parameters which reference other
> parameters as well.
> Available since version 1.1.0

Parameters which reference other parameters can also be used.

If you wish to use a literal `%name%` within your configuration, you **must**
double-escape the percentage signs: `%%name%%`. Failure to do so will result in
Expand Down Expand Up @@ -86,6 +87,11 @@ array(5) {

## Parameter Lazy Loading

If your parameters are resolved from a database, redis, consul, or any other i/o resource, you can use the `LazyParameterPostProcessor` which consumes just a `callable` which can provide the parameters.
> Available since version 1.4.0

If your parameters are resolved from a database, redis, consul, or any other i/o
resource, you can use the `LazyParameterPostProcessor` which consumes just a
`callable` which can provide the parameters.

In case you are using config-caching, the i/o is not executed when performed in the `callable`.
In case you are using config-caching, the i/o is not executed when performed in
the `callable`.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ docs_dir: docs/book
site_dir: docs/html
nav:
- Home: index.md
- Usage: usage.md
- Basic Usage: usage.md
site_description: 'PostProcessor extension for laminas/laminas-config-aggregator to allow usage of templated parameters within your configuration'
repo_url: 'https://github.com/laminas/laminas-config-aggregator-parameters'
extra:
Expand Down