From 899d0f0d9964aeda17b0716bd772eb75cb304da5 Mon Sep 17 00:00:00 2001 From: WouterJ Date: Wed, 18 Sep 2013 19:10:45 +0200 Subject: [PATCH] Fixed embedded references --- book/controller.rst | 9 +-- book/doctrine.rst | 14 ++--- book/forms.rst | 27 ++++----- book/from_flat_php_to_symfony2.rst | 12 ++-- book/http_fundamentals.rst | 14 ++--- book/installation.rst | 4 +- book/internals.rst | 4 +- book/page_creation.rst | 10 ++-- book/routing.rst | 8 +-- book/security.rst | 20 +++---- book/service_container.rst | 6 +- book/templating.rst | 10 ++-- book/testing.rst | 8 +-- book/validation.rst | 12 ++-- .../console/helpers/formatterhelper.rst | 2 +- components/console/introduction.rst | 2 +- components/css_selector.rst | 2 +- components/dependency_injection/advanced.rst | 4 +- .../dependency_injection/compilation.rst | 2 +- .../dependency_injection/introduction.rst | 4 +- components/dependency_injection/workflow.rst | 14 ++--- components/dom_crawler.rst | 6 +- .../container_aware_dispatcher.rst | 2 +- components/event_dispatcher/introduction.rst | 4 +- components/form/introduction.rst | 20 +++---- components/http_foundation/introduction.rst | 6 +- components/http_kernel/introduction.rst | 46 +++++++-------- components/routing/hostname_pattern.rst | 4 +- components/routing/introduction.rst | 6 +- components/templating/helpers/slotshelper.rst | 2 +- contributing/community/releases.rst | 2 +- contributing/documentation/format.rst | 2 +- contributing/documentation/overview.rst | 2 +- contributing/documentation/standards.rst | 4 +- contributing/map.rst.inc | 6 +- cookbook/assetic/asset_management.rst | 10 ++-- cookbook/assetic/uglifyjs.rst | 4 +- cookbook/bundles/best_practices.rst | 4 +- cookbook/bundles/extension.rst | 8 +-- cookbook/cache/varnish.rst | 4 +- cookbook/configuration/environments.rst | 2 +- .../front_controllers_and_kernel.rst | 6 +- cookbook/console/logging.rst | 4 +- cookbook/controller/error_pages.rst | 2 +- cookbook/controller/service.rst | 2 +- cookbook/doctrine/common_extensions.rst | 4 +- .../doctrine/event_listeners_subscribers.rst | 4 +- cookbook/doctrine/file_uploads.rst | 6 +- cookbook/doctrine/registration_form.rst | 4 +- .../event_dispatcher/before_after_filters.rst | 2 +- cookbook/form/create_form_type_extension.rst | 6 +- cookbook/form/data_transformers.rst | 2 +- cookbook/form/dynamic_form_modification.rst | 2 +- cookbook/form/form_collections.rst | 2 +- cookbook/form/form_customization.rst | 4 +- cookbook/form/unit_testing.rst | 2 +- cookbook/logging/monolog.rst | 4 +- cookbook/security/entity_provider.rst | 6 +- cookbook/security/form_login.rst | 2 +- cookbook/security/securing_services.rst | 6 +- cookbook/session/locale_sticky_session.rst | 4 +- cookbook/session/sessions_directory.rst | 2 +- cookbook/templating/global_variables.rst | 2 +- cookbook/testing/database.rst | 2 +- cookbook/testing/profiling.rst | 2 +- cookbook/workflow/_vendor_deps.rst.inc | 2 +- quick_tour/the_view.rst | 2 +- reference/configuration/framework.rst | 2 +- reference/configuration/security.rst | 4 +- reference/constraints/All.rst | 4 +- reference/constraints/Blank.rst | 2 +- reference/constraints/Callback.rst | 6 +- reference/constraints/CardScheme.rst | 4 +- reference/constraints/Choice.rst | 4 +- reference/constraints/Collection.rst | 4 +- reference/constraints/Count.rst | 6 +- reference/constraints/Country.rst | 2 +- reference/constraints/Date.rst | 2 +- reference/constraints/DateTime.rst | 2 +- reference/constraints/Email.rst | 2 +- reference/constraints/False.rst | 2 +- reference/constraints/File.rst | 8 +-- reference/constraints/Image.rst | 12 ++-- reference/constraints/Ip.rst | 2 +- reference/constraints/Language.rst | 2 +- reference/constraints/Length.rst | 6 +- reference/constraints/Locale.rst | 2 +- reference/constraints/Luhn.rst | 2 +- reference/constraints/Max.rst | 4 +- reference/constraints/MaxLength.rst | 4 +- reference/constraints/Min.rst | 4 +- reference/constraints/MinLength.rst | 4 +- reference/constraints/NotBlank.rst | 2 +- reference/constraints/NotNull.rst | 2 +- reference/constraints/Null.rst | 2 +- reference/constraints/Range.rst | 6 +- reference/constraints/Regex.rst | 4 +- reference/constraints/Time.rst | 2 +- reference/constraints/True.rst | 2 +- reference/constraints/Type.rst | 6 +- reference/constraints/UniqueEntity.rst | 4 +- reference/constraints/Url.rst | 2 +- reference/constraints/UserPassword.rst | 2 +- reference/constraints/Valid.rst | 2 +- reference/dic_tags.rst | 2 +- reference/forms/twig_reference.rst | 4 +- reference/forms/types/birthday.rst | 10 ++-- reference/forms/types/checkbox.rst | 4 +- reference/forms/types/choice.rst | 52 ++++++++--------- reference/forms/types/collection.rst | 8 +-- reference/forms/types/country.rst | 6 +- reference/forms/types/date.rst | 2 +- reference/forms/types/datetime.rst | 10 ++-- reference/forms/types/email.rst | 6 +- reference/forms/types/entity.rst | 6 +- reference/forms/types/field.rst | 2 +- reference/forms/types/file.rst | 4 +- reference/forms/types/form.rst | 2 +- reference/forms/types/hidden.rst | 4 +- reference/forms/types/integer.rst | 4 +- reference/forms/types/language.rst | 6 +- reference/forms/types/locale.rst | 6 +- reference/forms/types/map.rst.inc | 56 +++++++++---------- reference/forms/types/money.rst | 4 +- reference/forms/types/number.rst | 4 +- reference/forms/types/password.rst | 4 +- reference/forms/types/percent.rst | 4 +- reference/forms/types/radio.rst | 8 +-- reference/forms/types/repeated.rst | 4 +- reference/forms/types/search.rst | 6 +- reference/forms/types/text.rst | 4 +- reference/forms/types/textarea.rst | 4 +- reference/forms/types/time.rst | 2 +- reference/forms/types/timezone.rst | 6 +- reference/forms/types/url.rst | 4 +- reference/map.rst.inc | 6 +- reference/twig_reference.rst | 18 +++--- 137 files changed, 412 insertions(+), 410 deletions(-) diff --git a/book/controller.rst b/book/controller.rst index 7583924414d..ff9206158c1 100644 --- a/book/controller.rst +++ b/book/controller.rst @@ -196,7 +196,7 @@ see :ref:`controller-string-syntax`. .. tip:: - You can learn much more about the routing system in the :doc:`Routing chapter`. + You can learn much more about the routing system in the :doc:`Routing chapter `. .. index:: single: Controller; Controller arguments @@ -397,7 +397,7 @@ itself. .. note:: - You can also define your :doc:`Controllers as Services`. + You can also define your :doc:`Controllers as Services `. This is optional, but can give you more control over the exact dependencies that are injected into your controllers. @@ -494,7 +494,7 @@ value to each variable. Like other base ``Controller`` methods, the ``forward`` method is just a shortcut for core Symfony2 functionality. A forward can be accomplished directly by duplicating the current request. When this - :ref:`sub request` is executed via the ``http_kernel`` + :ref:`sub request ` is executed via the ``http_kernel`` service the ``HttpKernel`` returns a ``Response`` object:: use Symfony\Component\HttpKernel/HttpKernelInterface; @@ -549,7 +549,8 @@ The Symfony templating engine is explained in great detail in the .. tip:: You can even avoid calling the ``render`` method by using the ``@Template`` - annotation. See the :doc:`FrameworkExtraBundle documentation` + annotation. See the + :doc:`FrameworkExtraBundle documentation ` more details. .. tip:: diff --git a/book/doctrine.rst b/book/doctrine.rst index 033a72447a9..a97d783864b 100644 --- a/book/doctrine.rst +++ b/book/doctrine.rst @@ -473,7 +473,7 @@ in your application. To do this, run: new column to the existing ``product`` table. An even better way to take advantage of this functionality is via - :doc:`migrations`, which allow you to + :doc:`migrations `, which allow you to generate these SQL statements and store them in migration classes that can be run systematically on your production server in order to track and migrate your database schema safely and reliably. @@ -581,7 +581,7 @@ on its ``id`` value:: You can achieve the equivalent of this without writing any code by using the ``@ParamConverter`` shortcut. See the - :doc:`FrameworkExtraBundle documentation` + :doc:`FrameworkExtraBundle documentation ` for more details. When you query for a particular type of object, you always use what's known @@ -758,7 +758,7 @@ for just one object, you can use the ``getSingleResult()`` method instead:: // ... The DQL syntax is incredibly powerful, allowing you to easily join between -entities (the topic of :ref:`relations` will be +entities (the topic of :ref:`relations ` will be covered later), group, etc. For more information, see the official Doctrine `Doctrine Query Language`_ documentation. @@ -1112,7 +1112,7 @@ table, and ``product.category_id`` column, and new foreign key: This task should only be really used during development. For a more robust method of systematically updating your production database, read about - :doc:`Doctrine migrations`. + :doc:`Doctrine migrations `. Saving Related Entities ~~~~~~~~~~~~~~~~~~~~~~~ @@ -1300,7 +1300,7 @@ Configuration Doctrine is highly configurable, though you probably won't ever need to worry about most of its options. To find out more about configuring Doctrine, see -the Doctrine section of the :doc:`reference manual`. +the Doctrine section of the :doc:`reference manual `. Lifecycle Callbacks ------------------- @@ -1412,7 +1412,7 @@ These include thing such as *Sluggable*, *Timestampable*, *Loggable*, *Translata and *Tree*. For more information on how to find and use these extensions, see the cookbook -article about :doc:`using common Doctrine extensions`. +article about :doc:`using common Doctrine extensions `. .. _book-doctrine-field-types: @@ -1591,7 +1591,7 @@ that allow you to take different actions as objects go through their persistence lifecycle. For more information about Doctrine, see the *Doctrine* section of the -:doc:`cookbook`, which includes the following articles: +:doc:`cookbook `, which includes the following articles: * :doc:`/bundles/DoctrineFixturesBundle/index` * :doc:`/cookbook/doctrine/common_extensions` diff --git a/book/forms.rst b/book/forms.rst index 3cdae81abe8..713cea4a077 100644 --- a/book/forms.rst +++ b/book/forms.rst @@ -382,7 +382,7 @@ corresponding errors printed out with the form. blank fields. Validation is a very powerful feature of Symfony2 and has its own -:doc:`dedicated chapter`. +:doc:`dedicated chapter `. .. index:: single: Forms; Validation groups @@ -404,7 +404,7 @@ you'll need to specify which validation group(s) your form should use:: 'validation_groups' => array('registration'), ))->add(...); -If you're creating :ref:`form classes` (a +If you're creating :ref:`form classes ` (a good practice), then you'll need to add the following to the ``setDefaultOptions()`` method:: @@ -489,7 +489,7 @@ Field Type Options Each field type has a number of options that can be used to configure it. For example, the ``dueDate`` field is currently being rendered as 3 select -boxes. However, the :doc:`date field` can be +boxes. However, the :doc:`date field ` can be configured to be rendered as a single text box (where the user would enter the date as a string in the box):: @@ -508,7 +508,8 @@ the documentation for each type. any field. By default, the ``required`` option is set to ``true``, meaning that HTML5-ready browsers will apply client-side validation if the field is left blank. If you don't want this behavior, either set the ``required`` - option on your field to ``false`` or :ref:`disable HTML5 validation`. + option on your field to ``false`` or + :ref:`disable HTML5 validation `. Also note that setting the ``required`` option to ``true`` will **not** result in server-side validation to be applied. In other words, if a @@ -661,7 +662,7 @@ Take a look at each part: It's usually a good idea to place a call to this helper at the bottom of each form (in case you forgot to output a field or don't want to bother manually rendering hidden fields). This helper is also useful for taking - advantage of the automatic :ref:`CSRF Protection`. + advantage of the automatic :ref:`CSRF Protection `. The majority of the work is done by the ``form_row`` helper, which renders the label, errors and HTML form widget of each field inside a ``div`` tag @@ -794,7 +795,7 @@ Twig Template Function Reference ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you're using Twig, a full reference of the form rendering functions is -available in the :doc:`reference manual`. +available in the :doc:`reference manual `. Read this to know everything about the helpers available and the options that can be used with each. @@ -985,7 +986,7 @@ HTML form and then translate user-submitted data back to the original object. As such, the topic of persisting the ``Task`` object to the database is entirely unrelated to the topic of forms. But, if you've configured the ``Task`` class to be persisted via Doctrine (i.e. you've added -:ref:`mapping metadata` for it), then persisting +:ref:`mapping metadata ` for it), then persisting it after a form submission can be done when the form is valid:: if ($form->isValid()) { @@ -1001,7 +1002,7 @@ you can fetch it from the form:: $task = $form->getData(); -For more information, see the :doc:`Doctrine ORM chapter`. +For more information, see the :doc:`Doctrine ORM chapter `. The key thing to understand is that when the form is bound, the submitted data is transferred to the underlying object immediately. If you want to @@ -1166,7 +1167,7 @@ form with many ``Product`` sub-forms). This is done by using the ``collection`` field type. For more information see the ":doc:`/cookbook/form/form_collections`" cookbook -entry and the :doc:`collection` field type reference. +entry and the :doc:`collection ` field type reference. .. index:: single: Forms; Theming @@ -1354,7 +1355,7 @@ override the default error rendering for *all* fields, copy and customize the .. tip:: The "parent" type of each field type is available in the - :doc:`form type reference` for each field type. + :doc:`form type reference ` for each field type. .. index:: single: Forms; Global Theming @@ -1643,7 +1644,7 @@ array of your submitted data, how can you add constraints to the data of your form? The answer is to setup the constraints yourself, and attach them to the individual -fields. The overall approach is covered a bit more in the :ref:`validation chapter`, +fields. The overall approach is covered a bit more in the :ref:`validation chapter `, but here's a short example: .. versionadded:: 2.1 @@ -1689,11 +1690,11 @@ take the data submitted by the user and to re-apply it to the object. There's still much more to learn about the powerful world of forms, such as how to handle :doc:`file uploads with Doctrine -` or how to create a form where a dynamic + ` or how to create a form where a dynamic number of sub-forms can be added (e.g. a todo list where you can keep adding more fields via Javascript before submitting). See the cookbook for these topics. Also, be sure to lean on the -:doc:`field type reference documentation`, which +:doc:`field type reference documentation `, which includes examples of how to use each field type and its options. Learn more from the Cookbook diff --git a/book/from_flat_php_to_symfony2.rst b/book/from_flat_php_to_symfony2.rst index 7fca407dd9a..d3d290d21ad 100644 --- a/book/from_flat_php_to_symfony2.rst +++ b/book/from_flat_php_to_symfony2.rst @@ -582,7 +582,7 @@ them for you. Here's the same sample application, now built in Symfony2:: } } -The two controllers are still lightweight. Each uses the :doc:`Doctrine ORM library` +The two controllers are still lightweight. Each uses the :doc:`Doctrine ORM library ` to retrieve objects from the database and the ``Templating`` component to render a template and return a ``Response`` object. The list template is now quite a bit simpler: @@ -667,7 +667,7 @@ controller method is responsible for returning the final ``Response`` object. There's really not much else to it. For a visual representation of how Symfony2 handles each request, see the -:ref:`request flow diagram`. +:ref:`request flow diagram `. Where Symfony2 Delivers ~~~~~~~~~~~~~~~~~~~~~~~ @@ -681,8 +681,8 @@ migrating the blog from flat PHP to Symfony2 has improved life: allows for new developers to be productive in your project more quickly; * 100% of the code you write is for *your* application. You **don't need - to develop or maintain low-level utilities** such as :ref:`autoloading`, - :doc:`routing`, or rendering :doc:`controllers`; + to develop or maintain low-level utilities** such as :ref:`autoloading `, + :doc:`routing `, or rendering :doc:`controllers `; * Symfony2 gives you **access to open source tools** such as Doctrine and the Templating, Security, Form, Validation and Translation components (to name @@ -694,7 +694,7 @@ migrating the blog from flat PHP to Symfony2 has improved life: * Symfony2's HTTP-centric architecture gives you access to powerful tools such as **HTTP caching** powered by **Symfony2's internal HTTP cache** or more powerful tools such as `Varnish`_. This is covered in a later chapter - all about :doc:`caching`. + all about :doc:`caching `. And perhaps best of all, by using Symfony2, you now have access to a whole set of **high-quality open source tools developed by the Symfony2 community**! @@ -745,7 +745,7 @@ The corresponding ``layout.html.twig`` template is also easier to write: Twig is well-supported in Symfony2. And while PHP templates will always be supported in Symfony2, the many advantages of Twig will continue to -be discussed. For more information, see the :doc:`templating chapter`. +be discussed. For more information, see the :doc:`templating chapter `. Learn more from the Cookbook ---------------------------- diff --git a/book/http_fundamentals.rst b/book/http_fundamentals.rst index 1654678bffc..c8a781a7e67 100644 --- a/book/http_fundamentals.rst +++ b/book/http_fundamentals.rst @@ -455,12 +455,12 @@ by adding an entry for ``/contact`` to your routing configuration file: .. note:: - This example uses :doc:`YAML` to define the routing + This example uses :doc:`YAML ` to define the routing configuration. Routing configuration can also be written in other formats such as XML or PHP. When someone visits the ``/contact`` page, this route is matched, and the -specified controller is executed. As you'll learn in the :doc:`routing chapter`, +specified controller is executed. As you'll learn in the :doc:`routing chapter `, the ``AcmeDemoBundle:Main:contact`` string is a short syntax that points to a specific PHP method ``contactAction`` inside a class called ``MainController``:: @@ -479,7 +479,7 @@ specific PHP method ``contactAction`` inside a class called ``MainController``:: In this very simple example, the controller simply creates a :class:`Symfony\\Component\\HttpFoundation\\Response` object with the HTML -"``

Contact us!

"``. In the :doc:`controller chapter`, +"``

Contact us!

"``. In the :doc:`controller chapter `, you'll learn how a controller can render templates, allowing your "presentation" code (i.e. anything that actually writes out HTML) to live in a separate template file. This frees up the controller to worry only about the hard @@ -512,11 +512,11 @@ libraries that can be used inside *any* PHP project. These libraries, called the *Symfony2 Components*, contain something useful for almost any situation, regardless of how your project is developed. To name a few: -* :doc:`HttpFoundation` - Contains +* :doc:`HttpFoundation ` - Contains the ``Request`` and ``Response`` classes, as well as other classes for handling sessions and file uploads; -* :doc:`Routing` - Powerful and fast routing system that +* :doc:`Routing ` - Powerful and fast routing system that allows you to map a specific URI (e.g. ``/contact``) to some information about how that request should be handled (e.g. execute the ``contactAction()`` method); @@ -527,11 +527,11 @@ regardless of how your project is developed. To name a few: * `Validator`_ A system for creating rules about data and then validating whether or not user-submitted data follows those rules; -* :doc:`ClassLoader` An autoloading library that allows +* :doc:`ClassLoader ` An autoloading library that allows PHP classes to be used without needing to manually ``require`` the files containing those classes; -* :doc:`Templating` A toolkit for rendering templates, +* :doc:`Templating ` A toolkit for rendering templates, handling template inheritance (i.e. a template is decorated with a layout) and performing other common template tasks; diff --git a/book/installation.rst b/book/installation.rst index 698177d1c0e..3c32a36804e 100644 --- a/book/installation.rst +++ b/book/installation.rst @@ -21,7 +21,7 @@ Installing a Symfony2 Distribution First, check that you have installed and configured a Web server (such as Apache) with PHP 5.3.8 or higher. For more information on Symfony2 - requirements, see the :doc:`requirements reference`. + requirements, see the :doc:`requirements reference `. Symfony2 packages "distributions", which are fully-functional applications that include the Symfony2 core libraries, a selection of useful bundles, a @@ -308,7 +308,7 @@ If you're new to Symfony, check out ":doc:`page_creation`", where you'll learn how to create pages, change configuration, and do everything else you'll need in your new application. -Be sure to also check out the :doc:`Cookbook`, which contains +Be sure to also check out the :doc:`Cookbook `, which contains a wide variety of articles about solving specific problems with Symfony. .. note:: diff --git a/book/internals.rst b/book/internals.rst index 10cd050e34f..399f0d87daf 100644 --- a/book/internals.rst +++ b/book/internals.rst @@ -236,7 +236,7 @@ add the following code at the beginning of your listener method:: .. tip:: If you are not yet familiar with the Symfony2 Event Dispatcher, read the - :doc:`Event Dispatcher Component Documentation` + :doc:`Event Dispatcher Component Documentation ` section first. .. index:: @@ -432,7 +432,7 @@ The Event Dispatcher The event dispatcher is a standalone component that is responsible for much of the underlying logic and flow behind a Symfony request. For more information, -see the :doc:`Event Dispatcher Component Documentation`. +see the :doc:`Event Dispatcher Component Documentation `. .. seealso:: diff --git a/book/page_creation.rst b/book/page_creation.rst index dc100a0c5e4..5b92fddada4 100644 --- a/book/page_creation.rst +++ b/book/page_creation.rst @@ -286,7 +286,7 @@ application should greet you: .. tip:: - You can also view your app in the "prod" :ref:`environment` + You can also view your app in the "prod" :ref:`environment ` by visiting: .. code-block:: text @@ -600,7 +600,7 @@ in your application and to optimize them the way you want. .. note:: While you'll learn the basics here, an entire cookbook entry is devoted - to the organization and best practices of :doc:`bundles`. + to the organization and best practices of :doc:`bundles `. A bundle is simply a structured set of files within a directory that implement a single feature. You might create a ``BlogBundle``, a ``ForumBundle`` or @@ -675,7 +675,7 @@ called ``AcmeTestBundle.php``:: .. tip:: - The name ``AcmeTestBundle`` follows the standard :ref:`Bundle naming conventions`. + The name ``AcmeTestBundle`` follows the standard :ref:`Bundle naming conventions `. You could also choose to shorten the name of the bundle to simply ``TestBundle`` by naming this class ``TestBundle`` (and naming the file ``TestBundle.php``). @@ -884,7 +884,7 @@ The extension alias (configuration key) can also be used: .. note:: See the cookbook article: :doc:`How to expose a Semantic Configuration for - a Bundle` for information on adding + a Bundle ` for information on adding configuration for your own bundle. .. index:: @@ -942,7 +942,7 @@ cached files and allow them to rebuild: .. note:: The ``test`` environment is used when running automated tests and cannot - be accessed directly through the browser. See the :doc:`testing chapter` + be accessed directly through the browser. See the :doc:`testing chapter ` for more details. .. index:: diff --git a/book/routing.rst b/book/routing.rst index 1274d4b9274..ca19b6f2520 100644 --- a/book/routing.rst +++ b/book/routing.rst @@ -79,7 +79,7 @@ for you to use in your controller (keep reading). The ``_controller`` parameter is a special key that tells Symfony which controller should be executed when a URL matches this route. The ``_controller`` string -is called the :ref:`logical name`. It follows a +is called the :ref:`logical name `. It follows a pattern that points to a specific PHP class and method:: // src/Acme/BlogBundle/Controller/BlogController.php @@ -818,9 +818,9 @@ that are special: each adds a unique piece of functionality inside your applicat * ``_controller``: As you've seen, this parameter is used to determine which controller is executed when the route is matched; -* ``_format``: Used to set the request format (:ref:`read more`); +* ``_format``: Used to set the request format (:ref:`read more `); -* ``_locale``: Used to set the locale on the request (:ref:`read more`); +* ``_locale``: Used to set the locale on the request (:ref:`read more `); .. tip:: @@ -1062,7 +1062,7 @@ from the new routing resource. .. tip:: You can also define routes using annotations. See the - :doc:`FrameworkExtraBundle documentation` + :doc:`FrameworkExtraBundle documentation ` to see how. Adding a Host regex to Imported Routes diff --git a/book/security.rst b/book/security.rst index fbe468213ef..63dbfc76126 100644 --- a/book/security.rst +++ b/book/security.rst @@ -226,7 +226,7 @@ sort of message indicating that access has been denied. When Symfony denies the user access, the user sees an error screen and receives a 403 HTTP status code (``Forbidden``). You can customize the access denied error screen by following the directions in the - :ref:`Error Pages` cookbook entry + :ref:`Error Pages ` cookbook entry to customize the 403 error page. Finally, if the ``admin`` user requests ``/admin/foo``, a similar process @@ -285,7 +285,7 @@ then protect access to certain areas with roles. By using HTTP Authentication, you can effortlessly tap into the native username/password box offered by all browsers. However, Symfony supports many authentication mechanisms out of the box. For details on all of them, see the -:doc:`Security Configuration Reference`. +:doc:`Security Configuration Reference `. In this section, you'll enhance this process by allowing the user to authenticate via a traditional HTML login form. @@ -530,7 +530,7 @@ The form has very few requirements. First, by submitting the form to ``/login_ch (via the ``login_check`` route), the security system will intercept the form submission and process the form for you automatically. Second, the security system expects the submitted fields to be called ``_username`` and ``_password`` -(these field names can be :ref:`configured`). +(these field names can be :ref:`configured `). And that's it! When you submit the form, the security system will automatically check the user's credentials and either authenticate the user or send the @@ -756,8 +756,8 @@ is used to enforce access. Each ``access_control`` has several options that configure two different things: -* (a) :ref:`should the incoming request match this access control entry` -* (b) :ref:`once it matches, should some sort of access restriction be enforced`: +* (a) :ref:`should the incoming request match this access control entry ` +* (b) :ref:`once it matches, should some sort of access restriction be enforced `: .. _security-book-access-control-matching-options: @@ -886,7 +886,7 @@ Securing by IP Certain situations may arise when you may need to restrict access to a given path based on IP. This is particularly relevant in the case of -:ref:`Edge Side Includes` (ESI), for example. When ESI is +:ref:`Edge Side Includes ` (ESI), for example. When ESI is enabled, it's recommended to secure access to ESI URLs. Indeed, some ESI may contain some private content like the current logged in user's information. To prevent any direct access to these resources from a web browser (by guessing the @@ -1392,8 +1392,8 @@ that the hashed password can't be decoded (i.e. you can't determine the password from the hashed password). .. versionadded:: 2.2 - As of Symfony 2.2 you can also use the :ref:`PBKDF2` - and :ref:`BCrypt` password encoders. + As of Symfony 2.2 you can also use the :ref:`PBKDF2 ` + and :ref:`BCrypt ` password encoders. Determining the Hashed Password ............................... @@ -1439,7 +1439,7 @@ In a controller this can be shortcut to: role. In a Twig Template this object can be accessed via the ``app.user`` key, -which calls the :method:`GlobalVariables::getUser()` +which calls the :method:`GlobalVariables::getUser() ` method: .. configuration-block:: @@ -1805,7 +1805,7 @@ a route so that you can use it to generate the URL: Once the user has been logged out, he will be redirected to whatever path is defined by the ``target`` parameter above (e.g. the ``homepage``). For more information on configuring the logout, see the -:doc:`Security Configuration Reference`. +:doc:`Security Configuration Reference `. .. _book-security-template: diff --git a/book/service_container.rst b/book/service_container.rst index 21a83d89379..24526c7319b 100644 --- a/book/service_container.rst +++ b/book/service_container.rst @@ -31,7 +31,7 @@ the service container makes writing good code so easy. .. tip:: If you want to know a lot more after reading this chapter, check out - the :doc:`Dependency Injection Component Documentation`. + the :doc:`Dependency Injection Component Documentation `. .. index:: single: Service Container; What is a service? @@ -183,7 +183,7 @@ later how you can configure a service that has multiple instances in the In this example, the controller extends Symfony's base Controller, which gives you access to the service container itself. You can then use the ``get`` method to locate and retrieve the ``my_mailer`` service from - the service container. You can also define your :doc:`controllers as services`. + the service container. You can also define your :doc:`controllers as services `. This is a bit more advanced and not necessary, but it allows you to inject only the services you need into your controller. @@ -537,7 +537,7 @@ notifying you of options that are missing or the wrong data type. When installing or configuring a bundle, see the bundle's documentation for how the services for the bundle should be installed and configured. The options -available for the core bundles can be found inside the :doc:`Reference Guide`. +available for the core bundles can be found inside the :doc:`Reference Guide `. .. note:: diff --git a/book/templating.rst b/book/templating.rst index 0b62b8c152b..fc16b8c1c39 100644 --- a/book/templating.rst +++ b/book/templating.rst @@ -103,7 +103,7 @@ by default. You can even `add your own extensions`_ to Twig as needed. .. tip:: Registering a Twig extension is as easy as creating a new service and tagging - it with ``twig.extension`` :ref:`tag`. + it with ``twig.extension`` :ref:`tag `. As you'll see throughout the documentation, Twig also supports functions and new functions can be easily added. For example, the following uses a @@ -458,7 +458,7 @@ section. .. note:: The available "engines" can be configured and even new engines added. - See :ref:`Templating Configuration` for more details. + See :ref:`Templating Configuration ` for more details. .. index:: single: Templating; Tags and helpers @@ -671,7 +671,7 @@ Whenever you find that you need a variable or a piece of information that you don't have access to in a template, consider rendering a controller. Controllers are fast to execute and promote good code organization and reuse. Of course, like all controllers, they should ideally be "skinny", meaning -that as much code as possible lives in reusable :doc:`services`. +that as much code as possible lives in reusable :doc:`services `. Asynchronous Content with hinclude.js ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1124,7 +1124,7 @@ automatically: .. tip:: You can add your own global template variables. See the cookbook example - on :doc:`Global Variables`. + on :doc:`Global Variables `. .. index:: single: Templating; The templating service @@ -1192,7 +1192,7 @@ configuration file: )); Several configuration options are available and are covered in the -:doc:`Configuration Appendix`. +:doc:`Configuration Appendix `. .. note:: diff --git a/book/testing.rst b/book/testing.rst index db5fb373933..1f035eb73ac 100644 --- a/book/testing.rst +++ b/book/testing.rst @@ -175,7 +175,7 @@ you'll use to crawl your site:: $crawler = $client->request('GET', '/demo/hello/Fabien'); -The ``request()`` method (see :ref:`more about the request method`) +The ``request()`` method (see :ref:`more about the request method `) returns a :class:`Symfony\\Component\\DomCrawler\\Crawler` object which can be used to select elements in the Response, click on links, and submit forms. @@ -337,7 +337,7 @@ giving you a nice API for uploading files. .. tip:: You will learn more about the ``Link`` and ``Form`` objects in the - :ref:`Crawler` section below. + :ref:`Crawler ` section below. The ``request`` method can also be used to simulate form submissions directly or perform more complex requests:: @@ -741,7 +741,7 @@ You can also override HTTP headers on a per request basis:: .. tip:: The test client is available as a service in the container in the ``test`` - environment (or wherever the :ref:`framework.test` + environment (or wherever the :ref:`framework.test ` option is enabled). This means you can override the service entirely if you need to. @@ -776,7 +776,7 @@ the installed third-party bundles: -To include other directories in the code coverage, also edit the ```` +To include other directories in the code coverage, also edit the `` `` section: .. code-block:: xml diff --git a/book/validation.rst b/book/validation.rst index 1f922f833e0..158e7cc3c6e 100644 --- a/book/validation.rst +++ b/book/validation.rst @@ -33,7 +33,7 @@ your application:: So far, this is just an ordinary class that serves some purpose inside your application. The goal of validation is to tell you whether or not the data of an object is valid. For this to work, you'll configure a list of rules -(called :ref:`constraints`) that the object must +(called :ref:`constraints `) that the object must follow in order to be valid. These rules can be specified via a number of different formats (YAML, XML, annotations, or PHP). @@ -237,7 +237,7 @@ workflow looks like the following from inside a controller:: This example uses an ``AuthorType`` form class, which is not shown here. -For more information, see the :doc:`Forms` chapter. +For more information, see the :doc:`Forms ` chapter. .. index:: pair: Validation; Configuration @@ -318,8 +318,8 @@ the ":doc:`/cookbook/validation/custom_constraint`" article of the cookbook. Constraint Configuration ~~~~~~~~~~~~~~~~~~~~~~~~ -Some constraints, like :doc:`NotBlank`, -are simple whereas others, like the :doc:`Choice` +Some constraints, like :doc:`NotBlank `, +are simple whereas others, like the :doc:`Choice ` constraint, have several configuration options available. Suppose that the ``Author`` class has another property, ``gender`` that can be set to either "male" or "female": @@ -669,7 +669,7 @@ Classes ~~~~~~~ Some constraints apply to the entire class being validated. For example, -the :doc:`Callback` constraint is a generic +the :doc:`Callback ` constraint is a generic constraint that's applied to the class itself. When that class is validated, methods specified by that constraint are simply executed so that each can provide more custom validation. @@ -1136,7 +1136,7 @@ it looks like this:: By calling ``validateValue`` on the validator, you can pass in a raw value and the constraint object that you want to validate that value against. A full list of the available constraints - as well as the full class name for each -constraint - is available in the :doc:`constraints reference` +constraint - is available in the :doc:`constraints reference ` section . The ``validateValue`` method returns a :class:`Symfony\\Component\\Validator\\ConstraintViolationList` diff --git a/components/console/helpers/formatterhelper.rst b/components/console/helpers/formatterhelper.rst index cad14a16619..565be6e6bab 100644 --- a/components/console/helpers/formatterhelper.rst +++ b/components/console/helpers/formatterhelper.rst @@ -16,7 +16,7 @@ in the default helper set, which you can get by calling The methods return a string, which you'll usually render to the console by passing it to the -:method:`OutputInterface::writeln` method. +:method:`OutputInterface::writeln ` method. Print Messages in a Section --------------------------- diff --git a/components/console/introduction.rst b/components/console/introduction.rst index fa7344c7826..8133d071fef 100755 --- a/components/console/introduction.rst +++ b/components/console/introduction.rst @@ -191,7 +191,7 @@ level. For example:: } When the quiet level is used, all output is suppressed as the default -:method:`Symfony\Component\Console\Output::write` +:method:`Symfony\Component\Console\Output::write ` method returns without actually printing. Using Command Arguments diff --git a/components/css_selector.rst b/components/css_selector.rst index c5f5c0aabf7..2367b0fde7c 100644 --- a/components/css_selector.rst +++ b/components/css_selector.rst @@ -62,7 +62,7 @@ You can use this expression with, for instance, :phpclass:`DOMXPath` or .. tip:: - The :method:`Crawler::filter()` method + The :method:`Crawler::filter() ` method uses the ``CssSelector`` component to find elements based on a CSS selector string. See the :doc:`/components/dom_crawler` for more details. diff --git a/components/dependency_injection/advanced.rst b/components/dependency_injection/advanced.rst index 7bed45e2021..35d99771ca6 100644 --- a/components/dependency_injection/advanced.rst +++ b/components/dependency_injection/advanced.rst @@ -65,7 +65,7 @@ Synthetic Services Synthetic services are services that are injected into the container instead of being created by the container. -For example, if you're using the :doc:`HttpKernel` +For example, if you're using the :doc:`HttpKernel ` component with the DependencyInjection component, then the ``request`` service is injected in the :method:`ContainerAwareHttpKernel::handle() ` @@ -102,7 +102,7 @@ to configure how a service is created by the container. As the service isn't created by the container, these options are omitted. Now, you can inject the class by using -:method:`Container::set`:: +:method:`Container::set `:: // ... $container->set('request', new MyRequest(...)); diff --git a/components/dependency_injection/compilation.rst b/components/dependency_injection/compilation.rst index be24ed45de7..af1fd1444f5 100644 --- a/components/dependency_injection/compilation.rst +++ b/components/dependency_injection/compilation.rst @@ -148,7 +148,7 @@ like this:: ) Whilst you can manually manage merging the different files, it is much better -to use :doc:`the Config Component` to merge +to use :doc:`the Config Component ` to merge and validate the config values. Using the configuration processing you could access the config value this way:: diff --git a/components/dependency_injection/introduction.rst b/components/dependency_injection/introduction.rst index 88bc49e4e8f..c52fe256310 100644 --- a/components/dependency_injection/introduction.rst +++ b/components/dependency_injection/introduction.rst @@ -184,7 +184,7 @@ for the services rather than using PHP to define the services as in the above examples. In anything but the smallest applications it make sense to organize the service definitions by moving them into one or more configuration files. To do this you also need to install -:doc:`the Config Component`. +:doc:`the Config Component `. Loading an XML config file:: @@ -209,7 +209,7 @@ Loading a YAML config file:: .. note:: If you want to load YAML config files then you will also need to install - :doc:`The YAML component`. + :doc:`The YAML component `. If you *do* want to use PHP to create the services then you can move this into a separate config file and load it in a similar way:: diff --git a/components/dependency_injection/workflow.rst b/components/dependency_injection/workflow.rst index 98b411af398..a9b2222be2b 100644 --- a/components/dependency_injection/workflow.rst +++ b/components/dependency_injection/workflow.rst @@ -24,12 +24,12 @@ Working with cached Container Before building it, the kernel checks to see if a cached version of the container exists. The ``HttpKernel`` has a debug setting and if this is false, the cached version is used if it exists. If debug is true then the kernel -:doc:`checks to see if configuration is fresh` +:doc:`checks to see if configuration is fresh ` and if it is, the cached version of the container is used. If not then the container is built from the application-level configuration and the bundles's extension configuration. -Read :ref:`Dumping the Configuration for Performance` +Read :ref:`Dumping the Configuration for Performance ` for more details. Application-level Configuration @@ -40,9 +40,9 @@ files are loaded which are then merged when the extensions are processed. This allows for different configuration for different environments e.g. dev, prod. These files contain parameters and services that are loaded directly into -the container as per :ref:`Setting Up the Container with Configuration Files`. +the container as per :ref:`Setting Up the Container with Configuration Files `. They also contain configuration that is processed by extensions as per -:ref:`Managing Configuration with Extensions`. +:ref:`Managing Configuration with Extensions `. These are considered to be bundle configuration since each bundle contains an Extension class. @@ -51,17 +51,17 @@ Bundle-level Configuration with Extensions By convention, each bundle contains an Extension class which is in the bundle's ``DependencyInjection`` directory. These are registered with the ``ContainerBuilder`` -when the kernel is booted. When the ``ContainerBuilder`` is :doc:`compiled`, +when the kernel is booted. When the ``ContainerBuilder`` is :doc:`compiled `, the application-level configuration relevant to the bundle's extension is passed to the Extension which also usually loads its own config file(s), typically from the bundle's ``Resources/config`` directory. The application-level config is usually processed -with a :doc:`Configuration object` also stored +with a :doc:`Configuration object ` also stored in the bundle's ``DependencyInjection`` directory. Compiler passes to allow Interaction between Bundles ---------------------------------------------------- -:ref:`Compiler passes` are +:ref:`Compiler passes ` are used to allow interaction between different bundles as they cannot affect each other's configuration in the extension classes. One of the main uses is to process tagged services, allowing bundles to register services to picked diff --git a/components/dom_crawler.rst b/components/dom_crawler.rst index d0df2ee208c..bb45d6c2beb 100644 --- a/components/dom_crawler.rst +++ b/components/dom_crawler.rst @@ -55,12 +55,12 @@ interacting with html links and forms as you traverse through the HTML tree. .. note:: The DomCrawler will attempt to automatically fix your HTML to match the - official specification. For example, if you nest a ``

`` tag inside - another ``

`` tag, it will be moved to be a sibling of the parent tag. + official specification. For example, if you nest a ``

`` tag inside + another ``

`` tag, it will be moved to be a sibling of the parent tag. This is expected and is part of the HTML5 spec. But if you're getting unexpected behavior, this could be a cause. And while the ``DomCrawler`` isn't meant to dump content, you can see the "fixed" version if your HTML - by :ref:`dumping it`. + by :ref:`dumping it `. Node Filtering ~~~~~~~~~~~~~~ diff --git a/components/event_dispatcher/container_aware_dispatcher.rst b/components/event_dispatcher/container_aware_dispatcher.rst index 0e2551da0d5..eca7d823870 100644 --- a/components/event_dispatcher/container_aware_dispatcher.rst +++ b/components/event_dispatcher/container_aware_dispatcher.rst @@ -12,7 +12,7 @@ Introduction The :class:`Symfony\\Component\\EventDispatcher\\ContainerAwareEventDispatcher` is a special event dispatcher implementation which is coupled to the service container -that is part of :doc:`the Dependency Injection component`. +that is part of :doc:`the Dependency Injection component `. It allows services to be specified as event listeners making the event dispatcher extremely powerful. diff --git a/components/event_dispatcher/introduction.rst b/components/event_dispatcher/introduction.rst index 06804bb16fb..d03ee05364e 100644 --- a/components/event_dispatcher/introduction.rst +++ b/components/event_dispatcher/introduction.rst @@ -94,7 +94,7 @@ Event Names and Event Objects When the dispatcher notifies listeners, it passes an actual ``Event`` object to those listeners. The base ``Event`` class is very simple: it contains a method for stopping :ref:`event -propagation`, but not much else. +propagation `, but not much else. Often times, data about a specific event needs to be passed along with the ``Event`` object so that the listeners have needed information. In the case of @@ -538,7 +538,7 @@ Dispatcher Shortcuts .. versionadded:: 2.1 ``EventDispatcher::dispatch()`` method returns the event since Symfony 2.1. -The :method:`EventDispatcher::dispatch` +The :method:`EventDispatcher::dispatch ` method always returns an :class:`Symfony\\Component\\EventDispatcher\\Event` object. This allows for various shortcuts. For example if one does not need a custom event object, one can simply rely on a plain diff --git a/components/form/introduction.rst b/components/form/introduction.rst index d6af2ad8863..a66ac33d342 100644 --- a/components/form/introduction.rst +++ b/components/form/introduction.rst @@ -51,7 +51,7 @@ support for very important features: messages for submitted data. The Symfony2 Form component relies on other libraries to solve these problems. -Most of the time you will use Twig and the Symfony :doc:`HttpFoundation`, +Most of the time you will use Twig and the Symfony :doc:`HttpFoundation `, Translation and Validator components, but you can replace any of these with a different library of your choice. @@ -67,7 +67,7 @@ Request Handling To process form data, you'll need to grab information off of the request (typically ``$_POST`` data) and pass the array of submitted data to :method:`Symfony\\Component\\Form\\Form::bind`. -The Form component optionally integrates with Symfony's :doc:`HttpFoundation` +The Form component optionally integrates with Symfony's :doc:`HttpFoundation ` component to make this even easier. To integrate the HttpFoundation component, add the @@ -155,7 +155,7 @@ line to your ``composer.json`` file: } } -The TwigBridge integration provides you with several :doc:`Twig Functions` +The TwigBridge integration provides you with several :doc:`Twig Functions ` that help you render each the HTML widget, label and error for each field (as well as a few other things). To configure the integration, you'll need to bootstrap or access Twig and add the :class:`Symfony\\Bridge\\Twig\\Extension\\FormExtension`:: @@ -193,7 +193,7 @@ The exact details of your `Twig Configuration`_ will vary, but the goal is always to add the :class:`Symfony\\Bridge\\Twig\\Extension\\FormExtension` to Twig, which gives you access to the Twig functions for rendering forms. To do this, you first need to create a :class:`Symfony\\Bridge\\Twig\\Form\\TwigRendererEngine`, -where you define your :ref:`form themes` +where you define your :ref:`form themes ` (i.e. resources/files that define form HTML markup). For general details on rendering forms, see :doc:`/cookbook/form/form_customization`. @@ -219,7 +219,7 @@ with Symfony's ``Translation`` component, or add the 2 Twig filters yourself, via your own Twig extension. To use the built-in integration, be sure that your project has Symfony's -``Translation`` and :doc:`Config` components +``Translation`` and :doc:`Config ` components installed. If you're using Composer, you could get the latest 2.1 version of each of these by adding the following to your ``composer.json`` file: @@ -404,10 +404,10 @@ is created from the form factory. As you can see, creating a form is like writing a recipe: you call ``add`` for each new field you want to create. The first argument to ``add`` is the name of your field, and the second is the field "type". The Form component -comes with a lot of :doc:`built-in types`. +comes with a lot of :doc:`built-in types `. -Now that you've built your form, learn how to :ref:`render` -it and :ref:`process the form submission`. +Now that you've built your form, learn how to :ref:`render ` +it and :ref:`process the form submission `. Setting Default Values ~~~~~~~~~~~~~~~~~~~~~~ @@ -443,7 +443,7 @@ builder: .. tip:: In this example, the default data is an array. Later, when you use the - :ref:`data_class` option to bind data directly + :ref:`data_class ` option to bind data directly to objects, your default data will be an instance of that object. .. _component-form-intro-rendering-form: @@ -618,4 +618,4 @@ and the errors will display next to the fields on error. .. _Packagist: https://packagist.org/packages/symfony/form .. _Twig: http://twig.sensiolabs.org -.. _`Twig Configuration`: http://twig.sensiolabs.org/doc/intro.html \ No newline at end of file +.. _`Twig Configuration`: http://twig.sensiolabs.org/doc/intro.html diff --git a/components/http_foundation/introduction.rst b/components/http_foundation/introduction.rst index e29ac869d07..604e12972ea 100644 --- a/components/http_foundation/introduction.rst +++ b/components/http_foundation/introduction.rst @@ -61,7 +61,7 @@ can be accessed via several public properties: * ``cookies``: equivalent of ``$_COOKIE``; -* ``attributes``: no equivalent - used by your app to store other data (see :ref:`below`) +* ``attributes``: no equivalent - used by your app to store other data (see :ref:`below `) * ``files``: equivalent of ``$_FILES``; @@ -174,7 +174,7 @@ thanks to the public ``attributes`` property, which is also an instance of 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 Symfony2 framework, see -:ref:`the Symfony2 book`. +:ref:`the Symfony2 book `. Identifying a Request ~~~~~~~~~~~~~~~~~~~~~ @@ -266,7 +266,7 @@ Accessing other Data The ``Request`` class has many other methods that you can use to access the request information. Have a look at -:class:`the Request API` +:class:`the Request API ` for more information about them. .. _component-http-foundation-response: diff --git a/components/http_kernel/introduction.rst b/components/http_kernel/introduction.rst index 07d43c286c5..4d705242d2e 100644 --- a/components/http_kernel/introduction.rst +++ b/components/http_kernel/introduction.rst @@ -55,8 +55,8 @@ matter how varied the architecture of that system:: ); } -Internally, :method:`HttpKernel::handle()` - -the concrete implementation of :method:`HttpKernelInterface::handle()` - +Internally, :method:`HttpKernel::handle() ` - +the concrete implementation of :method:`HttpKernelInterface::handle() ` - defines a workflow that starts with a :class:`Symfony\\Component\\HttpFoundation\\Request` and ends with a :class:`Symfony\\Component\\HttpFoundation\\Response`. @@ -79,8 +79,8 @@ 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:`event dispatcher` -and a :ref:`controller resolver` +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:: @@ -130,9 +130,9 @@ For general information on adding listeners to the events below, see parts of the system, or return a ``Response`` if possible (e.g. a security layer that denies access). -:ref:`Kernel Events Information Table` +:ref:`Kernel Events Information Table ` -The first event that is dispatched inside :method:`HttpKernel::handle` +The first event that is dispatched inside :method:`HttpKernel::handle ` is ``kernel.request``, which may have a variety of different listeners. .. image:: /images/components/http_kernel/02-kernel-request.png @@ -145,7 +145,7 @@ that listener may return a :class:`Symfony\\Component\\HttpFoundation\\RedirectR to the login page or a 403 Access Denied response. If a ``Response`` is returned at this stage, the process skips directly to -the :ref:`kernel.response` event. +the :ref:`kernel.response ` event. .. image:: /images/components/http_kernel/03-kernel-request-response.png :align: center @@ -156,7 +156,7 @@ object. Another common listener is routing. A router listener may process the ``Request`` and determine the controller that should be rendered (see the next section). -In fact, the ``Request`` object has an ":ref:`attributes`" +In fact, the ``Request`` object has an ":ref:`attributes `" bag which is a perfect spot to store this extra, application-specific data about the request. This means that if your router listener somehow determines the controller, it can store it on the ``Request`` attributes (which can be used @@ -174,7 +174,7 @@ attributes). This class executes the routing layer, which returns an *array* of information about the matched request, including the ``_controller`` and any placeholders that are in the route's pattern (e.g. ``{slug}``). See - :doc:`Routing Component`. + :doc:`Routing Component `. This array of information is stored in the :class:`Symfony\\Component\\HttpFoundation\\Request` object's ``attributes`` array. Adding the routing information here doesn't @@ -267,7 +267,7 @@ will be called after another event - ``kernel.controller`` - is dispatched. **Typical Purposes**: Initialize things or change the controller just before the controller is executed. -:ref:`Kernel Events Information Table` +:ref:`Kernel Events Information Table ` After the controller callable has been determined, ``HttpKernel::handle`` dispatches the ``kernel.controller`` event. Listeners to this event might initialize @@ -279,7 +279,7 @@ the controller is executed. For some examples, see the Symfony2 section below. :align: center Listeners to this event can also change the controller callable completely -by calling :method:`FilterControllerEvent::setController` +by calling :method:`FilterControllerEvent::setController ` on the event object that's passed to listeners on this event. .. sidebar:: ``kernel.controller`` in the Symfony Framework @@ -290,7 +290,7 @@ on the event object that's passed to listeners on this event. One interesting listener comes from the :doc:`SensioFrameworkExtraBundle `, which is packaged with the Symfony Standard Edition. This listener's - :doc:`@ParamConverter` + :doc:`@ParamConverter ` functionality allows you to pass a full object (e.g. a ``Post`` object) to your controller instead of a scalar value (e.g. an ``id`` parameter that was on your route). The listener - ``ParamConverterListener`` - uses @@ -351,13 +351,13 @@ for each page that is built. Usually, the controller will return a ``Response`` object. If this is true, then the work of the kernel is just about done! In this case, the next step -is the :ref:`kernel.response` event. +is the :ref:`kernel.response ` event. .. image:: /images/components/http_kernel/09-controller-returns-response.png :align: center But if the controller returns anything besides a ``Response``, then the kernel -has a little bit more work to do - :ref:`kernel.view` +has a little bit more work to do - :ref:`kernel.view ` (since the end goal is *always* to generate a ``Response`` object). .. note:: @@ -373,7 +373,7 @@ has a little bit more work to do - :ref:`kernel.view` +:ref:`Kernel Events Information Table ` If the controller doesn't return a ``Response`` object, then the kernel dispatches another event - ``kernel.view``. The job of a listener to this event is to @@ -398,7 +398,7 @@ return a ``Response``. event. However, one core bundle - :doc:`SensioFrameworkExtraBundle ` - *does* add a listener to this event. If your controller returns an array, - and you place the :doc:`@Template` + and you place the :doc:`@Template ` annotation above the controller, then this listener renders a template, passes the array you returned from your controller to that template, and creates a ``Response`` containing the returned content from that @@ -416,19 +416,19 @@ return a ``Response``. **Typical Purposes**: Modify the ``Response`` object just before it is sent -:ref:`Kernel Events Information Table` +:ref:`Kernel Events Information Table ` The end goal of the kernel is to transform a ``Request`` into a ``Response``. The -``Response`` might be created during the :ref:`kernel.request` -event, returned from the :ref:`controller`, -or returned by one of the listeners to the :ref:`kernel.view` +``Response`` might be created during the :ref:`kernel.request ` +event, returned from the :ref:`controller `, +or returned by one of the listeners to the :ref:`kernel.view ` event. Regardless of who creates the ``Response``, another event - ``kernel.response`` is dispatched directly afterwards. A typical listener to this event will modify the ``Response`` object in some way, such as modifying headers, adding cookies, or even changing the content of the ``Response`` itself (e.g. injecting some -JavaScript before the end ```` tag of an HTML response). +JavaScript before the end `` `` tag of an HTML response). After this event is dispatched, the final ``Response`` object is returned from :method:`Symfony\\Component\\HttpKernel\\HttpKernel::handle`. In the @@ -457,7 +457,7 @@ method, which sends the headers and prints the ``Response`` content. **Typical Purposes**: To perform some "heavy" action after the response has been streamed to the user -:ref:`Kernel Events Information Table` +:ref:`Kernel Events Information Table ` The final event of the HttpKernel process is ``kernel.terminate`` and is unique because it occurs *after* the ``HttpKernel::handle`` method, and after the @@ -495,7 +495,7 @@ Handling Exceptions:: the ``kernel.exception`` event **Typical Purposes**: Handle some type of exception and create an appropriate ``Response`` to return for the exception -:ref:`Kernel Events Information Table` +:ref:`Kernel Events Information Table ` If an exception is thrown at any point inside ``HttpKernel::handle``, another event - ``kernel.exception`` is thrown. Internally, the body of the ``handle`` diff --git a/components/routing/hostname_pattern.rst b/components/routing/hostname_pattern.rst index 38bc0f143eb..dfe5df8a445 100644 --- a/components/routing/hostname_pattern.rst +++ b/components/routing/hostname_pattern.rst @@ -63,9 +63,9 @@ only if the host is ``m.example.com``. Placeholders and Requirements in Hostname Patterns -------------------------------------------------- -If you're using the :doc:`DependencyInjection Component` +If you're using the :doc:`DependencyInjection Component ` (or the full Symfony2 Framework), then you can use -:ref:`service container parameters` as +:ref:`service container parameters ` as variables anywhere in your routes. You can avoid hardcoding the domain name by using a placeholder and a requirement. diff --git a/components/routing/introduction.rst b/components/routing/introduction.rst index e152ee742cd..12a032eb9d4 100644 --- a/components/routing/introduction.rst +++ b/components/routing/introduction.rst @@ -49,12 +49,12 @@ your autoloader to load the Routing component:: Be careful when using ``$_SERVER['REQUEST_URI']``, as it may include any query parameters on the URL, which will cause problems with route matching. An easy way to solve this is to use the HttpFoundation component - as explained :ref:`below`. + as explained :ref:`below `. You can add as many routes as you like to a :class:`Symfony\\Component\\Routing\\RouteCollection`. -The :method:`RouteCollection::add()` +The :method:`RouteCollection::add() ` method takes two arguments. The first is the name of the route. The second is a :class:`Symfony\\Component\\Routing\\Route` object, which expects a URL path and some array of custom variables in its constructor. This array @@ -184,7 +184,7 @@ with this class via its constructor:: Normally you can pass the values from the ``$_SERVER`` variable to populate the :class:`Symfony\\Component\\Routing\\RequestContext`. But If you use the -:doc:`HttpFoundation` component, you can use its +:doc:`HttpFoundation ` component, you can use its :class:`Symfony\\Component\\HttpFoundation\\Request` class to feed the :class:`Symfony\\Component\\Routing\\RequestContext` in a shortcut:: diff --git a/components/templating/helpers/slotshelper.rst b/components/templating/helpers/slotshelper.rst index 01d1dff84d8..82be58a5db4 100644 --- a/components/templating/helpers/slotshelper.rst +++ b/components/templating/helpers/slotshelper.rst @@ -54,7 +54,7 @@ Extending Templates The :method:`Symfony\\Component\\Templating\\PhpEngine::extend` method is called in the sub-template to set its parent template. Then :method:`$view['slots']->set() -` can be used to + ` can be used to set the content of a slot. All content which is not explicitly set in a slot is in the ``_content`` slot. diff --git a/contributing/community/releases.rst b/contributing/community/releases.rst index 46862b05ab3..c849a38408a 100644 --- a/contributing/community/releases.rst +++ b/contributing/community/releases.rst @@ -127,7 +127,7 @@ Deprecations When a feature implementation cannot be replaced with a better one without breaking backward compatibility, there is still the possibility to deprecate the old implementation and add a new preferred one along side. Read the -:ref:`conventions` document to +:ref:`conventions ` document to learn more about how deprecations are handled in Symfony. Rationale diff --git a/contributing/documentation/format.rst b/contributing/documentation/format.rst index c3677aaa471..665111a5399 100644 --- a/contributing/documentation/format.rst +++ b/contributing/documentation/format.rst @@ -199,7 +199,7 @@ Installing the Sphinx extensions # add the extensions to the list of extensions extensions = [..., 'sensio.sphinx.refinclude', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode'] - # enable highlighting for PHP code not between ```` by default + # enable highlighting for PHP code not between `` `` by default lexers['php'] = PhpLexer(startinline=True) lexers['php-annotations'] = PhpLexer(startinline=True) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 8e1e0a81b20..3c538295a93 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -218,7 +218,7 @@ For this example, suppose version 2.1 has just reached its end of maintenance: When a new Branch is created for a Release ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -During the :ref:`stabilization phase`, a +During the :ref:`stabilization phase `, a new branch on the documentation is created. For example, if version 2.3 were being stabilized, then a new 2.3 branch would be created for it. When this happens, the following items are done: diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 3c7f301ef8f..f7ca59167aa 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -48,13 +48,13 @@ Example Code Examples ------------- -* The code follows the :doc:`Symfony Coding Standards` +* The code follows the :doc:`Symfony Coding Standards ` as well as the `Twig Coding Standards`_; * To avoid horizontal scrolling on code blocks, we prefer to break a line correctly if it crosses the 85th character; * When you fold one or more lines of code, place ``...`` in a comment at the point of the fold. These comments are: ``// ...`` (php), ``# ...`` (yaml/bash), ``{# ... #}`` - (twig), ```` (xml/html), ``; ...`` (ini), ``...`` (text); + (twig), `` `` (xml/html), ``; ...`` (ini), ``...`` (text); * When you fold a part of a line, e.g. a variable value, put ``...`` (without comment) at the place of the fold; * Description of the folded code: (optional) diff --git a/contributing/map.rst.inc b/contributing/map.rst.inc index 4e42fb384b2..d8d8cd578c2 100644 --- a/contributing/map.rst.inc +++ b/contributing/map.rst.inc @@ -4,9 +4,9 @@ * :doc:`Patches ` * :doc:`Security ` * :doc:`Tests ` - * :doc:`Coding Standards` - * :doc:`Code Conventions` - * :doc:`Git` + * :doc:`Coding Standards ` + * :doc:`Code Conventions ` + * :doc:`Git ` * :doc:`License ` * **Documentation** diff --git a/cookbook/assetic/asset_management.rst b/cookbook/assetic/asset_management.rst index 8580c15cf67..c4a63112278 100644 --- a/cookbook/assetic/asset_management.rst +++ b/cookbook/assetic/asset_management.rst @@ -4,8 +4,8 @@ How to Use Assetic for Asset Management ======================================= -Assetic combines two major ideas: :ref:`assets` and -:ref:`filters`. The assets are files such as CSS, +Assetic combines two major ideas: :ref:`assets ` and +:ref:`filters `. The assets are files such as CSS, JavaScript and image files. The filters are things that can be applied to these files before they are served to the browser. This allows a separation between the asset files stored in the application and the files actually presented @@ -43,8 +43,8 @@ Using Assetic provides many advantages over directly serving the files. The files do not need to be stored where they are served from and can be drawn from various sources such as from within a bundle. -You can use Assetic to process both :ref:`CSS stylesheets` -and :ref:`JavaScript files`. The philosophy +You can use Assetic to process both :ref:`CSS stylesheets ` +and :ref:`JavaScript files `. The philosophy behind adding either is basically the same, but with a slightly different syntax. .. _cookbook-assetic-including-javascript: @@ -117,7 +117,7 @@ inside a ``stylesheets`` block: But because Assetic changes the paths to your assets, this *will* break any background images (or other paths) that uses relative paths, unless you use -the :ref:`cssrewrite` filter. +the :ref:`cssrewrite ` filter. .. note:: diff --git a/cookbook/assetic/uglifyjs.rst b/cookbook/assetic/uglifyjs.rst index 0fa70ba3306..3dfa3a05a3b 100644 --- a/cookbook/assetic/uglifyjs.rst +++ b/cookbook/assetic/uglifyjs.rst @@ -169,8 +169,8 @@ apply this filter when debug mode is off (e.g. ``app.php``): To try this out, switch to your ``prod`` environment (``app.php``). But before -you do, don't forget to :ref:`clear your cache` -and :ref:`dump your assetic assets`. +you do, don't forget to :ref:`clear your cache ` +and :ref:`dump your assetic assets `. .. tip:: diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index 337e802b475..d0c029f50a2 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -143,7 +143,7 @@ instance, a ``HelloController`` controller is stored in class name is ``Bundle\HelloBundle\Controller\HelloController``. All classes and files must follow the Symfony2 coding :doc:`standards -`. + `. Some classes should be seen as facades and should be as short as possible, like Commands, Helpers, Listeners, and Controllers. @@ -184,7 +184,7 @@ Documentation All classes and functions must come with full PHPDoc. Extensive documentation should also be provided in the :doc:`reStructuredText -` format, under the ``Resources/doc/`` + ` format, under the ``Resources/doc/`` directory; the ``Resources/doc/index.rst`` file is the only mandatory file and must be the entry point for the documentation. diff --git a/cookbook/bundles/extension.rst b/cookbook/bundles/extension.rst index e7f7bb1bf59..164d35e575c 100644 --- a/cookbook/bundles/extension.rst +++ b/cookbook/bundles/extension.rst @@ -44,7 +44,7 @@ When you create a bundle, you have two choices on how to handle configuration: You can specify your services in a configuration file (e.g. ``services.yml``) that lives in your bundle and then import it from your main application configuration. This is really easy, quick and totally effective. If you - make use of :ref:`parameters`, then + make use of :ref:`parameters `, then you still have the flexibility to customize your bundle from your application configuration. See ":ref:`service-container-imports-directive`" for more details. @@ -75,7 +75,7 @@ The second method has several specific advantages: * Smart merging when several configuration files (e.g. ``config_dev.yml`` and ``config.yml``) override each other's configuration; -* Configuration validation (if you use a :ref:`Configuration Class`); +* Configuration validation (if you use a :ref:`Configuration Class `); * IDE auto-completion when you create an XSD and developers use XML. @@ -251,7 +251,7 @@ It's your job, then, to decide how these configurations should be merged together. You might, for example, have later values override previous values or somehow merge them together. -Later, in the :ref:`Configuration Class` +Later, in the :ref:`Configuration Class ` section, you'll learn of a truly robust way to handle this. But for now, you might just merge them manually:: @@ -493,7 +493,7 @@ configuration arrays together. The ``Configuration`` class can be much more complicated than shown here, supporting array nodes, "prototype" nodes, advanced validation, XML-specific -normalization and advanced merging. You can read more about this in :doc:`the Config Component documentation`. +normalization and advanced merging. You can read more about this in :doc:`the Config Component documentation `. You can also see it action by checking out some of the core Configuration classes, such as the one from the `FrameworkBundle Configuration`_ or the `TwigBundle Configuration`_. diff --git a/cookbook/cache/varnish.rst b/cookbook/cache/varnish.rst index fa2170304f9..64d8ab616c9 100644 --- a/cookbook/cache/varnish.rst +++ b/cookbook/cache/varnish.rst @@ -8,7 +8,7 @@ Because Symfony2's cache uses the standard HTTP cache headers, the :ref:`symfony-gateway-cache` can easily be replaced with any other reverse proxy. Varnish is a powerful, open-source, HTTP accelerator capable of serving cached content quickly and including support for :ref:`Edge Side -Includes`. +Includes `. .. index:: single: Varnish; configuration @@ -203,7 +203,7 @@ absolute URLs: .. note:: - Remember to configure :ref:`framework.trusted_proxies` + Remember to configure :ref:`framework.trusted_proxies ` in the Symfony configuration so that Varnish is seen as a trusted proxy and the ``X-Forwarded-`` headers are used. diff --git a/cookbook/configuration/environments.rst b/cookbook/configuration/environments.rst index b1dea887b47..c75638c74ba 100644 --- a/cookbook/configuration/environments.rst +++ b/cookbook/configuration/environments.rst @@ -138,7 +138,7 @@ either the ``app.php`` (for the ``prod`` environment) or the ``app_dev.php`` The given URLs assume that your web server is configured to use the ``web/`` directory of the application as its root. Read more in - :doc:`Installing Symfony2`. + :doc:`Installing Symfony2 `. If you open up one of these files, you'll quickly see that the environment used by each is explicitly set: diff --git a/cookbook/configuration/front_controllers_and_kernel.rst b/cookbook/configuration/front_controllers_and_kernel.rst index 2066898592f..5cd3d647938 100644 --- a/cookbook/configuration/front_controllers_and_kernel.rst +++ b/cookbook/configuration/front_controllers_and_kernel.rst @@ -44,7 +44,7 @@ to `decorate`_ the kernel with additional features. Examples include: * Configuring the autoloader or adding additional autoloading mechanisms; * Adding HTTP level caching by wrapping the kernel with an instance of - :ref:`AppCache`. + :ref:`AppCache `. The front controller can be chosen by requesting URLs like: @@ -105,7 +105,7 @@ called the ``AppKernel``. Again, the Symfony2 Standard Edition provides an `AppKernel`_ in the ``app/`` directory. This class uses the name of the environment - which is passed to -the Kernel's :method:`constructor` +the Kernel's :method:`constructor ` method and is available via :method:`Symfony\\Component\\HttpKernel\\Kernel::getEnvironment` - to decide which bundles to create. The logic for that is in ``registerBundles()``, a method meant to be extended by you when you start adding bundles to your @@ -145,7 +145,7 @@ This method is responsible for loading the application's configuration from the right *environment*. Environments have been covered extensively -:doc:`in the previous chapter`, +:doc:`in the previous chapter `, and you probably remember that the Standard Edition comes with three of them - ``dev``, ``prod`` and ``test``. diff --git a/cookbook/console/logging.rst b/cookbook/console/logging.rst index bbddf0c7646..50c21d5ebce 100644 --- a/cookbook/console/logging.rst +++ b/cookbook/console/logging.rst @@ -80,7 +80,7 @@ method, where exception handling should happen: .. caution:: Due to the nature of the core :class:`Symfony\\Component\\Console\\Application` - class, much of the :method:`run` + class, much of the :method:`run ` method has to be duplicated and even a private property ``originalAutoExit`` re-implemented. This serves as an example of what you *could* do in your code, though there is a high risk that something may break when upgrading @@ -187,7 +187,7 @@ In the code above, you disable exception catching so the parent ``run`` method will throw all exceptions. When an exception is caught, you simple log it by accessing the ``logger`` service from the service container and then handle the rest of the logic in the same way that the parent ``run`` method does -(specifically, since the parent :method:`run` +(specifically, since the parent :method:`run ` method will not handle exceptions rendering and status code handling when ``catchExceptions`` is set to false, it has to be done in the overridden method). diff --git a/cookbook/controller/error_pages.rst b/cookbook/controller/error_pages.rst index e6b4b371952..a61292f8434 100644 --- a/cookbook/controller/error_pages.rst +++ b/cookbook/controller/error_pages.rst @@ -18,7 +18,7 @@ control you need: 2. Replace the default exception controller ``twig.controller.exception:showAction`` with your own controller and handle it however you want (see - :ref:`exception_controller in the Twig reference`). + :ref:`exception_controller in the Twig reference `). The default exception controller is registered as a service - the actual class is ``Symfony\Bundle\TwigBundle\Controller\ExceptionController``. diff --git a/cookbook/controller/service.rst b/cookbook/controller/service.rst index d22042f726a..cb88f742c6b 100644 --- a/cookbook/controller/service.rst +++ b/cookbook/controller/service.rst @@ -133,7 +133,7 @@ the route ``_controller`` value: You can also use annotations to configure routing using a controller defined as a service. See the - :doc:`FrameworkExtraBundle documentation` + :doc:`FrameworkExtraBundle documentation ` for details. Alternatives to Base Controller Methods diff --git a/cookbook/doctrine/common_extensions.rst b/cookbook/doctrine/common_extensions.rst index 89954c4ce92..32ede55465a 100644 --- a/cookbook/doctrine/common_extensions.rst +++ b/cookbook/doctrine/common_extensions.rst @@ -14,7 +14,7 @@ functionality for `Sluggable`_, `Translatable`_, `Timestampable`_, `Loggable`_, The usage for each of these extensions is explained in that repository. However, to install/activate each extension you must register and activate an -:doc:`Event Listener`. +:doc:`Event Listener `. To do this, you have two options: #. Use the `StofDoctrineExtensionsBundle`_, which integrates the above library. @@ -30,4 +30,4 @@ To do this, you have two options: .. _`Loggable`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/loggable.md .. _`Tree`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/tree.md .. _`Sortable`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/sortable.md -.. _`Install Gedmo Doctrine2 extensions in Symfony2`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/symfony2.md \ No newline at end of file +.. _`Install Gedmo Doctrine2 extensions in Symfony2`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/symfony2.md diff --git a/cookbook/doctrine/event_listeners_subscribers.rst b/cookbook/doctrine/event_listeners_subscribers.rst index 99b6a947571..50cfb09ab90 100644 --- a/cookbook/doctrine/event_listeners_subscribers.rst +++ b/cookbook/doctrine/event_listeners_subscribers.rst @@ -8,7 +8,7 @@ How to Register Event Listeners and Subscribers Doctrine packages a rich event system that fires events when almost anything happens inside the system. For you, this means that you can create arbitrary -:doc:`services` and tell Doctrine to notify those +:doc:`services ` and tell Doctrine to notify those objects whenever a certain action (e.g. ``prePersist``) happens within Doctrine. This could be useful, for example, to create an independent search index whenever an object in your database is saved. @@ -23,7 +23,7 @@ Configuring the Listener/Subscriber ----------------------------------- To register a service to act as an event listener or subscriber you just have -to :ref:`tag` it with the appropriate name. Depending +to :ref:`tag ` it with the appropriate name. Depending on your use-case, you can hook a listener into every DBAL connection and ORM entity manager or just into one specific DBAL connection and all the entity managers that use this connection. diff --git a/cookbook/doctrine/file_uploads.rst b/cookbook/doctrine/file_uploads.rst index 9e839905cb6..362d06cf8ec 100644 --- a/cookbook/doctrine/file_uploads.rst +++ b/cookbook/doctrine/file_uploads.rst @@ -7,7 +7,7 @@ How to handle File Uploads with Doctrine Handling file uploads with Doctrine entities is no different than handling any other file upload. In other words, you're free to move the file in your controller after handling a form submission. For examples of how to do this, -see the :doc:`file type reference` page. +see the :doc:`file type reference ` page. If you choose to, you can also integrate the file upload into your entity lifecycle (i.e. creation, update and removal). In this case, as your entity @@ -91,14 +91,14 @@ file. .. tip:: If you have not done so already, you should probably read the - :doc:`file` type documentation first to + :doc:`file ` type documentation first to understand how the basic upload process works. .. note:: If you're using annotations to specify your validation rules (as shown in this example), be sure that you've enabled validation by annotation - (see :ref:`validation configuration`). + (see :ref:`validation configuration `). To handle the actual file upload in the form, use a "virtual" ``file`` field. For example, if you're building your form directly in a controller, it might diff --git a/cookbook/doctrine/registration_form.rst b/cookbook/doctrine/registration_form.rst index e274cf1c639..0912d02d5c4 100644 --- a/cookbook/doctrine/registration_form.rst +++ b/cookbook/doctrine/registration_form.rst @@ -82,7 +82,7 @@ the class. .. note:: If you want to integrate this User within the security system, you need - to implement the :ref:`UserInterface` of the + to implement the :ref:`UserInterface ` of the security component. Create a Form for the Model @@ -286,7 +286,7 @@ Add New Routes Next, update your routes. If you're placing your routes inside your bundle (as shown here), don't forget to make sure that the routing file is being -:ref:`imported`. +:ref:`imported `. .. configuration-block:: diff --git a/cookbook/event_dispatcher/before_after_filters.rst b/cookbook/event_dispatcher/before_after_filters.rst index 3ea82f65a95..1a38dc39ee5 100755 --- a/cookbook/event_dispatcher/before_after_filters.rst +++ b/cookbook/event_dispatcher/before_after_filters.rst @@ -11,7 +11,7 @@ or hooks. In symfony1, this was achieved with the preExecute and postExecute methods. Most major frameworks have similar methods but there is no such thing in Symfony2. The good news is that there is a much better way to interfere with the -Request -> Response process using the :doc:`EventDispatcher component`. +Request -> Response process using the :doc:`EventDispatcher component `. Token validation Example ------------------------ diff --git a/cookbook/form/create_form_type_extension.rst b/cookbook/form/create_form_type_extension.rst index a75eaefc7ca..c9ab81a401a 100644 --- a/cookbook/form/create_form_type_extension.rst +++ b/cookbook/form/create_form_type_extension.rst @@ -4,7 +4,7 @@ How to Create a Form Type Extension =================================== -:doc:`Custom form field types` are great when +:doc:`Custom form field types ` are great when you need field types with a specific purpose, such as a gender selector, or a VAT number input. @@ -88,7 +88,7 @@ to override one of the following methods: * ``finishView()`` For more information on what those methods do, you can refer to the -:doc:`Creating Custom Field Types` +:doc:`Creating Custom Field Types ` cookbook article. Registering your Form Type Extension as a Service @@ -135,7 +135,7 @@ Adding the extension Business Logic The goal of your extension is to display nice images next to file inputs (when the underlying model contains images). For that purpose, let's assume that you use an approach similar to the one described in -:doc:`How to handle File Uploads with Doctrine`: +:doc:`How to handle File Uploads with Doctrine `: you have a Media model with a file property (corresponding to the file field in the form) and a path property (corresponding to the image path in the database):: diff --git a/cookbook/form/data_transformers.rst b/cookbook/form/data_transformers.rst index e0bd57113ae..802581c1ff8 100644 --- a/cookbook/form/data_transformers.rst +++ b/cookbook/form/data_transformers.rst @@ -244,7 +244,7 @@ a field for issue numbers 2) You need to worry about passing in the ``em`` option whenever you're creating a form that uses the transformer. -Because of these, you may choose to :doc:`create a custom field type`. +Because of these, you may choose to :doc:`create a custom field type `. First, create the custom field type class:: // src/Acme/TaskBundle/Form/Type/IssueSelectorType.php diff --git a/cookbook/form/dynamic_form_modification.rst b/cookbook/form/dynamic_form_modification.rst index 8316335c3a8..1499657714d 100644 --- a/cookbook/form/dynamic_form_modification.rst +++ b/cookbook/form/dynamic_form_modification.rst @@ -115,7 +115,7 @@ is new (e.g. hasn't been persisted to the database). Based on that, the subscrib might look like the following: .. versionadded:: 2.2 - The ability to pass a string into :method:`FormInterface::add` + The ability to pass a string into :method:`FormInterface::add ` was added in Symfony 2.2. .. code-block:: php diff --git a/cookbook/form/form_collections.rst b/cookbook/form/form_collections.rst index a3be1c8172e..2210c9f5b16 100755 --- a/cookbook/form/form_collections.rst +++ b/cookbook/form/form_collections.rst @@ -112,7 +112,7 @@ goal is to allow the tags of a ``Task`` to be modified right inside the task form itself, create a form for the ``Task`` class. Notice that you embed a collection of ``TagType`` forms using the -:doc:`collection` field type:: +:doc:`collection ` field type:: // src/Acme/TaskBundle/Form/Type/TaskType.php namespace Acme\TaskBundle\Form\Type; diff --git a/cookbook/form/form_customization.rst b/cookbook/form/form_customization.rst index 5aa5bff48b5..20ac50db40e 100644 --- a/cookbook/form/form_customization.rst +++ b/cookbook/form/form_customization.rst @@ -668,7 +668,7 @@ Other Common Customizations So far, this recipe has shown you several different ways to customize a single piece of how a form is rendered. The key is to customize a specific fragment that corresponds to the portion of the form you want to control (see -:ref:`naming form blocks`). +:ref:`naming form blocks `). In the next sections, you'll see how you can make several common form customizations. To apply these customizations, use one of the methods described in the @@ -681,7 +681,7 @@ Customizing Error Output The form component only handles *how* the validation errors are rendered, and not the actual validation error messages. The error messages themselves are determined by the validation constraints you apply to your objects. - For more information, see the chapter on :doc:`validation`. + For more information, see the chapter on :doc:`validation `. There are many different ways to customize how errors are rendered when a form is submitted with errors. The error messages for a field are rendered diff --git a/cookbook/form/unit_testing.rst b/cookbook/form/unit_testing.rst index def51102f93..c7e4d8993ca 100644 --- a/cookbook/form/unit_testing.rst +++ b/cookbook/form/unit_testing.rst @@ -156,7 +156,7 @@ Adding custom Extensions ------------------------ It often happens that you use some options that are added by -:doc:`form extensions`. One of the +:doc:`form extensions `. One of the cases may be the ``ValidatorExtension`` with its ``invalid_message`` option. The ``TypeTestCase`` loads only the core form extension so an "Invalid option" exception will be raised if you try to use it for testing a class that depends diff --git a/cookbook/logging/monolog.rst b/cookbook/logging/monolog.rst index f31952a33e2..11cb46e41fd 100644 --- a/cookbook/logging/monolog.rst +++ b/cookbook/logging/monolog.rst @@ -36,7 +36,7 @@ to write the logs (the handlers can be shared). .. tip:: When injecting the logger in a service you can - :ref:`use a custom channel` control which "channel" + :ref:`use a custom channel ` control which "channel" the logger will log to. The basic handler is the ``StreamHandler`` which writes logs in a stream @@ -226,7 +226,7 @@ only for a specific handler. A processor is simply a callable receiving the record as its first argument. Processors are configured using the ``monolog.processor`` DIC tag. See the -:ref:`reference about it`. +:ref:`reference about it `. Adding a Session/Request Token ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/cookbook/security/entity_provider.rst b/cookbook/security/entity_provider.rst index bd87aef3694..61b27ea4310 100644 --- a/cookbook/security/entity_provider.rst +++ b/cookbook/security/entity_provider.rst @@ -42,7 +42,7 @@ focus on the most important methods that come from the .. tip:: - You can :ref:`generate the missing getter and setters` + You can :ref:`generate the missing getter and setters ` by running: .. code-block:: bash @@ -165,7 +165,7 @@ focus on the most important methods that come from the .. tip:: - :ref:`Generate the database table` + :ref:`Generate the database table ` for your ``User`` entity by running: .. code-block:: bash @@ -237,7 +237,7 @@ Authenticating Someone against a Database Authenticating a Doctrine user against the database with the Symfony security layer is a piece of cake. Everything resides in the configuration of the -:doc:`SecurityBundle` stored in the +:doc:`SecurityBundle ` stored in the ``app/config/security.yml`` file. Below is an example of configuration where the user will enter his/her diff --git a/cookbook/security/form_login.rst b/cookbook/security/form_login.rst index c20a4cb6b74..6d6290e995c 100644 --- a/cookbook/security/form_login.rst +++ b/cookbook/security/form_login.rst @@ -4,7 +4,7 @@ How to customize your Form Login ================================ -Using a :ref:`form login` for authentication is +Using a :ref:`form login ` for authentication is a common, and flexible, method for handling authentication in Symfony2. Pretty much every aspect of the form login can be customized. The full, default configuration is shown in the next section. diff --git a/cookbook/security/securing_services.rst b/cookbook/security/securing_services.rst index 810b83fc9b6..d83b33b94cc 100644 --- a/cookbook/security/securing_services.rst +++ b/cookbook/security/securing_services.rst @@ -5,7 +5,7 @@ How to secure any Service or Method in your Application ======================================================= -In the security chapter, you can see how to :ref:`secure a controller` +In the security chapter, you can see how to :ref:`secure a controller ` by requesting the ``security.context`` service from the Service Container and checking the current user's role:: @@ -148,10 +148,10 @@ You can also secure method calls in any service with annotations by using the optional `JMSSecurityExtraBundle`_ bundle. This bundle is included in the Symfony2 Standard Distribution. -To enable the annotations functionality, :ref:`tag` +To enable the annotations functionality, :ref:`tag ` the service you want to secure with the ``security.secure_service`` tag (you can also automatically enable this functionality for all services, see -the :ref:`sidebar` below): +the :ref:`sidebar ` below): .. configuration-block:: diff --git a/cookbook/session/locale_sticky_session.rst b/cookbook/session/locale_sticky_session.rst index ddd130528ed..48f27c477b0 100644 --- a/cookbook/session/locale_sticky_session.rst +++ b/cookbook/session/locale_sticky_session.rst @@ -14,7 +14,7 @@ Creating LocaleListener ----------------------- To simulate that the locale is stored in a session, you need to create and -register a :doc:`new event listener`. +register a :doc:`new event listener `. The listener will look something like this. Typically, ``_locale`` is used as a routing parameter to signify the locale, though it doesn't really matter how you determine the desired locale from the request:: @@ -96,7 +96,7 @@ Then register the listener: That's it! Now celebrate by changing the user's locale and seeing that it's sticky throughout the request. Remember, to get the user's locale, always -use the :method:`Request::getLocale` +use the :method:`Request::getLocale ` method:: // from a controller... diff --git a/cookbook/session/sessions_directory.rst b/cookbook/session/sessions_directory.rst index c041c555ef7..98353e75066 100644 --- a/cookbook/session/sessions_directory.rst +++ b/cookbook/session/sessions_directory.rst @@ -17,7 +17,7 @@ that your current sessions aren't lost when you clear Symfony's cache. method of session management available within Symfony. See :doc:`/components/http_foundation/session_configuration` for a discussion of session save handlers. There is also an entry in the cookbook - about storing sessions in the :doc:`database`. + about storing sessions in the :doc:`database `. To change the directory in which Symfony saves session data, you only need change the framework configuration. In this example, you will change the diff --git a/cookbook/templating/global_variables.rst b/cookbook/templating/global_variables.rst index 536157ac092..78ed01009bc 100644 --- a/cookbook/templating/global_variables.rst +++ b/cookbook/templating/global_variables.rst @@ -131,5 +131,5 @@ Using a Twig Extension If the global variable you want to set is more complicated - say an object - then you won't be able to use the above method. Instead, you'll need to create -a :ref:`Twig Extension` and return the +a :ref:`Twig Extension ` and return the global variable as one of the entries in the ``getGlobals`` method. diff --git a/cookbook/testing/database.rst b/cookbook/testing/database.rst index 2abb0f294e8..13ba54d32d0 100644 --- a/cookbook/testing/database.rst +++ b/cookbook/testing/database.rst @@ -27,7 +27,7 @@ class. .. tip:: It is possible (and a good idea) to inject your repository directly by - registering your repository as a :doc:`factory service` + registering your repository as a :doc:`factory service ` This is a little bit more work to setup, but makes testing easier as you only need to mock the repository. diff --git a/cookbook/testing/profiling.rst b/cookbook/testing/profiling.rst index 49d31a4c89f..2ee70f00eae 100644 --- a/cookbook/testing/profiling.rst +++ b/cookbook/testing/profiling.rst @@ -71,5 +71,5 @@ finish. It's easy to achieve if you embed the token in the error message:: .. tip:: - Read the API for built-in :doc:`data collectors` + Read the API for built-in :doc:`data collectors ` to learn more about their interfaces. diff --git a/cookbook/workflow/_vendor_deps.rst.inc b/cookbook/workflow/_vendor_deps.rst.inc index 90b8dfa264a..5fc208ed177 100644 --- a/cookbook/workflow/_vendor_deps.rst.inc +++ b/cookbook/workflow/_vendor_deps.rst.inc @@ -11,7 +11,7 @@ you need for each. By default, these libraries are downloaded by running a ``php composer.phar install`` "downloader" binary. This ``composer.phar`` file is from a library called -`Composer`_ and you can read more about installing it in the :ref:`Installation` +`Composer`_ and you can read more about installing it in the :ref:`Installation ` chapter. The ``composer.phar`` file reads from the ``composer.json`` file at the root diff --git a/quick_tour/the_view.rst b/quick_tour/the_view.rst index 9d9413837ac..bf8e8d4210b 100644 --- a/quick_tour/the_view.rst +++ b/quick_tour/the_view.rst @@ -286,7 +286,7 @@ the basics is easy, and you will soon learn that this simplicity is hidden under a very flexible architecture. But I'm getting ahead of myself. First, you need to learn more about the controller -and that's exactly the topic of the :doc:`next part of this tutorial`. +and that's exactly the topic of the :doc:`next part of this tutorial `. Ready for another 10 minutes with Symfony2? .. _Twig: http://twig.sensiolabs.org/ diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index db6cb3f28e6..b9187691f2f 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -41,7 +41,7 @@ Configuration * `assets_version`_ * `assets_version_format`_ * `profiler`_ - * :ref:`enabled` + * :ref:`enabled ` secret ~~~~~~ diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index 7871cf21aa5..dc41ad19f6a 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -236,7 +236,7 @@ The Login Form and Process This path **must** be accessible by a normal, un-authenticated user, else you may create a redirect loop. For details, see - ":ref:`Avoid Common Pitfalls`". + ":ref:`Avoid Common Pitfalls `". * ``check_path`` (type: ``string``, default: ``/login_check``) This is the route or path that your login form must submit to. The @@ -366,7 +366,7 @@ persisting the encoded password alone is enough. Firewall Context ---------------- -Most applications will only need one :ref:`firewall`. +Most applications will only need one :ref:`firewall `. But if your application *does* use multiple firewalls, you'll notice that if you're authenticated in one firewall, you're not automatically authenticated in another. In other words, the systems don't share a common "context": each diff --git a/reference/constraints/All.rst b/reference/constraints/All.rst index 64af3c51c41..2e45602375d 100644 --- a/reference/constraints/All.rst +++ b/reference/constraints/All.rst @@ -5,7 +5,7 @@ When applied to an array (or Traversable object), this constraint allows you to apply a collection of constraints to each element of the array. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `constraints`_ | +----------------+------------------------------------------------------------------------+ @@ -103,7 +103,7 @@ Options constraints ~~~~~~~~~~~ -**type**: ``array`` [:ref:`default option`] +**type**: ``array`` [:ref:`default option `] This required option is the array of validation constraints that you want to apply to each element of the underlying array. diff --git a/reference/constraints/Blank.rst b/reference/constraints/Blank.rst index 1461ee6b180..029099e0c77 100644 --- a/reference/constraints/Blank.rst +++ b/reference/constraints/Blank.rst @@ -7,7 +7,7 @@ to ``null``. To force that a value strictly be equal to ``null``, see the blank, see :doc:`/reference/constraints/NotBlank`. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `message`_ | +----------------+-----------------------------------------------------------------------+ diff --git a/reference/constraints/Callback.rst b/reference/constraints/Callback.rst index a367ac9f5d5..59495889506 100644 --- a/reference/constraints/Callback.rst +++ b/reference/constraints/Callback.rst @@ -18,7 +18,7 @@ can do anything, including creating and assigning validation errors. add validator "violations". +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`class` | +| Applies to | :ref:`class ` | +----------------+------------------------------------------------------------------------+ | Options | - `methods`_ | +----------------+------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Options methods ~~~~~~~ -**type**: ``array`` **default**: ``array()`` [:ref:`default option`] +**type**: ``array`` **default**: ``array()`` [:ref:`default option `] This is an array of the methods that should be executed during the validation process. Each method can be one of the following formats: @@ -226,5 +226,5 @@ process. Each method can be one of the following formats: the option to make your callback either a PHP closure or a non-static callback. It is *not* currently possible, however, to specify a :term:`service` as a constraint. To validate using a service, you should - :doc:`create a custom validation constraint` + :doc:`create a custom validation constraint ` and add that new constraint to your class. diff --git a/reference/constraints/CardScheme.rst b/reference/constraints/CardScheme.rst index 77447ecedce..172ddbfdf70 100644 --- a/reference/constraints/CardScheme.rst +++ b/reference/constraints/CardScheme.rst @@ -9,7 +9,7 @@ company. It can be used to validate the number before trying to initiate a payme through a payment gateway. +----------------+--------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------------+ | Options | - `schemes`_ | | | - `message`_ | @@ -101,7 +101,7 @@ Available Options schemes ------- -**type**: ``mixed`` [:ref:`default option`] +**type**: ``mixed`` [:ref:`default option `] This option is required and represents the name of the number scheme used to validate the credit card number, it can either be a string or an array. Valid diff --git a/reference/constraints/Choice.rst b/reference/constraints/Choice.rst index ab4571b7b57..1dadf269eed 100644 --- a/reference/constraints/Choice.rst +++ b/reference/constraints/Choice.rst @@ -6,7 +6,7 @@ set of *valid* choices. It can also be used to validate that each item in an array of items is one of those valid choices. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `choices`_ | | | - `callback`_ | @@ -263,7 +263,7 @@ Available Options choices ~~~~~~~ -**type**: ``array`` [:ref:`default option`] +**type**: ``array`` [:ref:`default option `] A required option (unless `callback`_ is specified) - this is the array of options that should be considered in the valid set. The input value diff --git a/reference/constraints/Collection.rst b/reference/constraints/Collection.rst index 4a040117ad5..ae25d16bb87 100644 --- a/reference/constraints/Collection.rst +++ b/reference/constraints/Collection.rst @@ -11,7 +11,7 @@ This constraint can also make sure that certain collection keys are present and that extra keys are not present. +----------------+--------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------------+ | Options | - `fields`_ | | | - `allowExtraFields`_ | @@ -287,7 +287,7 @@ Options fields ~~~~~~ -**type**: ``array`` [:ref:`default option`] +**type**: ``array`` [:ref:`default option `] This option is required, and is an associative array defining all of the keys in the collection and, for each key, exactly which validator(s) should diff --git a/reference/constraints/Count.rst b/reference/constraints/Count.rst index 7bf7763cf7b..fe37a3e54f7 100644 --- a/reference/constraints/Count.rst +++ b/reference/constraints/Count.rst @@ -8,7 +8,7 @@ element count is *between* some minimum and maximum value. The Count constraint was added in Symfony 2.1. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `min`_ | | | - `max`_ | @@ -108,7 +108,7 @@ Options min ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "min" count value. Validation will fail if the given collection elements count is **less** than this min value. @@ -116,7 +116,7 @@ collection elements count is **less** than this min value. max ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "max" count value. Validation will fail if the given collection elements count is **greater** than this max value. diff --git a/reference/constraints/Country.rst b/reference/constraints/Country.rst index 291583d842a..a3e38f20628 100644 --- a/reference/constraints/Country.rst +++ b/reference/constraints/Country.rst @@ -4,7 +4,7 @@ Country Validates that a value is a valid two-letter country code. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/Date.rst b/reference/constraints/Date.rst index d6816777b06..d65275e8dff 100644 --- a/reference/constraints/Date.rst +++ b/reference/constraints/Date.rst @@ -6,7 +6,7 @@ or a string (or an object that can be cast into a string) that follows a valid YYYY-MM-DD format. +----------------+--------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------+ | Options | - `message`_ | +----------------+--------------------------------------------------------------------+ diff --git a/reference/constraints/DateTime.rst b/reference/constraints/DateTime.rst index 7a13b8044c0..c46d1f87134 100644 --- a/reference/constraints/DateTime.rst +++ b/reference/constraints/DateTime.rst @@ -6,7 +6,7 @@ object or a string (or an object that can be cast into a string) that follows a valid YYYY-MM-DD HH:MM:SS format. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/Email.rst b/reference/constraints/Email.rst index f0ea3098655..d4be658f92c 100644 --- a/reference/constraints/Email.rst +++ b/reference/constraints/Email.rst @@ -5,7 +5,7 @@ Validates that a value is a valid email address. The underlying value is cast to a string before being validated. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `message`_ | | | - `checkMX`_ | diff --git a/reference/constraints/False.rst b/reference/constraints/False.rst index 339128cef66..3bcc33fb309 100644 --- a/reference/constraints/False.rst +++ b/reference/constraints/False.rst @@ -8,7 +8,7 @@ string "``0``". Also see :doc:`True `. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `message`_ | +----------------+---------------------------------------------------------------------+ diff --git a/reference/constraints/File.rst b/reference/constraints/File.rst index c54d70fc0db..8ece814cd7a 100644 --- a/reference/constraints/File.rst +++ b/reference/constraints/File.rst @@ -8,16 +8,16 @@ Validates that a value is a valid "file", which can be one of the following: * A valid :class:`Symfony\\Component\\HttpFoundation\\File\\File` object (including objects of class :class:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile`). -This constraint is commonly used in forms with the :doc:`file` +This constraint is commonly used in forms with the :doc:`file ` form type. .. tip:: - If the file you're validating is an image, try the :doc:`Image` + If the file you're validating is an image, try the :doc:`Image ` constraint. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `maxSize`_ | | | - `mimeTypes`_ | @@ -38,7 +38,7 @@ Basic Usage ----------- This constraint is most commonly used on a property that will be rendered -in a form as a :doc:`file` form type. For example, +in a form as a :doc:`file ` form type. For example, suppose you're creating an author form where you can upload a "bio" PDF for the author. In your form, the ``bioFile`` property would be a ``file`` type. The ``Author`` class might look as follows:: diff --git a/reference/constraints/Image.rst b/reference/constraints/Image.rst index f3a0cae3c62..7492dfed500 100644 --- a/reference/constraints/Image.rst +++ b/reference/constraints/Image.rst @@ -1,18 +1,18 @@ Image ===== -The Image constraint works exactly like the :doc:`File` +The Image constraint works exactly like the :doc:`File ` constraint, except that its `mimeTypes`_ and `mimeTypesMessage` options are automatically setup to work for image files specifically. Additionally, as of Symfony 2.1, it has options so you can validate against the width and height of the image. -See the :doc:`File` constraint for the bulk of +See the :doc:`File ` constraint for the bulk of the documentation on this constraint. +----------------+----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+----------------------------------------------------------------------+ | Options | - `mimeTypes`_ | | | - `minWidth`_ | @@ -25,7 +25,7 @@ the documentation on this constraint. | | - `minWidthMessage`_ | | | - `maxHeightMessage`_ | | | - `minHeightMessage`_ | -| | - See :doc:`File` for inherited options | +| | - See :doc:`File ` for inherited options | +----------------+----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Validator\\Constraints\\File` | +----------------+----------------------------------------------------------------------+ @@ -36,7 +36,7 @@ Basic Usage ----------- This constraint is most commonly used on a property that will be rendered -in a form as a :doc:`file` form type. For example, +in a form as a :doc:`file ` form type. For example, suppose you're creating an author form where you can upload a "headshot" image for the author. In your form, the ``headshot`` property would be a ``file`` type. The ``Author`` class might look as follows:: @@ -146,7 +146,7 @@ and that it is between a certain width and height. Options ------- -This constraint shares all of its options with the :doc:`File` +This constraint shares all of its options with the :doc:`File ` constraint. It does, however, modify two of the default option values and add several other options. diff --git a/reference/constraints/Ip.rst b/reference/constraints/Ip.rst index b4ef5e28378..2a92e978f1e 100644 --- a/reference/constraints/Ip.rst +++ b/reference/constraints/Ip.rst @@ -6,7 +6,7 @@ the value as IPv4, but a number of different options exist to validate as IPv6 and many other combinations. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `version`_ | | | - `message`_ | diff --git a/reference/constraints/Language.rst b/reference/constraints/Language.rst index de1f33560e8..582ce3380aa 100644 --- a/reference/constraints/Language.rst +++ b/reference/constraints/Language.rst @@ -4,7 +4,7 @@ Language Validates that a value is a valid language code. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/Length.rst b/reference/constraints/Length.rst index 54d32ef62fa..309d715be5e 100644 --- a/reference/constraints/Length.rst +++ b/reference/constraints/Length.rst @@ -7,7 +7,7 @@ Validates that a given string length is *between* some minimum and maximum value The Length constraint was added in Symfony 2.1. +----------------+----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+----------------------------------------------------------------------+ | Options | - `min`_ | | | - `max`_ | @@ -108,7 +108,7 @@ Options min ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "min" length value. Validation will fail if the given value's length is **less** than this min value. @@ -116,7 +116,7 @@ value's length is **less** than this min value. max ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "max" length value. Validation will fail if the given value's length is **greater** than this max value. diff --git a/reference/constraints/Locale.rst b/reference/constraints/Locale.rst index 6f1e992adc7..a39d1493b79 100644 --- a/reference/constraints/Locale.rst +++ b/reference/constraints/Locale.rst @@ -8,7 +8,7 @@ The "value" for each locale is either the two letter ISO639-1 *language* code the ISO3166 *country* code (e.g. ``fr_FR`` for French/France). +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/Luhn.rst b/reference/constraints/Luhn.rst index 2c7d261e434..58697e94184 100644 --- a/reference/constraints/Luhn.rst +++ b/reference/constraints/Luhn.rst @@ -9,7 +9,7 @@ It is useful as a first step to validating a credit card: before communicating w payment gateway. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `message`_ | +----------------+-----------------------------------------------------------------------+ diff --git a/reference/constraints/Max.rst b/reference/constraints/Max.rst index 93723ef35db..6e4e723dbe6 100644 --- a/reference/constraints/Max.rst +++ b/reference/constraints/Max.rst @@ -10,7 +10,7 @@ Max Validates that a given number is *less* than some maximum number. +----------------+--------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------+ | Options | - `limit`_ | | | - `message`_ | @@ -95,7 +95,7 @@ Options limit ~~~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "max" value. Validation will fail if the given value is **greater** than this max value. diff --git a/reference/constraints/MaxLength.rst b/reference/constraints/MaxLength.rst index 786b90f10d1..f3630abb21c 100644 --- a/reference/constraints/MaxLength.rst +++ b/reference/constraints/MaxLength.rst @@ -10,7 +10,7 @@ MaxLength Validates that the length of a string is not larger than the given limit. +----------------+-------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-------------------------------------------------------------------------+ | Options | - `limit`_ | | | - `message`_ | @@ -90,7 +90,7 @@ Options limit ~~~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "max" value. Validation will fail if the length of the give string is **greater** than this number. diff --git a/reference/constraints/Min.rst b/reference/constraints/Min.rst index 232ee37652d..2a9e3679fab 100644 --- a/reference/constraints/Min.rst +++ b/reference/constraints/Min.rst @@ -10,7 +10,7 @@ Min Validates that a given number is *greater* than some minimum number. +----------------+--------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------+ | Options | - `limit`_ | | | - `message`_ | @@ -95,7 +95,7 @@ Options limit ~~~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "min" value. Validation will fail if the given value is **less** than this min value. diff --git a/reference/constraints/MinLength.rst b/reference/constraints/MinLength.rst index 373c5039cd7..9ce206e93c6 100644 --- a/reference/constraints/MinLength.rst +++ b/reference/constraints/MinLength.rst @@ -10,7 +10,7 @@ MinLength Validates that the length of a string is at least as long as the given limit. +----------------+-------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-------------------------------------------------------------------------+ | Options | - `limit`_ | | | - `message`_ | @@ -95,7 +95,7 @@ Options limit ~~~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "min" value. Validation will fail if the length of the give string is **less** than this number. diff --git a/reference/constraints/NotBlank.rst b/reference/constraints/NotBlank.rst index b7d7bec9e2b..b4317c4802a 100644 --- a/reference/constraints/NotBlank.rst +++ b/reference/constraints/NotBlank.rst @@ -6,7 +6,7 @@ and also not equal to ``null``. To force that a value is simply not equal to ``null``, see the :doc:`/reference/constraints/NotNull` constraint. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/NotNull.rst b/reference/constraints/NotNull.rst index b038d92fd8c..6b6053c2ede 100644 --- a/reference/constraints/NotNull.rst +++ b/reference/constraints/NotNull.rst @@ -6,7 +6,7 @@ a value is simply not blank (not a blank string), see the :doc:`/reference/cons constraint. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `message`_ | +----------------+-----------------------------------------------------------------------+ diff --git a/reference/constraints/Null.rst b/reference/constraints/Null.rst index bbf3d0939ef..d63b1e7a94f 100644 --- a/reference/constraints/Null.rst +++ b/reference/constraints/Null.rst @@ -6,7 +6,7 @@ is simply blank (blank string or ``null``), see the :doc:`/reference/constraint constraint. To ensure that a property is not null, see :doc:`/reference/constraints/NotNull`. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `message`_ | +----------------+-----------------------------------------------------------------------+ diff --git a/reference/constraints/Range.rst b/reference/constraints/Range.rst index b47eb6d6440..913c7fed292 100644 --- a/reference/constraints/Range.rst +++ b/reference/constraints/Range.rst @@ -7,7 +7,7 @@ Validates that a given number is *between* some minimum and maximum number. The Range constraint was added in Symfony 2.1. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `min`_ | | | - `max`_ | @@ -107,7 +107,7 @@ Options min ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "min" value. Validation will fail if the given value is **less** than this min value. @@ -115,7 +115,7 @@ value is **less** than this min value. max ~~~ -**type**: ``integer`` [:ref:`default option`] +**type**: ``integer`` [:ref:`default option `] This required option is the "max" value. Validation will fail if the given value is **greater** than this max value. diff --git a/reference/constraints/Regex.rst b/reference/constraints/Regex.rst index 2bdf0a8a87c..1595ff4c042 100644 --- a/reference/constraints/Regex.rst +++ b/reference/constraints/Regex.rst @@ -4,7 +4,7 @@ Regex Validates that a value matches a regular expression. +----------------+-----------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+-----------------------------------------------------------------------+ | Options | - `pattern`_ | | | - `htmlPattern`_ | @@ -166,7 +166,7 @@ Options pattern ~~~~~~~ -**type**: ``string`` [:ref:`default option`] +**type**: ``string`` [:ref:`default option `] This required option is the regular expression pattern that the input will be matched against. By default, this validator will fail if the input string diff --git a/reference/constraints/Time.rst b/reference/constraints/Time.rst index 0ada2796e26..7fdeea6445b 100644 --- a/reference/constraints/Time.rst +++ b/reference/constraints/Time.rst @@ -6,7 +6,7 @@ or a string (or an object that can be cast into a string) that follows a valid "HH:MM:SS" format. +----------------+------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+------------------------------------------------------------------------+ diff --git a/reference/constraints/True.rst b/reference/constraints/True.rst index ba5ca5997d8..5228bda9634 100644 --- a/reference/constraints/True.rst +++ b/reference/constraints/True.rst @@ -8,7 +8,7 @@ string "``1``". Also see :doc:`False `. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `message`_ | +----------------+---------------------------------------------------------------------+ diff --git a/reference/constraints/Type.rst b/reference/constraints/Type.rst index 41849ba3086..dd854258183 100644 --- a/reference/constraints/Type.rst +++ b/reference/constraints/Type.rst @@ -6,9 +6,9 @@ should be an array, you can use this constraint with the ``array`` type option to validate this. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ -| Options | - :ref:`type` | +| Options | - :ref:`type ` | | | - `message`_ | +----------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Validator\\Constraints\\Type` | @@ -91,7 +91,7 @@ Options type ~~~~ -**type**: ``string`` [:ref:`default option`] +**type**: ``string`` [:ref:`default option `] This required option is the fully qualified class name or one of the PHP datatypes as determined by PHP's ``is_`` functions. diff --git a/reference/constraints/UniqueEntity.rst b/reference/constraints/UniqueEntity.rst index c6376469403..276d19c64aa 100644 --- a/reference/constraints/UniqueEntity.rst +++ b/reference/constraints/UniqueEntity.rst @@ -6,7 +6,7 @@ unique. This is commonly used, for example, to prevent a new user to register using an email address that already exists in the system. +----------------+-------------------------------------------------------------------------------------+ -| Applies to | :ref:`class` | +| Applies to | :ref:`class ` | +----------------+-------------------------------------------------------------------------------------+ | Options | - `fields`_ | | | - `message`_ | @@ -117,7 +117,7 @@ Options fields ~~~~~~ -**type**: ``array`` | ``string`` [:ref:`default option`] +**type**: ``array`` | ``string`` [:ref:`default option `] This required option is the field (or list of fields) on which this entity should be unique. For example, if you specified both the ``email`` and ``name`` diff --git a/reference/constraints/Url.rst b/reference/constraints/Url.rst index 51f5d8c093e..818156e3d73 100644 --- a/reference/constraints/Url.rst +++ b/reference/constraints/Url.rst @@ -4,7 +4,7 @@ Url Validates that a value is a valid URL string. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `message`_ | | | - `protocols`_ | diff --git a/reference/constraints/UserPassword.rst b/reference/constraints/UserPassword.rst index 3fcf47ea9c1..caa3fed7a72 100644 --- a/reference/constraints/UserPassword.rst +++ b/reference/constraints/UserPassword.rst @@ -22,7 +22,7 @@ but needs to enter his old password for security. automatically by the security system. +----------------+--------------------------------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+--------------------------------------------------------------------------------------------+ | Options | - `message`_ | +----------------+--------------------------------------------------------------------------------------------+ diff --git a/reference/constraints/Valid.rst b/reference/constraints/Valid.rst index 70110f8da26..137a357a0f5 100644 --- a/reference/constraints/Valid.rst +++ b/reference/constraints/Valid.rst @@ -6,7 +6,7 @@ as properties on an object being validated. This allows you to validate an object and all sub-objects associated with it. +----------------+---------------------------------------------------------------------+ -| Applies to | :ref:`property or method` | +| Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `traverse`_ | +----------------+---------------------------------------------------------------------+ diff --git a/reference/dic_tags.rst b/reference/dic_tags.rst index 1e5a8f3e7ac..5c0be67b18b 100644 --- a/reference/dic_tags.rst +++ b/reference/dic_tags.rst @@ -333,7 +333,7 @@ form.type_guesser **Purpose**: Add your own logic for "form type guessing" -This tag allows you to add your own logic to the :ref:`Form Guessing` +This tag allows you to add your own logic to the :ref:`Form Guessing ` process. By default, form guessing is done by "guessers" based on the validation metadata and Doctrine metadata (if you're using Doctrine). diff --git a/reference/forms/twig_reference.rst b/reference/forms/twig_reference.rst index e34b4c6e463..e01ecd05d41 100644 --- a/reference/forms/twig_reference.rst +++ b/reference/forms/twig_reference.rst @@ -7,8 +7,8 @@ Twig Template Form Function and Variable Reference When working with forms in a template, there are two powerful things at your disposal: -* :ref:`Functions` for rendering each part of a form -* :ref:`Variables` for getting *any* information about any field +* :ref:`Functions ` for rendering each part of a form +* :ref:`Variables ` for getting *any* information about any field You'll use functions often to render your fields. Variables, on the other hand, are less commonly-used, but infinitely powerful since you can access diff --git a/reference/forms/types/birthday.rst b/reference/forms/types/birthday.rst index fc1b58378be..39f3beb6da0 100644 --- a/reference/forms/types/birthday.rst +++ b/reference/forms/types/birthday.rst @@ -4,13 +4,13 @@ birthday Field Type =================== -A :doc:`date` field that specializes in handling +A :doc:`date ` field that specializes in handling birthdate data. Can be rendered as a single text box, three text boxes (month, day, and year), or three select boxes. -This type is essentially the same as the :doc:`date` +This type is essentially the same as the :doc:`date ` type, but with a more appropriate default for the `years`_ option. The `years`_ option defaults to 120 years ago to the current year. @@ -37,7 +37,7 @@ option defaults to 120 years ago to the current year. | | - `mapped`_ | | | - `virtual`_ | +----------------------+-------------------------------------------------------------------------------+ -| Parent type | :doc:`date` | +| Parent type | :doc:`date ` | +----------------------+-------------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BirthdayType` | +----------------------+-------------------------------------------------------------------------------+ @@ -56,7 +56,7 @@ relevant when the ``widget`` option is set to ``choice``. Inherited options ----------------- -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/date_widget.rst.inc @@ -74,7 +74,7 @@ These options inherit from the :doc:`date` type: .. include:: /reference/forms/types/options/user_timezone.rst.inc -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index e72400d2684..fa56992f3fd 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -21,7 +21,7 @@ if the box is unchecked, the value will be set to false. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CheckboxType` | +-------------+------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ not affect the value that's set on your object. Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index 8c9c924f862..7e4a17bbbee 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -10,31 +10,31 @@ It can be rendered as a ``select`` tag, radio buttons, or checkboxes. To use this field, you must specify *either* the ``choice_list`` or ``choices`` option. -+-------------+-----------------------------------------------------------------------------+ -| Rendered as | can be various tags (see below) | -+-------------+-----------------------------------------------------------------------------+ -| Options | - `choices`_ | -| | - `choice_list`_ | -| | - `multiple`_ | -| | - `expanded`_ | -| | - `preferred_choices`_ | -| | - `empty_value`_ | -+-------------+-----------------------------------------------------------------------------+ -| Inherited | - `required`_ | -| options | - `label`_ | -| | - `read_only`_ | -| | - `disabled`_ | -| | - `error_bubbling`_ | -| | - `error_mapping`_ | -| | - `mapped`_ | -| | - `virtual`_ | -| | - `by_reference`_ | -| | - `empty_data`_ | -+-------------+-----------------------------------------------------------------------------+ -| Parent type | :doc:`form` (if expanded), ``field`` otherwise | -+-------------+-----------------------------------------------------------------------------+ -| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ChoiceType` | -+-------------+-----------------------------------------------------------------------------+ ++-------------+------------------------------------------------------------------------------+ +| Rendered as | can be various tags (see below) | ++-------------+------------------------------------------------------------------------------+ +| Options | - `choices`_ | +| | - `choice_list`_ | +| | - `multiple`_ | +| | - `expanded`_ | +| | - `preferred_choices`_ | +| | - `empty_value`_ | ++-------------+------------------------------------------------------------------------------+ +| Inherited | - `required`_ | +| options | - `label`_ | +| | - `read_only`_ | +| | - `disabled`_ | +| | - `error_bubbling`_ | +| | - `error_mapping`_ | +| | - `mapped`_ | +| | - `virtual`_ | +| | - `by_reference`_ | +| | - `empty_data`_ | ++-------------+------------------------------------------------------------------------------+ +| Parent type | :doc:`form ` (if expanded), ``field`` otherwise | ++-------------+------------------------------------------------------------------------------+ +| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ChoiceType` | ++-------------+------------------------------------------------------------------------------+ Example Usage ------------- @@ -110,7 +110,7 @@ can be created to supply the choices. Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 08d581bea2b..484e68dd2a4 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -27,7 +27,7 @@ forms, which is useful when creating forms that expose one-to-many relationships | | - `empty_data`_ | | | - `mapped`_ | +-------------+-----------------------------------------------------------------------------+ -| Parent type | :doc:`form` | +| Parent type | :doc:`form ` | +-------------+-----------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CollectionType` | +-------------+-----------------------------------------------------------------------------+ @@ -215,7 +215,7 @@ type This is the field type for each item in this collection (e.g. ``text``, ``choice``, etc). For example, if you have an array of email addresses, you'd use the -:doc:`email` type. If you want to embed +:doc:`email ` type. If you want to embed a collection of some other form, create a new instance of your form type and pass it as this option. @@ -225,7 +225,7 @@ options **type**: ``array`` **default**: ``array()`` This is the array that's passed to the form type specified in the `type`_ -option. For example, if you used the :doc:`choice` +option. For example, if you used the :doc:`choice ` type as your `type`_ option (e.g. for a collection of drop-down menus), then you'd need to at least pass the ``choices`` option to the underlying type:: @@ -339,7 +339,7 @@ replaced with the same value. Inherited options ----------------- -These options inherit from the :doc:`field` type. +These options inherit from the :doc:`field ` type. Not all options are listed here - only the most applicable to this type: .. include:: /reference/forms/types/options/label.rst.inc diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index f26700d26c2..cbb83a3f6e4 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -37,7 +37,7 @@ you should just use the ``choice`` type directly. | | - `disabled`_ | | | - `mapped`_ | +-------------+-----------------------------------------------------------------------+ -| Parent type | :doc:`choice` | +| Parent type | :doc:`choice ` | +-------------+-----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CountryType` | +-------------+-----------------------------------------------------------------------+ @@ -57,7 +57,7 @@ It uses the default locale to determine the language. Inherited options ----------------- -These options inherit from the :doc:`choice` type: +These options inherit from the :doc:`choice ` type: .. include:: /reference/forms/types/options/multiple.rst.inc @@ -71,7 +71,7 @@ These options inherit from the :doc:`choice` type .. include:: /reference/forms/types/options/error_mapping.rst.inc -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst index aa87d713de2..10f5d5467e8 100644 --- a/reference/forms/types/date.rst +++ b/reference/forms/types/date.rst @@ -136,7 +136,7 @@ error_bubbling Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/datetime.rst b/reference/forms/types/datetime.rst index 3793987bd69..1f33c147b58 100644 --- a/reference/forms/types/datetime.rst +++ b/reference/forms/types/datetime.rst @@ -37,7 +37,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array. | | - `mapped`_ | | | - `virtual`_ | +----------------------+-----------------------------------------------------------------------------+ -| Parent type | :doc:`form` | +| Parent type | :doc:`form ` | +----------------------+-----------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\DateTimeType` | +----------------------+-----------------------------------------------------------------------------+ @@ -50,14 +50,14 @@ date_widget **type**: ``string`` **default**: ``choice`` -Defines the ``widget`` option for the :doc:`date` type +Defines the ``widget`` option for the :doc:`date ` type time_widget ~~~~~~~~~~~ **type**: ``string`` **default**: ``choice`` -Defines the ``widget`` option for the :doc:`time` type +Defines the ``widget`` option for the :doc:`time ` type input ~~~~~ @@ -83,7 +83,7 @@ date_format **type**: ``integer`` or ``string`` **default**: ``IntlDateFormatter::MEDIUM`` Defines the ``format`` option that will be passed down to the date field. -See the :ref:`date type's format option` +See the :ref:`date type's format option ` for more details. .. include:: /reference/forms/types/options/hours.rst.inc @@ -109,7 +109,7 @@ for more details. Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst index 94d586886ee..7653aa8d5f9 100644 --- a/reference/forms/types/email.rst +++ b/reference/forms/types/email.rst @@ -5,7 +5,7 @@ email Field Type ================ The ``email`` field is a text field that is rendered using the HTML5 -```` tag. +`` `` tag. +-------------+---------------------------------------------------------------------+ | Rendered as | ``input`` ``email`` field (a text box) | @@ -20,7 +20,7 @@ The ``email`` field is a text field that is rendered using the HTML5 | | - `error_mapping`_ | | | - `mapped`_ | +-------------+---------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\EmailType` | +-------------+---------------------------------------------------------------------+ @@ -28,7 +28,7 @@ The ``email`` field is a text field that is rendered using the HTML5 Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index c47382d74c6..f52e92aa4b6 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -33,7 +33,7 @@ objects from the database. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------+ -| Parent type | :doc:`choice` | +| Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------+ | Class | :class:`Symfony\\Bridge\\Doctrine\\Form\\Type\\EntityType` | +-------------+------------------------------------------------------------------+ @@ -145,7 +145,7 @@ are documented above. Inherited options ----------------- -These options inherit from the :doc:`choice` type: +These options inherit from the :doc:`choice ` type: .. include:: /reference/forms/types/options/multiple.rst.inc @@ -162,7 +162,7 @@ These options inherit from the :doc:`choice` type .. include:: /reference/forms/types/options/empty_value.rst.inc -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/field.rst b/reference/forms/types/field.rst index ee06911d6bb..753ef6800a5 100644 --- a/reference/forms/types/field.rst +++ b/reference/forms/types/field.rst @@ -5,4 +5,4 @@ The Abstract "field" Type ========================= The ``field`` form type is deprecated as of Symfony 2.1. -Please use the :doc:`Form field type` instead. +Please use the :doc:`Form field type ` instead. diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst index f9ff36d3950..7179ccdbd12 100644 --- a/reference/forms/types/file.rst +++ b/reference/forms/types/file.rst @@ -17,7 +17,7 @@ The ``file`` type represents a file input in your form. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+---------------------------------------------------------------------+ -| Parent type | :doc:`form` | +| Parent type | :doc:`form ` | +-------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FileType` | +-------------+---------------------------------------------------------------------+ @@ -84,7 +84,7 @@ how to manage a file upload associated with a Doctrine entity. Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index 97451e3c39c..82282cae5e9 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -34,5 +34,5 @@ on all fields. virtual ------- -See :doc:`How to use the Virtual Form Field Option` +See :doc:`How to use the Virtual Form Field Option ` diff --git a/reference/forms/types/hidden.rst b/reference/forms/types/hidden.rst index a0e954c3bfe..ab27d4b8351 100644 --- a/reference/forms/types/hidden.rst +++ b/reference/forms/types/hidden.rst @@ -17,7 +17,7 @@ The hidden type represents a hidden input field. | | - `mapped`_ | | | - `error_mapping`_ | +-------------+----------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\HiddenType` | +-------------+----------------------------------------------------------------------+ @@ -42,7 +42,7 @@ Pass errors to the root form, otherwise they will not be visible. Inherited Options ----------------- -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/data.rst.inc diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index b1a3d518eea..109072e50d7 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -29,7 +29,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6 | | - `invalid_message_parameters`_ | | | - `mapped`_ | +-------------+-----------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+-----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\IntegerType` | +-------------+-----------------------------------------------------------------------+ @@ -65,7 +65,7 @@ on the :class:`Symfony\\Component\\Form\\Extension\\Core\\DataTransformer\\Integ Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index 6f606541d06..4bce0a35ab3 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -38,7 +38,7 @@ you should just use the ``choice`` type directly. | | - `disabled`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`choice` | +| Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\LanguageType` | +-------------+------------------------------------------------------------------------+ @@ -58,7 +58,7 @@ default locale to specify the language. Inherited Options ----------------- -These options inherit from the :doc:`choice` type: +These options inherit from the :doc:`choice ` type: .. include:: /reference/forms/types/options/multiple.rst.inc @@ -72,7 +72,7 @@ These options inherit from the :doc:`choice` type .. include:: /reference/forms/types/options/error_mapping.rst.inc -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index 013ca4b6ec0..d8bb69d6d20 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -39,7 +39,7 @@ you should just use the ``choice`` type directly. | | - `disabled`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`choice` | +| Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\LanguageType` | +-------------+------------------------------------------------------------------------+ @@ -60,7 +60,7 @@ default locale to specify the language. Inherited options ----------------- -These options inherit from the :doc:`choice` type: +These options inherit from the :doc:`choice ` type: .. include:: /reference/forms/types/options/multiple.rst.inc @@ -74,7 +74,7 @@ These options inherit from the :doc:`choice` type .. include:: /reference/forms/types/options/error_mapping.rst.inc -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/map.rst.inc b/reference/forms/types/map.rst.inc index 7cd886a40e5..1d200deacb1 100644 --- a/reference/forms/types/map.rst.inc +++ b/reference/forms/types/map.rst.inc @@ -1,55 +1,55 @@ Text Fields ~~~~~~~~~~~ -* :doc:`text` -* :doc:`textarea` -* :doc:`email` -* :doc:`integer` -* :doc:`money` -* :doc:`number` -* :doc:`password` -* :doc:`percent` -* :doc:`search` -* :doc:`url` +* :doc:`text ` +* :doc:`textarea ` +* :doc:`email ` +* :doc:`integer ` +* :doc:`money ` +* :doc:`number ` +* :doc:`password ` +* :doc:`percent ` +* :doc:`search ` +* :doc:`url ` Choice Fields ~~~~~~~~~~~~~ -* :doc:`choice` -* :doc:`entity` -* :doc:`country` -* :doc:`language` -* :doc:`locale` -* :doc:`timezone` +* :doc:`choice ` +* :doc:`entity ` +* :doc:`country ` +* :doc:`language ` +* :doc:`locale ` +* :doc:`timezone ` Date and Time Fields ~~~~~~~~~~~~~~~~~~~~ -* :doc:`date` -* :doc:`datetime` -* :doc:`time` -* :doc:`birthday` +* :doc:`date ` +* :doc:`datetime ` +* :doc:`time ` +* :doc:`birthday ` Other Fields ~~~~~~~~~~~~ -* :doc:`checkbox` -* :doc:`file` -* :doc:`radio` +* :doc:`checkbox ` +* :doc:`file ` +* :doc:`radio ` Field Groups ~~~~~~~~~~~~ -* :doc:`collection` -* :doc:`repeated` +* :doc:`collection ` +* :doc:`repeated ` Hidden Fields ~~~~~~~~~~~~~ -* :doc:`hidden` +* :doc:`hidden ` Base Fields ~~~~~~~~~~~ -* :doc:`field` -* :doc:`form` \ No newline at end of file +* :doc:`field ` +* :doc:`form ` diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst index df489534fa4..f7bac78ce2b 100644 --- a/reference/forms/types/money.rst +++ b/reference/forms/types/money.rst @@ -29,7 +29,7 @@ how the input and output of the data is handled. | | - `invalid_message_parameters`_ | | | - `mapped`_ | +-------------+---------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\MoneyType` | +-------------+---------------------------------------------------------------------+ @@ -83,7 +83,7 @@ to ``0``). Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst index ce40bce055c..15918d31993 100644 --- a/reference/forms/types/number.rst +++ b/reference/forms/types/number.rst @@ -25,7 +25,7 @@ you want to use for your number. | | - `invalid_message_parameters`_ | | | - `mapped`_ | +-------------+----------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\NumberType` | +-------------+----------------------------------------------------------------------+ @@ -73,7 +73,7 @@ option is a constant on the :class:`Symfony\\Component\\Form\\Extension\\Core\\D Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/password.rst b/reference/forms/types/password.rst index 8ae6fee67df..7c0243d2956 100644 --- a/reference/forms/types/password.rst +++ b/reference/forms/types/password.rst @@ -21,7 +21,7 @@ The ``password`` field renders an input password text box. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`text` | +| Parent type | :doc:`text ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\PasswordType` | +-------------+------------------------------------------------------------------------+ @@ -44,7 +44,7 @@ Put simply, if for some reason you want to render your password field Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst index 33e566fbf5f..9ac7a2c4cfa 100644 --- a/reference/forms/types/percent.rst +++ b/reference/forms/types/percent.rst @@ -28,7 +28,7 @@ This field adds a percentage sign "``%``" after the input box. | | - `invalid_message_parameters`_ | | | - `mapped`_ | +-------------+-----------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+-----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\PercentType` | +-------------+-----------------------------------------------------------------------+ @@ -67,7 +67,7 @@ places, use this option. Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/radio.rst b/reference/forms/types/radio.rst index f2fa999e97a..634548ee76a 100644 --- a/reference/forms/types/radio.rst +++ b/reference/forms/types/radio.rst @@ -9,8 +9,8 @@ be set to the specified value. Radio buttons cannot be unchecked - the value onl changes when another radio button with the same name gets checked. The ``radio`` type isn't usually used directly. More commonly it's used -internally by other types such as :doc:`choice`. -If you want to have a Boolean field, use :doc:`checkbox`. +internally by other types such as :doc:`choice `. +If you want to have a Boolean field, use :doc:`checkbox `. +-------------+---------------------------------------------------------------------+ | Rendered as | ``input`` ``radio`` field | @@ -25,7 +25,7 @@ If you want to have a Boolean field, use :doc:`checkbox` | +| Parent type | :doc:`field ` | +-------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\RadioType` | +-------------+---------------------------------------------------------------------+ @@ -44,7 +44,7 @@ not affect the value that's set on your object. Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/repeated.rst b/reference/forms/types/repeated.rst index 83e1878b316..75707b6f110 100644 --- a/reference/forms/types/repeated.rst +++ b/reference/forms/types/repeated.rst @@ -27,7 +27,7 @@ accuracy. | | - `mapped`_ | | | - `error_mapping`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\RepeatedType` | +-------------+------------------------------------------------------------------------+ @@ -186,7 +186,7 @@ error_bubbling Inherited options ----------------- -These options inherit from the :doc:`date` type: +These options inherit from the :doc:`date ` type: .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/search.rst b/reference/forms/types/search.rst index 463e8cbf600..038c50295c2 100644 --- a/reference/forms/types/search.rst +++ b/reference/forms/types/search.rst @@ -4,7 +4,7 @@ search Field Type ================= -This renders an ```` field, which is a text box with +This renders an `` `` field, which is a text box with special functionality supported by some browsers. Read about the input search field at `DiveIntoHTML5.info`_ @@ -22,7 +22,7 @@ Read about the input search field at `DiveIntoHTML5.info`_ | | - `error_mapping`_ | | | - `mapped`_ | +-------------+----------------------------------------------------------------------+ -| Parent type | :doc:`text` | +| Parent type | :doc:`text ` | +-------------+----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\SearchType` | +-------------+----------------------------------------------------------------------+ @@ -30,7 +30,7 @@ Read about the input search field at `DiveIntoHTML5.info`_ Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/text.rst b/reference/forms/types/text.rst index 2dd4e1479c3..fb7a0466a6d 100644 --- a/reference/forms/types/text.rst +++ b/reference/forms/types/text.rst @@ -19,7 +19,7 @@ The text field represents the most basic input text field. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+--------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+--------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TextType` | +-------------+--------------------------------------------------------------------+ @@ -28,7 +28,7 @@ The text field represents the most basic input text field. Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/textarea.rst b/reference/forms/types/textarea.rst index 2c6f6b6c632..2e38c72f0f0 100644 --- a/reference/forms/types/textarea.rst +++ b/reference/forms/types/textarea.rst @@ -19,7 +19,7 @@ Renders a ``textarea`` HTML element. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`field` | +| Parent type | :doc:`field ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TextareaType` | +-------------+------------------------------------------------------------------------+ @@ -27,7 +27,7 @@ Renders a ``textarea`` HTML element. Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst index 5034e14e97e..3174197f9d2 100644 --- a/reference/forms/types/time.rst +++ b/reference/forms/types/time.rst @@ -137,7 +137,7 @@ error_bubbling Inherited options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst index 535a552f75e..3806b3dc43d 100644 --- a/reference/forms/types/timezone.rst +++ b/reference/forms/types/timezone.rst @@ -33,7 +33,7 @@ you should just use the ``choice`` type directly. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+------------------------------------------------------------------------+ -| Parent type | :doc:`choice` | +| Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TimezoneType` | +-------------+------------------------------------------------------------------------+ @@ -52,7 +52,7 @@ The Timezone type defaults the choice_list to all timezones returned by Inherited options ----------------- -These options inherit from the :doc:`choice` type: +These options inherit from the :doc:`choice ` type: .. include:: /reference/forms/types/options/multiple.rst.inc @@ -62,7 +62,7 @@ These options inherit from the :doc:`choice` type .. include:: /reference/forms/types/options/empty_value.rst.inc -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/url.rst b/reference/forms/types/url.rst index ce25cb82fe3..2802b715d1b 100644 --- a/reference/forms/types/url.rst +++ b/reference/forms/types/url.rst @@ -23,7 +23,7 @@ have a protocol. | | - `error_mapping`_ | | | - `mapped`_ | +-------------+-------------------------------------------------------------------+ -| Parent type | :doc:`text` | +| Parent type | :doc:`text ` | +-------------+-------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\UrlType` | +-------------+-------------------------------------------------------------------+ @@ -43,7 +43,7 @@ the data is bound to the form. Inherited Options ----------------- -These options inherit from the :doc:`field` type: +These options inherit from the :doc:`field ` type: .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/map.rst.inc b/reference/map.rst.inc index f94634919a2..2fdd8210ced 100755 --- a/reference/map.rst.inc +++ b/reference/map.rst.inc @@ -18,11 +18,11 @@ * **Forms and Validation** - * :doc:`Form Field Type Reference` + * :doc:`Form Field Type Reference ` * :doc:`Validation Constraints Reference ` - * :doc:`Twig Template Function and Variable Reference` + * :doc:`Twig Template Function and Variable Reference ` -* :doc:`Twig Extensions (forms, filters, tags, etc) Reference` +* :doc:`Twig Extensions (forms, filters, tags, etc) Reference ` * **Other Areas** diff --git a/reference/twig_reference.rst b/reference/twig_reference.rst index d2ff0dc9e31..88efb03223e 100644 --- a/reference/twig_reference.rst +++ b/reference/twig_reference.rst @@ -50,22 +50,22 @@ Functions +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_enctype(view)`` | This will render the required ``enctype="multipart/form-data"`` attribute | | | if the form contains at least one file upload field, more information in | -| | in :ref:`the Twig Form reference`. | +| | in :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_widget(view, variables = {})`` | This will render a complete form or a specific HTML widget of a field, | -| | more information in :ref:`the Twig Form reference`. | +| | more information in :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_errors(view)`` | This will render any errors for the given field or the "global" errors, | -| | more information in :ref:`the Twig Form reference`. | +| | more information in :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_label(view, label = null, variables = {})`` | This will render the label for the given field, more information in | -| | :ref:`the Twig Form reference`. | +| | :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_row(view, variables = {})`` | This will render the row (the field's label, errors and widget) of the | -| | given field, more information in :ref:`the Twig Form reference`. | +| | given field, more information in :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``form_rest(view, variables = {})`` | This will render all fields that have not yet been rendered, more | -| | information in :ref:`the Twig Form reference`. | +| | information in :ref:`the Twig Form reference `. | +----------------------------------------------------+--------------------------------------------------------------------------------------------+ | ``csrf_token(intention)`` | This will render a CSRF token. Use this function if you want CSRF protection without | | | creating a form | @@ -97,10 +97,10 @@ Filters +---------------------------------------------------------------------------------+-------------------------------------------------------------------+ | ``text|trans(arguments = {}, domain = 'messages', locale = null)`` | This will translate the text into the current language, more | | | information in . | -| | :ref:`Translation Filters`. | +| | :ref:`Translation Filters `. | +---------------------------------------------------------------------------------+-------------------------------------------------------------------+ | ``text|transchoice(count, arguments = {}, domain = 'messages', locale = null)`` | This will translate the text with pluralization, more information | -| | in :ref:`Translation Filters`. | +| | in :ref:`Translation Filters `. | +---------------------------------------------------------------------------------+-------------------------------------------------------------------+ | ``variable|yaml_encode(inline = 0)`` | This will transform the variable text into a YAML syntax. | +---------------------------------------------------------------------------------+-------------------------------------------------------------------+ @@ -181,7 +181,7 @@ Those bundles can have other Twig extensions: `the official Twig Extensions documentation`_ * **Assetic** adds the ``{% stylesheets %}``, ``{% javascripts %}`` and ``{% image %}`` tags. You can read more about them in - :doc:`the Assetic Documentation`; + :doc:`the Assetic Documentation `; .. _`the official Twig Extensions documentation`: http://twig.sensiolabs.org/doc/extensions/index.html .. _`http://twig.sensiolabs.org/documentation`: http://twig.sensiolabs.org/documentation