Symfony Best Practices typos and errors

[javiereguiluz]

In a few days we are going to add the "Best Practices" book to the symfony-docs repo. That's why it will be great to collect in this issue the typos and errors found by the community. We are not talking (yet) about discussing best practices, but about actual and objective errors.

[javiereguiluz]

Don't recommend to use parameter classes for third-party bundles. Reported by @stof via Twitter

UPDATE: This error has been already fixed

[javiereguiluz]

Listing 5-5: use $postSlug instead of $slug in: ->findOneBy(array('slug' => $slug));. Reported by @aitboudad via Twitter

UPDATE: This error has been already fixed

[javiereguiluz]

Typo page 17: "You may have have noticed". Reported by @aitboudad via Twitter

UPDATE: This error has been already fixed

[cordoval]

number the suggestions on the guide

[javiereguiluz]

@cordoval very nice suggestion! @wouterj made it to us earlier and I think it will be nice to have the complete listing of all best-practices.

[cordoval]

"that are used as services are good examples of business logic stuff." try to avoid stuff 👶

[cordoval]

"meant to be shared, then you may define parameters But if you're developing a service for your own" missing period

worth perhaps mentioning to avoid this usage as it will be deprecated in next versions, so not really a practice or an option imo

[cordoval]

http://elnur.pro/symfony-without-bundles/
http://php-and-symfony.matthiasnoback.nl/2014/06/don-t-use-annotations-in-your-controllers/

the use of annotations is very contested "Annotations are by far the most convenient and agile way of setting up and looking for mapping" then later you say it is a matter of taste, maybe doing the "if you are advanced" would be more correct.

but again not focusing on the practices just typos, i mean to have a uniform phrasing here to be consistent with how it is being done in the previous suggestions

[cordoval]

1 $ composer require "doctrine/doctrine-fixtures-bundle":"~2"

can be just

1 $ composer require "doctrine/doctrine-fixtures-bundle"

and composer will find the latest on its own

[cordoval]

"Pre and Post Hooks" is very short, i know the cookbook details most of it, but it does not elaborate on simple use cases where this can be needed or why one would want those. Maybe just mentioning something like "this is used for example when one wants to ascertain authorization of some kind or something"...

[javiereguiluz]

Reword the reasoning of the recommendation of not using @Template() annotation. Reported by @aitboudad via Twitter

[javiereguiluz]

It should be parameters.yml.dist and not parameters.dist.yml. Reported by @Baptouuuu via Twitter

[cordoval]

introduce the word "smoke tests" which i think the "functional tests" referred rather are, i do this in projects but contrary to this i get the routes from the router and eliminate some routes via a blacklist

[javiereguiluz]

---

UPDATE All the errors reported previously to this comment, are now fixed. They will appear in the new document published in the coming days. Please, keep reporting typos and errors.

---

[weaverryan]

@javiereguiluz on the main page /best-practices page, we should clearly define that these are for non-reused bundles. I got feedback on Twitter that someone hadn't seen that - they suggested a <blink> tag ;)