diff --git a/cookbook/assetic/apply_to_option.rst b/cookbook/assetic/apply_to_option.rst index 9c2e7cccdfb..1e9661327af 100644 --- a/cookbook/assetic/apply_to_option.rst +++ b/cookbook/assetic/apply_to_option.rst @@ -1,7 +1,7 @@ .. index:: single: Assetic; Apply filters -How to Apply an Assetic Filter to a Specific File Extension +How to Apply an Assetic Filter to a specific File Extension =========================================================== Assetic filters can be applied to individual files, groups of files or even, @@ -49,7 +49,7 @@ An example configuration might look like this: ), )); -Filter a Single File +Filter a single File -------------------- You can now serve up a single CoffeeScript file as JavaScript from within your @@ -75,7 +75,7 @@ templates: This is all that's needed to compile this CoffeeScript file and serve it as the compiled JavaScript. -Filter Multiple Files +Filter multiple Files --------------------- You can also combine multiple CoffeeScript files into a single output file: @@ -107,7 +107,7 @@ JavaScript. .. _cookbook-assetic-apply-to: -Filtering based on a File Extension +Filtering Based on a File Extension ----------------------------------- One of the great advantages of using Assetic is reducing the number of asset @@ -146,7 +146,7 @@ applied to all ``.coffee`` files: apply_to="\.coffee$" /> /usr/lib/node_modules/ - + .. code-block:: php // app/config/config.php diff --git a/cookbook/assetic/asset_management.rst b/cookbook/assetic/asset_management.rst index 8c16204ea0e..cc80026071e 100644 --- a/cookbook/assetic/asset_management.rst +++ b/cookbook/assetic/asset_management.rst @@ -159,7 +159,7 @@ the :ref:`cssrewrite ` filter. .. _cookbook-assetic-including-image: -Including images +Including Images ~~~~~~~~~~~~~~~~ To include an image you can use the ``image`` tag. @@ -422,7 +422,7 @@ into your template: A more detailed guide about configuring and using Assetic filters as well as details of Assetic's debug mode can be found in :doc:`/cookbook/assetic/uglifyjs`. -Controlling the URL used +Controlling the URL Used ------------------------ If you wish to, you can control the URLs that Assetic produces. This is @@ -471,7 +471,7 @@ it might be downright frustrating. Fortunately, Assetic provides a way to dump your assets to real files, instead of being generated dynamically. -Dumping Asset Files in the ``prod`` environment +Dumping Asset Files in the ``prod`` Environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In the ``prod`` environment, your JS and CSS files are represented by a single @@ -500,7 +500,7 @@ This will physically generate and write each file that you need (e.g. ``/js/abcd If you update any of your assets, you'll need to run this again to regenerate the file. -Dumping Asset Files in the ``dev`` environment +Dumping Asset Files in the ``dev`` Environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default, each asset path generated in the ``dev`` environment is handled diff --git a/cookbook/assetic/jpeg_optimize.rst b/cookbook/assetic/jpeg_optimize.rst index ff1ef34ae96..162b859fcf9 100644 --- a/cookbook/assetic/jpeg_optimize.rst +++ b/cookbook/assetic/jpeg_optimize.rst @@ -1,7 +1,7 @@ .. index:: single: Assetic; Image optimization -How to Use Assetic For Image Optimization with Twig Functions +How to Use Assetic for Image Optimization with Twig Functions ============================================================= Amongst its many filters, Assetic has four filters which can be used for on-the-fly @@ -111,7 +111,7 @@ remove these by using the ``strip_all`` option: ), )); -Lowering Maximum Quality +Lowering maximum Quality ~~~~~~~~~~~~~~~~~~~~~~~~ The quality level of the JPEG is not affected by default. You can gain @@ -152,7 +152,7 @@ image quality: ), )); -Shorter syntax: Twig Function +Shorter Syntax: Twig Function ----------------------------- If you're using Twig, it's possible to achieve all of this with a shorter diff --git a/cookbook/assetic/uglifyjs.rst b/cookbook/assetic/uglifyjs.rst index 1c0d4d11a58..efdcd07e362 100644 --- a/cookbook/assetic/uglifyjs.rst +++ b/cookbook/assetic/uglifyjs.rst @@ -1,7 +1,7 @@ .. index:: single: Assetic; UglifyJS -How to Minify CSS/JS Files (using UglifyJS and UglifyCSS) +How to Minify CSS/JS Files (Using UglifyJS and UglifyCSS) ========================================================= `UglifyJS`_ is a JavaScript parser/compressor/beautifier toolkit. It can be used @@ -183,7 +183,7 @@ and :ref:`dump your assetic assets `. rather than the common config file. For details on applying filters by file extension, see :ref:`cookbook-assetic-apply-to`. -Install, configure and use UglifyCSS +Install, Configure and Use UglifyCSS ------------------------------------ The usage of UglifyCSS works the same way as UglifyJS. First, make sure diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index 3f98b4f591d..e143f023b5a 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -1,7 +1,7 @@ .. index:: single: Bundle; Best practices -How to use Best Practices for Structuring Bundles +How to Use best Practices for Structuring Bundles ================================================= A bundle is a directory that has a well-defined structure and can host anything diff --git a/cookbook/bundles/extension.rst b/cookbook/bundles/extension.rst index 51d158b3ccb..d35580aabca 100644 --- a/cookbook/bundles/extension.rst +++ b/cookbook/bundles/extension.rst @@ -2,7 +2,7 @@ single: Configuration; Semantic single: Bundle; Extension configuration -How to expose a Semantic Configuration for a Bundle +How to Expose a semantic Configuration for a Bundle =================================================== If you open your application configuration file (usually ``app/config/config.yml``), @@ -330,7 +330,7 @@ information loaded from other bundles). The goal of the ``load()`` method is to manipulate the container, adding and configuring any methods or services needed by your bundle. -Loading External Configuration Resources +Loading external Configuration Resources ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ One common thing to do is to load an external configuration file that may @@ -549,7 +549,7 @@ normalization and advanced merging. You can read more about this in You can also see it in action by checking out some of the core Configuration classes, such as the one from the `FrameworkBundle Configuration`_ or the `TwigBundle Configuration`_. -Modifying the configuration of another Bundle +Modifying the Configuration of another Bundle ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you have multiple bundles that depend on each other, it may be useful diff --git a/cookbook/bundles/inheritance.rst b/cookbook/bundles/inheritance.rst index 3d6832b41c1..13500eb6685 100644 --- a/cookbook/bundles/inheritance.rst +++ b/cookbook/bundles/inheritance.rst @@ -1,7 +1,7 @@ .. index:: single: Bundle; Inheritance -How to use Bundle Inheritance to Override parts of a Bundle +How to Use Bundle Inheritance to Override Parts of a Bundle =========================================================== When working with third-party bundles, you'll probably come across a situation diff --git a/cookbook/bundles/installation.rst b/cookbook/bundles/installation.rst index d0ea5d677fb..a9150291642 100644 --- a/cookbook/bundles/installation.rst +++ b/cookbook/bundles/installation.rst @@ -1,7 +1,7 @@ .. index:: single: Bundle; Installation -How to install 3rd party Bundles +How to Install 3rd Party Bundles ================================ Most bundles provide their own installation instructions. However, the diff --git a/cookbook/bundles/override.rst b/cookbook/bundles/override.rst index 4e51034cdb4..bdca242f217 100644 --- a/cookbook/bundles/override.rst +++ b/cookbook/bundles/override.rst @@ -93,7 +93,7 @@ See :doc:`/cookbook/service_container/compiler_passes` for information on how to compiler passes. If you want to do something beyond just overriding the class - like adding a method call - you can only use the compiler pass method. -Entities & Entity mapping +Entities & Entity Mapping ------------------------- Due to the way Doctrine works, it is not possible to override entity mapping @@ -119,7 +119,7 @@ rather than:: .. _override-validation: -Validation metadata +Validation Metadata ------------------- Symfony loads all validation configuration files from every bundle and diff --git a/cookbook/bundles/prepend_extension.rst b/cookbook/bundles/prepend_extension.rst index 27b21a03fe2..4c5cb7364fc 100644 --- a/cookbook/bundles/prepend_extension.rst +++ b/cookbook/bundles/prepend_extension.rst @@ -2,7 +2,7 @@ single: Configuration; Semantic single: Bundle; Extension configuration -How to simplify configuration of multiple Bundles +How to Simplify Configuration of multiple Bundles ================================================= When building reusable and extensible applications, developers are often diff --git a/cookbook/bundles/remove.rst b/cookbook/bundles/remove.rst index ce36fae32ab..0a814d70d40 100644 --- a/cookbook/bundles/remove.rst +++ b/cookbook/bundles/remove.rst @@ -1,7 +1,7 @@ .. index:: single: Bundle; Removing AcmeDemoBundle -How to remove the AcmeDemoBundle +How to Remove the AcmeDemoBundle ================================ The Symfony2 Standard Edition comes with a complete demo that lives inside a @@ -13,7 +13,7 @@ starting a project, but you'll probably want to eventually remove it. This article uses the AcmeDemoBundle as an example, but you can use these steps to remove any bundle. -1. Unregister the bundle in the ``AppKernel`` +1. Unregister the Bundle in the ``AppKernel`` --------------------------------------------- To disconnect the bundle from the framework, you should remove the bundle from @@ -38,20 +38,20 @@ development environment and you can find it inside the if statement below:: } } -2. Remove bundle configuration +2. Remove Bundle Configuration ------------------------------ Now that Symfony doesn't know about the bundle, you need to remove any configuration and routing configuration inside the ``app/config`` directory that refers to the bundle. -2.1 Remove bundle routing +2.1 Remove Bundle Routing ~~~~~~~~~~~~~~~~~~~~~~~~~ The routing for the AcmeDemoBundle can be found in ``app/config/routing_dev.yml``. Remove the ``_acme_demo`` entry at the bottom of this file. -2.2 Remove bundle configuration +2.2 Remove Bundle Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Some bundles contain configuration in one of the ``app/config/config*.yml`` @@ -65,7 +65,7 @@ used in the configuration for the ``app/config/security.yml`` file. You can use it as a boilerplate for your own security, but you **can** also remove everything: it doesn't matter to Symfony if you remove it or not. -3. Remove the bundle from the Filesystem +3. Remove the Bundle from the Filesystem ---------------------------------------- Now you have removed every reference to the bundle in your application, you @@ -81,7 +81,7 @@ can remove the ``Acme`` directory as well. echo $this->container->get('kernel')->getBundle('AcmeDemoBundle')->getPath(); -4. Remove integration in other bundles +4. Remove Integration in other Bundles -------------------------------------- .. note:: diff --git a/cookbook/cache/varnish.rst b/cookbook/cache/varnish.rst index 7dd46d9a11f..5a80b034188 100644 --- a/cookbook/cache/varnish.rst +++ b/cookbook/cache/varnish.rst @@ -1,7 +1,7 @@ .. index:: single: Cache; Varnish -How to use Varnish to speed up my Website +How to Use Varnish to Speed up my Website ========================================= Because Symfony2's cache uses the standard HTTP cache headers, the @@ -62,7 +62,7 @@ Symfony2 adds automatically: // For Varnish < 3.0 // esi; } - /* By default Varnish ignores Cache-Control: nocache + /* By default Varnish ignores Cache-Control: nocache (https://www.varnish-cache.org/docs/3.0/tutorial/increasing_your_hitrate.html#cache-control), so in order avoid caching it has to be done explicitly */ if (beresp.http.Pragma ~ "no-cache" || diff --git a/cookbook/configuration/apache_router.rst b/cookbook/configuration/apache_router.rst index d765295147a..97e8774cf96 100644 --- a/cookbook/configuration/apache_router.rst +++ b/cookbook/configuration/apache_router.rst @@ -1,7 +1,7 @@ .. index:: single: Apache Router -How to use the Apache Router +How to Use the Apache Router ============================ Symfony2, while fast out of the box, also provides various ways to increase that speed with a little bit of tweaking. @@ -49,7 +49,7 @@ Symfony2 to use the ``ApacheUrlMatcher`` instead of the default one: at the end of ``ApacheUrlMatcher::match()`` a call to ``parent::match()`` is done). -Generating mod_rewrite rules +Generating mod_rewrite Rules ---------------------------- To test that it's working, create a very basic route for the AcmeDemoBundle: @@ -119,7 +119,7 @@ it should look like this: That's it! You're now all set to use Apache routes. -Additional tweaks +Additional Tweaks ----------------- To save a little bit of processing time, change occurrences of ``Request`` diff --git a/cookbook/configuration/environments.rst b/cookbook/configuration/environments.rst index 6360350e2cc..f5042ee17f8 100644 --- a/cookbook/configuration/environments.rst +++ b/cookbook/configuration/environments.rst @@ -16,7 +16,7 @@ optimized for speed. .. index:: single: Environments; Configuration files -Different Environments, Different Configuration Files +Different Environments, different Configuration Files ----------------------------------------------------- A typical Symfony2 application begins with three environments: ``dev``, @@ -125,7 +125,7 @@ activated by modifying the default value in the ``dev`` configuration file: .. index:: single: Environments; Executing different environments -Executing an Application in Different Environments +Executing an Application in different Environments -------------------------------------------------- To execute the application in each environment, load up the application using @@ -147,7 +147,7 @@ If you open up one of these files, you'll quickly see that the environment used by each is explicitly set:: // web/app.php - // ... + // ... $kernel = new AppKernel('prod', false); @@ -215,7 +215,7 @@ environment by using this code and changing the environment string. .. index:: single: Environments; Creating a new environment -Creating a New Environment +Creating a new Environment -------------------------- By default, a Symfony2 application has three environments that handle most @@ -345,7 +345,7 @@ includes the following: You can easily change the directory location and name. For more information read the article :doc:`/cookbook/configuration/override_dir_structure`. -Going Further +Going further ------------- Read the article on :doc:`/cookbook/configuration/external_parameters`. diff --git a/cookbook/configuration/external_parameters.rst b/cookbook/configuration/external_parameters.rst index f177f392f1f..39ee107aa61 100644 --- a/cookbook/configuration/external_parameters.rst +++ b/cookbook/configuration/external_parameters.rst @@ -1,7 +1,7 @@ .. index:: single: Environments; External parameters -How to Set External Parameters in the Service Container +How to Set external Parameters in the Service Container ======================================================= In the chapter :doc:`/cookbook/configuration/environments`, you learned how diff --git a/cookbook/configuration/front_controllers_and_kernel.rst b/cookbook/configuration/front_controllers_and_kernel.rst index 8c7252f3abf..b1faf65e9cd 100644 --- a/cookbook/configuration/front_controllers_and_kernel.rst +++ b/cookbook/configuration/front_controllers_and_kernel.rst @@ -2,7 +2,7 @@ single: How the front controller, ``AppKernel`` and environments work together -Understanding how the Front Controller, Kernel and Environments work together +Understanding how the Front Controller, Kernel and Environments Work together ============================================================================= The section :doc:`/cookbook/configuration/environments` explained the basics diff --git a/cookbook/configuration/override_dir_structure.rst b/cookbook/configuration/override_dir_structure.rst index 2f0382e8984..23ea5fea5d9 100644 --- a/cookbook/configuration/override_dir_structure.rst +++ b/cookbook/configuration/override_dir_structure.rst @@ -1,7 +1,7 @@ .. index:: single: Override Symfony -How to override Symfony's Default Directory Structure +How to Override Symfony's default Directory Structure ===================================================== Symfony automatically ships with a default directory structure. You can @@ -26,7 +26,7 @@ directory structure is: .. _override-cache-dir: -Override the ``cache`` directory +Override the ``cache`` Directory -------------------------------- You can override the cache directory by overriding the ``getCacheDir`` method @@ -58,7 +58,7 @@ the location of the cache directory to ``app/{environment}/cache``. .. _override-logs-dir: -Override the ``logs`` directory +Override the ``logs`` Directory ------------------------------- Overriding the ``logs`` directory is the same as overriding the ``cache`` @@ -80,7 +80,7 @@ method:: Here you have changed the location of the directory to ``app/{environment}/logs``. -Override the ``web`` directory +Override the ``web`` Directory ------------------------------ If you need to rename or move your ``web`` directory, the only thing you diff --git a/cookbook/configuration/pdo_session_storage.rst b/cookbook/configuration/pdo_session_storage.rst index c44955c9cd7..305b08e2ec5 100644 --- a/cookbook/configuration/pdo_session_storage.rst +++ b/cookbook/configuration/pdo_session_storage.rst @@ -1,7 +1,7 @@ .. index:: single: Session; Database Storage -How to use PdoSessionHandler to store Sessions in the Database +How to Use PdoSessionHandler to Store Sessions in the Database ============================================================== The default session storage of Symfony2 writes the session information to diff --git a/cookbook/configuration/web_server_configuration.rst b/cookbook/configuration/web_server_configuration.rst index 5fbe75f6923..2ea1a976f6b 100644 --- a/cookbook/configuration/web_server_configuration.rst +++ b/cookbook/configuration/web_server_configuration.rst @@ -1,7 +1,7 @@ .. index:: single: Web Server -Configuring a web server +Configuring a Web Server ======================== The web directory is the home of all of your application's public and static diff --git a/cookbook/console/console_command.rst b/cookbook/console/console_command.rst index 342c3f7d83f..642777cfa19 100644 --- a/cookbook/console/console_command.rst +++ b/cookbook/console/console_command.rst @@ -1,7 +1,7 @@ .. index:: single: Console; Create commands -How to create a Console Command +How to Create a Console Command =============================== The Console page of the Components section (:doc:`/components/console/introduction`) covers diff --git a/cookbook/console/logging.rst b/cookbook/console/logging.rst index 6f34a75048d..ee8ec0d9e08 100644 --- a/cookbook/console/logging.rst +++ b/cookbook/console/logging.rst @@ -1,7 +1,7 @@ .. index:: single: Console; Enabling logging -How to enable logging in Console Commands +How to Enable Logging in Console Commands ========================================= The Console component doesn't provide any logging capabilities out of the box. @@ -17,7 +17,7 @@ There are basically two logging cases you would need: * Manually logging some information from your command; * Logging uncaught Exceptions. -Manually logging from a console Command +Manually Logging from a Console Command --------------------------------------- This one is really simple. When you create a console command within the full @@ -66,7 +66,7 @@ container and use it to do the logging:: Depending on the environment in which you run your command (and your logging setup), you should see the logged entries in ``app/logs/dev.log`` or ``app/logs/prod.log``. -Enabling automatic Exceptions logging +Enabling automatic Exceptions Logging ------------------------------------- To get your console application to automatically log uncaught exceptions for @@ -174,7 +174,7 @@ service configuration. Your method receives a :class:`Symfony\\Component\\Console\\Event\\ConsoleExceptionEvent` object, which has methods to get information about the event and the exception. -Logging non-0 exit statuses +Logging non-0 Exit Statuses --------------------------- The logging capabilities of the console can be further extended by logging diff --git a/cookbook/console/sending_emails.rst b/cookbook/console/sending_emails.rst index b5f1ba41cb2..633ef0e8849 100644 --- a/cookbook/console/sending_emails.rst +++ b/cookbook/console/sending_emails.rst @@ -2,7 +2,7 @@ single: Console; Sending emails single: Console; Generating URLs -How to generate URLs and send Emails from the Console +How to Generate URLs and Send Emails from the Console ===================================================== Unfortunately, the command line context does not know about your VirtualHost diff --git a/cookbook/console/usage.rst b/cookbook/console/usage.rst index 2e6deca06e8..9fa569f9d7f 100644 --- a/cookbook/console/usage.rst +++ b/cookbook/console/usage.rst @@ -1,7 +1,7 @@ .. index:: single: Console; Usage -How to use the Console +How to Use the Console ====================== The :doc:`/components/console/usage` page of the components documentation looks @@ -62,4 +62,4 @@ supported so you will need to pass all command params explicitly. Unless you are using isolated processes, clearing the cache in the shell will not have an effect on subsequent commands you run. This is because - the original cached files are still being used. \ No newline at end of file + the original cached files are still being used. diff --git a/cookbook/controller/error_pages.rst b/cookbook/controller/error_pages.rst index 3766fa56b70..1f4af550f39 100644 --- a/cookbook/controller/error_pages.rst +++ b/cookbook/controller/error_pages.rst @@ -2,7 +2,7 @@ single: Controller; Customize error pages single: Error pages -How to customize Error Pages +How to Customize Error Pages ============================ When any exception is thrown in Symfony2, the exception is caught inside the diff --git a/cookbook/controller/service.rst b/cookbook/controller/service.rst index 3577c1a2487..602b14aead3 100644 --- a/cookbook/controller/service.rst +++ b/cookbook/controller/service.rst @@ -1,7 +1,7 @@ .. index:: single: Controller; As Services -How to define Controllers as Services +How to Define Controllers as Services ===================================== In the book, you've learned how easily a controller can be used when it @@ -89,7 +89,7 @@ Then you can define it as a service as follows: '%acme.controller.hello.class%' )); -Referring to the service +Referring to the Service ------------------------ To refer to a controller that's defined as a service, use the single colon (:) @@ -136,7 +136,7 @@ the route ``_controller`` value: :doc:`FrameworkExtraBundle documentation ` for details. -Alternatives to Base Controller Methods +Alternatives to base Controller Methods --------------------------------------- When using a controller defined as a service, it will most likely not extend diff --git a/cookbook/debugging.rst b/cookbook/debugging.rst index cadd1303667..372fb707931 100644 --- a/cookbook/debugging.rst +++ b/cookbook/debugging.rst @@ -1,7 +1,7 @@ .. index:: single: Debugging -How to optimize your development Environment for debugging +How to Optimize your Development Environment for Debugging ========================================================== When you work on a Symfony project on your local machine, you should use the diff --git a/cookbook/deployment/azure-website.rst b/cookbook/deployment/azure-website.rst index 0485ad613a3..a35ccbaea03 100644 --- a/cookbook/deployment/azure-website.rst +++ b/cookbook/deployment/azure-website.rst @@ -51,7 +51,7 @@ plan configuration in the previous step. Agree to the terms and conditions and click on the right arrow to continue. -Step 3: Where Is your source code +Step 3: Where Is your Source Code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Now, on the third step, select a **Local Git repository** item and click @@ -93,7 +93,7 @@ This section of the tutorial details how to configure the correct version of PHP to run Symfony. It also shows you how to enable some mandatory PHP extensions and how to properly configure PHP for a production environment. -Configuring the Latest PHP Runtime +Configuring the latest PHP Runtime ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Even though Symfony only requires PHP 5.3.3 to run, it's always recommended diff --git a/cookbook/deployment/tools.rst b/cookbook/deployment/tools.rst index f32ca384660..4e0d147f7e0 100644 --- a/cookbook/deployment/tools.rst +++ b/cookbook/deployment/tools.rst @@ -29,7 +29,7 @@ A deployment may also include other things, such as: * Removal of any unnecessary files from ``web`` to keep your production environment clean; * Clearing of external cache systems (like `Memcached`_ or `Redis`_). -How to deploy a Symfony2 application +How to Deploy a Symfony2 Application ------------------------------------ There are several ways you can deploy a Symfony2 application. @@ -55,7 +55,7 @@ control system. This makes updating your files *easier*, but you still need to worry about manually taking other steps (see `Common Post-Deployment Tasks`_). -Using Build scripts and other Tools +Using Build Scripts and other Tools ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There are also high-quality tools to help ease the pain of deployment. There @@ -71,14 +71,14 @@ Common Post-Deployment Tasks After deploying your actual source code, there are a number of common things you'll need to do: -A) Configure your ``app/config/parameters.yml`` file +A) Configure your ``app/config/parameters.yml`` File ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This file should be customized on each system. The method you use to deploy your source code should *not* deploy this file. Instead, you should set it up manually (or via some build process) on your server(s). -B) Update your vendors +B) Update your Vendors ~~~~~~~~~~~~~~~~~~~~~~ Your vendors can be updated before transferring your source code (i.e. @@ -97,7 +97,7 @@ as you normally do: ensures that development packages are not installed in the production environment. -C) Clear your Symfony cache +C) Clear your Symfony Cache ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Make sure you clear (and warm-up) your Symfony cache: @@ -106,7 +106,7 @@ Make sure you clear (and warm-up) your Symfony cache: $ php app/console cache:clear --env=prod --no-debug -D) Dump your Assetic assets +D) Dump your Assetic Assets ~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you're using Assetic, you'll also want to dump your assets: @@ -115,7 +115,7 @@ If you're using Assetic, you'll also want to dump your assets: $ php app/console assetic:dump --env=prod --no-debug -E) Other things! +E) Other Things! ~~~~~~~~~~~~~~~~ There may be lots of other things that you need to do, depending on your diff --git a/cookbook/doctrine/custom_dql_functions.rst b/cookbook/doctrine/custom_dql_functions.rst index 35141309b5e..b15877ffa2a 100644 --- a/cookbook/doctrine/custom_dql_functions.rst +++ b/cookbook/doctrine/custom_dql_functions.rst @@ -1,7 +1,7 @@ .. index:: single: Doctrine; Custom DQL functions -How to Register Custom DQL Functions +How to Register custom DQL Functions ==================================== Doctrine allows you to specify custom DQL functions. For more information diff --git a/cookbook/doctrine/dbal.rst b/cookbook/doctrine/dbal.rst index 71349c6bc75..e47ed2d8fca 100644 --- a/cookbook/doctrine/dbal.rst +++ b/cookbook/doctrine/dbal.rst @@ -1,7 +1,7 @@ .. index:: pair: Doctrine; DBAL -How to use Doctrine's DBAL Layer +How to Use Doctrine's DBAL Layer ================================ .. note:: @@ -77,7 +77,7 @@ You can then access the Doctrine DBAL connection by accessing the } } -Registering Custom Mapping Types +Registering custom Mapping Types -------------------------------- You can register custom mapping types through Symfony's configuration. They @@ -124,7 +124,7 @@ mapping types, read Doctrine's `Custom Mapping Types`_ section of their document ), )); -Registering Custom Mapping Types in the SchemaTool +Registering custom Mapping Types in the SchemaTool -------------------------------------------------- The SchemaTool is used to inspect the database to compare the schema. To diff --git a/cookbook/doctrine/file_uploads.rst b/cookbook/doctrine/file_uploads.rst index f2bfd1601c1..ab90001194e 100644 --- a/cookbook/doctrine/file_uploads.rst +++ b/cookbook/doctrine/file_uploads.rst @@ -1,7 +1,7 @@ .. index:: single: Doctrine; File uploads -How to handle File Uploads with Doctrine +How to Handle File Uploads with Doctrine ======================================== Handling file uploads with Doctrine entities is no different than handling @@ -412,10 +412,10 @@ Next, refactor the ``Document`` class to take advantage of these callbacks:: .. caution:: - If changes to your entity are handled by a Doctrine event listener or event - subscriber, the ``preUpdate()`` callback must notify Doctrine about the changes + If changes to your entity are handled by a Doctrine event listener or event + subscriber, the ``preUpdate()`` callback must notify Doctrine about the changes being done. - For full reference on preUpdate event restrictions, see `preUpdate`_ in the + For full reference on preUpdate event restrictions, see `preUpdate`_ in the Doctrine Events documentation. The class now does everything you need: it generates a unique filename before @@ -450,7 +450,7 @@ call to ``$document->upload()`` should be removed from the controller:: via Doctrine. One solution would be to use an ``updated`` field that's persisted to Doctrine, and to modify it manually when changing the file. -Using the ``id`` as the filename +Using the ``id`` as the Filename -------------------------------- If you want to use the ``id`` as the name of the file, the implementation is diff --git a/cookbook/doctrine/mapping_model_classes.rst b/cookbook/doctrine/mapping_model_classes.rst index 45dd20a5ce0..975d95cd0be 100644 --- a/cookbook/doctrine/mapping_model_classes.rst +++ b/cookbook/doctrine/mapping_model_classes.rst @@ -1,7 +1,7 @@ .. index:: single: Doctrine; Mapping Model classes -How to provide model classes for several Doctrine implementations +How to Provide Model Classes for several Doctrine Implementations ================================================================= When building a bundle that could be used not only with Doctrine ORM but diff --git a/cookbook/doctrine/multiple_entity_managers.rst b/cookbook/doctrine/multiple_entity_managers.rst index e41301f00f2..271ed3f6f7a 100644 --- a/cookbook/doctrine/multiple_entity_managers.rst +++ b/cookbook/doctrine/multiple_entity_managers.rst @@ -1,7 +1,7 @@ .. index:: single: Doctrine; Multiple entity managers -How to work with Multiple Entity Managers and Connections +How to Work with multiple Entity Managers and Connections ========================================================= You can use multiple Doctrine entity managers or connections in a Symfony2 diff --git a/cookbook/doctrine/registration_form.rst b/cookbook/doctrine/registration_form.rst index 20413aec4e8..4e4abbb5a05 100644 --- a/cookbook/doctrine/registration_form.rst +++ b/cookbook/doctrine/registration_form.rst @@ -2,7 +2,7 @@ single: Doctrine; Simple Registration Form single: Form; Simple Registration Form -How to implement a simple Registration Form +How to Implement a simple Registration Form =========================================== Some forms have extra fields whose values don't need to be stored in the @@ -10,7 +10,7 @@ database. For example, you may want to create a registration form with some extra fields (like a "terms accepted" checkbox field) and embed the form that actually stores the account information. -The simple User model +The simple User Model --------------------- You have a simple ``User`` entity mapped to the database:: @@ -146,7 +146,7 @@ underlying data class (i.e. your ``User`` entity). To explore more things about the Form component, read :doc:`/book/forms`. -Embedding the User form into a Registration Form +Embedding the User Form into a Registration Form ------------------------------------------------ The form that you'll use for the registration page is not the same as the @@ -296,7 +296,7 @@ the validation and saves the data into the database:: ); } -Add New Routes +Add new Routes -------------- Next, update your routes. If you're placing your routes inside your bundle @@ -311,7 +311,7 @@ Next, update your routes. If you're placing your routes inside your bundle account_register: path: /register defaults: { _controller: AcmeAccountBundle:Account:register } - + account_create: path: /register/create defaults: { _controller: AcmeAccountBundle:Account:create } diff --git a/cookbook/doctrine/reverse_engineering.rst b/cookbook/doctrine/reverse_engineering.rst index ff245052973..b5078d4aa44 100644 --- a/cookbook/doctrine/reverse_engineering.rst +++ b/cookbook/doctrine/reverse_engineering.rst @@ -1,7 +1,7 @@ .. index:: single: Doctrine; Generating entities from existing database -How to generate Entities from an Existing Database +How to Generate Entities from an Existing Database ================================================== When starting work on a brand new project that uses a database, two different diff --git a/cookbook/email/cloud.rst b/cookbook/email/cloud.rst index c409826a918..ad832e5d7d5 100644 --- a/cookbook/email/cloud.rst +++ b/cookbook/email/cloud.rst @@ -1,7 +1,7 @@ .. index:: single: Emails; Using the cloud -How to use the Cloud to Send Emails +How to Use the Cloud to Send Emails =================================== Requirements for sending emails from a production system differ from your diff --git a/cookbook/email/dev_environment.rst b/cookbook/email/dev_environment.rst index 87d24a00e56..216370d2f72 100644 --- a/cookbook/email/dev_environment.rst +++ b/cookbook/email/dev_environment.rst @@ -1,7 +1,7 @@ .. index:: single: Emails; In development -How to Work with Emails During Development +How to Work with Emails during Development ========================================== When developing an application which sends email, you will often diff --git a/cookbook/email/email.rst b/cookbook/email/email.rst index e2192ed7626..6c2d8978714 100644 --- a/cookbook/email/email.rst +++ b/cookbook/email/email.rst @@ -1,7 +1,7 @@ .. index:: single: Emails -How to send an Email +How to Send an Email ==================== Sending emails is a classic task for any web application and one that has diff --git a/cookbook/email/gmail.rst b/cookbook/email/gmail.rst index aba19a74a1e..1565dc00c28 100644 --- a/cookbook/email/gmail.rst +++ b/cookbook/email/gmail.rst @@ -1,7 +1,7 @@ .. index:: single: Emails; Gmail -How to use Gmail to Send Emails +How to Use Gmail to Send Emails =============================== During development, instead of using a regular SMTP server to send emails, you diff --git a/cookbook/email/spool.rst b/cookbook/email/spool.rst index 0ca07526e7c..37fb02f2344 100644 --- a/cookbook/email/spool.rst +++ b/cookbook/email/spool.rst @@ -15,7 +15,7 @@ such as a file. Another process can then read from the spool and take care of sending the emails in the spool. Currently only spooling to file or memory is supported by Swift Mailer. -Spool using memory +Spool Using Memory ------------------ When you use spooling to store the emails to memory, they will get sent right @@ -53,7 +53,7 @@ swiftmailer with the memory option, use the following configuration: 'spool' => array('type' => 'memory') )); -Spool using a file +Spool Using a File ------------------ In order to use the spool with a file, use the following configuration: diff --git a/cookbook/email/testing.rst b/cookbook/email/testing.rst index 345faa86c17..f42025bef6e 100644 --- a/cookbook/email/testing.rst +++ b/cookbook/email/testing.rst @@ -1,7 +1,7 @@ .. 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 Symfony2 is pretty straightforward thanks to the diff --git a/cookbook/event_dispatcher/before_after_filters.rst b/cookbook/event_dispatcher/before_after_filters.rst index 484be1084d0..b4e17c33590 100644 --- a/cookbook/event_dispatcher/before_after_filters.rst +++ b/cookbook/event_dispatcher/before_after_filters.rst @@ -1,7 +1,7 @@ .. index:: single: EventDispatcher -How to setup before and after Filters +How to Setup before and after Filters ===================================== It is quite common in web application development to need some logic to be @@ -13,7 +13,7 @@ Most major frameworks have similar methods but there is no such thing in Symfony The good news is that there is a much better way to interfere with the Request -> Response process using the :doc:`EventDispatcher component `. -Token validation Example +Token Validation Example ------------------------ Imagine that you need to develop an API where some controllers are public @@ -30,7 +30,7 @@ token. in config and neither database setup nor authentication via the Security component will be used. -Before filters with the ``kernel.controller`` Event +Before Filters with the ``kernel.controller`` Event --------------------------------------------------- First, store some basic token configuration using ``config.yml`` and the @@ -64,7 +64,7 @@ parameters key: 'client2' => 'pass2', )); -Tag Controllers to be checked +Tag Controllers to Be Checked ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A ``kernel.controller`` listener gets notified on *every* request, right before @@ -186,7 +186,7 @@ implements ``TokenAuthenticatedController``, token authentication is applied. This lets you have a "before" filter on any controller that you want. -After filters with the ``kernel.response`` Event +After Filters with the ``kernel.response`` Event ------------------------------------------------ In addition to having a "hook" that's executed before your controller, you diff --git a/cookbook/event_dispatcher/class_extension.rst b/cookbook/event_dispatcher/class_extension.rst index 2207e8f6997..d6b961fb17d 100644 --- a/cookbook/event_dispatcher/class_extension.rst +++ b/cookbook/event_dispatcher/class_extension.rst @@ -1,7 +1,7 @@ .. index:: single: EventDispatcher -How to extend a Class without using Inheritance +How to Extend a Class without Using Inheritance =============================================== To allow multiple classes to add methods to another one, you can define the diff --git a/cookbook/event_dispatcher/method_behavior.rst b/cookbook/event_dispatcher/method_behavior.rst index 2370955f63f..5ad5da29441 100644 --- a/cookbook/event_dispatcher/method_behavior.rst +++ b/cookbook/event_dispatcher/method_behavior.rst @@ -1,7 +1,7 @@ .. index:: single: EventDispatcher -How to customize a Method Behavior without using Inheritance +How to Customize a Method Behavior without Using Inheritance ============================================================ Doing something before or after a Method Call diff --git a/cookbook/form/data_transformers.rst b/cookbook/form/data_transformers.rst index f847127c894..072d02a1aa8 100644 --- a/cookbook/form/data_transformers.rst +++ b/cookbook/form/data_transformers.rst @@ -1,7 +1,7 @@ .. index:: single: Form; Data transformers -How to use Data Transformers +How to Use Data Transformers ============================ You'll often find the need to transform the data the user entered in a form into @@ -218,7 +218,7 @@ Which transformer you need depends on your situation. To use the view transformer, call ``addViewTransformer``. -So why use the model transformer? +So why Use the Model Transformer? --------------------------------- In this example, the field is a ``text`` field, and a text field is always @@ -232,7 +232,7 @@ about what the "norm" data for a field should really be. For example, the "norm" data for a ``text`` field is a string, but is a ``DateTime`` object for a ``date`` field. -Using Transformers in a custom field type +Using Transformers in a custom Field Type ----------------------------------------- In the above example, you applied the transformer to a normal ``text`` field. diff --git a/cookbook/form/direct_submit.rst b/cookbook/form/direct_submit.rst index a83cf21b21c..5a40a0aec3f 100644 --- a/cookbook/form/direct_submit.rst +++ b/cookbook/form/direct_submit.rst @@ -1,7 +1,7 @@ .. index:: single: Form; Form::submit() -How to use the submit() Function to handle Form Submissions +How to Use the submit() Function to Handle Form Submissions =========================================================== .. versionadded:: 2.3 @@ -84,7 +84,7 @@ method, pass the submitted data directly to .. _cookbook-form-submit-request: -Passing a Request to Form::submit() (deprecated) +Passing a Request to Form::submit() (Deprecated) ------------------------------------------------ .. versionadded:: 2.3 diff --git a/cookbook/form/dynamic_form_modification.rst b/cookbook/form/dynamic_form_modification.rst index 262b34347d5..36b4b9e9800 100644 --- a/cookbook/form/dynamic_form_modification.rst +++ b/cookbook/form/dynamic_form_modification.rst @@ -30,7 +30,7 @@ documentation. .. _cookbook-form-events-underlying-data: -Customizing your Form based on the underlying Data +Customizing your Form Based on the Underlying Data -------------------------------------------------- Before jumping right into dynamic form generation, hold on and recall what @@ -207,7 +207,7 @@ class:: .. _cookbook-form-events-user-data: -How to Dynamically Generate Forms based on user Data +How to dynamically Generate Forms Based on user Data ---------------------------------------------------- Sometimes you want a form to be generated dynamically based not only on data @@ -445,7 +445,7 @@ You can also easily embed the form type into another form:: .. _cookbook-form-events-submitted-data: -Dynamic generation for submitted Forms +Dynamic Generation for Submitted Forms -------------------------------------- Another case that can appear is that you want to customize the form specific to diff --git a/cookbook/form/form_collections.rst b/cookbook/form/form_collections.rst index 27ab0bc74db..66bda184f8b 100644 --- a/cookbook/form/form_collections.rst +++ b/cookbook/form/form_collections.rst @@ -261,7 +261,7 @@ great, your user can't actually add any new tags yet. .. _cookbook-form-collections-new-prototype: -Allowing "new" tags with the "prototype" +Allowing "new" Tags with the "Prototype" ----------------------------------------- Allowing the user to dynamically add new tags means that you'll need to @@ -559,7 +559,7 @@ we talk about next!). .. _cookbook-form-collections-remove: -Allowing tags to be removed +Allowing Tags to be Removed ---------------------------- The next step is to allow the deletion of a particular item in the collection. @@ -595,8 +595,8 @@ Now, you need to put some code into the ``removeTag`` method of ``Task``:: } } -Templates Modifications -~~~~~~~~~~~~~~~~~~~~~~~ +Template Modifications +~~~~~~~~~~~~~~~~~~~~~~ The ``allow_delete`` option has one consequence: if an item of a collection isn't sent on submission, the related data is removed from the collection @@ -609,7 +609,7 @@ First, add a "delete this tag" link to each tag form: jQuery(document).ready(function() { // Get the ul that holds the collection of tags $collectionHolder = $('ul.tags'); - + // add a delete link to all of the existing tag form li elements $collectionHolder.find('li').each(function() { addTagFormDeleteLink($(this)); @@ -667,9 +667,9 @@ the relationship between the removed ``Tag`` and ``Task`` object. is handling the "update" of your Task:: // src/Acme/TaskBundle/Controller/TaskController.php - + use Doctrine\Common\Collections\ArrayCollection; - + // ... public function editAction($id, Request $request) { diff --git a/cookbook/form/form_customization.rst b/cookbook/form/form_customization.rst index eccdcfe2754..41361bf6775 100644 --- a/cookbook/form/form_customization.rst +++ b/cookbook/form/form_customization.rst @@ -1,7 +1,7 @@ .. index:: single: Form; Custom form rendering -How to customize Form Rendering +How to Customize Form Rendering =============================== Symfony gives you a wide variety of ways to customize how a form is rendered. @@ -180,7 +180,7 @@ this folder. .. _cookbook-form-customization-sidebar: -.. sidebar:: Knowing which block to customize +.. sidebar:: Knowing which Block to Customize In this example, the customized fragment name is ``integer_widget`` because you want to override the HTML ``widget`` for all ``integer`` field types. If @@ -265,7 +265,7 @@ several (or all) forms in your application, read on to the next section. .. _cookbook-form-twig-separate-template: -Method 2: Inside a Separate Template +Method 2: Inside a separate Template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also choose to put the customized ``integer_widget`` form block in a @@ -376,7 +376,7 @@ method: .. _cookbook-form-twig-import-base-blocks: -Referencing Base Form Blocks (Twig specific) +Referencing base Form Blocks (Twig specific) -------------------------------------------- So far, to override a particular form block, the best method is to copy @@ -410,7 +410,7 @@ via ``base_integer_widget``: {% endblock %} -Referencing Base Blocks from an External Template +Referencing base Blocks from an external Template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If your form customizations live inside an external template, you can reference @@ -629,7 +629,7 @@ your template file rather than adding the template as a resource: Note that the ``$form`` variable in the above code is the form view variable that you passed to your template. -How to customize an Individual field +How to Customize an individual Field ------------------------------------ So far, you've seen the different ways you can customize the widget output @@ -725,7 +725,7 @@ You can also override the markup for an entire field row using the same method: widget($form) ?> -Other Common Customizations +Other common Customizations --------------------------- So far, this recipe has shown you several different ways to customize a single @@ -810,10 +810,10 @@ of PHP templates). For example: ``text_errors`` (or ``text_errors.html.php``). .. tip:: - See :ref:`form-template-blocks` to find out which specific block or file you + See :ref:`form-template-blocks` to find out which specific block or file you have to customize. -Certain errors that are more global to your form (i.e. not specific to just one +Certain errors that are more global to your form (i.e. not specific to just one field) are rendered separately, usually at the top of your form: .. configuration-block:: @@ -828,7 +828,7 @@ field) are rendered separately, usually at the top of your form: To customize *only* the markup used for these errors, follow the same directions as above, but now check if the ``compound`` variable is set to ``true``. If it -is ``true``, it means that what's being currently rendered is a collection of +is ``true``, it means that what's being currently rendered is a collection of fields (e.g. a whole form), and not just an individual field. .. configuration-block:: @@ -972,7 +972,7 @@ original template: content: "* "; } -Adding "help" messages +Adding "help" Messages ~~~~~~~~~~~~~~~~~~~~~~ You can also customize your form widgets to have an optional "help" message. diff --git a/cookbook/form/unit_testing.rst b/cookbook/form/unit_testing.rst index e1dbb005607..7a9100fda29 100644 --- a/cookbook/form/unit_testing.rst +++ b/cookbook/form/unit_testing.rst @@ -110,7 +110,7 @@ widgets you want to display are available in the children property:: $this->assertArrayHasKey($key, $children); } -Adding a Type your Form depends on +Adding a Type your Form Depends on ---------------------------------- Your form may depend on other types that are defined as services. It diff --git a/cookbook/form/use_empty_data.rst b/cookbook/form/use_empty_data.rst index 61e44b00039..a032379c8fd 100644 --- a/cookbook/form/use_empty_data.rst +++ b/cookbook/form/use_empty_data.rst @@ -1,7 +1,7 @@ .. index:: single: Form; Empty data -How to configure Empty Data for a Form Class +How to Configure empty Data for a Form Class ============================================ The ``empty_data`` option allows you to specify an empty data set for your diff --git a/cookbook/form/use_virtuals_forms.rst b/cookbook/form/use_virtuals_forms.rst index 9f8ed394cff..0de48e6ecb7 100644 --- a/cookbook/form/use_virtuals_forms.rst +++ b/cookbook/form/use_virtuals_forms.rst @@ -1,4 +1,4 @@ -How to use the Virtual Form Field Option +How to Use the virtual Form Field Option ======================================== As of Symfony 2.3, the ``virtual`` option is renamed to ``inherit_data``. You diff --git a/cookbook/logging/channels_handlers.rst b/cookbook/logging/channels_handlers.rst index 6da06bbcdbd..94b7182e838 100644 --- a/cookbook/logging/channels_handlers.rst +++ b/cookbook/logging/channels_handlers.rst @@ -1,7 +1,7 @@ .. index:: single: Logging -How to log Messages to different Files +How to Log Messages to different Files ====================================== The Symfony Standard Edition contains a bunch of channels for logging: ``doctrine``, @@ -84,7 +84,7 @@ To do so, just create a new handler and configure it like this: ), )); -YAML specification +YAML Specification ------------------ You can specify the configuration by many forms: diff --git a/cookbook/logging/monolog.rst b/cookbook/logging/monolog.rst index e4f26b282a9..3955d7a3b24 100644 --- a/cookbook/logging/monolog.rst +++ b/cookbook/logging/monolog.rst @@ -1,7 +1,7 @@ .. index:: single: Logging -How to use Monolog to write Logs +How to Use Monolog to Write Logs ================================ Monolog_ is a logging library for PHP 5.3 used by Symfony2. It is @@ -26,7 +26,7 @@ The ``logger`` service has different methods for different logging levels. See :class:`Symfony\\Component\\HttpKernel\\Log\\LoggerInterface` for details on which methods are available. -Handlers and Channels: Writing logs to different Locations +Handlers and Channels: Writing Logs to different Locations ---------------------------------------------------------- In Monolog each logger defines a logging channel, which organizes your log @@ -49,7 +49,7 @@ messages in a buffer and to log them only if a message reaches the action level (``error`` in the configuration provided in the Standard Edition) by forwarding the messages to another handler. -Using several handlers +Using several Handlers ~~~~~~~~~~~~~~~~~~~~~~ The logger uses a stack of handlers which are called successively. This @@ -154,7 +154,7 @@ in the order where they are defined. because the order matters and a merge does not allow to control the order. -Changing the formatter +Changing the Formatter ~~~~~~~~~~~~~~~~~~~~~~ The handler uses a ``Formatter`` to format the record before logging @@ -218,7 +218,7 @@ easily. Your formatter must implement ), )); -Adding some extra data in the log messages +Adding some extra Data in the Log Messages ------------------------------------------ Monolog allows to process the record before logging it to add some diff --git a/cookbook/profiler/data_collector.rst b/cookbook/profiler/data_collector.rst index ab3f53be1e5..c88d55701df 100644 --- a/cookbook/profiler/data_collector.rst +++ b/cookbook/profiler/data_collector.rst @@ -1,14 +1,14 @@ .. index:: single: Profiling; Data collector -How to create a custom Data Collector +How to Create a custom Data Collector ===================================== The Symfony2 :ref:`Profiler ` delegates data collecting to data collectors. Symfony2 comes bundled with a few of them, but you can easily create your own. -Creating a Custom Data Collector +Creating a custom Data Collector -------------------------------- Creating a custom data collector is as simple as implementing the @@ -73,7 +73,7 @@ populate the ``$this->data`` property (it takes care of serializing the .. _data_collector_tag: -Enabling Custom Data Collectors +Enabling custom Data Collectors ------------------------------- To enable a data collector, add it as a regular service in one of your diff --git a/cookbook/profiler/matchers.rst b/cookbook/profiler/matchers.rst index 2857af88e3e..09f83c73f55 100644 --- a/cookbook/profiler/matchers.rst +++ b/cookbook/profiler/matchers.rst @@ -1,7 +1,7 @@ .. index:: single: Profiling; Matchers -How to use Matchers to enable the Profiler Conditionally +How to Use Matchers to Enable the Profiler Conditionally ======================================================== By default, the profiler is only activated in the development environment. But @@ -52,7 +52,7 @@ You can also set a ``path`` option to define the path on which the profiler should be enabled. For instance, setting it to ``^/admin/`` will enable the profiler only for the ``/admin/`` URLs. -Creating a Custom Matcher +Creating a custom Matcher ------------------------- You can also create a custom matcher. This is a service that checks whether diff --git a/cookbook/request/mime_type.rst b/cookbook/request/mime_type.rst index fb57352c189..648c29e6d43 100644 --- a/cookbook/request/mime_type.rst +++ b/cookbook/request/mime_type.rst @@ -1,7 +1,7 @@ .. index:: single: Request; Add a request format and mime type -How to register a new Request Format and Mime Type +How to Register a new Request Format and Mime Type ================================================== Every ``Request`` has a "format" (e.g. ``html``, ``json``), which is used diff --git a/cookbook/routing/custom_route_loader.rst b/cookbook/routing/custom_route_loader.rst index 5c582db6230..b4c25110d1f 100644 --- a/cookbook/routing/custom_route_loader.rst +++ b/cookbook/routing/custom_route_loader.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; Custom route loader -How to create a custom Route Loader +How to Create a custom Route Loader =================================== A custom route loader allows you to add routes to an application without @@ -54,7 +54,7 @@ its :method:`Symfony\\Component\\Config\\Loader\\LoaderInterface::load` method will be called, which should return a :class:`Symfony\\Component\\Routing\\RouteCollection` containing :class:`Symfony\\Component\\Routing\\Route` objects. -Creating a Custom Loader +Creating a custom Loader ------------------------ To load routes from some custom source (i.e. from something other than annotations, @@ -97,7 +97,7 @@ type you want. The resource name itself is not actually used in the example:: // add the new route to the route collection: $routeName = 'extraRoute'; $routes->add($routeName, $route); - + $this->loaded = true; return $routes; @@ -166,7 +166,7 @@ Notice the tag ``routing.loader``. All services with this tag will be marked as potential route loaders and added as specialized routers to the :class:`Symfony\\Bundle\\FrameworkBundle\\Routing\\DelegatingLoader`. -Using the Custom Loader +Using the custom Loader ~~~~~~~~~~~~~~~~~~~~~~~ If you did nothing else, your custom routing loader would *not* be called. @@ -212,7 +212,7 @@ for the ``ExtraLoader``, so it is set to ".". cached by the framework. So whenever you change something in the loader class itself, don't forget to clear the cache. -More Advanced Loaders +More advanced Loaders --------------------- In most cases it's better not to implement diff --git a/cookbook/routing/method_parameters.rst b/cookbook/routing/method_parameters.rst index ecf152ecc47..097ae3daebc 100644 --- a/cookbook/routing/method_parameters.rst +++ b/cookbook/routing/method_parameters.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; methods -How to use HTTP Methods beyond GET and POST in Routes +How to Use HTTP Methods beyond GET and POST in Routes ===================================================== The HTTP method of a request is one of the requirements that can be checked @@ -71,14 +71,14 @@ delete it by matching on GET, PUT and DELETE. return $collection; -Faking the Method with _method ------------------------------- +Faking the Method with ``_method`` +---------------------------------- .. note:: The ``_method`` functionality shown here is disabled by default in Symfony 2.2 and enabled by default in Symfony 2.3. To control it in Symfony 2.2, you - must call :method:`Request::enableHttpMethodParameterOverride ` + must call :method:`Request::enableHttpMethodParameterOverride ` before you handle the request (e.g. in your front controller). In Symfony 2.3, use the :ref:`configuration-framework-http_method_override` option. diff --git a/cookbook/routing/redirect_in_config.rst b/cookbook/routing/redirect_in_config.rst index c9bdeca4147..6715e3ffdce 100644 --- a/cookbook/routing/redirect_in_config.rst +++ b/cookbook/routing/redirect_in_config.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; Redirect using Framework:RedirectController -How to Configure a Redirect without a Custom Controller +How to Configure a Redirect without a custom Controller ======================================================= Sometimes, a URL needs to redirect to another URL. You can do that by creating diff --git a/cookbook/routing/scheme.rst b/cookbook/routing/scheme.rst index a9727560398..e502750ea9e 100644 --- a/cookbook/routing/scheme.rst +++ b/cookbook/routing/scheme.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; Scheme requirement -How to force routes to always use HTTPS or HTTP +How to Force Routes to always Use HTTPS or HTTP =============================================== Sometimes, you want to secure some routes and be sure that they are always diff --git a/cookbook/routing/service_container_parameters.rst b/cookbook/routing/service_container_parameters.rst index 295bb366be4..a3c84db5c04 100644 --- a/cookbook/routing/service_container_parameters.rst +++ b/cookbook/routing/service_container_parameters.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; Service Container Parameters -How to use Service Container Parameters in your Routes +How to Use Service Container Parameters in your Routes ====================================================== Sometimes you may find it useful to make some parts of your routes diff --git a/cookbook/routing/slash_in_parameter.rst b/cookbook/routing/slash_in_parameter.rst index e5cdcbeafba..64f1a27c08d 100644 --- a/cookbook/routing/slash_in_parameter.rst +++ b/cookbook/routing/slash_in_parameter.rst @@ -1,7 +1,7 @@ .. index:: single: Routing; Allow / in route parameter -How to allow a "/" character in a route parameter +How to Allow a "/" Character in a Route Parameter ================================================= Sometimes, you need to compose URLs with parameters that can contain a slash diff --git a/cookbook/security/acl.rst b/cookbook/security/acl.rst index 24cbedbf26e..0ee5b34fecd 100644 --- a/cookbook/security/acl.rst +++ b/cookbook/security/acl.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Access Control Lists (ACLs) -How to use Access Control Lists (ACLs) +How to Use Access Control Lists (ACLs) ====================================== In complex applications, you will often face the problem that access decisions @@ -94,8 +94,8 @@ Once the ACL is created, you can grant access to objects by creating an Access Control Entity (ACE) to solidify the relationship between the entity and your user. -Creating an ACL, and adding an ACE -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Creating an ACL and Adding an ACE +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: php diff --git a/cookbook/security/acl_advanced.rst b/cookbook/security/acl_advanced.rst index 8a902004b3d..9dbbe722b4f 100644 --- a/cookbook/security/acl_advanced.rst +++ b/cookbook/security/acl_advanced.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Advanced ACL concepts -How to use Advanced ACL Concepts +How to Use advanced ACL Concepts ================================ The aim of this chapter is to give a more in-depth view of the ACL system, and diff --git a/cookbook/security/custom_authentication_provider.rst b/cookbook/security/custom_authentication_provider.rst index a9244dfe002..b3e8c2535ae 100644 --- a/cookbook/security/custom_authentication_provider.rst +++ b/cookbook/security/custom_authentication_provider.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Custom authentication provider -How to create a custom Authentication Provider +How to Create a custom Authentication Provider ============================================== If you have read the chapter on :doc:`/book/security`, you understand the @@ -495,7 +495,7 @@ You are finished! You can now define parts of your app as under WSSE protection. Congratulations! You have written your very own custom security authentication provider! -A Little Extra +A little Extra -------------- How about making your WSSE authentication provider a bit more exciting? The diff --git a/cookbook/security/custom_provider.rst b/cookbook/security/custom_provider.rst index 5056f96f7c0..2743c6f8c0d 100644 --- a/cookbook/security/custom_provider.rst +++ b/cookbook/security/custom_provider.rst @@ -1,7 +1,7 @@ .. index:: single: Security; User Provider -How to create a custom User Provider +How to Create a custom User Provider ==================================== Part of Symfony's standard authentication process depends on "user providers". @@ -285,7 +285,7 @@ then encoded using this algorithm before being compared to the hashed password returned by your ``getPassword()`` method. Additionally, depending on your options, the password may be encoded multiple times and encoded to base64. -.. sidebar:: Specifics on how passwords are encoded +.. sidebar:: Specifics on how Passwords are Encoded Symfony uses a specific method to combine the salt and encode the password before comparing it to your encoded password. If ``getSalt()`` returns diff --git a/cookbook/security/entity_provider.rst b/cookbook/security/entity_provider.rst index efe3a0f4592..352427eb64e 100644 --- a/cookbook/security/entity_provider.rst +++ b/cookbook/security/entity_provider.rst @@ -2,7 +2,7 @@ single: Security; User provider single: Security; Entity provider -How to load Security Users from the Database (the Entity Provider) +How to Load Security Users from the Database (the Entity Provider) ================================================================== The security layer is one of the smartest tools of Symfony. It handles two @@ -358,7 +358,7 @@ entity user provider to load User entity objects from the database by using the ``username`` unique field. In other words, this tells Symfony how to fetch the user from the database before checking the password validity. -Forbid Inactive Users +Forbid inactive Users --------------------- If a User's ``isActive`` property is set to ``false`` (i.e. ``is_active`` diff --git a/cookbook/security/force_https.rst b/cookbook/security/force_https.rst index 5887e8a8c44..63bb7b2e2b2 100644 --- a/cookbook/security/force_https.rst +++ b/cookbook/security/force_https.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Force HTTPS -How to force HTTPS or HTTP for Different URLs +How to Force HTTPS or HTTP for different URLs ============================================= You can force areas of your site to use the HTTPS protocol in the security diff --git a/cookbook/security/form_login.rst b/cookbook/security/form_login.rst index 295bbd28c08..6e6b14133f5 100644 --- a/cookbook/security/form_login.rst +++ b/cookbook/security/form_login.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Customizing form login -How to customize your Form Login +How to Customize your Form Login ================================ Using a :ref:`form login ` for authentication is @@ -39,7 +39,7 @@ in several ways. redirected there. For information on controlling this behavior, see :doc:`/cookbook/security/target_path`. -Changing the Default Page +Changing the default Page ~~~~~~~~~~~~~~~~~~~~~~~~~ First, the default page can be set (i.e. the page the user is redirected to @@ -88,7 +88,7 @@ if no previous page was stored in the session). To set it to the Now, when no URL is set in the session, users will be sent to the ``default_security_target`` route. -Always Redirect to the Default Page +Always Redirect to the default Page ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can make it so that users are always redirected to the default page regardless diff --git a/cookbook/security/remember_me.rst b/cookbook/security/remember_me.rst index 15de1b4028d..7efb39f277d 100644 --- a/cookbook/security/remember_me.rst +++ b/cookbook/security/remember_me.rst @@ -1,7 +1,7 @@ .. index:: single: Security; "Remember me" -How to add "Remember Me" Login Functionality +How to Add "Remember Me" Login Functionality ============================================ Once a user is authenticated, their credentials are typically stored in the @@ -109,7 +109,7 @@ might ultimately looks like this: The user will then automatically be logged in on subsequent visits while the cookie remains valid. -Forcing the User to Re-authenticate before accessing certain Resources +Forcing the User to Re-authenticate before Accessing certain Resources ---------------------------------------------------------------------- When the user returns to your site, they are authenticated automatically based diff --git a/cookbook/security/securing_services.rst b/cookbook/security/securing_services.rst index cbec97fb4d8..b13a8fbc99b 100644 --- a/cookbook/security/securing_services.rst +++ b/cookbook/security/securing_services.rst @@ -2,7 +2,7 @@ single: Security; Securing any service single: Security; Securing any method -How to secure any Service or Method in your Application +How to Secure any Service or Method in your Application ======================================================= In the security chapter, you can see how to :ref:`secure a controller ` diff --git a/cookbook/security/target_path.rst b/cookbook/security/target_path.rst index 53914102f33..4c9db2541bc 100644 --- a/cookbook/security/target_path.rst +++ b/cookbook/security/target_path.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Target redirect path -How to change the Default Target Path Behavior +How to Change the default Target Path Behavior ============================================== By default, the Security component retains the information of the last request diff --git a/cookbook/security/voters.rst b/cookbook/security/voters.rst index 9f07ba49b33..fd64a79cc4d 100644 --- a/cookbook/security/voters.rst +++ b/cookbook/security/voters.rst @@ -1,7 +1,7 @@ .. index:: single: Security; Voters -How to implement your own Voter to blacklist IP Addresses +How to Implement your own Voter to Blacklist IP Addresses ========================================================= The Symfony2 Security component provides several layers to authorize users. @@ -29,7 +29,7 @@ blacklisted addresses and "something" will be the application. If the user's IP ``VoterInterface::ACCESS_ABSTAIN`` as this voter's purpose is only to deny access, not to grant access. -Creating a Custom Voter +Creating a custom Voter ----------------------- To blacklist a user based on its IP, you can use the ``request`` service @@ -49,7 +49,7 @@ and compare the IP address against a set of blacklisted IP addresses: private $container; private $blacklistedIp; - + public function __construct(ContainerInterface $container, array $blacklistedIp = array()) { $this->container = $container; diff --git a/cookbook/security/voters_data_permission.rst b/cookbook/security/voters_data_permission.rst index f6f52904f7a..efd6c7c1064 100644 --- a/cookbook/security/voters_data_permission.rst +++ b/cookbook/security/voters_data_permission.rst @@ -50,7 +50,7 @@ the object). If the condition fails, you'll return ``VoterInterface::ACCESS_GRANTED``. In case the responsibility for this decision does not belong to this voter, it will return ``VoterInterface::ACCESS_ABSTAIN``. -Creating the Custom Voter +Creating the custom Voter ------------------------- The goal is to create a voter that checks if a user has access to view or @@ -208,7 +208,7 @@ from the security context is called. { // get a Post instance $post = ...; - + // keep in mind, this will call all registered security voters if (false === $this->get('security.context')->isGranted('view', $post)) { throw new AccessDeniedException('Unauthorised access!'); diff --git a/cookbook/serializer.rst b/cookbook/serializer.rst index e85631f74e2..762a0f86d19 100644 --- a/cookbook/serializer.rst +++ b/cookbook/serializer.rst @@ -1,7 +1,7 @@ .. index:: single: Serializer -How to use the Serializer +How to Use the Serializer ========================= Serializing and deserializing to and from objects and different formats (e.g. @@ -67,10 +67,10 @@ You can load normalizers and/or encoders by tagging them as :ref:`serializer.encoder`. It's also possible to set the priority of the tag in order to decide the matching order. -Here is an example on how to load the +Here is an example on how to load the :class:`Symfony\\Component\\Serializer\\Normalizer\\GetSetMethodNormalizer`: -.. configuration-block:: +.. configuration-block:: .. code-block:: yaml diff --git a/cookbook/service_container/compiler_passes.rst b/cookbook/service_container/compiler_passes.rst index f573d584951..cf629a695ef 100644 --- a/cookbook/service_container/compiler_passes.rst +++ b/cookbook/service_container/compiler_passes.rst @@ -2,7 +2,7 @@ single: DependencyInjection; Compiler passes single: Service Container; Compiler passes -How to work with Compiler Passes in Bundles +How to Work with Compiler Passes in Bundles =========================================== Compiler passes give you an opportunity to manipulate other service diff --git a/cookbook/service_container/event_listener.rst b/cookbook/service_container/event_listener.rst index d0e7ae08831..a78acded921 100644 --- a/cookbook/service_container/event_listener.rst +++ b/cookbook/service_container/event_listener.rst @@ -1,7 +1,7 @@ .. index:: single: Events; Create listener -How to create an Event Listener +How to Create an Event Listener =============================== Symfony has various events and hooks that can be used to trigger custom @@ -94,7 +94,7 @@ using a special "tag": in the order of their priority (highest to lowest). This is useful when you need to guarantee that one listener is executed before another. -Request events, checking types +Request Events, Checking Types ------------------------------ A single page can make several requests (one master request, and then multiple diff --git a/cookbook/service_container/scopes.rst b/cookbook/service_container/scopes.rst index cb71b5f63f7..786de8a93e2 100644 --- a/cookbook/service_container/scopes.rst +++ b/cookbook/service_container/scopes.rst @@ -95,7 +95,7 @@ Each scenario is detailed in the following sections. .. _using-synchronized-service: -Using a synchronized Service +Using a Synchronized Service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. versionadded:: 2.3 diff --git a/cookbook/session/php_bridge.rst b/cookbook/session/php_bridge.rst index 7d9c6aa8321..fd18a7e3b75 100644 --- a/cookbook/session/php_bridge.rst +++ b/cookbook/session/php_bridge.rst @@ -1,7 +1,7 @@ .. index:: single: Sessions -Bridge a legacy application with Symfony Sessions +Bridge a legacy Application with Symfony Sessions ================================================= .. versionadded:: 2.3 diff --git a/cookbook/session/sessions_directory.rst b/cookbook/session/sessions_directory.rst index e1120165453..61922ec6fcd 100644 --- a/cookbook/session/sessions_directory.rst +++ b/cookbook/session/sessions_directory.rst @@ -1,8 +1,8 @@ .. index:: single: Sessions, sessions directory -Configuring the Directory Where Sessions Files are Saved -======================================================== +Configuring the Directory where Session Files are Saved +======================================================= By default, the Symfony Standard Edition uses the global ``php.ini`` values for ``session.save_handler`` and ``session.save_path`` to determine where @@ -138,4 +138,4 @@ session directory to ``app/sessions``: 'save_path' => '%kernel.root_dir%/sessions', ), )); - + diff --git a/cookbook/symfony1.rst b/cookbook/symfony1.rst index 9fa77504bcc..a393534e8ec 100644 --- a/cookbook/symfony1.rst +++ b/cookbook/symfony1.rst @@ -1,7 +1,7 @@ .. index:: single: symfony1 -How Symfony2 differs from symfony1 +How Symfony2 Differs from Symfony1 ================================== The Symfony2 framework embodies a significant evolution when compared with diff --git a/cookbook/templating/PHP.rst b/cookbook/templating/PHP.rst index 4ecfa7b1a41..2b2b3f812f7 100644 --- a/cookbook/templating/PHP.rst +++ b/cookbook/templating/PHP.rst @@ -1,7 +1,7 @@ .. index:: single: PHP Templates -How to use PHP instead of Twig for Templates +How to Use PHP instead of Twig for Templates ============================================ Symfony2 defaults to Twig for its template engine, but you can still use @@ -296,8 +296,8 @@ pattern: path: /hello/{name} defaults: { _controller: AcmeHelloBundle:Hello:index } -Using Assets: images, JavaScripts, and stylesheets -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Using Assets: Images, JavaScripts and Stylesheets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ What would the Internet be without images, JavaScripts, and stylesheets? Symfony2 provides the ``assets`` tag to deal with them easily: diff --git a/cookbook/templating/global_variables.rst b/cookbook/templating/global_variables.rst index 78ed01009bc..c0d4d332854 100644 --- a/cookbook/templating/global_variables.rst +++ b/cookbook/templating/global_variables.rst @@ -1,7 +1,7 @@ .. index:: single: Templating; Global variables -How to Inject Variables into all Templates (i.e. Global Variables) +How to Inject Variables into all Templates (i.e. global Variables) ================================================================== Sometimes you want a variable to be accessible to all the templates you use. diff --git a/cookbook/templating/render_without_controller.rst b/cookbook/templating/render_without_controller.rst index cfd96b61c7b..004a8816a55 100644 --- a/cookbook/templating/render_without_controller.rst +++ b/cookbook/templating/render_without_controller.rst @@ -1,7 +1,7 @@ .. index:: single: Templating; Render template without custom controller -How to render a Template without a custom Controller +How to Render a Template without a custom Controller ==================================================== Usually, when you need to create a page, you need to create a controller diff --git a/cookbook/templating/twig_extension.rst b/cookbook/templating/twig_extension.rst index 25b629cb81c..f3f17dfbbc0 100644 --- a/cookbook/templating/twig_extension.rst +++ b/cookbook/templating/twig_extension.rst @@ -1,7 +1,7 @@ .. index:: single: Twig extensions -How to write a custom Twig Extension +How to Write a custom Twig Extension ==================================== The main motivation for writing an extension is to move often used code diff --git a/cookbook/testing/bootstrap.rst b/cookbook/testing/bootstrap.rst index 25c8dea6d53..aecbaff6c94 100644 --- a/cookbook/testing/bootstrap.rst +++ b/cookbook/testing/bootstrap.rst @@ -1,4 +1,4 @@ -How to customize the Bootstrap Process before running Tests +How to Customize the Bootstrap Process before Running Tests =========================================================== Sometimes when running tests, you need to do additional bootstrap work before diff --git a/cookbook/testing/database.rst b/cookbook/testing/database.rst index da3467abc3c..bd73d70b889 100644 --- a/cookbook/testing/database.rst +++ b/cookbook/testing/database.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; Database -How to test code that interacts with the Database +How to Test Code that Interacts with the Database ================================================= If your code interacts with the database, e.g. reads data from or stores data @@ -99,7 +99,7 @@ the employee which gets returned by the ``Repository``, which itself gets returned by the ``EntityManager``. This way, no real class is involved in testing. -Changing database Settings for functional Tests +Changing Database Settings for Functional Tests ----------------------------------------------- If you have functional tests, you want them to interact with a real database. diff --git a/cookbook/testing/doctrine.rst b/cookbook/testing/doctrine.rst index ef9467861a3..b4f1cda682a 100644 --- a/cookbook/testing/doctrine.rst +++ b/cookbook/testing/doctrine.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; Doctrine -How to test Doctrine Repositories +How to Test Doctrine Repositories ================================= Unit testing Doctrine repositories in a Symfony project is not recommended. diff --git a/cookbook/testing/http_authentication.rst b/cookbook/testing/http_authentication.rst index d6db89a8873..c201562a017 100644 --- a/cookbook/testing/http_authentication.rst +++ b/cookbook/testing/http_authentication.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; HTTP authentication -How to simulate HTTP Authentication in a Functional Test +How to Simulate HTTP Authentication in a Functional Test ======================================================== If your application needs HTTP authentication, pass the username and password diff --git a/cookbook/testing/insulating_clients.rst b/cookbook/testing/insulating_clients.rst index fa91e591813..ae0ac239efa 100644 --- a/cookbook/testing/insulating_clients.rst +++ b/cookbook/testing/insulating_clients.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; Insulating clients -How to test the Interaction of several Clients +How to Test the Interaction of several Clients ============================================== If you need to simulate an interaction between different clients (think of a diff --git a/cookbook/testing/profiling.rst b/cookbook/testing/profiling.rst index 613e997629f..3b6ece0d159 100644 --- a/cookbook/testing/profiling.rst +++ b/cookbook/testing/profiling.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; Profiling -How to use the Profiler in a Functional Test +How to Use the Profiler in a Functional Test ============================================ It's highly recommended that a functional test only tests the Response. But if diff --git a/cookbook/testing/simulating_authentication.rst b/cookbook/testing/simulating_authentication.rst index 56168f09552..9004fe0832a 100644 --- a/cookbook/testing/simulating_authentication.rst +++ b/cookbook/testing/simulating_authentication.rst @@ -1,7 +1,7 @@ .. index:: single: Tests; Simulating authentication -How to simulate Authentication with a Token in a Functional Test +How to Simulate Authentication with a Token in a Functional Test ================================================================ Authenticating requests in functional tests might slow down the suite. diff --git a/cookbook/validation/custom_constraint.rst b/cookbook/validation/custom_constraint.rst index 4bdffc45e0c..1aa828b76a0 100644 --- a/cookbook/validation/custom_constraint.rst +++ b/cookbook/validation/custom_constraint.rst @@ -1,7 +1,7 @@ .. index:: single: Validation; Custom constraints -How to create a Custom Validation Constraint +How to Create a custom Validation Constraint ============================================ You can create a custom constraint by extending the base constraint class, @@ -9,8 +9,8 @@ You can create a custom constraint by extending the base constraint class, As an example you're going to create a simple validator that checks if a string contains only alphanumeric characters. -Creating Constraint class -------------------------- +Creating the Constraint Class +----------------------------- First you need to create a Constraint class and extend :class:`Symfony\\Component\\Validator\\Constraint`:: diff --git a/cookbook/workflow/_vendor_deps.rst.inc b/cookbook/workflow/_vendor_deps.rst.inc index 1524fa69fa7..23ab3c3e073 100644 --- a/cookbook/workflow/_vendor_deps.rst.inc +++ b/cookbook/workflow/_vendor_deps.rst.inc @@ -1,7 +1,7 @@ Managing Vendor Libraries with ``composer.json`` ------------------------------------------------ -How does it work? +How Does it Work? ~~~~~~~~~~~~~~~~~ Every Symfony project uses a group of third-party "vendor" libraries. One diff --git a/cookbook/workflow/new_project_git.rst b/cookbook/workflow/new_project_git.rst index 0b96a42f146..574c7d5915e 100644 --- a/cookbook/workflow/new_project_git.rst +++ b/cookbook/workflow/new_project_git.rst @@ -1,7 +1,7 @@ .. index:: single: Workflow; Git -How to Create and store a Symfony2 Project in Git +How to Create and Store a Symfony2 Project in Git ================================================= .. tip:: @@ -92,7 +92,7 @@ is the official way to solve this problem and probably much easier to deal with. Unlike Git submodules, Composer is smart enough to calculate which libraries depend on which other libraries. -Storing your Project on a Remote Server +Storing your Project on a remote Server --------------------------------------- You now have a fully-functional Symfony2 project stored in Git. However, diff --git a/cookbook/workflow/new_project_svn.rst b/cookbook/workflow/new_project_svn.rst index feb4e399ee9..2e08d4e7cfa 100644 --- a/cookbook/workflow/new_project_svn.rst +++ b/cookbook/workflow/new_project_svn.rst @@ -1,7 +1,7 @@ .. index:: single: Workflow; Subversion -How to Create and store a Symfony2 Project in Subversion +How to Create and Store a Symfony2 Project in Subversion ======================================================== .. tip:: @@ -125,7 +125,7 @@ to learn more about how to configure and develop inside your application. .. _svn-hosting: -Subversion hosting solutions +Subversion Hosting Solutions ---------------------------- The biggest difference between `Git`_ and `SVN`_ is that Subversion *needs* a