Skip to content

Commit ae5e762

Browse files
committed
Readme: clarify autoconfiguration [#99]
1 parent 8ee6465 commit ae5e762

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.docs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Integration of [Doctrine ORM](https://www.doctrine-project.org/projects/orm.html
88
- [Configuration](#configuration)
99
- [Minimal configuration](#minimal-configuration)
1010
- [Advanced configuration](#advanced-configuration)
11+
- [Auto configuration](#auto-configuration)
1112
- [Caching](#caching)
1213
- [Mapping](#mapping)
1314
- [Attributes](#attributes)
@@ -139,6 +140,18 @@ nettrine.orm:
139140
> [!TIP]
140141
> Take a look at real **Nettrine ORM** configuration example at [contributte/doctrine-project](https://github.com/contributte/doctrine-project/blob/f226bcf46b9bcce2f68961769a02e507936e4682/config/config.neon).
141142
143+
### Auto configuration
144+
145+
By default, this extension will try to autoconfigure itself.
146+
147+
- **proxyDir**: `%tempDir%/proxies`, if `%tempDir%` is not defined,, you have to define it manually.
148+
- **autoGenerateProxyClasses**: `%debugMode%`, if `%debugMode%` is not defined, you have to define it manually.
149+
- `0` means that the proxy classes must be generated manually.
150+
- `1` means that the proxy classes are generated automatically.
151+
- `2` means that the proxy classes are generated automatically when the proxy file does not exist.
152+
- `3` means that the proxy classes are generated automatically using `eval()` (useful for debugging).
153+
- `4` means that the proxy classes are generated automatically when the proxy file does not exist or when the proxied file changed.
154+
142155
### Caching
143156

144157
> [!TIP]

0 commit comments

Comments
 (0)