Global dump

[nicolas-grekas]

Q	A
Doc fix?	no
New docs?	yes
Applies to	all
Fixed tickets	-

[wouterj]

I think it's more clear to put this in a step list:

.. tip::

    In order to have to ``dump()`` function always available, you can install
    it globally in your dev environment:

    #. Run ``composer global require symfony/var-dumper``;
    #. Add ``auto_prepend_file = ${HOME}/.composer/vendor/autoload.php``
       to your ``php.ini`` file;
    #. (Don't forget to run ``composer global update`` from time to time to always
       have the latest bug fixes.)

[nicolas-grekas]

Fixed, thanks

[xabbuh]

Does PHP interpret environment variables in the php.ini file? What happens when the file doesn't exist?

[nicolas-grekas]

1. Yes it does: http://php.net/manual/en/configuration.file.php
2. A fatal error

[xabbuh]

Should we add a warning then? Otherwise, people could get these errors when they execute PHP scripts with different users.

[nicolas-grekas]

I think the error message is good enough to not clutter the doc, what do you think?

[xabbuh]

I'm not sure. Will each and every beginner really understand that a global Composer installation is only global in regard of their user account? We should keep in mind that the web server might not be the same account as the one the developer is using.

[wouterj]

Looks like a very nice tip to add to the documentation! :)

[lyrixx]

👍

[javiereguiluz]

The phrase ... in your dev environment may sound confusing. This has nothing to do with the dev environment of Symfony applications. I would replace it by:

In order to have the ``dump()`` function available for any PHP script or application and not only for 
your Symfony applications, you can install it globally in your machine:

[wouterj]

I do agree with you, but I also don't like the verbose thing you proposed. The docs are always a fight between making something easy to understand and keeping something as short as possible (especially when it's about simple tips like this).

What do you think about replacing "environment" with "machine" or "box"?

[javiereguiluz]

It's true that my proposal is more verbose, but I think it explains the purpose of the tip better.

In the original text, what does "to have the function always available" mean? That's why I prefer to say explicitly that this is referring to using it outside Symfony applications.

And the same for dev environment or dev box. Prefer to say your machine, your computer, your local machine, etc.

[nicolas-grekas]

Thanks for the comments guys, PR updated. Ok for you?

[stof]

I see an issue with this proposal: the composer global project can contain lots of other stuff as well, which might create issues in your project. To do it in a safe way, you should do a composer installation where you only have the var-dumper component

[wouterj]

@javiereguiluz and I concluded to put this after the list (not as a list item). If you agree, could you please do that? (I hope it's the last fix, as you've had to push way to many times for a simple tip like this)

[nicolas-grekas]

I prefer it with a 3d item (I talked last with @javiereguiluz offline, so I win ;-) )

[wouterj]

Okay, you won. 👍 then :)

[wouterj]

@stof that's exactly what I was thinking. Or maybe we have to recommend to add $HOME/.composer/vendor/symfony/var-dumper/Resources/functions/dump.php as auto prepend file.

(or create a custom auto prepend file in the PHP dir which requires this one)

[nicolas-grekas]

@stof lets document an easy way for new comers. Advanced users that know what they do with composer will find their way. New comers won't have many "composer global" things (it's not a very common thing, or you're an advanced user).
This just works (c)

[nicolas-grekas]

For the reader wondering about autoloading precedence, global classes are always looked up after project classes. So, the project always takes precedence.

[Pierstoval]

Absolutely awesome, I've just installed it and it works like a charm, this is REALLY great ! :)

[weaverryan]

@nicolas-grekas how did you know that I was wondering about autoloading precedence? :) Because of that, I like this.

Thanks!