8000 Some more minor fixes: Typos, Formatting, broken code block, logic by bicpi · Pull Request #3207 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Some more minor fixes: Typos, Formatting, broken code block, logic #3207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 27, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cookbook/configuration/pdo_session_storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ configuration format of your choice):

.. versionadded:: 2.1
In Symfony2.1 the class and namespace are slightly modified. You can now
find the session storage classes in the `Session\\Storage` namespace:
find the session storage classes in the ``Session\\Storage`` namespace:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove double backslash

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the second backslash is not rendered in the docs and due to the recent changes at https://github.com/symfony/symfony-docs/pull/3199/files#diff-61123442647c483b4b656fb83927bb45R89 i thought this is some escaping. What's the right way?

``Symfony\Component\HttpFoundation\Session\Storage``. Also
note that in Symfony2.1 you should configure ``handler_id`` not ``storage_id`` like in Symfony2.0.
Below, you'll notice that ``%session.storage.options%`` is not used anymore.
Expand Down
2 changes: 1 addition & 1 deletion cookbook/form/dynamic_form_modification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ it with :ref:`dic-tags-form-type`.
services:
acme.form.friend_message:
class: Acme\DemoBundle\Form\Type\FriendMessageFormType
arguments: [@security.context]
arguments: ["@security.context"]
tags:
-
name: form.type
Expand Down
2 changes: 1 addition & 1 deletion cookbook/profiler/matchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Then, you need to configure the service:
services:
acme_demo.profiler.matcher.super_admin:
class: "%acme_demo.profiler.matcher.super_admin.class%"
arguments: [@security.context]
arguments: ["@security.context"]

.. code-block:: xml

Expand Down
17 changes: 10 additions & 7 deletions cookbook/security/acl_advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,10 @@ tables are ordered from least rows to most rows in a typical application:

- *acl_security_identities*: This table records all security identities (SID)
which hold ACEs. The default implementation ships with two security
identities: ``RoleSecurityIdentity``, and ``UserSecurityIdentity``
- *acl_classes*: This table maps class names to a unique id which can be
identities:
:class:`Symfony\\Component\\Security\\Acl\\Domain\\RoleSecurityIdentity` and
:class:`Symfony\\Component\\Security\\Acl\\Domain\\UserSecurityIdentity`.
- *acl_classes*: This table maps class names to a unique ID which can be
referenced from other tables.
- *acl_object_identities*: Each row in this table represents a single domain
object instance.
Expand Down Expand Up @@ -173,12 +175,13 @@ Process for Reaching Authorization Decisions
The ACL class provides two methods for determining whether a security identity
has the required bitmasks, ``isGranted`` and ``isFieldGranted``. When the ACL
receives an authorization request through one of these methods, it delegates
this request to an implementation of PermissionGrantingStrategy. This allows
you to replace the way access decisions are reached without actually modifying
the ACL class itself.
this request to an implementation of
:class:`Symfony\\Component\\Security\\Acl\\Domain\\PermissionGrantingStrategy`.
This allows you to replace the way access decisions are reached without actually
modifying the ACL class itself.

The PermissionGrantingStrategy first checks all your object-scope ACEs if none
is applicable, the class-scope ACEs will be checked, if none is applicable,
The ``PermissionGrantingStrategy`` first checks all your object-scope ACEs. If none
is applicable, the class-scope ACEs will be checked. If none is applicable,
then the process will be repeated with the ACEs of the parent ACL. If no
parent ACL exists, an exception will be thrown.

Expand Down
4 changes: 2 additions & 2 deletions cookbook/security/custom_authentication_provider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ The Factory

You have created a custom token, custom listener, and custom provider. Now
you need to tie them all together. How do you make your provider available
to your security configuration? The answer is by using a ``factory``. A factory
to your security configuration? The answer is by using a *factory*. A factory
is where you hook into the Security component, telling it the name of your
provider and any configuration options available for it. First, you must
create a class which implements
Expand Down Expand Up @@ -531,7 +531,7 @@ the ``addConfiguration`` method.
}

Now, in the ``create`` method of the factory, the ``$config`` argument will
contain a 'lifetime' key, set to 5 minutes (300 seconds) unless otherwise
contain a ``lifetime`` key, set to 5 minutes (300 seconds) unless otherwise
set in the configuration. Pass this argument to your authentication provider
in order to put it to use.

Expand Down
2 changes: 1 addition & 1 deletion cookbook/security/custom_provider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ users, e.g. by filling in a login form. You can do this by adding a line to the

The value here should correspond with however the passwords were originally
encoded when creating your users (however those users were created). When
a user submits her password, the password is appended to the salt value and
a user submits her password, the salt value is appended to the password and
then encoded using this algorithm before being compared to the hashed password
returned by your ``getPassword()`` method. Additionally, depending on your
options, the password may be encoded multiple times and encoded to base64.
Expand Down
2 changes: 1 addition & 1 deletion cookbook/security/entity_provider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ then be checked against your User entity records in the database:

role_hierarchy:
ROLE_ADMIN: ROLE_USER
ROLE_SUPER_ADMIN: [ ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH ]
ROLE_SUPER_ADMIN: [ ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH ]

providers:
administrators:
Expand Down
2 changes: 1 addition & 1 deletion cookbook/security/target_path.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class and override the default method named ``setTargetPath()``.

First, override the ``security.exception_listener.class`` parameter in your
configuration file. This can be done from your main configuration file (in
`app/config`) or from a configuration file being imported from a bundle:
``app/config``) or from a configuration file being imported from a bundle:

.. configuration-block::

Expand Down
2 changes: 1 addition & 1 deletion cookbook/security/voters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Declaring the Voter as a Service
--------------------------------

To inject the voter into the security layer, you must declare it as a service,
and tag it as a "security.voter":
and tag it as a ``security.voter``:

.. configuration-block::

Expand Down
4 changes: 2 additions & 2 deletions cookbook/session/locale_sticky_session.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ during a user's request. In this article, you'll learn how to make the locale
of a user "sticky" so that once it's set, that same locale will be used for
every subsequent request.

Creating LocaleListener
-----------------------
Creating a LocaleListener
-------------------------

To simulate that the locale is stored in a session, you need to create and
register a :doc:`new event listener </cookbook/service_container/event_listener>`.
Expand Down
2 changes: 1 addition & 1 deletion cookbook/testing/http_authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ key in your firewall, along with the ``form_login`` key:
security:
firewalls:
your_firewall_name:
http_basic:
http_basic: ~

.. code-block:: xml

Expand Down
4 changes: 2 additions & 2 deletions cookbook/testing/insulating_clients.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
How to test the Interaction of several Clients
==============================================

If you need to simulate an interaction between different Clients (think of a
chat for instance), create several Clients::
If you need to simulate an interaction between different clients (think of a
chat for instance), create several clients::

$harry = static::createClient();
$sally = static::createClient();
Expand Down
6 changes: 3 additions & 3 deletions cookbook/testing/simulating_authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ One of the solutions is to configure your firewall to use ``http_basic`` in
the test environment as explained in
:doc:`/cookbook/testing/http_authentication`.
Another way would be to create a token yourself and store it in a session.
While doing this, you have to make sure that appropriate cookie is sent
While doing this, you have to make sure that an appropriate cookie is sent
with a request. The following example demonstrates this technique::

// src/Acme/DemoBundle/Tests/Controller/DemoControllerTest.php
Expand Down Expand Up @@ -57,5 +57,5 @@ with a request. The following example demonstrates this technique::

.. note::

The technique described in :doc:`/cookbook/testing/http_authentication`.
is cleaner and therefore preferred way.
The technique described in :doc:`/cookbook/testing/http_authentication`
is cleaner and therefore the preferred way.
0