symfony/symfony-docsPublic

NotificationsYou must be signed in to change notification settings
Fork5.3k
Star2.3k

Commit4712b10

committed

bug#6490 Revert "minor#6479 Update php.rst (carlos-granados)" (WouterJ)

This PR was merged into the 2.3 branch.Discussion----------Revert "minor#6479 Update php.rst (carlos-granados)"This reverts commitfefc8a0, reversingchanges made to7819f9e.I messed up badly yesterday evening. This should make things good again. Please review if you have time (I'll merge it later this afternoon).Commits-------5adc91c Revert "minor#6479 Update php.rst (carlos-granados)"

2 parents1653948 +5adc91c commit4712b10Copy full SHA for 4712b10

File tree

406 files changed

+5728

-17256

lines changed

best_practices
book
changelog.rst
components
- asset
  - index.rst
  - introduction.rst
- class_loader
  - cache_class_loader.rst
  - class_loader.rst
  - debug_class_loader.rst
  - index.rst
  - introduction.rst
  - psr4_class_loader.rst
- config
  - definition.rst
- console
  - changing_default_command.rst
  - events.rst
  - helpers
  - index.rst
  - introduction.rst
  - logger.rst
- css_selector.rst
- debug.rst
- debug
  - class_loader.rst
  - index.rst
- dependency_injection
  - advanced.rst
  - autowiring.rst
  - compilation.rst
  - factories.rst
  - index.rst
  - lazy_services.rst
  - parentservices.rst
  - tags.rst
- dom_crawler.rst
- event_dispatcher
  - immutable_dispatcher.rst
  - introduction.rst
  - traceable_dispatcher.rst
- expression_language
  - caching.rst
  - extending.rst
  - index.rst
  - introduction.rst
  - syntax.rst
- filesystem.rst
- filesystem
  - index.rst
  - lock_handler.rst
- finder.rst
- form
  - form_events.rst
  - introduction.rst
  - type_guesser.rst
- http_foundation
  - introduction.rst
  - trusting_proxies.rst
- http_kernel
  - introduction.rst
- index.rst
- intl.rst
- map.rst.inc
- options_resolver.rst
- phpunit_bridge.rst
- process.rst
- property_access
  - introduction.rst
- routing
  - hostname_pattern.rst
  - introduction.rst
- security
  - authentication.rst
  - authorization.rst
  - firewall.rst
  - introduction.rst
  - secure_tools.rst
- serializer.rst
- stopwatch.rst
- templating/helpers
  - assetshelper.rst
- translation
  - custom_formats.rst
  - introduction.rst
  - usage.rst
- var_dumper
  - advanced.rst
  - index.rst
  - introduction.rst
- yaml
  - introduction.rst
contributing
- code
- documentation
  - standards.rst
cookbook
create_framework
images
- book
- components
- cookbook/controller/error_pages
  - exceptions-in-dev-environment.png
- quick_tour
- reference/form
quick_tour
- the_architecture.rst
redirection_map
reference

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

406 files changed

+5728

-17256

lines changed

`‎best_practices/business-logic.rst‎`

Lines changed: 1 addition & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,6 @@ Inside here, you can create whatever directories you want to organize things:`
`21`	`21`	`│ └─ AppBundle/`
`22`	`22`	`│ └─ Utils/`
`23`	`23`	`│ └─ MyClass.php`
`24`		`- ├─ tests/`
`25`		`- ├─ var/`
`26`	`24`	`├─ vendor/`
`27`	`25`	`└─ web/`
`28`	`26`
`@@ -42,8 +40,6 @@ and put things there:`
`42`	`40`	`│ │ └─ Utils/`
`43`	`41`	`│ │ └─ MyClass.php`
`44`	`42`	`│ └─ AppBundle/`
`45`		`- ├─ tests/`
`46`		`- ├─ var/`
`47`	`43`	`├─ vendor/`
`48`	`44`	`└─ web/`
`49`	`45`
`@@ -322,7 +318,7 @@ command:`
`322`	`318`
`323`	`319`	`..code-block::bash`
`324`	`320`
`325`		`- $ phpbin/console doctrine:fixtures:load`
	`321`	`+ $ phpapp/console doctrine:fixtures:load`
`326`	`322`
`327`	`323`	`Careful, database will be purged. Do you want tocontinue Y/N? Y`
`328`	`324`	`> purging database`

`‎best_practices/configuration.rst‎`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,8 @@ Canonical Parameters`
`52`	`52`	`Define all your application's parameters in the`
`53`	`53`	``app/config/parameters.yml.dist`` file.
`54`	`54`
`55`		-Symfony includes a configuration file called ``parameters.yml.dist``, which
`56`		`-stores the canonical list of configuration parameters for the application.`
	`55`	+Since version 2.3,Symfony includes a configuration file called ``parameters.yml.dist``,
	`56`	`+whichstores the canonical list of configuration parameters for the application.`
`57`	`57`
`58`	`58`	`Whenever a new configuration parameter is defined for the application, you`
`59`	`59`	`should also add it to this file and submit the changes to your version control`

`‎best_practices/creating-the-project.rst‎`

Lines changed: 33 additions & 23 deletions

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ to create files and execute the following commands:`
`27`	`27`
`28`	`28`	`..code-block::bash`
`29`	`29`
	`30`	`+# Linux, Mac OS X`
`30`	`31`	`$cd projects/`
`31`	`32`	`$ symfony new blog`
`32`	`33`
`@@ -62,35 +63,27 @@ number of files and directories generated automatically:`
`62`	`63`
`63`	`64`	`blog/`
`64`	`65`	`├─ app/`
	`66`	`+ │ ├─ console`
	`67`	`+ │ ├─ cache/`
`65`	`68`	`│ ├─ config/`
	`69`	`+ │ ├─ logs/`
`66`	`70`	`│ └─ Resources/`
`67`		`- ├─ bin`
`68`		`- │ └─ console`
`69`	`71`	`├─ src/`
`70`	`72`	`│ └─ AppBundle/`
`71`		`- ├─ var/`
`72`		`- │ ├─ cache/`
`73`		`- │ ├─ logs/`
`74`		`- │ └─ sessions/`
`75`		`- ├─ tests/`
`76`		`- │ └─ AppBundle/`
`77`	`73`	`├─ vendor/`
`78`	`74`	`└─ web/`
`79`	`75`
`80`	`76`	`This file and directory hierarchy is the convention proposed by Symfony to`
`81`	`77`	`structure your applications. The recommended purpose of each directory is the`
`82`	`78`	`following:`
`83`	`79`
	`80`	+* ``app/cache/``, stores all the cache files generated by the application;
`84`	`81`	* ``app/config/``, stores all the configuration defined for any environment;
	`82`	+* ``app/logs/``, stores all the log files generated by the application;
`85`	`83`	* ``app/Resources/``, stores all the templates and the translation files for the
`86`	`84`	`application;`
`87`	`85`	* ``src/AppBundle/``, stores the Symfony specific code (controllers and routes),
`88`	`86`	`your domain code (e.g. Doctrine classes) and all your business logic;`
`89`		-* ``var/cache/``, stores all the cache files generated by the application;
`90`		-* ``var/logs/``, stores all the log files generated by the application;
`91`		-* ``var/sessions/``, stores all the session files generated by the application;
`92`		-* ``tests/AppBundle/``, stores the automatic tests (e.g. Unit tests) of the
`93`		`- application.`
`94`	`87`	* ``vendor/``, this is the directory where Composer installs the application's
`95`	`88`	`dependencies and you should never modify any of its contents;`
`96`	`89`	* ``web/``, stores all the front controller files and all the web assets, such
`@@ -114,7 +107,8 @@ ProductBundle, then there's no advantage to having two separate bundles.`
`114`	`107`	`Create only one bundle called AppBundle for your application logic.`
`115`	`108`
`116`	`109`	`Implementing a single AppBundle bundle in your projects will make your code`
`117`		`-more concise and easier to understand.`
	`110`	`+more concise and easier to understand. Starting in Symfony 2.6, the official`
	`111`	`+Symfony documentation uses the AppBundle name.`
`118`	`112`
`119`	`113`	`..note::`
`120`	`114`
`@@ -134,18 +128,13 @@ that follows these best practices:`
`134`	`128`
`135`	`129`	`blog/`
`136`	`130`	`├─ app/`
	`131`	`+ │ ├─ console`
	`132`	`+ │ ├─ cache/`
`137`	`133`	`│ ├─ config/`
	`134`	`+ │ ├─ logs/`
`138`	`135`	`│ └─ Resources/`
`139`		`- ├─ bin/`
`140`		`- │ └─ console`
`141`	`136`	`├─ src/`
`142`	`137`	`│ └─ AppBundle/`
`143`		`- ├─ tests/`
`144`		`- │ └─ AppBundle/`
`145`		`- ├─ var/`
`146`		`- │ ├─ cache/`
`147`		`- │ ├─ logs/`
`148`		`- └─ sessions/`
`149`	`138`	`├─ vendor/`
`150`	`139`	`└─ web/`
`151`	`140`	`├─ app.php`
`@@ -158,7 +147,7 @@ that follows these best practices:`
`158`	`147`
`159`	`148`	`..code-block::bash`
`160`	`149`
`161`		`- $ phpbin/console generate:bundle --namespace=AppBundle --dir=src --format=annotation --no-interaction`
	`150`	`+ $ phpapp/console generate:bundle --namespace=AppBundle --dir=src --format=annotation --no-interaction`
`162`	`151`
`163`	`152`	`Extending the Directory Structure`
`164`	`153`	`---------------------------------`
`@@ -168,6 +157,27 @@ structure of Symfony, you can`
`168`	`157`	:doc:`override the location of the main directories</cookbook/configuration/override_dir_structure>`:
`169`	`158`	``cache/``, ``logs/`` and ``web/``.
`170`	`159`
	`160`	`+In addition, Symfony3 will use a slightly different directory structure when`
	`161`	`+it's released:`
	`162`	`+`
	`163`	`+..code-block::text`
	`164`	`+`
	`165`	`+ blog-symfony3/`
	`166`	`+ ├─ app/`
	`167`	`+ │ ├─ config/`
	`168`	`+ │ └─ Resources/`
	`169`	`+ ├─ bin/`
	`170`	`+ │ └─ console`
	`171`	`+ ├─ src/`
	`172`	`+ ├─ var/`
	`173`	`+ │ ├─ cache/`
	`174`	`+ │ └─ logs/`
	`175`	`+ ├─ vendor/`
	`176`	`+ └─ web/`
	`177`	`+`
	`178`	`+The changes are pretty superficial, but for now, we recommend that you use`
	`179`	`+the Symfony directory structure.`
	`180`	`+`
`171`	`181`	.. _`Composer`:https://getcomposer.org/
`172`	`182`	.. _`Phar extension`:http://php.net/manual/en/intro.phar.php
`173`	`183`	.. _`public checksums repository`:https://github.com/sensiolabs/checksums

`‎best_practices/forms.rst‎`

Lines changed: 44 additions & 22 deletions

Original file line number	Diff line number	Diff line change
`@@ -21,38 +21,40 @@ form in its own PHP class::`
`21`	`21`
`22`	`22`	`use Symfony\Component\Form\AbstractType;`
`23`	`23`	`use Symfony\Component\Form\FormBuilderInterface;`
`24`		`- use Symfony\Component\OptionsResolver\OptionsResolver;`
`25`		`- use Symfony\Component\Form\Extension\Core\Type\TextareaType;`
`26`		`- use Symfony\Component\Form\Extension\Core\Type\EmailType;`
`27`		`- use Symfony\Component\Form\Extension\Core\Type\DateTimeType;`
	`24`	`+ use Symfony\Component\OptionsResolver\OptionsResolverInterface;`
`28`	`25`
`29`	`26`	`class PostType extends AbstractType`
`30`	`27`	`{`
`31`	`28`	`public function buildForm(FormBuilderInterface $builder, array $options)`
`32`	`29`	`{`
`33`	`30`	`$builder`
`34`	`31`	`->add('title')`
`35`		`- ->add('summary',TextareaType::class)`
`36`		`- ->add('content',TextareaType::class)`
`37`		`- ->add('authorEmail',EmailType::class)`
`38`		`- ->add('publishedAt',DateTimeType::class)`
	`32`	`+ ->add('summary','textarea')`
	`33`	`+ ->add('content','textarea')`
	`34`	`+ ->add('authorEmail','email')`
	`35`	`+ ->add('publishedAt','datetime')`
`39`	`36`	`;`
`40`	`37`	`}`
`41`	`38`
`42`		`- public functionconfigureOptions(OptionsResolver $resolver)`
	`39`	`+ public functionsetDefaultOptions(OptionsResolverInterface $resolver)`
`43`	`40`	`{`
`44`	`41`	`$resolver->setDefaults(array(`
`45`	`42`	`'data_class' => 'AppBundle\Entity\Post'`
`46`	`43`	`));`
`47`	`44`	`}`
	`45`	`+`
	`46`	`+ public function getName()`
	`47`	`+ {`
	`48`	`+ return 'post';`
	`49`	`+ }`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`..best-practice::`
`51`	`53`
`52`	`54`	Put the form type classes in the ``AppBundle\Form`` namespace, unless you
`53`	`55`	`use other custom form classes like data transformers.`
`54`	`56`
`55`		-To use the class, use ``createForm()`` andpass thefully qualifiedclass name::
	`57`	+To use the class, use ``createForm()`` andinstantiate thenewclass::
`56`	`58`
`57`	`59`	`// ...`
`58`	`60`	`use AppBundle\Form\PostType;`
@@ -61,7 +63,7 @@ To use the class, use ``createForm()`` and pass the fully qualified class name::
`61`	`63`	`public function newAction(Request $request)`
`62`	`64`	`{`
`63`	`65`	`$post = new Post();`
`64`		`- $form = $this->createForm(PostType::class, $post);`
	`66`	`+ $form = $this->createForm(newPostType(), $post);`
`65`	`67`
`66`	`68`	`// ...`
`67`	`69`	`}`
`@@ -71,9 +73,13 @@ Registering Forms as Services`
`71`	`73`
`72`	`74`	`You can also`
`73`	`75`	:ref:`register your form type as a service<form-cookbook-form-field-service>`.
`74`		`-This is only needed if your form type requires some dependencies to be injected`
`75`		`-by the container, otherwise it is unnecessary overhead and therefore not`
`76`		`-recommended to do this for all form type classes.`
	`76`	`+But this is not recommended unless you plan to reuse the new form type in many`
	`77`	`+places or embed it in other forms directly or via the`
	`78`	+:doc:`collection type</reference/forms/types/collection>`.
	`79`	`+`
	`80`	`+For most forms that are used only to edit or create something, registering`
	`81`	`+the form as a service is over-kill, and makes it more difficult to figure`
	`82`	`+out exactly which form class is being used in a controller.`
`77`	`83`
`78`	`84`	`Form Button Configuration`
`79`	`85`	`-------------------------`
`@@ -85,10 +91,9 @@ makes them easier to re-use later.`
`85`	`91`
`86`	`92`	`Add buttons in the templates, not in the form classes or the controllers.`
`87`	`93`
`88`		`-The Symfony Form component allows you to add buttons as fields on your form.`
`89`		`-This is a nice way to simplify the template that renders your form. But if you`
`90`		`-add the buttons directly in your form class, this would effectively limit the`
`91`		`-scope of that form:`
	`94`	`+Since Symfony 2.3, you can add buttons as fields on your form. This is a nice`
	`95`	`+way to simplify the template that renders your form. But if you add the buttons`
	`96`	`+directly in your form class, this would effectively limit the scope of that form:`
`92`	`97`
`93`	`98`	`..code-block::php`
`94`	`99`
`@@ -98,7 +103,7 @@ scope of that form:`
`98`	`103`	`{`
`99`	`104`	`$builder`
`100`	`105`	`// ...`
`101`		`- ->add('save',SubmitType::class, array('label' => 'Create Post'))`
	`106`	`+ ->add('save','submit', array('label' => 'Create Post'))`
`102`	`107`	`;`
`103`	`108`	`}`
`104`	`109`
`@@ -113,7 +118,6 @@ some developers configure form buttons in the controller::`
`113`	`118`
`114`	`119`	`use Symfony\Component\HttpFoundation\Request;`
`115`	`120`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`116`		`- use Symfony\Component\Form\Extension\Core\Type\SubmitType;`
`117`	`121`	`use AppBundle\Entity\Post;`
`118`	`122`	`use AppBundle\Form\PostType;`
`119`	`123`
`@@ -124,8 +128,8 @@ some developers configure form buttons in the controller::`
`124`	`128`	`public function newAction(Request $request)`
`125`	`129`	`{`
`126`	`130`	`$post = new Post();`
`127`		`- $form = $this->createForm(PostType::class, $post);`
`128`		`- $form->add('submit',SubmitType::class, array(`
	`131`	`+ $form = $this->createForm(newPostType(), $post);`
	`132`	`+ $form->add('submit','submit', array(`
`129`	`133`	`'label' => 'Create',`
`130`	`134`	`'attr' => array('class' => 'btn btn-default pull-right')`
`131`	`135`	`));`
@@ -209,3 +213,21 @@ Second, we recommend using ``$form->isSubmitted()`` in the ``if`` statement
`209`	`213`	for clarity. This isn't technically needed, since ``isValid()`` first calls
`210`	`214`	``isSubmitted()``. But without this, the flow doesn't read well as it looks
`211`	`215`	`like the form is always processed (even on the GET request).`
	`216`	`+`
	`217`	`+Custom Form Field Types`
	`218`	`+-----------------------`
	`219`	`+`
	`220`	`+..best-practice::`
	`221`	`+`
	`222`	+ Add the ``app_`` prefix to your custom form field types to avoid collisions.
	`223`	`+`
	`224`	+Custom form field types inherit from the ``AbstractType`` class, which defines the
	`225`	+``getName()`` method to configure the name of that form type. These names must
	`226`	`+be unique in the application.`
	`227`	`+`
	`228`	`+If a custom form type uses the same name as any of the Symfony's built-in form`
	`229`	`+types, it will override it. The same happens when the custom form type matches`
	`230`	`+any of the types defined by the third-party bundles installed in your application.`
	`231`	`+`
	`232`	+Add the ``app_`` prefix to your custom form field types to avoid name collisions
	`233`	`+that can lead to hard to debug errors.`

`‎best_practices/i18n.rst‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -32,9 +32,9 @@ Of all the available translation formats, only XLIFF and gettext have broad`
`32`	`32`	`support in the tools used by professional translators. And since it's based`
`33`	`33`	`on XML, you can validate XLIFF file contents as you write them.`
`34`	`34`
`35`		`-Symfonysupportsnotesin XLIFF files, making them more user-friendly for`
`36`		`-translators. At the end, good translations are all about context, and these`
`37`		`-XLIFF notes allow you to define that context.`
	`35`	`+Symfony2.6 added support fornotesinside XLIFF files, making them more`
	`36`	`+user-friendly fortranslators. At the end, good translations are all about`
	`37`	`+context, and theseXLIFF notes allow you to define that context.`
`38`	`38`
`39`	`39`	`..tip::`
`40`	`40`

`‎best_practices/introduction.rst‎`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -76,8 +76,12 @@ installer and then execute this command to download the demo application:`
`76`	`76`
`77`	`77`	`..code-block::bash`
`78`	`78`
	`79`	`+# Linux and Mac OS X`
`79`	`80`	`$ symfony demo`
`80`	`81`
	`82`	`+# Windows`
	`83`	`+ c:\> php symfony demo`
	`84`	`+`
`81`	`85`	`The demo application is a simple blog engine, because that will allow us to`
`82`	`86`	`focus on the Symfony concepts and features without getting buried in difficult`
`83`	`87`	`implementation details. Instead of developing the application step by step in`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit4712b10

File tree

406 files changed

Some content is hidden

406 files changed

`‎best_practices/business-logic.rst‎`

`‎best_practices/configuration.rst‎`

`‎best_practices/creating-the-project.rst‎`

`‎best_practices/forms.rst‎`

`‎best_practices/i18n.rst‎`

`‎best_practices/introduction.rst‎`

0 commit comments