symfony/symfony-docsPublic

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

Commit682562a

committed

No contraction

1 parentc7463b2 commit682562aCopy full SHA for 682562a

File tree

286 files changed

+1214

-1213

lines changed

.doctor-rst.yaml
_build
- maintainer_guide.rst
_includes
- _annotation_loader_tip.rst.inc
- _rewrite_rule_tip.rst.inc
best_practices.rst
bundles.rst
bundles
- best_practices.rst
- configuration.rst
- extension.rst
- override.rst
- prepend_extension.rst
cache.rst
components
- asset.rst
- browser_kit.rst
- cache.rst
- cache
  - adapters
  - cache_items.rst
  - cache_pools.rst
  - psr6_psr16_adapters.rst
- config
  - definition.rst
- console
  - helpers
  - usage.rst
- css_selector.rst
- dependency_injection
  - compilation.rst
- dom_crawler.rst
- event_dispatcher.rst
- event_dispatcher
  - immutable_dispatcher.rst
- expression_language.rst
- filesystem.rst
- finder.rst
- form.rst
- http_foundation.rst
- http_kernel.rst
- lock.rst
- messenger.rst
- mime.rst
- options_resolver.rst
- phpunit_bridge.rst
- process.rst
- property_info.rst
- runtime.rst
- serializer.rst
- string.rst
- uid.rst
- using_components.rst
- validator.rst
- validator
  - resources.rst
- var_dumper.rst
- yaml.rst
configuration.rst
configuration
- env_var_processors.rst
- front_controllers_and_kernel.rst
- micro_kernel_trait.rst
- multiple_kernels.rst
- override_dir_structure.rst
- secrets.rst
console.rst
console
- coloring.rst
- commands_as_services.rst
- input.rst
- style.rst
contributing
- code_of_conduct
  - reporting_guidelines.rst
- code
- community
  - releases.rst
  - review-comments.rst
- documentation
  - index.rst
  - overview.rst
controller.rst
controller
- argument_value_resolver.rst
- error_pages.rst
- service.rst
- soap_web_service.rst
- upload_file.rst
create_framework
- dependency_injection.rst
- http_foundation.rst
- http_kernel_controller_resolver.rst
- http_kernel_httpkernelinterface.rst
- introduction.rst
- templating.rst
deployment.rst
deployment
- proxies.rst
doctrine.rst
doctrine
- associations.rst
- custom_dql_functions.rst
- dbal.rst
- events.rst
- multiple_entity_managers.rst
- reverse_engineering.rst
event_dispatcher.rst
event_dispatcher
- before_after_filters.rst
forms.rst
form
- bootstrap4.rst
- bootstrap5.rst
- create_custom_field_type.rst
- create_form_type_extension.rst
- data_mappers.rst
- data_transformers.rst
- direct_submit.rst
- dynamic_form_modification.rst
- embedded.rst
- form_collections.rst
- form_customization.rst
- form_themes.rst
- type_guesser.rst
- unit_testing.rst
- use_empty_data.rst
- validation_group_service_resolver.rst
- validation_groups.rst
- without_class.rst
frontend
- encore
- ux.rst
http_cache.rst
http_cache
- cache_vary.rst
- esi.rst
- expiration.rst
- validation.rst
- varnish.rst
http_client.rst
introduction
- from_flat_php_to_symfony.rst
- http_fundamentals.rst
lock.rst
logging.rst
logging
- channels_handlers.rst
- formatter.rst
- handlers.rst
- monolog_console.rst
mailer.rst
mercure.rst
messenger.rst
messenger
- dispatch_after_current_bus.rst
page_creation.rst
performance.rst
profiler.rst
profiler
- data_collector.rst
quick_tour
- flex_recipes.rst
- the_architecture.rst
- the_big_picture.rst
rate_limiter.rst
reference
- configuration
- constraints
- dic_tags.rst
- events.rst
- forms/types
- twig_reference.rst
routing.rst
routing
- custom_route_loader.rst
security.rst
security
- access_control.rst
- access_denied_handler.rst
- custom_authenticator.rst
- expressions.rst
- impersonating_user.rst
- ldap.rst
- login_link.rst
- passwords.rst
- remember_me.rst
- user_checkers.rst
- user_providers.rst
- voters.rst
serializer.rst
serializer
- custom_encoders.rst
- custom_normalizer.rst
service_container.rst
service_container
- alias_private.rst
- autowiring.rst
- calls.rst
- configurators.rst
- definitions.rst
- import.rst
- injection_types.rst
- lazy_services.rst
- parent_services.rst
- request.rst
- service_decoration.rst
- service_subscribers_locators.rst
- shared.rst
- tags.rst
session.rst
setup.rst
setup
- _update_all_packages.rst.inc
- _update_recipes.rst.inc
- bundles.rst
- docker.rst
- file_permissions.rst
- flex.rst
- homestead.rst
- symfony_server.rst
- unstable_versions.rst
- upgrade_major.rst
- upgrade_minor.rst
- upgrade_patch.rst
- web_server_configuration.rst
templates.rst
templating
- twig_extension.rst
testing.rst
testing
- bootstrap.rst
- database.rst
- insulating_clients.rst
- profiling.rst
translation.rst
translation
- debug.rst
- lint.rst
- locale.rst
- message_format.rst
validation.rst
validation
- custom_constraint.rst
- groups.rst
- sequence_provider.rst
- translations.rst
workflow.rst
workflow
- workflow-and-state-machine.rst

Some content is hidden

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

286 files changed

+1214

-1213

lines changed

`‎.doctor-rst.yaml‎`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ rules:`
`29`	`29`	`no_blank_line_after_filepath_in_yaml_code_block:~`
`30`	`30`	`no_brackets_in_method_directive:~`
`31`	`31`	`no_composer_req:~`
	`32`	`+no_contraction:~`
`32`	`33`	`no_directive_after_shorthand:~`
`33`	`34`	`no_explicit_use_of_code_block_php:~`
`34`	`35`	`no_inheritdoc:~`

`‎_build/maintainer_guide.rst‎`

Lines changed: 21 additions & 21 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ Symfony Docs Maintainer Guide`
`3`	`3`
`4`	`4`	The `symfony/symfony-docs`_ repository stores the Symfony project documentation
`5`	`5`	and is managed by the `Symfony Docs team`_. This article explains in detail some
`6`		`-of those management tasks, so it's only useful for maintainers and not regular`
	`6`	`+of those management tasks, so it is only useful for maintainers and not regular`
`7`	`7`	`readers or Symfony developers.`
`8`	`8`
`9`	`9`	`Reviewing Pull Requests`
`@@ -17,7 +17,7 @@ but there are extra things to keep in mind for maintainers:`
`17`	`17`	`* Don't assume that contributors know what you think is obvious (e.g. lots of`
`18`	`18`	`them don't know what to "squash commits" means).`
`19`	`19`	`* Don't use acronyms like IMO, IIRC, etc. or complex English words (most`
`20`		`- contributors are not native in English and it's intimidating for them).`
	`20`	`+ contributors are not native in English and it is intimidating for them).`
`21`	`21`	`* Never engage in a heated discussion. Lock it right away using GitHub.`
`22`	`22`	`* Never discuss non-tech issues. Some PRs are related to our Diversity initiative`
`23`	`23`	`and some people always try to drag you into politics. Never engage in that and`
`@@ -26,14 +26,14 @@ but there are extra things to keep in mind for maintainers:`
`26`	`26`	`Fixing Minor Issues Yourself`
`27`	`27`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`28`	`28`
`29`		`-It's common for new contributors to make lots of minor mistakes in the syntax`
`30`		`-of the RST format used in the docs. It's also common for non English speakers to`
	`29`	`+It is common for new contributors to make lots of minor mistakes in the syntax`
	`30`	`+of the RST format used in the docs. It is also common for non English speakers to`
`31`	`31`	`make minor typos.`
`32`	`32`
`33`	`33`	`Even if your intention is good, if you add lots of comments when reviewing a`
`34`		`-first contribution, that person will probably not contribute again. It's better`
	`34`	`+first contribution, that person will probably not contribute again. It is better`
`35`	`35`	`to fix the minor errors and typos yourself while merging. If that person`
`36`		`-contributes again, it's OK to mention some of the minor issues to educate them.`
	`36`	`+contributes again, it is OK to mention some of the minor issues to educate them.`
`37`	`37`
`38`	`38`	`..code-block::terminal`
`39`	`39`
`@@ -53,7 +53,7 @@ contributes again, it's OK to mention some of the minor issues to educate them.`
`53`	`53`	`$ git commit -a`
`54`	`54`	`# Use "Minor reword", "Minor tweak", etc. as the commit message`
`55`	`55`
`56`		`- # now run the 'push' command shown above by 'gh' (it's different each time)`
	`56`	`+ # now run the 'push' command shown above by 'gh' (it is different each time)`
`57`	`57`	`$ git push gh "5.4" refs/notes/github-comments`
`58`	`58`
`59`	`59`	`Merging Pull Requests`
`@@ -93,8 +93,8 @@ interface. Then:`
`93`	`93`	`Merging Process`
`94`	`94`	`~~~~~~~~~~~~~~~`
`95`	`95`
`96`		`-At first, it's common to make mistakes and merge things badly. Don't worry. This`
`97`		`-has happened to all of us and we've always been able to recover from any mistake.`
	`96`	`+At first, it is common to make mistakes and merge things badly. Don't worry. This`
	`97`	`+has happened to all of us and we have always been able to recover from any mistake.`
`98`	`98`
`99`	`99`	`Step 1: Select the right branch to merge`
`100`	`100`	`........................................`
`@@ -107,7 +107,7 @@ PRs must be merged in the oldest maintained branch where they are applicable:`
`107`	`107`	usually means ``master``. And don't forget to check that new feature includes
`108`	`108`	the ``versionadded`` directive.
`109`	`109`
`110`		`-It's very common for contributors (specially newcomers) to select the wrong`
	`110`	`+It is very common for contributors (specially newcomers) to select the wrong`
`111`	`111`	`branch for their PRs, so we must always check if the change should go to the`
`112`	`112`	`proposed branch or not.`
`113`	`113`
`@@ -121,12 +121,12 @@ Never use GitHub's web interface (or desktop clients) to merge PRs or to solve`
`121`	`121`	merge conflicts. Always use the ``gh`` tool for anything related to merges.
`122`	`122`
`123`	`123`	`We require two approval votes from team members before merging a PR, except if`
`124`		`-it's a typo, a small change or clearly an error.`
	`124`	`+it is a typo, a small change or clearly an error.`
`125`	`125`
`126`	`126`	`If a PR contains lots of commits, there's no need to ask the contributor to`
`127`	`127`	squash them. The ``gh`` tool does that automatically. The only exceptions are
`128`	`128`	`when commits are made by more than one person and when there's a merge commit.`
`129`		-``gh``can't squash commits in those cases, so it's better to ask to the
	`129`	+``gh``cannot squash commits in those cases, so it is better to ask to the
`130`	`130`	`original contributor.`
`131`	`131`
`132`	`132`	`..code-block::terminal`
`@@ -147,13 +147,13 @@ original contributor.`
`147`	`147`	`$ git push origin`
`148`	`148`	`$ git push upstream`
`149`	`149`
`150`		`-It's common to have to change the branch where a PR is merged. Instead of asking`
	`150`	`+It is common to have to change the branch where a PR is merged. Instead of asking`
`151`	`151`	`the contributors to rebase their PRs, the "gh" tool can change the branch with`
`152`	`152`	the ``-s`` option:
`153`	`153`
`154`	`154`	`..code-block::terminal`
`155`	`155`
`156`		`- # e.g. this PR was sent against 'master', but it's merged in '4.4'`
	`156`	`+ # e.g. this PR was sent against 'master', but it is merged in '4.4'`
`157`	`157`	`$ gh merge 11160 -s 4.4`
`158`	`158`
`159`	`159`	`Sometimes, when changing the branch, you may face rebase issues, but they are`
@@ -228,7 +228,7 @@ maintained branches until ``master``. Imagine that you are merging a PR against
`228`	`228`
`229`	`229`	`..tip::`
`230`	`230`
`231`		`- When the support of a Symfony branch ends, it's recommended to delete your`
	`231`	`+ When the support of a Symfony branch ends, it is recommended to delete your`
`232`	`232`	`local branch to avoid merging in it unawarely:`
`233`	`233`
`234`	`234`	`..code-block::terminal`
`@@ -250,12 +250,12 @@ When updating your local branches before merging:`
`250`	`250`	`$ git checkout 4.4`
`251`	`251`	`$ git merge upstream/4.4`
`252`	`252`
`253`		`-It'spossible that you merge a wrong upstream branch unawarely. It's usually`
`254`		`-easy to spot because you'll see lots of conflicts:`
	`253`	`+It ispossible that you merge a wrong upstream branch unawarely. It is usually`
	`254`	`+easy to spot because you will see lots of conflicts:`
`255`	`255`
`256`	`256`	`..code-block::terminal`
`257`	`257`
`258`		`- # DON'T DO THIS! It's a wrong branch merge`
	`258`	`+ # DON'T DO THIS! It is a wrong branch merge`
`259`	`259`	`$ git checkout 4.4`
`260`	`260`	`$ git merge upstream/5.0`
`261`	`261`
`@@ -269,12 +269,12 @@ local branch and check it out again:`
`269`	`269`	`$ git checkout 4.4 upstream/4.4`
`270`	`270`
`271`	`271`	`If you did push the wrong branch merge, ask for help in the documentation`
`272`		`-mergers chat and we'll help solve the problem.`
	`272`	`+mergers chat and we will help solve the problem.`
`273`	`273`
`274`	`274`	`Solving merge conflicts`
`275`	`275`	`.......................`
`276`	`276`
`277`		`-When merging things to upper branches, most of the times you'll see conflicts:`
	`277`	`+When merging things to upper branches, most of the times you will see conflicts:`
`278`	`278`
`279`	`279`	`..code-block::terminal`
`280`	`280`
`@@ -303,7 +303,7 @@ the marker used by Git for conflicts) and then do this:`
`303`	`303`	`..tip::`
`304`	`304`
`305`	`305`	When there are lots of conflicts, look for ``<<<<<`` with your editor in all
`306`		`- docs before committing the changes. It's common to forget about some of them.`
	`306`	`+ docs before committing the changes. It is common to forget about some of them.`
`307`	`307`	If you prefer, you can run this too: ``git grep --cached "<<<<<"``.
`308`	`308`
`309`	`309`	`Merging deleted files`

`‎_includes/_annotation_loader_tip.rst.inc‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`.. tip::`
`7`	`7`
`8`		`- Annotation classesaren't loaded automatically, so you must load them`
	`8`	`+ Annotation classesare not loaded automatically, so you must load them`
`9`	`9`	`using a class loader like this::`
`10`	`10`
`11`	`11`	`use Composer\Autoload\ClassLoader;`

`‎_includes/_rewrite_rule_tip.rst.inc‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`
`3`	`3`	`By using rewrite rules in your`
`4`	`4`	:doc:`web server configuration</setup/web_server_configuration>`,
`5`		- the ``index.php``won't be needed and you will have beautiful, clean URLs
	`5`	+ the ``index.php``will not be needed and you will have beautiful, clean URLs
`6`	`6`	(e.g. ``/show``).

`‎best_practices.rst‎`

Lines changed: 20 additions & 20 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ Use the Default Directory Structure`
`40`	`40`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`41`	`41`
`42`	`42`	`Unless your project follows a development practice that imposes a certain`
`43`		`-directory structure, follow the default Symfony directory structure. It's flat,`
	`43`	`+directory structure, follow the default Symfony directory structure. It is flat,`
`44`	`44`	`self-explanatory and not coupled to Symfony:`
`45`	`45`
`46`	`46`	`..code-block::text`
`@@ -123,7 +123,7 @@ Then, use just one or two words to describe the purpose of the parameter:`
`123`	`123`	`app.dir:'...'`
`124`	`124`	`# do this: short but easy to understand names`
`125`	`125`	`app.contents_dir:'...'`
`126`		`-# it's OK to use dots, underscores, dashes or nothing, but always`
	`126`	`+# it is OK to use dots, underscores, dashes or nothing, but always`
`127`	`127`	`# be consistent and use the same format for all the parameters`
`128`	`128`	`app.dir.contents:'...'`
`129`	`129`	`app.contents-dir:'...'`
`@@ -150,7 +150,7 @@ Twig templates and Doctrine entities, whereas parameters are only available`
`150`	`150`	from places with access to the:doc:`service container</service_container>`.
`151`	`151`
`152`	`152`	`The only notable disadvantage of using constants for this kind of configuration`
`153`		`-values is that it's complicated to redefine their values in your tests.`
	`153`	`+values is that it is complicated to redefine their values in your tests.`
`154`	`154`
`155`	`155`	`Business Logic`
`156`	`156`	`--------------`
`@@ -191,9 +191,9 @@ Use the YAML Format to Configure your own Services`
`191`	`191`
`192`	`192`	If you use the:ref:`default services.yaml configuration<service-container-services-load-example>`,
`193`	`193`	`most services will be configured automatically. However, in some edge cases`
`194`		`-you'll need to configure services (or parts of them) manually.`
	`194`	`+you will need to configure services (or parts of them) manually.`
`195`	`195`
`196`		`-YAML is the format recommended configuring services because it's friendly to`
	`196`	`+YAML is the format recommended configuring services because it is friendly to`
`197`	`197`	`newcomers and concise, but Symfony also supports XML and PHP configuration.`
`198`	`198`
`199`	`199`	`Use Attributes to Define the Doctrine Entity Mapping`
`@@ -203,7 +203,7 @@ Doctrine entities are plain PHP objects that you store in some "database".`
`203`	`203`	`Doctrine only knows about your entities through the mapping metadata configured`
`204`	`204`	`for your model classes.`
`205`	`205`
`206`		`-Doctrine supports several metadata formats, but it's recommended to use PHP`
	`206`	`+Doctrine supports several metadata formats, but it is recommended to use PHP`
`207`	`207`	`attributes because they are by far the most convenient and agile way of setting`
`208`	`208`	`up and looking for mapping information.`
`209`	`209`
`@@ -222,7 +222,7 @@ or checking security permissions.`
`222`	`222`
`223`	`223`	`Extending your controllers from this base controller couples your application`
`224`	`224`	`to Symfony. Coupling is generally wrong, but it may be OK in this case because`
`225`		`-controllersshouldn't contain any business logic. Controllers should contain`
	`225`	`+controllersshould not contain any business logic. Controllers should contain`
`226`	`226`	`nothing more than a few lines of glue-code, so you are not coupling the`
`227`	`227`	`important parts of your application.`
`228`	`228`
`@@ -257,12 +257,12 @@ constructor arguments.`
`257`	`257`	`Use ParamConverters If They Are Convenient`
`258`	`258`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`259`	`259`
`260`		-If you're using:doc:`Doctrine</doctrine>`, then you can optionally use the
	`260`	+If you are using:doc:`Doctrine</doctrine>`, then you can optionally use the
`261`	`261`	`ParamConverter`_ to automatically query for an entity and pass it as an argument
`262`	`262`	`to your controller. It will also show a 404 page if no entity can be found.`
`263`	`263`
`264`	`264`	`If the logic to get an entity from a route variable is more complex, instead of`
`265`		`-configuring the ParamConverter, it's better to make the Doctrine query inside`
	`265`	`+configuring the ParamConverter, it is better to make the Doctrine query inside`
`266`	`266`	the controller (e.g. by calling to a:doc:`Doctrine repository method</doctrine>`).
`267`	`267`
`268`	`268`	`Templates`
`@@ -298,16 +298,16 @@ Add Form Buttons in Templates`
`298`	`298`
`299`	`299`	`Form classes should be agnostic to where they will be used. For example, the`
`300`	`300`	`button of a form used to both create and edit items should change from "Add new"`
`301`		`-to "Save changes" depending on where it's used.`
	`301`	`+to "Save changes" depending on where it is used.`
`302`	`302`
`303`		`-Instead of adding buttons in form classes or the controllers, it's recommended`
	`303`	`+Instead of adding buttons in form classes or the controllers, it is recommended`
`304`	`304`	`to add buttons in the templates. This also improves the separation of concerns`
`305`	`305`	`because the button styling (CSS class and other attributes) is defined in the`
`306`	`306`	`template instead of in a PHP class.`
`307`	`307`
`308`	`308`	However, if you create a:doc:`form with multiple submit buttons</form/multiple_buttons>`
`309`	`309`	`you should define them in the controller instead of the template. Otherwise, you`
`310`		`-won't be able to check which button was clicked when handling the form in the controller.`
	`310`	`+will not be able to check which button was clicked when handling the form in the controller.`
`311`	`311`
`312`	`312`	`Define Validation Constraints on the Underlying Object`
`313`	`313`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`@@ -323,7 +323,7 @@ Use a Single Action to Render and Process the Form`
`323`	`323`
`324`	`324`	:ref:`Rendering forms<rendering-forms>` and:ref:`processing forms<processing-forms>`
`325`	`325`	`are two of the main tasks when handling forms. Both are too similar (most of the`
`326`		`-time, almost identical), so it's much simpler to let a single controller action`
	`326`	`+time, almost identical), so it is much simpler to let a single controller action`
`327`	`327`	`handle both.`
`328`	`328`
`329`	`329`	`.. _best-practice-internationalization:`
`@@ -336,7 +336,7 @@ Use the XLIFF Format for Your Translation Files`
`336`	`336`
`337`	`337`	Of all the translation formats supported by Symfony (PHP, Qt, ``.po``, ``.mo``,
`338`	`338`	JSON, CSV, INI, etc.), ``XLIFF`` and ``gettext`` have the best support in the tools used
`339`		-by professional translators. And since it's based on XML, you can validate ``XLIFF``
	`339`	+by professional translators. And since it is based on XML, you can validate ``XLIFF``
`340`	`340`	`file contents as you write them.`
`341`	`341`
`342`	`342`	`Symfony also supports notes in XLIFF files, making them more user-friendly for`
`@@ -361,7 +361,7 @@ Define a Single Firewall`
`361`	`361`	`~~~~~~~~~~~~~~~~~~~~~~~~`
`362`	`362`
`363`	`363`	`Unless you have two legitimately different authentication systems and users`
`364`		`-(e.g. form login for the main site and a token system for your API only), it's`
	`364`	`+(e.g. form login for the main site and a token system for your API only), it is`
`365`	`365`	`recommended to have only one firewall to keep things simple.`
`366`	`366`
`367`	`367`	Additionally, you should use the ``anonymous`` key under your firewall. If you
`@@ -439,21 +439,21 @@ checks that all application URLs load successfully::`
`439`	`439`	`}`
`440`	`440`
`441`	`441`	`Add this test while creating your application because it requires little effort`
`442`		`-and checks that none of your pages returns an error. Later, you'll add more`
	`442`	`+and checks that none of your pages returns an error. Later, you will add more`
`443`	`443`	`specific tests for each page.`
`444`	`444`
`445`	`445`	`.. _hardcode-urls-in-a-functional-test:`
`446`	`446`
`447`	`447`	`Hard-code URLs in a Functional Test`
`448`	`448`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`449`	`449`
`450`		-In Symfony applications, it's recommended to:ref:`generate URLs<routing-generating-urls>`
	`450`	+In Symfony applications, it is recommended to:ref:`generate URLs<routing-generating-urls>`
`451`	`451`	`using routes to automatically update all links when a URL changes. However, if a`
`452`		`-public URL changes, userswon't be able to browse it unless you set up a`
	`452`	`+public URL changes, userswill not be able to browse it unless you set up a`
`453`	`453`	`redirection to the new URL.`
`454`	`454`
`455`		`-That's why it's recommended to use raw URLs in tests instead of generating them`
`456`		`-from routes. Whenever a route changes, tests will fail, and you'll know that`
	`455`	`+That's why it is recommended to use raw URLs in tests instead of generating them`
	`456`	`+from routes. Whenever a route changes, tests will fail, and you will know that`
`457`	`457`	`you must set up a redirection.`
`458`	`458`
`459`	`459`	.. _`Symfony Demo`:https://github.com/symfony/demo

`‎bundles.rst‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ file::`
`30`	`30`	`Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true],`
`31`	`31`	`Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],`
`32`	`32`	`Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle::class => ['all' => true],`
`33`		`- // this bundle is enabled only in 'dev' and 'test', so youcan't use it in 'prod'`
	`33`	`+ // this bundle is enabled only in 'dev' and 'test', so youcannot use it in 'prod'`
`34`	`34`	`Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],`
`35`	`35`	`];`
`36`	`36`
@@ -69,7 +69,7 @@ called ``AcmeTestBundle.php``::
`69`	`69`
`70`	`70`	`This empty class is the only piece you need to create the new bundle. Though`
`71`	`71`	`commonly empty, this class is powerful and can be used to customize the behavior`
`72`		`-of the bundle. Now that you've created the bundle, enable it::`
	`72`	`+of the bundle. Now that you have created the bundle, enable it::`
`73`	`73`
`74`	`74`	`// config/bundles.php`
`75`	`75`	`return [`
`@@ -111,7 +111,7 @@ to be adjusted if needed:`
`111`	`111`	`A bundle can be as small or large as the feature it implements. It contains`
`112`	`112`	`only the files you need and nothing else.`
`113`	`113`
`114`		`-As you move through the guides, you'll learn how to persist objects to a`
	`114`	`+As you move through the guides, you will learn how to persist objects to a`
`115`	`115`	`database, create and validate forms, create translations for your application,`
`116`	`116`	`write tests and much more. Each of these has their own place and role within`
`117`	`117`	`the bundle.`

`‎bundles/best_practices.rst‎`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ CSS or any other language.`
`165`	`165`	`Doctrine Entities/Documents`
`166`	`166`	`---------------------------`
`167`	`167`
`168`		`-If the bundle includes Doctrine ORM entities and/or ODM documents, it's`
	`168`	`+If the bundle includes Doctrine ORM entities and/or ODM documents, it is`
`169`	`169`	`recommended to define their mapping using XML files stored in`
`170`	`170`	``Resources/config/doctrine/``. This allows to override that mapping using the
`171`	`171`	:doc:`standard Symfony mechanism to override bundle parts</bundles/override>`.
`@@ -255,7 +255,7 @@ Installation`
`255`	`255`
`256`	`256`	Bundles should set ``"type": "symfony-bundle"`` in their ``composer.json`` file.
`257`	`257`	With this,:ref:`Symfony Flex<symfony-flex>` will be able to automatically
`258`		`-enable your bundle when it's installed.`
	`258`	`+enable your bundle when it is installed.`
`259`	`259`
`260`	`260`	`If your bundle requires any setup (e.g. configuration, new files, changes to`
`261`	`261`	``.gitignore``, etc), then you should create a `Symfony Flex recipe`_.
`@@ -467,7 +467,7 @@ Services`
`467`	`467`	`If the bundle defines services, they must be prefixed with the bundle alias`
`468`	`468`	`instead of using fully qualified class names like you do in your project`
`469`	`469`	services. For example, AcmeBlogBundle services must be prefixed with ``acme_blog``.
`470`		`-The reason is that bundlesshouldn't rely on features such as service autowiring`
	`470`	`+The reason is that bundlesshould not rely on features such as service autowiring`
`471`	`471`	`or autoconfiguration to not impose an overhead when compiling application services.`
`472`	`472`
`473`	`473`	`In addition, services not meant to be used by the application directly, should`
@@ -508,7 +508,7 @@ The ``composer.json`` file should include at least the following metadata:
`508`	`508`	a string (or array of strings) with a `valid license identifier`_, such as ``MIT``.
`509`	`509`
`510`	`510`	``autoload``
`511`		`- This information is used by Symfony to load the classes of the bundle. It's`
	`511`	`+ This information is used by Symfony to load the classes of the bundle. It is`
`512`	`512`	recommended to use the `PSR-4`_ autoload standard: use the namespace as key,
`513`	`513`	and the location of the bundle's main class (relative to ``composer.json``)
`514`	`514`	as value. As the main class is located in the ``src/`` directory of the bundle:

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!

Commit682562a

File tree

286 files changed

Some content is hidden

286 files changed

`‎.doctor-rst.yaml‎`

`‎_build/maintainer_guide.rst‎`

`‎_includes/_annotation_loader_tip.rst.inc‎`

`‎_includes/_rewrite_rule_tip.rst.inc‎`

`‎best_practices.rst‎`

`‎bundles.rst‎`

`‎bundles/best_practices.rst‎`

0 commit comments