From 6f7010f1b512de4c870f9166b58d4c44c8603111 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Wed, 18 Jul 2018 17:00:44 +0200 Subject: [PATCH] Replace entry/section by "article" --- components/http_foundation/session_configuration.rst | 2 +- components/security/firewall.rst | 4 ++-- deployment.rst | 2 +- doctrine/event_listeners_subscribers.rst | 2 +- doctrine/repository.rst | 8 ++++---- form/create_custom_field_type.rst | 2 +- form/dynamic_form_modification.rst | 4 ++-- form/form_collections.rst | 6 +++--- introduction/http_fundamentals.rst | 2 +- routing.rst | 2 +- security/acl.rst | 2 +- security/api_key_authentication.rst | 4 ++-- security/custom_authentication_provider.rst | 2 +- security/custom_password_authenticator.rst | 2 +- security/custom_provider.rst | 4 ++-- security/entity_provider.rst | 2 +- service_container/scopes.rst | 2 +- setup/new_project_git.rst | 2 +- setup/new_project_svn.rst | 2 +- 19 files changed, 28 insertions(+), 28 deletions(-) diff --git a/components/http_foundation/session_configuration.rst b/components/http_foundation/session_configuration.rst index 79c51eb546c..5ad54f7f132 100644 --- a/components/http_foundation/session_configuration.rst +++ b/components/http_foundation/session_configuration.rst @@ -5,7 +5,7 @@ Configuring Sessions and Save Handlers ====================================== -This section deals with how to configure session management and fine tune it +This article deals with how to configure session management and fine tune it to your specific needs. This documentation covers save handlers, which store and retrieve session data, and configuring session behavior. diff --git a/components/security/firewall.rst b/components/security/firewall.rst index 95a59864841..2b089bf0b5f 100644 --- a/components/security/firewall.rst +++ b/components/security/firewall.rst @@ -36,7 +36,7 @@ certain action or resource of the application:: .. note:: - Read the dedicated sections to learn more about :doc:`/components/security/authentication` + Read the dedicated articles to learn more about :doc:`/components/security/authentication` and :doc:`/components/security/authorization`. .. _firewall: @@ -148,5 +148,5 @@ context works: #. Once a user is authenticated, you'll use :doc:`/components/security/authorization` to deny access to certain resources. -Read the next sections to find out more about :doc:`/components/security/authentication` +Read the next articles to find out more about :doc:`/components/security/authentication` and :doc:`/components/security/authorization`. diff --git a/deployment.rst b/deployment.rst index 481efb7c5d0..0c3c19f4a37 100644 --- a/deployment.rst +++ b/deployment.rst @@ -196,7 +196,7 @@ setup: Application Lifecycle: Continuous Integration, QA, etc. ------------------------------------------------------- -While this entry covers the technical details of deploying, the full lifecycle +While this article covers the technical details of deploying, the full lifecycle of taking code from development up to production may have more steps: deploying to staging, QA (Quality Assurance), running tests, etc. diff --git a/doctrine/event_listeners_subscribers.rst b/doctrine/event_listeners_subscribers.rst index 716ff97a3b8..4013f4c74cc 100644 --- a/doctrine/event_listeners_subscribers.rst +++ b/doctrine/event_listeners_subscribers.rst @@ -266,7 +266,7 @@ to the tag like so: .. note::   Marking an event listener as ``lazy`` has nothing to do with lazy service - definitions which are described :doc:`in their own section ` + definitions which are described :doc:`in their own article ` .. _`The Event System`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html .. _`the Doctrine Documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#entity-listeners diff --git a/doctrine/repository.rst b/doctrine/repository.rst index 2c49a4dcdc2..5afa9d8e911 100644 --- a/doctrine/repository.rst +++ b/doctrine/repository.rst @@ -4,10 +4,10 @@ How to Create custom Repository Classes ======================================= -In the previous sections, you began constructing and using more complex queries -from inside a controller. In order to isolate, reuse and test these queries, -it's a good practice to create a custom repository class for your entity. -Methods containing your query logic can then be stored in this class. +Constructing and using complex queries inside controllers complicate the +maintenance of your application. In order to isolate, reuse and test these +queries, it's a good practice to create a custom repository class for your +entity. Methods containing your query logic can then be stored in this class. To do this, add the repository class name to your entity's mapping definition: diff --git a/form/create_custom_field_type.rst b/form/create_custom_field_type.rst index 483b69901f2..111d58557c8 100644 --- a/form/create_custom_field_type.rst +++ b/form/create_custom_field_type.rst @@ -273,7 +273,7 @@ section explains how more complex field types solve this problem. Creating your Field Type as a Service ------------------------------------- -So far, this entry has assumed that you have a very simple custom field type. +So far, this article has assumed that you have a very simple custom field type. But if you need access to configuration, a database connection, or some other service, then you'll want to register your custom type as a service. For example, suppose that you're storing the shipping parameters in configuration: diff --git a/form/dynamic_form_modification.rst b/form/dynamic_form_modification.rst index 4ac8da7b373..09ba18ac7ec 100644 --- a/form/dynamic_form_modification.rst +++ b/form/dynamic_form_modification.rst @@ -4,7 +4,7 @@ How to Dynamically Modify Forms Using Form Events ================================================= -Often times, a form can't be created statically. In this entry, you'll learn +Often times, a form can't be created statically. In this article, you'll learn how to customize your form based on three common use-cases: 1) :ref:`form-events-underlying-data` @@ -74,7 +74,7 @@ Suppose now, that you don't want the user to be able to change the ``name`` valu once the object has been created. To do this, you can rely on Symfony's :doc:`EventDispatcher component ` system to analyze the data on the object and modify the form based on the -Product object's data. In this entry, you'll learn how to add this level of +Product object's data. In this article, you'll learn how to add this level of flexibility to your forms. Adding an Event Listener to a Form Class diff --git a/form/form_collections.rst b/form/form_collections.rst index ac710b1c575..fa650cbfa82 100644 --- a/form/form_collections.rst +++ b/form/form_collections.rst @@ -4,14 +4,14 @@ How to Embed a Collection of Forms ================================== -In this entry, you'll learn how to create a form that embeds a collection +In this article, you'll learn how to create a form that embeds a collection of many other forms. This could be useful, for example, if you had a ``Task`` class and you wanted to edit/create/remove many ``Tag`` objects related to that Task, right inside the same form. .. note:: - In this entry, it's loosely assumed that you're using Doctrine as your + In this article, it's loosely assumed that you're using Doctrine as your database store. But if you're not using Doctrine (e.g. Propel or just a database connection), it's all very similar. There are only a few parts of this tutorial that really care about "persistence". @@ -224,7 +224,7 @@ great, your user can't actually add any new tags yet. .. caution:: - In this entry, you embed only one collection, but you are not limited + In this article, you embed only one collection, but you are not limited to this. You can also embed nested collection as many levels down as you like. But if you use Xdebug in your development setup, you may receive a ``Maximum function nesting level of '100' reached, aborting!`` error. diff --git a/introduction/http_fundamentals.rst b/introduction/http_fundamentals.rst index afc4c2ebb13..5c4b1c67492 100644 --- a/introduction/http_fundamentals.rst +++ b/introduction/http_fundamentals.rst @@ -78,7 +78,7 @@ resource - the most common HTTP methods are: Delete the resource from the server (used by APIs). With this in mind, you can imagine what an HTTP request might look like to -delete a specific blog entry, for example: +delete a specific blog post, for example: .. code-block:: text diff --git a/routing.rst b/routing.rst index cf829385daf..048dfd57477 100644 --- a/routing.rst +++ b/routing.rst @@ -29,7 +29,7 @@ Routing Examples A *route* is a map from a URL path to a controller. For example, suppose you want to match any URL like ``/blog/my-post`` or ``/blog/all-about-symfony`` -and send it to a controller that can look up and render that blog entry. +and send it to a controller that can look up and render that blog post. The route is simple: .. configuration-block:: diff --git a/security/acl.rst b/security/acl.rst index 905ed98c7b2..e1a9ecd6075 100644 --- a/security/acl.rst +++ b/security/acl.rst @@ -17,7 +17,7 @@ the ACL system comes in. :doc:`voters `. A voter is passed the object being voted on, which you can use to make complex decisions and effectively implement your own ACL. Enforcing authorization (e.g. the ``isGranted()`` - part) will look similar to what you see in this entry, but your voter + part) will look similar to what you see in this article, but your voter class will handle the logic behind the scenes, instead of the ACL system. Imagine you are designing a blog system where your users can comment on your diff --git a/security/api_key_authentication.rst b/security/api_key_authentication.rst index 1d71feb3bf1..e62cca20ad7 100644 --- a/security/api_key_authentication.rst +++ b/security/api_key_authentication.rst @@ -490,7 +490,7 @@ to store authentication in the session, keep reading! Storing Authentication in the Session ------------------------------------- -So far, this entry has described a situation where some sort of authentication +So far, this article has described a situation where some sort of authentication token is sent on every request. But in some situations (like an OAuth flow), the token may be sent on only *one* request. In this case, you will want to authenticate the user and store that authentication in the session so that @@ -667,7 +667,7 @@ of the user to make sure it's not out-of-date. But regardless of your requiremen Only Authenticating for Certain URLs ------------------------------------ -This entry has assumed that you want to look for the ``apikey`` authentication +This article has assumed that you want to look for the ``apikey`` authentication on *every* request. But in some situations (like an OAuth flow), you only really need to look for authentication information once the user has reached a certain URL (e.g. the redirect URL in OAuth). diff --git a/security/custom_authentication_provider.rst b/security/custom_authentication_provider.rst index 1a41b7c5c64..6278d69b383 100644 --- a/security/custom_authentication_provider.rst +++ b/security/custom_authentication_provider.rst @@ -6,7 +6,7 @@ How to Create a custom Authentication Provider .. tip:: - Creating a custom authentication system is hard, and this entry will walk + Creating a custom authentication system is hard, and this article will walk you through that process. But depending on your needs, you may be able to solve your problem in a simpler manner, or via a community bundle: diff --git a/security/custom_password_authenticator.rst b/security/custom_password_authenticator.rst index 03b816a7128..2acbe5337a2 100644 --- a/security/custom_password_authenticator.rst +++ b/security/custom_password_authenticator.rst @@ -10,7 +10,7 @@ How to Create a Custom Form Password Authenticator flexible way to accomplish custom authentication tasks like this. Imagine you want to allow access to your website only between 2pm and 4pm -UTC. In this entry, you'll learn how to do this for a login form (i.e. where +UTC. In this article, you'll learn how to do this for a login form (i.e. where your user submits their username and password). The Password Authenticator diff --git a/security/custom_provider.rst b/security/custom_provider.rst index e7c3834b9e7..6ae6607679d 100644 --- a/security/custom_provider.rst +++ b/security/custom_provider.rst @@ -10,7 +10,7 @@ the configured user provider to return a user object for a given username. Symfony then checks whether the password of this user is correct and generates a security token so the user stays authenticated during the current session. Out of the box, Symfony has four user providers: ``memory``, ``entity``, -``ldap`` and ``chain``. In this entry you'll see how you can create your +``ldap`` and ``chain``. In this article you'll see how you can create your own user provider, which could be useful if your users are accessed via a custom database, a file, or - as shown in this example - a web service. @@ -328,7 +328,7 @@ is compared to the hashed password returned by your ``getPassword()`` method. If your external users have their passwords salted via a different method, then you'll need to do a bit more work so that Symfony properly encodes - the password. That is beyond the scope of this entry, but would include + the password. That is beyond the scope of this article, but would include sub-classing ``MessageDigestPasswordEncoder`` and overriding the ``mergePasswordAndSalt()`` method. diff --git a/security/entity_provider.rst b/security/entity_provider.rst index c0efc31c520..63915e43847 100644 --- a/security/entity_provider.rst +++ b/security/entity_provider.rst @@ -36,7 +36,7 @@ and :ref:`user serialization to the session ` 1) Create your User Entity -------------------------- -For this entry, suppose that you already have a ``User`` entity inside an +For this article, suppose that you already have a ``User`` entity inside an ``AppBundle`` with the following fields: ``id``, ``username``, ``password``, ``email`` and ``isActive``:: diff --git a/service_container/scopes.rst b/service_container/scopes.rst index 527c1cec0ec..87ea5cd2433 100644 --- a/service_container/scopes.rst +++ b/service_container/scopes.rst @@ -24,7 +24,7 @@ This article is all about scopes, a somewhat advanced topic related to the is to inject the ``request_stack`` service instead and access the current Request by calling the :method:`Symfony\\Component\\HttpFoundation\\RequestStack::getCurrentRequest` - method (see :doc:`/service_container/request`). The rest of this entry + method (see :doc:`/service_container/request`). The rest of this article talks about scopes in a theoretical and more advanced way. If you're dealing with scopes for the ``request`` service, simply inject ``request_stack``. diff --git a/setup/new_project_git.rst b/setup/new_project_git.rst index 6c175456c05..d434c90291a 100644 --- a/setup/new_project_git.rst +++ b/setup/new_project_git.rst @@ -8,7 +8,7 @@ How to Create and Store a Symfony Project in Git .. tip:: - Though this entry is specifically about Git, the same generic principles + Though this article is specifically about Git, the same generic principles will apply if you're storing your project in Subversion. Once you've read through :doc:`/page_creation` and become familiar with diff --git a/setup/new_project_svn.rst b/setup/new_project_svn.rst index 36684137e49..9606b3e5309 100644 --- a/setup/new_project_svn.rst +++ b/setup/new_project_svn.rst @@ -8,7 +8,7 @@ How to Create and Store a Symfony Project in Subversion .. tip:: - This entry is specifically about Subversion, and based on principles found + This article is specifically about Subversion, and based on principles found in :doc:`/setup/new_project_git`. Once you've read through :doc:`/page_creation` and become familiar with