diff --git a/book/controller.rst b/book/controller.rst index c7cccc810db..8e85f102973 100644 --- a/book/controller.rst +++ b/book/controller.rst @@ -556,7 +556,7 @@ Symfony will automatically return a 500 HTTP response code. throw new \Exception('Something went wrong!'); In every case, an error page is shown to the end user and a full debug -error page is shown to the developer (i.e. when you're using ``app_dev.php`` - +error page is shown to the developer (i.e. when you're using ``app_dev.php`` - see :ref:`page-creation-environments`). You'll want to customize the error page your user sees. To do that, see the diff --git a/book/from_flat_php_to_symfony2.rst b/book/from_flat_php_to_symfony2.rst index 364546977c9..ff779b0dd14 100644 --- a/book/from_flat_php_to_symfony2.rst +++ b/book/from_flat_php_to_symfony2.rst @@ -244,7 +244,7 @@ the layout: -You now have a setup that will allow you to reuse the layout. +You now have a setup that will allow you to reuse the layout. Unfortunately, to accomplish this, you're forced to use a few ugly PHP functions (``ob_start()``, ``ob_get_clean()``) in the template. Symfony uses a Templating component that allows this to be accomplished cleanly diff --git a/book/http_cache.rst b/book/http_cache.rst index 658288f1958..6341ccecc44 100644 --- a/book/http_cache.rst +++ b/book/http_cache.rst @@ -538,8 +538,8 @@ won't be asked to return the updated response until the cache finally becomes stale. The validation model addresses this issue. Under this model, the cache continues -to store responses. The difference is that, for each request, the cache asks the -application if the cached response is still valid or if it needs to be regenerated. +to store responses. The difference is that, for each request, the cache asks the +application if the cached response is still valid or if it needs to be regenerated. If the cache *is* still valid, your application should return a 304 status code and no content. This tells the cache that it's ok to return the cached response. diff --git a/book/service_container.rst b/book/service_container.rst index fef11d05fda..a41d0718981 100644 --- a/book/service_container.rst +++ b/book/service_container.rst @@ -611,7 +611,7 @@ the service container gives you a much more appealing option: services: my_mailer: # ... - + newsletter_manager: class: Acme\HelloBundle\Newsletter\NewsletterManager arguments: ["@my_mailer"] @@ -696,7 +696,7 @@ Injecting the dependency by the setter method just needs a change of syntax: services: my_mailer: # ... - + newsletter_manager: class: Acme\HelloBundle\Newsletter\NewsletterManager calls: @@ -731,7 +731,7 @@ Injecting the dependency by the setter method just needs a change of syntax: use Symfony\Component\DependencyInjection\Reference; $container->setDefinition('my_mailer', ...); - + $container->setDefinition('newsletter_manager', new Definition( 'Acme\HelloBundle\Newsletter\NewsletterManager' ))->addMethodCall('setMailer', array( @@ -777,7 +777,7 @@ it exists and do nothing if it doesn't: - + @@ -792,7 +792,7 @@ it exists and do nothing if it doesn't: use Symfony\Component\DependencyInjection\ContainerInterface; $container->setDefinition('my_mailer', ...); - + $container->setDefinition('newsletter_manager', new Definition( 'Acme\HelloBundle\Newsletter\NewsletterManager', array( diff --git a/components/class_loader/cache_class_loader.rst b/components/class_loader/cache_class_loader.rst index cb2dc5f93c8..918041e5bd9 100644 --- a/components/class_loader/cache_class_loader.rst +++ b/components/class_loader/cache_class_loader.rst @@ -4,7 +4,7 @@ single: ClassLoader; Cache single: ClassLoader; XcacheClassLoader single: XCache; XcacheClassLoader - + Cache a Class Loader ==================== @@ -33,16 +33,16 @@ ApcClassLoader ``findFile()`` method using `APC`_:: require_once '/path/to/src/Symfony/Component/ClassLoader/ApcClassLoader.php'; - + // instance of a class that implements a findFile() method, like the ClassLoader $loader = ...; - + // sha1(__FILE__) generates an APC namespace prefix $cachedLoader = new ApcClassLoader(sha1(__FILE__), $loader); - + // register the cached class loader $cachedLoader->register(); - + // deactivate the original, non-cached loader if it was registered previously $loader->unregister(); @@ -56,16 +56,16 @@ XcacheClassLoader it is straightforward:: require_once '/path/to/src/Symfony/Component/ClassLoader/XcacheClassLoader.php'; - + // instance of a class that implements a findFile() method, like the ClassLoader $loader = ...; - + // sha1(__FILE__) generates an XCache namespace prefix $cachedLoader = new XcacheClassLoader(sha1(__FILE__), $loader); - + // register the cached class loader $cachedLoader->register(); - + // deactivate the original, non-cached loader if it was registered previously $loader->unregister(); diff --git a/components/class_loader/debug_class_loader.rst b/components/class_loader/debug_class_loader.rst index f5ae81c471e..cc99762b5cc 100644 --- a/components/class_loader/debug_class_loader.rst +++ b/components/class_loader/debug_class_loader.rst @@ -1,6 +1,6 @@ .. index:: single: ClassLoader; DebugClassLoader - + Debugging a Class Loader ======================== @@ -16,5 +16,5 @@ Using the ``DebugClassLoader`` is as easy as calling its static :method:`Symfony\\Component\\ClassLoader\\DebugClassLoader::enable` method:: use Symfony\Component\ClassLoader\DebugClassLoader; - + DebugClassLoader::enable(); diff --git a/components/class_loader/map_class_loader.rst b/components/class_loader/map_class_loader.rst index 0243550af68..0a157416040 100644 --- a/components/class_loader/map_class_loader.rst +++ b/components/class_loader/map_class_loader.rst @@ -1,6 +1,6 @@ .. index:: single: ClassLoader; MapClassLoader - + MapClassLoader ============== @@ -26,14 +26,14 @@ Using it is as easy as passing your mapping to its constructor when creating an instance of the ``MapClassLoader`` class:: require_once '/path/to/src/Symfony/Component/ClassLoader/MapClassLoader'; - + $mapping = array( 'Foo' => '/path/to/Foo', 'Bar' => '/path/to/Bar', ); - + $loader = new MapClassLoader($mapping); - + $loader->register(); .. _PSR-0: http://www.php-fig.org/psr/psr-0/ diff --git a/components/css_selector.rst b/components/css_selector.rst index b62c58d94a3..2eaf063169c 100644 --- a/components/css_selector.rst +++ b/components/css_selector.rst @@ -76,7 +76,7 @@ web-browser. * link-state selectors: ``:link``, ``:visited``, ``:target`` * selectors based on user action: ``:hover``, ``:focus``, ``:active`` -* UI-state selectors: ``:invalid``, ``:indeterminate`` (however, ``:enabled``, +* UI-state selectors: ``:invalid``, ``:indeterminate`` (however, ``:enabled``, ``:disabled``, ``:checked`` and ``:unchecked`` are available) Pseudo-elements (``:before``, ``:after``, ``:first-line``, diff --git a/components/dependency_injection/advanced.rst b/components/dependency_injection/advanced.rst index b0485461a25..82263ca6e66 100644 --- a/components/dependency_injection/advanced.rst +++ b/components/dependency_injection/advanced.rst @@ -17,7 +17,7 @@ using the ``get()`` method:: In some cases, a service *only* exists to be injected into another service and is *not* intended to be fetched directly from the container as shown -above. +above. .. _inlined-private-services: diff --git a/components/security/authentication.rst b/components/security/authentication.rst index 3abba44dea3..bf29ac98287 100644 --- a/components/security/authentication.rst +++ b/components/security/authentication.rst @@ -257,7 +257,7 @@ in) is correct, you can use:: // fetch the Acme\Entity\LegacyUser $user = ...; - + // the submitted password, e.g. from the login form $plainPassword = ...; diff --git a/components/templating/helpers/assetshelper.rst b/components/templating/helpers/assetshelper.rst index 5ae45979725..d369214f8b2 100644 --- a/components/templating/helpers/assetshelper.rst +++ b/components/templating/helpers/assetshelper.rst @@ -75,7 +75,7 @@ Asset path generation is handled internally by packages. The component provides You can also use multiple packages:: use Symfony\Component\Templating\Asset\PathPackage; - + // ... $templateEngine->set(new AssetsHelper()); diff --git a/components/templating/introduction.rst b/components/templating/introduction.rst index 946da963104..aac7019f6ed 100644 --- a/components/templating/introduction.rst +++ b/components/templating/introduction.rst @@ -135,7 +135,7 @@ escaper using the Helpers ------- -The Templating component can be easily extended via helpers. Helpers are PHP objects that +The Templating component can be easily extended via helpers. Helpers are PHP objects that provide features useful in a template context. The component has 2 built-in helpers: diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst index 1fb4297ddce..c187890183f 100644 --- a/contributing/code/standards.rst +++ b/contributing/code/standards.rst @@ -79,7 +79,7 @@ example containing most features described below: throw new \RuntimeException(sprintf('Unrecognized dummy option "%s"', $dummy)); } - + private function reverseBoolean($value = null, $theSwitch = false) { if (!$theSwitch) { @@ -95,7 +95,7 @@ Structure * Add a single space after each comma delimiter; -* Add a single space around binary operators (``==``, ``&&``, ...), with +* Add a single space around binary operators (``==``, ``&&``, ...), with the exception of the concatenation (``.``) operator; * Place unary operators (``!``, ``--``, ...) adjacent to the affected variable; diff --git a/cookbook/configuration/external_parameters.rst b/cookbook/configuration/external_parameters.rst index 58a72fd898c..0e0619b1409 100644 --- a/cookbook/configuration/external_parameters.rst +++ b/cookbook/configuration/external_parameters.rst @@ -14,12 +14,12 @@ Environment Variables --------------------- Symfony will grab any environment variable prefixed with ``SYMFONY__`` and -set it as a parameter in the service container. Some transformations are +set it as a parameter in the service container. Some transformations are applied to the resulting parameter name: * ``SYMFONY__`` prefix is removed; * Parameter name is lowercased; -* Double underscores are replaced with a period, as a period is not +* Double underscores are replaced with a period, as a period is not a valid character in an environment variable name. For example, if you're using Apache, environment variables can be set using diff --git a/cookbook/configuration/override_dir_structure.rst b/cookbook/configuration/override_dir_structure.rst index e42bcf4795e..c0fd15ef47a 100644 --- a/cookbook/configuration/override_dir_structure.rst +++ b/cookbook/configuration/override_dir_structure.rst @@ -151,7 +151,7 @@ the ``extra.symfony-web-dir`` option in the ``composer.json`` file: work: .. code-block:: bash - + $ php app/console cache:clear --env=prod $ php app/console assetic:dump --env=prod --no-debug diff --git a/cookbook/deployment/platformsh.rst b/cookbook/deployment/platformsh.rst index 1d73bfdc38a..0419195f8e0 100644 --- a/cookbook/deployment/platformsh.rst +++ b/cookbook/deployment/platformsh.rst @@ -4,8 +4,8 @@ Deploying to Platform.sh ======================== -This step-by-step cookbook describes how to deploy a Symfony web application to -`Platform.sh`_. You can read more about using Symfony with Platform.sh on the +This step-by-step cookbook describes how to deploy a Symfony web application to +`Platform.sh`_. You can read more about using Symfony with Platform.sh on the official `Platform.sh documentation`_. Deploy an Existing Site @@ -15,23 +15,23 @@ In this guide, it is assumed your codebase is already versioned with Git. Get a Project on Platform.sh ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + You need to subscribe to a `Platform.sh project`_. Choose the development plan -and go through the checkout process. Once your project is ready, give it a name +and go through the checkout process. Once your project is ready, give it a name and choose: **Import an existing site**. Prepare Your Application ~~~~~~~~~~~~~~~~~~~~~~~~ -To deploy your Symfony application on Platform.sh, you simply need to add a +To deploy your Symfony application on Platform.sh, you simply need to add a ``.platform.app.yaml`` at the root of your Git repository which will tell -Platform.sh how to deploy your application (read more about +Platform.sh how to deploy your application (read more about `Platform.sh configuration files`_). .. code-block:: yaml # .platform.app.yaml - + # This file describes an application. You can have multiple applications # in the same project. @@ -96,7 +96,7 @@ Configure Database Access Platform.sh overrides your database specific configuration via importing the following file:: - + // app/config/parameters_platform.php `_ can be found on the +More information about `migrating your database and files `_ can be found on the Platform.sh documentation. Deploy a new Site ----------------- - -You can start a new `Platform.sh project`_. Choose the development plan and go + +You can start a new `Platform.sh project`_. Choose the development plan and go through the checkout process. Once your project is ready, give it a name and choose: **Create a new site**. Choose the *Symfony* stack and a starting point such as *Standard*. -That's it! Your Symfony application will be bootstrapped and deployed. You'll +That's it! Your Symfony application will be bootstrapped and deployed. You'll soon be able to see it in your browser. .. _`Platform.sh`: https://platform.sh diff --git a/cookbook/form/form_collections.rst b/cookbook/form/form_collections.rst index 9793a67d357..dcc1266650d 100644 --- a/cookbook/form/form_collections.rst +++ b/cookbook/form/form_collections.rst @@ -463,8 +463,8 @@ we talk about next!). .. caution:: - You have to create **both** ``addTag`` and ``removeTag`` methods, - otherwise the form will still use ``setTag`` even if ``by_reference`` is ``false``. + You have to create **both** ``addTag`` and ``removeTag`` methods, + otherwise the form will still use ``setTag`` even if ``by_reference`` is ``false``. You'll learn more about the ``removeTag`` method later in this article. .. sidebar:: Doctrine: Cascading Relations and saving the "Inverse" side diff --git a/cookbook/form/unit_testing.rst b/cookbook/form/unit_testing.rst index 944ed25b372..29f54372cf3 100644 --- a/cookbook/form/unit_testing.rst +++ b/cookbook/form/unit_testing.rst @@ -184,7 +184,7 @@ on other extensions. You need add those extensions to the factory object:: protected function setUp() { parent::setUp(); - + $validator = $this->getMock('\Symfony\Component\Validator\ValidatorInterface'); $validator->method('validate')->will($this->returnValue(new ConstraintViolationList())); diff --git a/cookbook/security/access_control.rst b/cookbook/security/access_control.rst index 9e0cb9ea532..ec09e05d4b9 100644 --- a/cookbook/security/access_control.rst +++ b/cookbook/security/access_control.rst @@ -177,7 +177,7 @@ pattern so that it is only accessible by requests from the local server itself: security: # ... access_control: - # + # - { path: ^/internal, roles: IS_AUTHENTICATED_ANONYMOUSLY, ips: [127.0.0.1, ::1] } - { path: ^/internal, roles: ROLE_NO_ACCESS } diff --git a/cookbook/security/pre_authenticated.rst b/cookbook/security/pre_authenticated.rst index fe77000422c..3b2fb7c2e16 100644 --- a/cookbook/security/pre_authenticated.rst +++ b/cookbook/security/pre_authenticated.rst @@ -71,8 +71,8 @@ in the x509 firewall configuration respectively. An authentication provider will only inform the user provider of the username that made the request. You will need to create (or use) a "user provider" that is referenced by the ``provider`` configuration parameter (``your_user_provider`` - in the configuration example). This provider will turn the username into a User - object of your choice. For more information on creating or configuring a user + in the configuration example). This provider will turn the username into a User + object of your choice. For more information on creating or configuring a user provider, see: * :doc:`/cookbook/security/custom_provider` diff --git a/reference/constraints/Choice.rst b/reference/constraints/Choice.rst index 28f1628d042..aab73b59c44 100644 --- a/reference/constraints/Choice.rst +++ b/reference/constraints/Choice.rst @@ -89,11 +89,11 @@ If your valid choice list is simple, you can pass them in directly via the use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; - + class Author { protected $gender; - + public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('gender', new Assert\Choice(array( @@ -176,11 +176,11 @@ constraint. use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; - + class Author { protected $gender; - + public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('gender', new Assert\Choice(array( @@ -244,11 +244,11 @@ you can pass the class name and the method as an array. use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; - + class Author { protected $gender; - + public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('gender', new Assert\Choice(array( diff --git a/reference/constraints/Time.rst b/reference/constraints/Time.rst index 3e9540801b8..251bb007eab 100644 --- a/reference/constraints/Time.rst +++ b/reference/constraints/Time.rst @@ -35,7 +35,7 @@ of the day when the event starts: // src/Acme/EventBundle/Entity/Event.php namespace Acme\EventBundle\Entity; - + use Symfony\Component\Validator\Constraints as Assert; class Event @@ -62,10 +62,10 @@ of the day when the event starts: .. code-block:: php - + // src/Acme/EventBundle/Entity/Event.php namespace Acme\EventBundle\Entity; - + use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index 120cb37b11c..ede6626279f 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -8,7 +8,7 @@ The ``language`` type is a subset of the ``ChoiceType`` that allows the user to select from a large list of languages. As an added bonus, the language names are displayed in the language of the user. -The "value" for each language is the *Unicode language identifier* used in +The "value" for each language is the *Unicode language identifier* used in the `International Components for Unicode`_ (e.g. ``fr`` or ``zh_Hant``). .. note:: diff --git a/reference/forms/types/options/data.rst.inc b/reference/forms/types/options/data.rst.inc index ee92e82a2d3..9873740cf48 100644 --- a/reference/forms/types/options/data.rst.inc +++ b/reference/forms/types/options/data.rst.inc @@ -14,6 +14,6 @@ an individual field, you can set it in the data option:: .. note:: - The default values for form fields are taken directly from the - underlying data structure (e.g. an entity or an array). + The default values for form fields are taken directly from the + underlying data structure (e.g. an entity or an array). The ``data`` option overrides this default value. diff --git a/reference/forms/types/options/max_length.rst.inc b/reference/forms/types/options/max_length.rst.inc index d20d44e1199..23b1aa327cc 100644 --- a/reference/forms/types/options/max_length.rst.inc +++ b/reference/forms/types/options/max_length.rst.inc @@ -3,8 +3,8 @@ max_length **type**: ``integer`` **default**: ``null`` -If this option is not null, an attribute ``maxlength`` is added, which -is used by some browsers to limit the amount of text in a field. +If this option is not null, an attribute ``maxlength`` is added, which +is used by some browsers to limit the amount of text in a field. -This is just a browser validation, so data must still be validated +This is just a browser validation, so data must still be validated server-side.