Document the built in env var processors #9507

mcfedr · 2018-03-27T20:14:20Z

This is start at adding documentation for env var processors, e.g. %env(int:FOO)%

I would welcome some feedback, if this a appropriate way to go about this, I think it needs some more examples to show how its used.

It also would ideally add a description of how custom processors are added, although that might be a later request.

starts to fix #8382, #9094

javiereguiluz

@mcfedr thanks for working on this! It's a great feature and the docs you propose are very nice: concise and well explained!

javiereguiluz · 2018-03-28T09:08:31Z

configuration/external_parameters.rst

+
+A number of different types are supported:
+
+``env(string):FOO)``


Typo: should be env(string:FOO)

javiereguiluz · 2018-03-28T09:10:48Z

configuration/external_parameters.rst

+
+A number of different types are supported:
+
+``env(string):FOO)``


I'm not a big fan of using foo and bar in docs because I prefer to use more realistic examples. For example we could use ENV_VAR_NAME instead of FOO. But before making any change, let's wait for other opinions.

I think its a fair point, and more consistent with the style of the docs in general

javiereguiluz · 2018-03-28T09:13:41Z

configuration/external_parameters.rst

+``env(float:FOO)``
+    Casts ``FOO`` to an float
+
+``env(const:FOO)``


I think it'd be great to show a super simple example for each of these cases. Example:

``env(const:FOO)`` Finds the const value named in ``FOO`` (e.g. ``FOO=App\Config\UserConfig::FIREWALL_KEY``)

Yes, I agree,

I was wondering if its useful to show even something like

parameters: env(FOO): Some\Const framework: something: '%env(const:FOO)%'

javiereguiluz · 2018-05-23T12:49:55Z

@mcfedr will you have some time before this months end to finish this PR? This is a top priority feature and we'd like to end the docs soon. It's OK if you don't have time because we can take it over for you. Cheers!

mcfedr · 2018-05-24T17:22:00Z

I have added the extra examples that were missing originally. These mostly show examples of how it can be used.

I kept to the sections using env(FOO) because ENV_VAR_NAME seems confusing,

Anything you think is missing?

javiereguiluz · 2018-05-27T17:02:33Z

@mcfedr thanks a lot for documenting this great feature. The only missing thing is the XML and PHP versions of all the YAML config examples. That's pretty boring, so let's merge this "as is" and I've created #9831 to look for volunteers who help us with that.

…guiluz) This PR was merged into the master branch. Discussion ---------- Document the built in env var processors This is start at adding documentation for env var processors, e.g. `%env(int:FOO)%` I would welcome some feedback, if this a appropriate way to go about this, I think it needs some more examples to show how its used. It also would ideally add a description of how custom processors are added, although that might be a later request. starts to fix #8382, #9094 Commits ------- aed1607 Minor rewords and formatting fixes e3fe5fe Example of customer env var processor 67227a6 Add examples for parameter processors cd353c7 Add description of the built in envvar processors

…javiereguiluz) This PR was merged into the 3.4 branch. Discussion ---------- Document the built in env var processors This is start at adding documentation for env var processors, e.g. `%env(int:FOO)%` I would welcome some feedback, if this a appropriate way to go about this, I think it needs some more examples to show how its used. It also would ideally add a description of how custom processors are added, although that might be a later request. starts to fix symfony#8382, symfony#9094 Commits ------- aed1607 Minor rewords and formatting fixes e3fe5fe Example of customer env var processor 67227a6 Add examples for parameter processors cd353c7 Add description of the built in envvar processors

…mcfedr, javiereguiluz)" This reverts commit c98569d, reversing changes made to 2a76e88.

* 3.4: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

* 4.0: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

* 4.1: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

* 3.4: [#9507] remove csv processor, it was added in 4.1

* 4.0: [#9507] remove csv processor, it was added in 4.1

This reverts commit 50bddbd.

* 4.1: Fixed some wrong file paths Change code file location Fix typo for variable name Add link to configuration documentation Update upgrade_major.rst Add composer require symfony/webpack-encore-pack Reword the intro of a console article fix(Caution): Validator folder for YAML or XML format Fix the interface/abstract classes documentation Fix typo in Memcached adapter documentation [symfony#9507] add versionadded directive Revert "[symfony#9507] remove csv processor, it was added in 4.1" [symfony#9507] remove csv processor, it was added in 4.1

* 4.0: (24 commits) updating the guard session migration details for Symfony 3.4 changes Avoiding authentication on every request with Guard Minor typo in csrf.rst [Filesystem] Improved the code of an example Removed another usage of mt_rand() Transition from mt_rand to random_int Update setup.rst remove not existent label_attr options from buttons Fixed some code indentation Added the versionadded directive add missing XML and PHP code examples Expanded the explanation a bit Minor fixes Update licence hint for JMS serializer Revert "minor #9507 Document the built in env var processors (mcfedr, javiereguiluz)" Minor rewords and formatting fixes Example of customer env var processor Add examples for parameter processors Add description of the built in envvar processors Mention that "exclude" option now accepts arrays too ...

…mcfedr, javiereguiluz)" This reverts commit c98569d, reversing changes made to 2a76e88.

This reverts commit 50bddbd.

carsonbot added the Status: Needs Review label Mar 27, 2018

mcfedr changed the title ~~Add description of the built in envvar processors~~ [WIP] Add description of the built in envvar processors Mar 27, 2018

javiereguiluz reviewed Mar 28, 2018

View reviewed changes

xabbuh added this to the 3.4 milestone Apr 20, 2018

bobvandevijver mentioned this pull request May 4, 2018

[DI] Add select specific key from an array resolved env var documentation #9734

Closed

mcfedr added 2 commits May 24, 2018 20:16

Add description of the built in envvar processors

cd353c7

Add examples for parameter processors

67227a6

mcfedr force-pushed the env-var-processors branch from c904191 to af9448d Compare May 24, 2018 17:35

Example of customer env var processor

e3fe5fe

mcfedr force-pushed the env-var-processors branch from af9448d to e3fe5fe Compare May 24, 2018 17:38

Minor rewords and formatting fixes

aed1607

javiereguiluz changed the title ~~[WIP] Add description of the built in envvar processors~~ Document the built in env var processors May 27, 2018

javiereguiluz added Missing Documentation DependencyInjection Status: Reviewed and removed Status: Needs Review labels May 27, 2018

javiereguiluz mentioned this pull request May 27, 2018

Add XML and PHP to the YAML examples of env var processors #9831

Closed

javiereguiluz merged commit aed1607 into symfony:master May 27, 2018

This was referenced May 27, 2018

Update %env()% documentation #8382

Closed

[DependencyInjection] Add a simple CSV env var processor #9094

Closed

javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this pull request May 27, 2018

Revert "minor symfony#9507 Document the built in env var processors (…

4998d0a

…mcfedr, javiereguiluz)" This reverts commit c98569d, reversing changes made to 2a76e88.

javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this pull request May 27, 2018

Merge branch '3.4' into 4.0

8916422

* 3.4: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this pull request May 27, 2018

Merge branch '4.0' into 4.1

71ab3b0

* 4.0: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this pull request May 27, 2018

Merge branch '4.1'

ff23048

* 4.1: minor symfony#9507 Document the built in env var processors (mcfedr, javiereguiluz)

xabbuh added a commit that referenced this pull request Jun 2, 2018

[#9507] remove csv processor, it was added in 4.1

50bddbd

xabbuh added a commit that referenced this pull request Jun 2, 2018

Merge branch '3.4' into 4.0

cfb9084

* 3.4: [#9507] remove csv processor, it was added in 4.1

xabbuh added a commit that referenced this pull request Jun 2, 2018

Merge branch '4.0' into 4.1

b00d9d5

* 4.0: [#9507] remove csv processor, it was added in 4.1

xabbuh added a commit that referenced this pull request Jun 2, 2018

Revert "[#9507] remove csv processor, it was added in 4.1"

ee9ba3a

This reverts commit 50bddbd.

xabbuh added a commit that referenced this pull request Jun 2, 2018

[#9507] add versionadded directive

40c3c16

Guikingone pushed a commit to Guikingone/symfony-docs that referenced this pull request Feb 12, 2019

Revert "minor symfony#9507 Document the built in env var processors (…

d98cfbf

…mcfedr, javiereguiluz)" This reverts commit c98569d, reversing changes made to 2a76e88.

Guikingone pushed a commit to Guikingone/symfony-docs that referenced this pull request Feb 12, 2019

[symfony#9507] remove csv processor, it was added in 4.1

798ed24

Guikingone pushed a commit to Guikingone/symfony-docs that referenced this pull request Feb 12, 2019

Revert "[symfony#9507] remove csv processor, it was added in 4.1"

88bf5b2

This reverts commit 50bddbd.

Guikingone pushed a commit to Guikingone/symfony-docs that referenced this pull request Feb 12, 2019

[symfony#9507] add versionadded directive

75be7d0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the built in env var processors #9507

Document the built in env var processors #9507

mcfedr commented Mar 27, 2018 •

edited

Loading

javiereguiluz left a comment

javiereguiluz Mar 28, 2018 •

edited

Loading

javiereguiluz Mar 28, 2018

mcfedr Mar 28, 2018

javiereguiluz Mar 28, 2018 •

edited

Loading

mcfedr Mar 28, 2018

javiereguiluz commented May 23, 2018

mcfedr commented May 24, 2018 •

edited

Loading

javiereguiluz commented May 27, 2018


		A number of different types are supported:

		``env(string):FOO)``

Document the built in env var processors #9507

Document the built in env var processors #9507

Conversation

mcfedr commented Mar 27, 2018 • edited Loading

javiereguiluz left a comment

Choose a reason for hiding this comment

javiereguiluz Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

javiereguiluz Mar 28, 2018

Choose a reason for hiding this comment

mcfedr Mar 28, 2018

Choose a reason for hiding this comment

javiereguiluz Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

mcfedr Mar 28, 2018

Choose a reason for hiding this comment

javiereguiluz commented May 23, 2018

mcfedr commented May 24, 2018 • edited Loading

javiereguiluz commented May 27, 2018

mcfedr commented Mar 27, 2018 •

edited

Loading

javiereguiluz Mar 28, 2018 •

edited

Loading

javiereguiluz Mar 28, 2018 •

edited

Loading

mcfedr commented May 24, 2018 •

edited

Loading