Skip to content

Commit 8c32e1a

Browse files
committed
#226 - document base path for file loading
1 parent eba1c0f commit 8c32e1a

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/content/anonymization/core-anonymizers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ This page list all *Anonymizers* provided by *DbToolsBundle*.
1919
<!--@include: ./core-anonymizers/lorem-ipsum.md-->
2020
<!--@include: ./core-anonymizers/address.md-->
2121
<!--@include: ./core-anonymizers/iban-bic.md-->
22+
<!--@include: ./core-anonymizers/file-resolution.md-->
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## File name resolution
2+
3+
In various places you can configure relative file names in order to load data,
4+
here is how relative file names are resolved.
5+
**All relative file names will be considered relative to a given _base path_.**
6+
7+
The default base path is always stable but depends upon your selected flavor.
8+
9+
@todo examples
10+
11+
@@@ symfony
12+
13+
When parsing Symfony configuration, base path will always be the project
14+
directory, known as `%kernel.project_dir%` variable in Symfony configuration.
15+
This is the directory where your `composer.json` file.
16+
17+
@todo examples
18+
19+
@@@
20+
@@@ laravel
21+
22+
When parsing Laravel configuration, base path will always be the project
23+
directory, as returned by the `base_path()` Laravel function.
24+
25+
@todo examples
26+
27+
@@@
28+
@@@ standalone docker
29+
30+
When parsing configuration in the standalone CLI version or in docker context,
31+
base path will be currently being parsed Yaml file.
32+
33+
:::tip
34+
If you set the `workdir` option in your configuration file, then it will
35+
override the file directory and use it as the base path.
36+
37+
@todo link to `workdir` documentation
38+
:::
39+
@@@

0 commit comments

Comments
 (0)