diff --git a/best_practices/introduction.rst b/best_practices/introduction.rst index 3c4fb03e7e4..cd7c0a655f4 100644 --- a/best_practices/introduction.rst +++ b/best_practices/introduction.rst @@ -4,7 +4,7 @@ The Symfony Framework Best Practices ==================================== -The Symfony framework is well-known for being *really* flexible and is used +The Symfony Framework is well-known for being *really* flexible and is used to build micro-sites, enterprise applications that handle billions of connections and even as the basis for *other* frameworks. Since its release in July 2011, the community has learned a lot about what's possible and how to do things *best*. @@ -19,7 +19,7 @@ What is this Guide About? ------------------------- This guide aims to fix that by describing the **best practices for developing -web apps with the Symfony full-stack framework**. These are best practices that +web apps with the Symfony full-stack Framework**. These are best practices that fit the philosophy of the framework as envisioned by its original creator `Fabien Potencier`_. @@ -32,7 +32,7 @@ fit the philosophy of the framework as envisioned by its original creator This guide is **specially suited** for: -* Websites and web applications developed with the full-stack Symfony framework. +* Websites and web applications developed with the full-stack Symfony Framework. For other situations, this guide might be a good **starting point** that you can then **extend and fit to your specific needs**: @@ -62,8 +62,8 @@ Symfony to follow everything. If you are totally new to Symfony, welcome! Start with :doc:`The Quick Tour ` tutorial first. We've deliberately kept this guide short. We won't repeat explanations that -you can find in the vast Symfony documentation, like discussions about dependency -injection or front controllers. We'll solely focus on explaining how to do +you can find in the vast Symfony documentation, like discussions about Dependency +Injection or front controllers. We'll solely focus on explaining how to do what you already know. The Application diff --git a/book/doctrine.rst b/book/doctrine.rst index d3b424920eb..d354f0f258c 100644 --- a/book/doctrine.rst +++ b/book/doctrine.rst @@ -6,7 +6,7 @@ Databases and Doctrine One of the most common and challenging tasks for any application involves persisting and reading information to and from a database. Although -the Symfony full-stack framework doesn't integrate any ORM by default, +the Symfony full-stack Framework doesn't integrate any ORM by default, the Symfony Standard Edition, which is the most widely used distribution, comes integrated with `Doctrine`_, a library whose sole goal is to give you powerful tools to make this easy. In this chapter, you'll learn the diff --git a/book/forms.rst b/book/forms.rst index 0119aa4575a..44fcd8a4ba0 100644 --- a/book/forms.rst +++ b/book/forms.rst @@ -198,7 +198,7 @@ it into a format that's suitable for being rendered in an HTML form. ``task`` property via the ``getTask()`` and ``setTask()`` methods on the ``Task`` class. Unless a property is public, it *must* have a "getter" and "setter" method so that the Form component can get and put data onto the - property. For a Boolean property, you can use an "isser" or "hasser" method + property. For a boolean property, you can use an "isser" or "hasser" method (e.g. ``isPublished()`` or ``hasReminder()``) instead of a getter (e.g. ``getPublished()`` or ``getReminder()``). @@ -1526,7 +1526,7 @@ file, you can see every block needed to render a form and every default field type. In PHP, the fragments are individual template files. By default they are located in -the `Resources/views/Form` directory of the framework bundle (`view on GitHub`_). +the ``Resources/views/Form`` directory of the FrameworkBundle (`view on GitHub`_). Each fragment name follows the same basic pattern and is broken up into two pieces, separated by a single underscore character (``_``). A few examples are: @@ -1867,7 +1867,7 @@ an array. Be advised, however, that in most cases using the ``getData()`` method is a better choice, since it returns the data (usually an object) after - it's been transformed by the form framework. + it's been transformed by the Form component. Adding Validation ~~~~~~~~~~~~~~~~~ diff --git a/book/http_fundamentals.rst b/book/http_fundamentals.rst index 38027843014..19d8df030da 100644 --- a/book/http_fundamentals.rst +++ b/book/http_fundamentals.rst @@ -266,7 +266,7 @@ the user is connecting via a secured connection (i.e. HTTPS). The Request class also has a public ``attributes`` property, which holds special data related to how the application works internally. For the - Symfony framework, the ``attributes`` holds the values returned by the + Symfony Framework, the ``attributes`` holds the values returned by the matched route, like ``_controller``, ``id`` (if you have an ``{id}`` wildcard), and even the name of the matched route (``_route``). The ``attributes`` property exists entirely to be a place where you can @@ -500,7 +500,7 @@ emails, validating user input and handling security. The good news is that none of these problems is unique. Symfony provides a framework full of tools that allow you to build your application, not your tools. With Symfony, nothing is imposed on you: you're free to use the full -Symfony framework, or just one piece of Symfony all by itself. +Symfony Framework, or just one piece of Symfony all by itself. .. index:: single: Symfony Components @@ -542,9 +542,9 @@ regardless of how your project is developed. To name a few: :doc:`Translation ` A framework for translating strings in your application. -Each one of these components is decoupled and can be used in *any* -PHP project, regardless of whether or not you use the Symfony framework. -Every part is made to be used if needed and replaced when necessary. +Each one of these components is decoupled and can be used in *any* PHP project, +regardless of whether or not you use the Symfony Framework. Every part is +made to be used if needed and replaced when necessary. .. _the-full-solution-the-symfony2-framework: diff --git a/book/installation.rst b/book/installation.rst index c7d9b509968..6d3e4bab42d 100644 --- a/book/installation.rst +++ b/book/installation.rst @@ -126,7 +126,7 @@ you can create Symfony applications using the alternative installation method based on `Composer`_. Composer is the dependency manager used by modern PHP applications and it can -also be used to create new applications based on the Symfony framework. If you +also be used to create new applications based on the Symfony Framework. If you don't have installed it globally, start by reading the next section. Installing Composer Globally @@ -321,7 +321,7 @@ applications: * The `Symfony CMF Standard Edition`_ is the best distribution to get started with the `Symfony CMF`_ project, which is a project that makes it easier for developers to add CMS functionality to applications built with the Symfony - framework. + Framework. * The `Symfony REST Edition`_ shows how to build an application that provides a RESTful API using the FOSRestBundle and several other related bundles. diff --git a/book/internals.rst b/book/internals.rst index ff9e8c6f5cf..7a0db79fb61 100644 --- a/book/internals.rst +++ b/book/internals.rst @@ -55,7 +55,7 @@ On top of HttpFoundation is the :namespace:`Symfony\\Component\\HttpKernel` component. HttpKernel handles the dynamic part of HTTP; it is a thin wrapper on top of the Request and Response classes to standardize the way requests are handled. It also provides extension points and tools that makes it the ideal -starting point to create a Web framework without too much overhead. +starting point to create a web framework without too much overhead. It also optionally adds configurability and extensibility, thanks to the DependencyInjection component and a powerful plugin system (bundles). @@ -177,12 +177,12 @@ Event): #. Listeners of the ``kernel.terminate`` event can perform tasks after the Response has been served. -If an Exception is thrown during processing, the ``kernel.exception`` is -notified and listeners are given a chance to convert the Exception to a +If an exception is thrown during processing, the ``kernel.exception`` is +notified and listeners are given a chance to convert the exception into a Response. If that works, the ``kernel.response`` event is notified; if not, the Exception is re-thrown. -If you don't want Exceptions to be caught (for embedded requests for +If you don't want exceptions to be caught (for embedded requests for instance), disable the ``kernel.exception`` event by passing ``false`` as the third argument to the ``handle()`` method. @@ -238,8 +238,8 @@ add the following code at the beginning of your listener method:: .. tip:: - If you are not yet familiar with the Symfony EventDispatcher, read the - :doc:`EventDispatcher component documentation ` + If you are not yet familiar with the Symfony EventDispatcher component, + read :doc:`its documentation ` section first. .. index:: @@ -351,7 +351,7 @@ The FrameworkBundle registers several listeners: Collects data for the current request. :class:`Symfony\\Bundle\\WebProfilerBundle\\EventListener\\WebDebugToolbarListener` - Injects the Web Debug Toolbar. + Injects the web debug toolbar. :class:`Symfony\\Component\\HttpKernel\\EventListener\\ResponseListener` Fixes the Response ``Content-Type`` based on the request format. @@ -396,7 +396,7 @@ forwards the ``Request`` to a given Controller (the value of the ``class::method`` notation). A listener on this event can create and set a ``Response`` object, create -and set a new ``Exception`` object, or do nothing:: +and set a new ``Exception`` object or do nothing:: use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent; use Symfony\Component\HttpFoundation\Response; @@ -433,8 +433,10 @@ and set a new ``Exception`` object, or do nothing:: .. index:: single: EventDispatcher -The EventDispatcher -------------------- +.. _the-eventdispatcher: + +The EventDispatcher Component +----------------------------- The EventDispatcher is a standalone component that is responsible for much of the underlying logic and flow behind a Symfony request. For more information, @@ -455,7 +457,7 @@ enhance performance; use it in the production environment to explore problems after the fact. You rarely have to deal with the profiler directly as Symfony provides -visualizer tools like the Web Debug Toolbar and the Web Profiler. If you use +visualizer tools like the web debug toolbar and the web profiler. If you use the Symfony Standard Edition, the profiler, the web debug toolbar, and the web profiler are all already configured with sensible settings. @@ -481,7 +483,7 @@ bottom of all pages. It displays a good summary of the profiling data that gives you instant access to a lot of useful information when something does not work as expected. -If the summary provided by the Web Debug Toolbar is not enough, click on the +If the summary provided by the web debug toolbar is not enough, click on the token link (a string made of 13 random characters) to access the Web Profiler. .. note:: diff --git a/book/page_creation.rst b/book/page_creation.rst index 3d050051612..48217d53ece 100644 --- a/book/page_creation.rst +++ b/book/page_creation.rst @@ -763,7 +763,7 @@ of the most common elements of a bundle: Contains the controllers of the bundle (e.g. ``RandomController.php``). ``DependencyInjection/`` - Holds certain dependency injection extension classes, which may import service + Holds certain Dependency Injection Extension classes, which may import service configuration, register compiler passes or more (this directory is not necessary). @@ -1082,7 +1082,7 @@ in mind: and ``vendor/`` (third-party code) (there's also a ``bin/`` directory that's used to help updated vendor libraries); -* Each feature in Symfony (including the Symfony framework core) is organized +* Each feature in Symfony (including the Symfony Framework core) is organized into a *bundle*, which is a structured set of files for that feature; * The **configuration** for each bundle lives in the ``Resources/config`` diff --git a/book/performance.rst b/book/performance.rst index e3496b42476..72d90ceb8ec 100644 --- a/book/performance.rst +++ b/book/performance.rst @@ -46,7 +46,7 @@ your ``php.ini`` configuration. Use Composer's Class Map Functionality -------------------------------------- -By default, the Symfony standard edition uses Composer's autoloader +By default, the Symfony Standard Edition uses Composer's autoloader in the `autoload.php`_ file. This autoloader is easy to use, as it will automatically find any new classes that you've placed in the registered directories. diff --git a/book/propel.rst b/book/propel.rst index d1b812f4653..53b953dd75d 100644 --- a/book/propel.rst +++ b/book/propel.rst @@ -288,8 +288,8 @@ from cheapest to most expensive. From inside a controller, do the following:: ->orderByPrice() ->find(); -In one line, you get your products in a powerful oriented object way. No need -to waste your time with SQL or whatever, Symfony offers fully object oriented +In one line, you get your products in a powerful object-oriented way. No need +to waste your time with SQL or whatever, Symfony offers fully object-oriented programming and Propel respects the same philosophy by providing an awesome abstraction layer. diff --git a/book/routing.rst b/book/routing.rst index b5cc3da9715..0ce2f434618 100644 --- a/book/routing.rst +++ b/book/routing.rst @@ -1419,7 +1419,7 @@ In an upcoming section, you'll learn how to generate URLs from inside templates. .. tip:: - If the frontend of your application uses Ajax requests, you might want + If the front-end of your application uses Ajax requests, you might want to be able to generate URLs in JavaScript based on your routing configuration. By using the `FOSJsRoutingBundle`_, you can do exactly that: diff --git a/book/service_container.rst b/book/service_container.rst index 7d50adc019d..cb5624d6553 100644 --- a/book/service_container.rst +++ b/book/service_container.rst @@ -461,7 +461,7 @@ In other words, a service container extension configures the services for a bundle on your behalf. And as you'll see in a moment, the extension provides a sensible, high-level interface for configuring the bundle. -Take the FrameworkBundle - the core Symfony framework bundle - as an +Take the FrameworkBundle - the core Symfony Framework bundle - as an example. The presence of the following code in your application configuration invokes the service container extension inside the FrameworkBundle: @@ -516,7 +516,7 @@ can handle the ``framework`` configuration directive. The extension in question, which lives in the FrameworkBundle, is invoked and the service configuration for the FrameworkBundle is loaded. If you remove the ``framework`` key from your application configuration file entirely, the core Symfony services -won't be loaded. The point is that you're in control: the Symfony framework +won't be loaded. The point is that you're in control: the Symfony Framework doesn't contain any magic or perform any actions that you don't have control over. diff --git a/book/templating.rst b/book/templating.rst index a77bde19fce..313fe125296 100644 --- a/book/templating.rst +++ b/book/templating.rst @@ -1345,7 +1345,7 @@ subdirectory. Overriding Core Templates ~~~~~~~~~~~~~~~~~~~~~~~~~ -Since the Symfony framework itself is just a bundle, core templates can be +Since the Symfony Framework itself is just a bundle, core templates can be overridden in the same way. For example, the core TwigBundle contains a number of different "exception" and "error" templates that can be overridden by copying each from the ``Resources/views/Exception`` directory of the diff --git a/book/testing.rst b/book/testing.rst index 8339d641710..b4a40af1fd6 100644 --- a/book/testing.rst +++ b/book/testing.rst @@ -455,8 +455,8 @@ Accessing the Container It's highly recommended that a functional test only tests the Response. But under certain very rare circumstances, you might want to access some internal -objects to write assertions. In such cases, you can access the dependency -injection container:: +objects to write assertions. In such cases, you can access the Dependency +Injection Container:: $container = $client->getContainer(); diff --git a/book/translation.rst b/book/translation.rst index a4955b05801..c8a5f260ee4 100644 --- a/book/translation.rst +++ b/book/translation.rst @@ -27,7 +27,7 @@ into the language of the user:: *country* code (e.g. ``fr_FR`` for French/France) is recommended. In this chapter, you'll learn how to use the Translation component in the -Symfony framework. You can read the +Symfony Framework. You can read the :doc:`Translation component documentation ` to learn even more. Overall, the process has several steps: @@ -573,7 +573,7 @@ the framework: Translating Constraint Messages ------------------------------- -If you're using validation constraints with the form framework, then translating +If you're using validation constraints with the Form component, then translating the error messages is easy: simply create a translation resource for the ``validators`` :ref:`domain `. diff --git a/components/config/definition.rst b/components/config/definition.rst index 396328ef687..b79ad3853a2 100644 --- a/components/config/definition.rst +++ b/components/config/definition.rst @@ -99,6 +99,8 @@ node definition. Node types are available for: * scalar (generic type that includes booleans, strings, integers, floats and ``null``) * boolean +* scalar +* boolean * integer (new in 2.2) * float (new in 2.2) * enum (new in 2.1) (similar to scalar, but it only allows a finite set of values) diff --git a/components/console/helpers/dialoghelper.rst b/components/console/helpers/dialoghelper.rst index 9c04923f6d2..c28588796ff 100644 --- a/components/console/helpers/dialoghelper.rst +++ b/components/console/helpers/dialoghelper.rst @@ -95,7 +95,7 @@ convenient for passwords:: When you ask for a hidden response, Symfony will use either a binary, change stty mode or use another trick to hide the response. If none is available, it will fallback and allow the response to be visible unless you pass ``false`` - as the third argument like in the example above. In this case, a RuntimeException + as the third argument like in the example above. In this case, a ``RuntimeException`` would be thrown. Validating the Answer diff --git a/components/dependency_injection/compilation.rst b/components/dependency_injection/compilation.rst index f3c074106cf..e9b9939bff8 100644 --- a/components/dependency_injection/compilation.rst +++ b/components/dependency_injection/compilation.rst @@ -207,7 +207,7 @@ The XML version of the config would then look like this: .. note:: - In the Symfony full stack framework there is a base Extension class which + In the Symfony full-stack Framework there is a base Extension class which implements these methods as well as a shortcut method for processing the configuration. See :doc:`/cookbook/bundles/extension` for more details. @@ -347,9 +347,9 @@ will then be called when the container is compiled:: .. note:: - Compiler passes are registered differently if you are using the full - stack framework, see :doc:`/cookbook/service_container/compiler_passes` - for more details. + Compiler passes are registered differently if you are using the full-stack + framework, see :doc:`/cookbook/service_container/compiler_passes` for + more details. Controlling the Pass Ordering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -510,5 +510,5 @@ to see if the files have changed, if they have the cache will be considered stal .. note:: - In the full stack framework the compilation and caching of the container + In the full-stack framework the compilation and caching of the container is taken care of for you. diff --git a/components/dependency_injection/tags.rst b/components/dependency_injection/tags.rst index 3bb349517f2..9bb0d000707 100644 --- a/components/dependency_injection/tags.rst +++ b/components/dependency_injection/tags.rst @@ -173,9 +173,9 @@ run when the container is compiled:: .. note:: - Compiler passes are registered differently if you are using the full - stack framework. See :doc:`/cookbook/service_container/compiler_passes` - for more details. + Compiler passes are registered differently if you are using the full-stack + framework. See :doc:`/cookbook/service_container/compiler_passes` for + more details. Adding additional Attributes on Tags ------------------------------------ diff --git a/components/dependency_injection/workflow.rst b/components/dependency_injection/workflow.rst index f769fefd1a1..d528c10fa6b 100644 --- a/components/dependency_injection/workflow.rst +++ b/components/dependency_injection/workflow.rst @@ -8,11 +8,11 @@ In the preceding pages of this section, there has been little to say about where the various files and classes should be located. This is because this depends on the application, library or framework in which you want to use the container. Looking at how the container is configured and built in the -Symfony full stack framework will help you see how this all fits together, -whether you are using the full stack framework or looking to use the service +Symfony full-stack Framework will help you see how this all fits together, +whether you are using the full-stack framework or looking to use the service container in another application. -The full stack framework uses the HttpKernel component to manage the loading +The full-stack framework uses the HttpKernel component to manage the loading of the service container configuration from the application and bundles and also handles the compilation and caching. Even if you are not using HttpKernel, it should give you an idea of one way of organizing configuration in a modular diff --git a/components/event_dispatcher/container_aware_dispatcher.rst b/components/event_dispatcher/container_aware_dispatcher.rst index 1caa778cc03..82a502f582b 100644 --- a/components/event_dispatcher/container_aware_dispatcher.rst +++ b/components/event_dispatcher/container_aware_dispatcher.rst @@ -8,9 +8,9 @@ Introduction ------------ The :class:`Symfony\\Component\\EventDispatcher\\ContainerAwareEventDispatcher` is -a special EventDispatcher implementation which is coupled to the service container +a special ``EventDispatcher`` implementation which is coupled to the service container that is part of :doc:`the DependencyInjection component `. -It allows services to be specified as event listeners making the EventDispatcher +It allows services to be specified as event listeners making the ``EventDispatcher`` extremely powerful. Services are lazy loaded meaning the services attached as listeners will only be @@ -31,8 +31,8 @@ into the :class:`Symfony\\Component\\EventDispatcher\\ContainerAwareEventDispatc Adding Listeners ---------------- -The *Container Aware EventDispatcher* can either load specified services -directly, or services that implement :class:`Symfony\\Component\\EventDispatcher\\EventSubscriberInterface`. +The ``ContainerAwareEventDispatcher`` can either load specified services +directly or services that implement :class:`Symfony\\Component\\EventDispatcher\\EventSubscriberInterface`. The following examples assume the service container has been loaded with any services that are mentioned. @@ -53,7 +53,7 @@ method where the ``$callback`` is an array of ``array($serviceId, $methodName)`` Adding Subscriber Services ~~~~~~~~~~~~~~~~~~~~~~~~~~ -``EventSubscribers`` can be added using the +Event subscribers can be added using the :method:`Symfony\\Component\\EventDispatcher\\ContainerAwareEventDispatcher::addSubscriberService` method where the first argument is the service ID of the subscriber service, and the second argument is the service's class name (which must implement @@ -64,7 +64,7 @@ and the second argument is the service's class name (which must implement 'StoreSubscriber' ); -The ``EventSubscriberInterface`` will be exactly as you would expect:: +The ``EventSubscriberInterface`` is exactly as you would expect:: use Symfony\Component\EventDispatcher\EventSubscriberInterface; // ... diff --git a/components/event_dispatcher/introduction.rst b/components/event_dispatcher/introduction.rst index 9e2b661268c..5ed56cc3e05 100644 --- a/components/event_dispatcher/introduction.rst +++ b/components/event_dispatcher/introduction.rst @@ -12,7 +12,7 @@ The EventDispatcher Component Introduction ------------ -Object Oriented code has gone a long way to ensuring code extensibility. By +Object-oriented code has gone a long way to ensuring code extensibility. By creating classes that have well defined responsibilities, your code becomes more flexible and a developer can extend them with subclasses to modify their behaviors. But if they want to share the changes with other developers who have @@ -591,8 +591,8 @@ specifically pass one:: $dispatcher->dispatch('foo.event'); -Moreover, the EventDispatcher always returns whichever event object that was -dispatched, i.e. either the event that was passed or the event that was +Moreover, the event dispatcher always returns whichever event object that +was dispatched, i.e. either the event that was passed or the event that was created internally by the dispatcher. This allows for nice shortcuts:: if (!$dispatcher->dispatch('foo.event')->isPropagationStopped()) { diff --git a/components/form/form_events.rst b/components/form/form_events.rst index 838d59efe02..2d7ba337429 100644 --- a/components/form/form_events.rst +++ b/components/form/form_events.rst @@ -5,10 +5,11 @@ Form Events =========== The Form component provides a structured process to let you customize your -forms, by making use of the :doc:`EventDispatcher ` -component. Using form events, you may modify information or fields at -different steps of the workflow: from the population of the form to the -submission of the data from the request. +forms, by making use of the +:doc:`EventDispatcher component `. +Using form events, you may modify information or fields at different steps +of the workflow: from the population of the form to the submission of the +data from the request. Registering an event listener is very easy using the Form component. diff --git a/components/form/introduction.rst b/components/form/introduction.rst index d17ae87e0e2..0d05caf8a1b 100644 --- a/components/form/introduction.rst +++ b/components/form/introduction.rst @@ -27,7 +27,7 @@ Configuration .. tip:: - If you are working with the full-stack Symfony framework, the Form component + If you are working with the full-stack Symfony Framework, the Form component is already configured for you. In this case, skip to :ref:`component-form-intro-create-simple-form`. In Symfony, forms are represented by objects and these objects are built @@ -375,7 +375,7 @@ Creating a simple Form .. tip:: - If you're using the Symfony framework, then the form factory is available + If you're using the Symfony Framework, then the form factory is available automatically as a service called ``form.factory``. Also, the default base controller class has a :method:`Symfony\\Bundle\\FrameworkBundle\\Controller::createFormBuilder` method, which is a shortcut to fetch the form factory and call ``createBuilder`` diff --git a/components/form/type_guesser.rst b/components/form/type_guesser.rst index ae5f305a5c9..13a64400118 100644 --- a/components/form/type_guesser.rst +++ b/components/form/type_guesser.rst @@ -186,6 +186,6 @@ The last thing you need to do is registering your custom type guesser by using .. note:: - When you use the Symfony framework, you need to register your type guesser + When you use the Symfony Framework, you need to register your type guesser and tag it with ``form.type_guesser``. For more information see :ref:`the tag reference `. diff --git a/components/http_foundation/introduction.rst b/components/http_foundation/introduction.rst index f95117dd1e6..57f4ba479cf 100644 --- a/components/http_foundation/introduction.rst +++ b/components/http_foundation/introduction.rst @@ -173,7 +173,7 @@ in the request, which is also an instance of :class:`Symfony\\Component\\HttpFoundation\\ParameterBag`. This is mostly used to attach information that belongs to the Request and that needs to be accessed from many different points in your application. For information -on how this is used in the Symfony framework, see +on how this is used in the Symfony Framework, see :ref:`the Symfony book `. Finally, the raw data sent with the request body can be accessed using diff --git a/components/http_foundation/session_php_bridge.rst b/components/http_foundation/session_php_bridge.rst index 5b55417d983..295c0976854 100644 --- a/components/http_foundation/session_php_bridge.rst +++ b/components/http_foundation/session_php_bridge.rst @@ -16,9 +16,9 @@ However when there really are circumstances where this is not possible, you can use a special storage bridge :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\PhpBridgeSessionStorage` which is designed to allow Symfony to work with a session started outside of -the Symfony Session framework. You are warned that things can interrupt this -use-case unless you are careful: for example the legacy application erases -``$_SESSION``. +the Symfony HttpFoundation component. You are warned that things can interrupt +this use-case unless you are careful: for example the legacy application +erases ``$_SESSION``. A typical use of this might look like this:: diff --git a/components/http_kernel/introduction.rst b/components/http_kernel/introduction.rst index 929df646be1..d97571ebcb8 100644 --- a/components/http_kernel/introduction.rst +++ b/components/http_kernel/introduction.rst @@ -7,9 +7,9 @@ The HttpKernel Component ======================== The HttpKernel component provides a structured process for converting - a ``Request`` into a ``Response`` by making use of the EventDispatcher. - It's flexible enough to create a full-stack framework (Symfony), a micro-framework - (Silex) or an advanced CMS system (Drupal). + a ``Request`` into a ``Response`` by making use of the EventDispatcher + component. It's flexible enough to create a full-stack framework (Symfony), + a micro-framework (Silex) or an advanced CMS system (Drupal). Installation ------------ @@ -79,10 +79,11 @@ and talks about how one specific implementation of the HttpKernel - the Symfony Framework - works. Initially, using the :class:`Symfony\\Component\\HttpKernel\\HttpKernel` -is really simple, and involves creating an :doc:`EventDispatcher ` -and a :ref:`controller resolver ` -(explained below). To complete your working kernel, you'll add more event -listeners to the events discussed below:: +is really simple and involves creating an +:doc:`event dispatcher ` and a +:ref:`controller resolver ` (explained +below). To complete your working kernel, you'll add more event listeners +to the events discussed below:: use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\HttpKernel; diff --git a/components/templating/introduction.rst b/components/templating/introduction.rst index 247ea748c35..52c1cee65dc 100644 --- a/components/templating/introduction.rst +++ b/components/templating/introduction.rst @@ -84,7 +84,7 @@ Global Variables Sometimes, you need to set a variable which is available in all templates rendered by an engine (like the ``$app`` variable when using the Symfony -framework). These variables can be set by using the +Framework). These variables can be set by using the :method:`Symfony\\Component\\Templating\\PhpEngine::addGlobal` method and they can be accessed in the template as normal variables:: diff --git a/cookbook/assetic/asset_management.rst b/cookbook/assetic/asset_management.rst index 503036bb3fe..6db46608147 100644 --- a/cookbook/assetic/asset_management.rst +++ b/cookbook/assetic/asset_management.rst @@ -89,7 +89,7 @@ To include JavaScript files, use the ``javascripts`` tag in any template: .. tip:: - You can also include CSS Stylesheets: see :ref:`cookbook-assetic-including-css`. + You can also include CSS stylesheets: see :ref:`cookbook-assetic-including-css`. In this example, all of the files in the ``Resources/public/js/`` directory of the AppBundle will be loaded and served from a different location. @@ -155,7 +155,7 @@ the :ref:`cssrewrite ` filter. but that in this example, you referred to the CSS files using their actual, publicly-accessible path: ``bundles/app/css``. You can use either, except that there is a known issue that causes the ``cssrewrite`` filter to fail - when using the ``@AppBundle`` syntax for CSS Stylesheets. + when using the ``@AppBundle`` syntax for CSS stylesheets. .. _cookbook-assetic-including-image: @@ -204,7 +204,7 @@ Combining Assets ~~~~~~~~~~~~~~~~ One feature of Assetic is that it will combine many files into one. This helps -to reduce the number of HTTP requests, which is great for frontend performance. +to reduce the number of HTTP requests, which is great for front-end performance. It also allows you to maintain the files more easily by splitting them into manageable parts. This can help with re-usability as you can easily split project-specific files from those which can be used in other applications, diff --git a/cookbook/assetic/yuicompressor.rst b/cookbook/assetic/yuicompressor.rst index dccb8351a56..4d537c71c17 100644 --- a/cookbook/assetic/yuicompressor.rst +++ b/cookbook/assetic/yuicompressor.rst @@ -131,7 +131,7 @@ can be repeated to minify your stylesheets. Disable Minification in Debug Mode ---------------------------------- -Minified JavaScripts and Stylesheets are very difficult to read, let alone +Minified JavaScripts and stylesheets are very difficult to read, let alone debug. Because of this, Assetic lets you disable a certain filter when your application is in debug mode. You can do this by prefixing the filter name in your template with a question mark: ``?``. This tells Assetic to only diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index e39590d7750..46389382840 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -166,7 +166,7 @@ Commands, Helpers, Listeners, and Controllers. Classes that connect to the event dispatcher should be suffixed with ``Listener``. -Exceptions classes should be stored in an ``Exception`` sub-namespace. +Exception classes should be stored in an ``Exception`` sub-namespace. Vendors ------- diff --git a/cookbook/bundles/configuration.rst b/cookbook/bundles/configuration.rst index fd1c9ea14a1..a6505f481af 100644 --- a/cookbook/bundles/configuration.rst +++ b/cookbook/bundles/configuration.rst @@ -117,7 +117,7 @@ bundle configuration would look like: .. seealso:: - For parameter handling within a Dependency Injection class see + For parameter handling within a dependency injection container see :doc:`/cookbook/configuration/using_parameters_in_dic`. diff --git a/cookbook/configuration/front_controllers_and_kernel.rst b/cookbook/configuration/front_controllers_and_kernel.rst index 35c50e72bce..f1906c16837 100644 --- a/cookbook/configuration/front_controllers_and_kernel.rst +++ b/cookbook/configuration/front_controllers_and_kernel.rst @@ -58,7 +58,7 @@ As you can see, this URL contains the PHP script to be used as the front controller. You can use that to easily switch the front controller or use a custom one by placing it in the ``web/`` directory (e.g. ``app_cache.php``). -When using Apache and the `RewriteRule shipped with the Standard Edition`_, +When using Apache and the `RewriteRule shipped with the Symfony Standard Edition`_, you can omit the filename from the URL and the RewriteRule will use ``app.php`` as the default one. @@ -126,7 +126,7 @@ controller to make use of the new kernel. Having different ``AppKernels`` might be useful to enable different front controllers (on potentially different servers) to run parts of your application -independently (for example, the admin UI, the frontend UI and database migrations). +independently (for example, the admin UI, the front-end UI and database migrations). .. note:: @@ -145,7 +145,7 @@ configuration from the right *environment*. Environments have been covered extensively :doc:`in the previous chapter `, -and you probably remember that the Standard Edition comes with three +and you probably remember that the Symfony Standard Edition comes with three of them - ``dev``, ``prod`` and ``test``. More technically, these names are nothing more than strings passed from the @@ -153,7 +153,7 @@ front controller to the ``AppKernel``'s constructor. This name can then be used in the :method:`Symfony\\Component\\HttpKernel\\KernelInterface::registerContainerConfiguration` method to decide which configuration files to load. -The Standard Edition's `AppKernel`_ class implements this method by simply +The Symfony Standard Edition's `AppKernel`_ class implements this method by simply loading the ``app/config/config_*environment*.yml`` file. You are, of course, free to implement this method differently if you need a more sophisticated way of loading your configuration. @@ -165,5 +165,5 @@ way of loading your configuration. .. _app/console: https://github.com/symfony/symfony-standard/blob/master/app/console .. _AppKernel: https://github.com/symfony/symfony-standard/blob/master/app/AppKernel.php .. _decorate: http://en.wikipedia.org/wiki/Decorator_pattern -.. _RewriteRule shipped with the Standard Edition: https://github.com/symfony/symfony-standard/blob/master/web/.htaccess +.. _RewriteRule shipped with the Symfony Standard Edition: https://github.com/symfony/symfony-standard/blob/master/web/.htaccess .. _template methods: http://en.wikipedia.org/wiki/Template_method_pattern diff --git a/cookbook/configuration/using_parameters_in_dic.rst b/cookbook/configuration/using_parameters_in_dic.rst index 55d6656b244..f5c00244797 100644 --- a/cookbook/configuration/using_parameters_in_dic.rst +++ b/cookbook/configuration/using_parameters_in_dic.rst @@ -104,7 +104,7 @@ be injected with this parameter via the extension as follows:: public function __construct($debug) { - $this->debug = (Boolean) $debug; + $this->debug = (bool) $debug; } public function getConfigTreeBuilder() diff --git a/cookbook/console/console_command.rst b/cookbook/console/console_command.rst index 67073a92e5b..028e85f423f 100644 --- a/cookbook/console/console_command.rst +++ b/cookbook/console/console_command.rst @@ -6,7 +6,7 @@ How to Create a Console Command The Console page of the Components section (:doc:`/components/console/introduction`) covers how to create a console command. This cookbook article covers the differences -when creating console commands within the Symfony framework. +when creating console commands within the Symfony Framework. Automatically Registering Commands ---------------------------------- @@ -153,9 +153,9 @@ see :doc:`/cookbook/service_container/scopes`. Testing Commands ---------------- -When testing commands used as part of the full framework -:class:`Symfony\\Bundle\\FrameworkBundle\\Console\\Application ` should be used -instead of +When testing commands used as part of the full-stack framework, +:class:`Symfony\\Bundle\\FrameworkBundle\\Console\\Application ` +should be used instead of :class:`Symfony\\Component\\Console\\Application `:: use Symfony\Component\Console\Tester\CommandTester; diff --git a/cookbook/console/logging.rst b/cookbook/console/logging.rst index 3bed28d5e7a..08781d7901b 100644 --- a/cookbook/console/logging.rst +++ b/cookbook/console/logging.rst @@ -14,13 +14,14 @@ output and process it. This can be especially handful if you already have some existing setup for aggregating and analyzing Symfony logs. There are basically two logging cases you would need: - * Manually logging some information from your command; - * Logging uncaught Exceptions. + +* Manually logging some information from your command; +* Logging uncaught exceptions. Manually Logging from a Console Command --------------------------------------- -This one is really simple. When you create a console command within the full +This one is really simple. When you create a console command within the full-stack framework as described in ":doc:`/cookbook/console/console_command`", your command extends :class:`Symfony\\Bundle\\FrameworkBundle\\Command\\ContainerAwareCommand`. This means that you can simply access the standard logger service through the diff --git a/cookbook/console/sending_emails.rst b/cookbook/console/sending_emails.rst index c6e870189e5..41318938a61 100644 --- a/cookbook/console/sending_emails.rst +++ b/cookbook/console/sending_emails.rst @@ -7,7 +7,7 @@ How to Generate URLs and Send Emails from the Console Unfortunately, the command line context does not know about your VirtualHost or domain name. This means that if you generate absolute URLs within a -Console Command you'll probably end up with something like ``http://localhost/foo/bar`` +console command you'll probably end up with something like ``http://localhost/foo/bar`` which is not very useful. To fix this, you need to configure the "request context", which is a fancy diff --git a/cookbook/console/usage.rst b/cookbook/console/usage.rst index 9fa569f9d7f..dc3495261c9 100644 --- a/cookbook/console/usage.rst +++ b/cookbook/console/usage.rst @@ -5,8 +5,8 @@ How to Use the Console ====================== The :doc:`/components/console/usage` page of the components documentation looks -at the global console options. When you use the console as part of the full -stack framework, some additional global options are available as well. +at the global console options. When you use the console as part of the full-stack +framework, some additional global options are available as well. By default, console commands run in the ``dev`` environment and you may want to change this for some commands. For example, you may want to run some commands diff --git a/cookbook/doctrine/registration_form.rst b/cookbook/doctrine/registration_form.rst index 4e4abbb5a05..0c64e4cf7e3 100644 --- a/cookbook/doctrine/registration_form.rst +++ b/cookbook/doctrine/registration_form.rst @@ -194,7 +194,7 @@ Start by creating a simple class which represents the "registration":: public function setTermsAccepted($termsAccepted) { - $this->termsAccepted = (Boolean) $termsAccepted; + $this->termsAccepted = (bool) $termsAccepted; } } diff --git a/cookbook/email/dev_environment.rst b/cookbook/email/dev_environment.rst index bf16761a78b..d5dbabba918 100644 --- a/cookbook/email/dev_environment.rst +++ b/cookbook/email/dev_environment.rst @@ -186,7 +186,7 @@ Viewing from the Web Debug Toolbar ---------------------------------- You can view any email sent during a single response when you are in the -``dev`` environment using the Web Debug Toolbar. The email icon in the toolbar +``dev`` environment using the web debug toolbar. The email icon in the toolbar will show how many emails were sent. If you click it, a report will open showing the details of the sent emails. diff --git a/cookbook/email/spool.rst b/cookbook/email/spool.rst index cf8ccce2c9d..db40c23ba44 100644 --- a/cookbook/email/spool.rst +++ b/cookbook/email/spool.rst @@ -20,7 +20,7 @@ Spool Using Memory When you use spooling to store the emails to memory, they will get sent right before the kernel terminates. This means the email only gets sent if the whole -request got executed without any unhandled Exception or any errors. To configure +request got executed without any unhandled exception or any errors. To configure swiftmailer with the memory option, use the following configuration: .. configuration-block:: diff --git a/cookbook/email/testing.rst b/cookbook/email/testing.rst index d5fce3b4186..c95ea6cb5dc 100644 --- a/cookbook/email/testing.rst +++ b/cookbook/email/testing.rst @@ -1,16 +1,16 @@ .. index:: single: Emails; Testing -How to Test that an Email is Sent in a functional Test +How to Test that an Email is Sent in a Functional Test ====================================================== -Sending e-mails with Symfony is pretty straightforward thanks to the +Sending emails with Symfony is pretty straightforward thanks to the SwiftmailerBundle, which leverages the power of the `Swift Mailer`_ library. To functionally test that an email was sent, and even assert the email subject, content or any other headers, you can use :ref:`the Symfony Profiler `. -Start with an easy controller action that sends an e-mail:: +Start with an easy controller action that sends an email:: public function sendEmailAction($name) { @@ -49,13 +49,13 @@ to get information about the messages send on the previous request:: $mailCollector = $client->getProfile()->getCollector('swiftmailer'); - // Check that an e-mail was sent + // Check that an email was sent $this->assertEquals(1, $mailCollector->getMessageCount()); $collectedMessages = $mailCollector->getMessages(); $message = $collectedMessages[0]; - // Asserting e-mail data + // Asserting email data $this->assertInstanceOf('Swift_Message', $message); $this->assertEquals('Hello Email', $message->getSubject()); $this->assertEquals('send@example.com', key($message->getFrom())); diff --git a/cookbook/form/data_transformers.rst b/cookbook/form/data_transformers.rst index b7b46836812..8bbcea505c1 100644 --- a/cookbook/form/data_transformers.rst +++ b/cookbook/form/data_transformers.rst @@ -169,8 +169,8 @@ when creating your form. Later, you'll learn how you could create a custom Cool, you're done! Your user will be able to enter an issue number into the text field and it will be transformed back into an Issue object. This means -that, after a successful submission, the Form framework will pass a real Issue -object to ``Task::setIssue()`` instead of the issue number. +that, after a successful submission, the Form component will pass a real +``Issue`` object to ``Task::setIssue()`` instead of the issue number. If the issue isn't found, a form error will be created for that field and its error message can be controlled with the ``invalid_message`` field option. diff --git a/cookbook/form/dynamic_form_modification.rst b/cookbook/form/dynamic_form_modification.rst index 6124d9b6f24..acada20afda 100644 --- a/cookbook/form/dynamic_form_modification.rst +++ b/cookbook/form/dynamic_form_modification.rst @@ -77,7 +77,7 @@ or if an existing product is being edited (e.g. a product fetched from the datab Suppose now, that you don't want the user to be able to change the ``name`` value once the object has been created. To do this, you can rely on Symfony's -:doc:`EventDispatcher ` +:doc:`EventDispatcher component ` system to analyze the data on the object and modify the form based on the Product object's data. In this entry, you'll learn how to add this level of flexibility to your forms. diff --git a/cookbook/logging/monolog.rst b/cookbook/logging/monolog.rst index 6093fa85589..0cf3a3cfeff 100644 --- a/cookbook/logging/monolog.rst +++ b/cookbook/logging/monolog.rst @@ -46,7 +46,7 @@ The basic handler is the ``StreamHandler`` which writes logs in a stream Monolog comes also with a powerful built-in handler for the logging in prod environment: ``FingersCrossedHandler``. It allows you to store the messages in a buffer and to log them only if a message reaches the -action level (``error`` in the configuration provided in the Standard +action level (``error`` in the configuration provided in the Symfony Standard Edition) by forwarding the messages to another handler. Using several Handlers diff --git a/cookbook/routing/service_container_parameters.rst b/cookbook/routing/service_container_parameters.rst index 74f92b53a22..ec8f8dce56b 100644 --- a/cookbook/routing/service_container_parameters.rst +++ b/cookbook/routing/service_container_parameters.rst @@ -127,5 +127,5 @@ path): .. seealso:: - For parameter handling within a Dependency Injection class see + For parameter handling within a Dependency Injection Class see :doc:`/cookbook/configuration/using_parameters_in_dic`. diff --git a/cookbook/security/voters_data_permission.rst b/cookbook/security/voters_data_permission.rst index 7ac729b9892..2376d393b53 100644 --- a/cookbook/security/voters_data_permission.rst +++ b/cookbook/security/voters_data_permission.rst @@ -121,7 +121,7 @@ edit a particular object. Here's an example implementation:: switch($attribute) { case self::VIEW: // the data object could have for example a method isPrivate() - // which checks the Boolean attribute $private + // which checks the boolean attribute $private if (!$post->isPrivate()) { return VoterInterface::ACCESS_GRANTED; } diff --git a/cookbook/service_container/event_listener.rst b/cookbook/service_container/event_listener.rst index b1640b490fa..3dd9987266c 100644 --- a/cookbook/service_container/event_listener.rst +++ b/cookbook/service_container/event_listener.rst @@ -10,7 +10,7 @@ component and can be viewed in the :class:`Symfony\\Component\\HttpKernel\\Kerne To hook into an event and add your own custom logic, you have to create a service that will act as an event listener on that event. In this entry, -you will create a service that will act as an Exception Listener, allowing +you will create a service that will act as an exception listener, allowing you to modify how exceptions are shown by your application. The ``KernelEvents::EXCEPTION`` event is just one of the core kernel events:: diff --git a/cookbook/session/php_bridge.rst b/cookbook/session/php_bridge.rst index fd18a7e3b75..80606654670 100644 --- a/cookbook/session/php_bridge.rst +++ b/cookbook/session/php_bridge.rst @@ -81,13 +81,13 @@ the example below: .. note:: - If the legacy application requires its own session save-handler, do not + If the legacy application requires its own session save handler, do not override this. Instead set ``handler_id: ~``. Note that a save handler cannot be changed once the session has been started. If the application - starts the session before Symfony is initialized, the save-handler will + starts the session before Symfony is initialized, the save handler will have already been set. In this case, you will need ``handler_id: ~``. - Only override the save-handler if you are sure the legacy application - can use the Symfony save-handler without side effects and that the session + Only override the save handler if you are sure the legacy application + can use the Symfony save handler without side effects and that the session has not been started before Symfony is initialized. For more details, see :doc:`/components/http_foundation/session_php_bridge`. diff --git a/cookbook/symfony1.rst b/cookbook/symfony1.rst index 10ba32149ff..b471f4729cf 100644 --- a/cookbook/symfony1.rst +++ b/cookbook/symfony1.rst @@ -4,7 +4,7 @@ How Symfony2 Differs from Symfony1 ================================== -The Symfony2 framework embodies a significant evolution when compared with +The Symfony2 Framework embodies a significant evolution when compared with the first version of the framework. Fortunately, with the MVC architecture at its core, the skills used to master a symfony1 project continue to be very relevant when developing in Symfony2. Sure, ``app.yml`` is gone, but @@ -20,7 +20,7 @@ So, sit back and relax as you travel from "then" to "now". Directory Structure ------------------- -When looking at a Symfony2 project - for example, the `Symfony2 Standard Edition`_ - +When looking at a Symfony2 project - for example, the `Symfony Standard Edition`_ - you'll notice a very different directory structure than in symfony1. The differences, however, are somewhat superficial. @@ -162,7 +162,7 @@ settings defined and Composer takes care of everything for you. For this to work, all third-party libraries used by your project must be defined in the ``composer.json`` file. -If you look at the ``HelloController`` from the Symfony2 Standard Edition you +If you look at the ``HelloController`` from the Symfony Standard Edition you can see that it lives in the ``Acme\DemoBundle\Controller`` namespace. Yet, the AcmeDemoBundle is not defined in your ``composer.json`` file. Nonetheless are the files autoloaded. This is because you can tell Composer to autoload files @@ -200,14 +200,14 @@ Applications ------------ In a symfony1 project, it is common to have several applications: one for the -frontend and one for the backend for instance. +front-end and one for the back-end for instance. In a Symfony2 project, you only need to create one application (a blog application, an intranet application, ...). Most of the time, if you want to create a second application, you might instead create another project and share some bundles between them. -And if you need to separate the frontend and the backend features of some +And if you need to separate the front-end and the back-end features of some bundles, you can create sub-namespaces for controllers, sub-directories for templates, different semantic configurations, separate routing configurations, and so on. @@ -227,7 +227,7 @@ Bundles and Plugins In a symfony1 project, a plugin could contain configuration, modules, PHP libraries, assets and anything else related to your project. In Symfony2, the idea of a plugin is replaced by the "bundle". A bundle is even more powerful -than a plugin because the core Symfony2 framework is brought in via a series +than a plugin because the core Symfony2 Framework is brought in via a series of bundles. In Symfony2, bundles are first-class citizens that are so flexible that even core code itself is a bundle. @@ -365,5 +365,5 @@ primarily to configure objects that you can use. For more information, see the chapter titled ":doc:`/book/service_container`". .. _`Composer`: http://getcomposer.org -.. _`Symfony2 Standard Edition`: https://github.com/symfony/symfony-standard +.. _`Symfony Standard Edition`: https://github.com/symfony/symfony-standard .. _`the Composer documentation`: http://getcomposer.org/doc/04-schema.md#autoload diff --git a/cookbook/validation/custom_constraint.rst b/cookbook/validation/custom_constraint.rst index b2a27b61216..24f3c615f4c 100644 --- a/cookbook/validation/custom_constraint.rst +++ b/cookbook/validation/custom_constraint.rst @@ -159,8 +159,8 @@ Constraint Validators with Dependencies ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If your constraint validator has dependencies, such as a database connection, -it will need to be configured as a service in the dependency injection -container. This service must include the ``validator.constraint_validator`` +it will need to be configured as a service in the Dependency Injection +Container. This service must include the ``validator.constraint_validator`` tag and an ``alias`` attribute: .. configuration-block:: diff --git a/cookbook/web_services/php_soap_extension.rst b/cookbook/web_services/php_soap_extension.rst index 49ec8c323b1..c12efb742e7 100644 --- a/cookbook/web_services/php_soap_extension.rst +++ b/cookbook/web_services/php_soap_extension.rst @@ -51,7 +51,7 @@ In this case, the SOAP service will allow the client to call a method called } Next, you can train Symfony to be able to create an instance of this class. -Since the class sends an e-mail, it's been designed to accept a ``Swift_Mailer`` +Since the class sends an email, it's been designed to accept a ``Swift_Mailer`` instance. Using the Service Container, you can configure Symfony to construct a ``HelloService`` object properly: diff --git a/quick_tour/the_big_picture.rst b/quick_tour/the_big_picture.rst index f63f7473c1a..d82025deb27 100644 --- a/quick_tour/the_big_picture.rst +++ b/quick_tour/the_big_picture.rst @@ -269,7 +269,7 @@ Working with Environments Now that you have a better understanding of how Symfony works, take a closer look at the bottom of any Symfony rendered page. You should notice a small -bar with the Symfony logo. This is the "Web Debug Toolbar" and it is a Symfony +bar with the Symfony logo. This is the "web debug toolbar" and it is a Symfony developer's best friend! .. image:: /images/quick_tour/web_debug_toolbar.png @@ -310,8 +310,8 @@ URL, you can visit ``http://localhost:8000/app_dev.php`` URL. The main difference between environments is that ``dev`` is optimized to provide lots of information to the developer, which means worse application performance. Meanwhile, ``prod`` is optimized to get the best performance, -which means that debug information is disabled, as well as the Web Debug -Toolbar. +which means that debug information is disabled, as well as the web debug +toolbar. The other difference between environments is the configuration options used to execute the application. When you access the ``dev`` environment, Symfony diff --git a/quick_tour/the_controller.rst b/quick_tour/the_controller.rst index 2aadff900d4..028fe3d75d9 100644 --- a/quick_tour/the_controller.rst +++ b/quick_tour/the_controller.rst @@ -339,6 +339,6 @@ Final Thoughts That's all there is to it and I'm not even sure you'll have spent the full 10 minutes. You were briefly introduced to bundles in the first part and -all the features you've learned about so far are part of the core framework -bundle. But thanks to bundles, everything in Symfony can be extended or -replaced. That's the topic of the :doc:`next part of this tutorial `. +all the features you've learned about so far are part of the core FrameworkBundle. +But thanks to bundles, everything in Symfony can be extended or replaced. +That's the topic of the :doc:`next part of this tutorial `. diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 81b85e53063..675d770ac8c 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -87,7 +87,7 @@ http_method_override .. versionadded:: 2.3 The ``http_method_override`` option was introduced in Symfony 2.3. -**type**: ``Boolean`` **default**: ``true`` +**type**: ``boolean`` **default**: ``true`` This determines whether the ``_method`` request parameter is used as the intended HTTP method on POST requests. If enabled, the @@ -176,7 +176,7 @@ is set, then the ``ide`` option will be ignored. test ~~~~ -**type**: ``Boolean`` +**type**: ``boolean`` If this configuration parameter is present (and not ``false``), then the services related to testing your application (e.g. ``test.client``) are loaded. @@ -321,14 +321,14 @@ to the cookie specification. cookie_secure ............. -**type**: ``Boolean`` **default**: ``false`` +**type**: ``boolean`` **default**: ``false`` This determines whether cookies should only be sent over secure connections. cookie_httponly ............... -**type**: ``Boolean`` **default**: ``false`` +**type**: ``boolean`` **default**: ``false`` This determines whether cookies should only be accessible through the HTTP protocol. This means that the cookie won't be accessible by scripting languages, such @@ -641,7 +641,7 @@ to implement the :class:`Symfony\\Component\\Validator\\Mapping\\Cache\\CacheInt enable_annotations .................. -**type**: ``Boolean`` **default**: ``false`` +**type**: ``boolean`` **default**: ``false`` If this option is enabled, validation constraints can be defined using annotations. diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index b3d5807f475..c3f174f4a98 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -277,7 +277,7 @@ a separate firewall just for ``check_path`` URL). use_forward ........... -**type**: ``Boolean`` **default**: ``false`` +**type**: ``boolean`` **default**: ``false`` If you'd like the user to be forwarded to the login form instead of being redirected, set this option to ``true``. @@ -303,7 +303,7 @@ will look for a POST parameter with this name. post_only ......... -**type**: ``Boolean`` **default**: ``true`` +**type**: ``boolean`` **default**: ``true`` By default, you must submit your login form to the ``check_path`` URL as a POST request. By setting this option to ``false``, you can send a GET request @@ -312,10 +312,10 @@ to the ``check_path`` URL. Redirecting after Login ~~~~~~~~~~~~~~~~~~~~~~~ -* ``always_use_default_target_path`` (type: ``Boolean``, default: ``false``) +* ``always_use_default_target_path`` (type: ``boolean``, default: ``false``) * ``default_target_path`` (type: ``string``, default: ``/``) * ``target_path_parameter`` (type: ``string``, default: ``_target_path``) -* ``use_referer`` (type: ``Boolean``, default: ``false``) +* ``use_referer`` (type: ``boolean``, default: ``false``) .. _reference-security-pbkdf2: diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index d9614377bb3..ccadb7dcb69 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -169,7 +169,7 @@ For details, see :ref:`the cookbook entry. `. -If you want to have a Boolean field, use :doc:`checkbox `. +If you want to have a boolean field, use :doc:`checkbox `. +-------------+---------------------------------------------------------------------+ | Rendered as | ``input`` ``radio`` field | diff --git a/reference/forms/types/submit.rst b/reference/forms/types/submit.rst index 63385eb328c..89c3632999b 100644 --- a/reference/forms/types/submit.rst +++ b/reference/forms/types/submit.rst @@ -79,5 +79,5 @@ Form Variables ======== =========== ============================================================== Variable Type Usage ======== =========== ============================================================== -clicked ``Boolean`` Whether the button is clicked or not. +clicked ``boolean`` Whether the button is clicked or not. ======== =========== ============================================================== diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst index 71b3af1cdb5..f729f419dcc 100644 --- a/reference/forms/types/time.rst +++ b/reference/forms/types/time.rst @@ -175,9 +175,9 @@ Form Variables +==============+=============+======================================================================+ | widget | ``mixed`` | The value of the `widget`_ option. | +--------------+-------------+----------------------------------------------------------------------+ -| with_minutes | ``Boolean`` | The value of the `with_minutes`_ option. | +| with_minutes | ``boolean`` | The value of the `with_minutes`_ option. | +--------------+-------------+----------------------------------------------------------------------+ -| with_seconds | ``Boolean`` | The value of the `with_seconds`_ option. | +| with_seconds | ``boolean`` | The value of the `with_seconds`_ option. | +--------------+-------------+----------------------------------------------------------------------+ | type | ``string`` | Only present when widget is ``single_text`` and HTML5 is activated, | | | | contains the input type to use (``datetime``, ``date`` or ``time``). | diff --git a/reference/forms/types/variables/check_or_radio_table.rst.inc b/reference/forms/types/variables/check_or_radio_table.rst.inc index ae137a3f200..ddc30c7fee6 100644 --- a/reference/forms/types/variables/check_or_radio_table.rst.inc +++ b/reference/forms/types/variables/check_or_radio_table.rst.inc @@ -1,5 +1,5 @@ -======== ============ ============================================ -Variable Type Usage -======== ============ ============================================ -checked ``Boolean`` Whether or not the current input is checked. -======== ============ ============================================ +======== =========== ============================================ +Variable Type Usage +======== =========== ============================================ +checked ``boolean`` Whether or not the current input is checked. +======== =========== ============================================