Skip to content

Commit 42e658a

Browse files
OleksandrProtsiukOleksandrProtsiuk
authored
BAP-22390: Update PHP code-blocks in documentation (#37707)
- Updated inline php code-blocks - Fixed errors in the literal includes
1 parent 083c3ac commit 42e658a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+580
-749
lines changed

‎backend/api/how-to.rst

+5-15
Original file line numberDiff line numberDiff line change
@@ -1120,39 +1120,29 @@ Let's use the following schema of entities to illustrate how to use a custom que
11201120

11211121
.. code-block:: php
11221122
1123-
/**
1124-
* @ORM\OneToMany(targetEntity="AccountContactLink", mappedBy="account")
1125-
*/
1123+
#[ORM\OneToMany(mappedBy: 'account', targetEntity: 'AccountContactLink')]
11261124
private $contactLinks;
11271125
11281126
11291127
- Contact entity
11301128

11311129
.. code-block:: php
11321130
1133-
/**
1134-
* @ORM\OneToMany(targetEntity="AccountContactLink", mappedBy="contact")
1135-
*/
1131+
#[ORM\OneToMany(mappedBy: 'contact', targetEntity: 'AccountContactLink')]
11361132
private $accountLinks;
11371133
11381134
11391135
- AccountContactLink entity
11401136

11411137
.. code-block:: php
11421138
1143-
/**
1144-
* @ORM\ManyToOne(targetEntity="Account", inversedBy="contactLinks")
1145-
*/
1139+
#[ORM\ManyToOne(targetEntity: 'Account', inversedBy: 'contactLinks')]
11461140
private $account;
11471141
1148-
/**
1149-
* @ORM\ManyToOne(targetEntity="Contact", inversedBy="accountLinks")
1150-
*/
1142+
#[ORM\ManyToOne(targetEntity: 'Contact', inversedBy: 'accountLinks')]
11511143
private $contact;
11521144
1153-
/**
1154-
* @ORM\Column(type="boolean", nullable=false, options={"default"=true})
1155-
*/
1145+
#[ORM\Column(type: 'boolean', nullable: false, options: ['default' => true])]
11561146
private $enabled = true;
11571147
11581148
This schema represents a many-to-many association between the Account and Contact entities but with an additional attribute for each associated record (e.g., attribute ``enabled`` in the example above).

‎backend/architecture/differences.rst

+11-15
Original file line numberDiff line numberDiff line change
@@ -59,44 +59,40 @@ Access Control Lists
5959
--------------------
6060

6161
|Access Control Lists| (ACLs) usually involve working with the ACL provider, object identities, ACEs, the mask builder, etc. OroPlatform makes
62-
things more accessible by providing the |@Acl| annotation that you can use to define an ACL and protect a controller in a single step:
62+
things more accessible by providing the |#[Acl]| attribute that you can use to define an ACL and protect a controller in a single step:
6363

6464
.. code-block:: php
6565
:caption: src/Acme/Bundle/DemoBundle/Controller/BlogController.php
6666
6767
namespace Acme\Bundle\DemoBundle\Controller;
6868
69-
use Oro\Bundle\SecurityBundle\Annotation\Acl;
69+
use Oro\Bundle\SecurityBundle\Attribute\Acl;
7070
7171
// ...
7272
73-
/**
74-
* @Acl(
75-
* id="acme_demo.blog_post_view",
76-
* type="entity",
77-
* class="Acme\Bundle\WysiwygBundle\Entity\BlogPost",
78-
* permission="VIEW"
79-
* )
80-
*/
73+
#[Acl(
74+
id: 'acme_demo.blog_post_view',
75+
type: 'entity',
76+
class: 'Acme\Bundle\WysiwygBundle\Entity\BlogPost',
77+
permission: 'VIEW'
78+
)]
8179
public function indexAction()
8280
{
8381
// ...
8482
}
8583
86-
Furthermore, once an ACL has been defined, you can reuse it using the |@AclAncestor| annotation:
84+
Furthermore, once an ACL has been defined, you can reuse it using the |#[AclAncestor]| attribute:
8785

8886
.. code-block:: php
8987
:caption: src/Acme/Bundle/DemoBundle/Controller/BlogController.php
9088
9189
namespace Acme\Bundle\DemoBundle\Controller;
9290
93-
use Oro\Bundle\SecurityBundle\Annotation\AclAncestor;
91+
use Oro\Bundle\SecurityBundle\Attribute\AclAncestor;
9492
9593
// ...
9694
97-
/**
98-
* @AclAncestor("acme_demo.blog_post_view")
99-
*/
95+
#[AclAncestor('acme_demo.blog_post_view')]
10096
public function postAction()
10197
{
10298
// ...

‎backend/configuration/annotation/acl-ancestor.rst

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
.. _acl-ancestor:
22

3-
@AclAncestor
4-
============
3+
#[AclAncestor]
4+
==============
55

6-
This annotation is used to protect a controller based on an existing access control list. The ID of
7-
the parent access control list is passed as the only option:
6+
This attribute is used to protect a controller based on an existing access control list. The ID of
7+
the parent access control list is passed as the only argument:
88

99
.. code-block:: php
1010
1111
1212
// ...
13-
use Oro\Bundle\SecurityBundle\Annotation\AclAncestor;
13+
use Oro\Bundle\SecurityBundle\Attribute\AclAncestor;
1414
15-
/**
16-
* @AclAncestor("an_acl_id")
17-
*/
15+
#[AclAncestor("an_acl_id")]
1816
public function demoAction()
1917
{
2018
// ...

‎backend/configuration/annotation/acl.rst

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
.. _acl:
22

3-
@Acl
4-
====
3+
#[Acl]
4+
======
55

6-
The ``@Acl`` annotation is used to create a new access control list and to protect the controller
7-
that is annotation with this ACL accordingly:
6+
The ``#[Acl]`` attribute is used to create a new access control list and to protect the controller
7+
that is attribute with this ACL accordingly:
88

99
.. code-block:: php
1010
1111
1212
// ...
13-
use Oro\Bundle\SecurityBundle\Annotation\Acl;
14-
15-
/**
16-
* @Acl(
17-
* id="user_user_view",
18-
* type="entity",
19-
* class="Oro\Bundle\UserBundle\Entity\User",
20-
* permission="VIEW"
21-
* )
22-
*/
13+
use Oro\Bundle\SecurityBundle\Attribute\Acl;
14+
15+
#[Acl(
16+
id="user_user_view",
17+
type="entity",
18+
class="Oro\Bundle\UserBundle\Entity\User",
19+
permission="VIEW"
20+
)]
2321
public function demoAction()
2422
{
2523
// ...
2624
}
2725
28-
Options
29-
-------
26+
Arguments
27+
---------
3028

3129
``class``
3230
~~~~~~~~~
@@ -37,7 +35,7 @@ When the `type`_ option is set to ``entity``, the fully qualified class name con
3735
``class`` option is used to decide whether or not the ACL has to be evaluated when checking if a
3836
user has access to a certain class. If the given action is annotated with the |ParamConverter|
3937
parameter, and the class of this parameter is the same as the class parameter from the ACL
40-
annotation, the check will be done on the object level (check if the user has access to the given
38+
attribute, the check will be done on the object level (check if the user has access to the given
4139
object).
4240

4341
``group``
@@ -50,7 +48,7 @@ ACLs can optionally be grouped. A group is identified by its name.
5048
``id``
5149
~~~~~~
5250

53-
A unique identifier that is used, for example, to reference an access control list with the :ref:`@AclAncestor annotation <acl-ancestor>`.
51+
A unique identifier that is used, for example, to reference an access control list with the :ref:`#[AclAncestor] attribute <acl-ancestor>`.
5452

5553
``label``
5654
~~~~~~~~~

‎backend/configuration/annotation/config-field.rst

+11-15
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
.. _backend-configuration-annotation-config-field:
44

5-
@ConfigField
6-
============
5+
#[ConfigField]
6+
==============
77

8-
This annotation is used to configure default values for properties of configurable entity classes.
8+
This attribute is used to configure default values for properties of configurable entity classes.
99

10-
Options
11-
-------
10+
Arguments
11+
---------
1212

1313
.. _annotation-config-field-default-values:
1414

@@ -21,19 +21,15 @@ Configures default values for particular config options on a per property basis:
2121
2222
2323
// ...
24-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
24+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\ConfigField;
2525
2626
class User
2727
{
28-
/**
29-
* @ConfigField(
30-
* defaultValues={
31-
* "dataaudit"={
32-
* "auditable"=true
33-
* }
34-
* }
35-
* )
36-
*/
28+
#[ConfigField(
29+
defaultValues: [
30+
"dataaudit" => ["auditable" => true]
31+
]
32+
)]
3733
private $username;
3834
}
3935

‎backend/configuration/annotation/config.rst

+29-41
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
.. _annotation-config:
1+
.. _attribute-config:
22

3-
@Config
4-
=======
3+
#[Config]
4+
=========
55

6-
This annotation is used to configure default values for configurable entity classes.
6+
This attribute is used to configure default values for configurable entity classes.
77

8-
Options
9-
-------
8+
Arguments
9+
---------
1010

1111
``defaultValues``
1212
^^^^^^^^^^^^^^^^^
@@ -16,17 +16,13 @@ Configures default values for particular config options on a per property basis:
1616
.. code-block:: php
1717
1818
// ...
19-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
20-
21-
/**
22-
* @Config(
23-
* defaultValues={
24-
* "dataaudit"={
25-
* "auditable"=true
26-
* }
27-
* }
28-
* )
29-
*/
19+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;
20+
21+
#[Config(
22+
defaultValues: [
23+
"dataaudit" => ["auditable" => true]
24+
]
25+
)]
3026
class User
3127
{
3228
// ...
@@ -391,13 +387,11 @@ The route name of the view that shows the datagrid of available records:
391387
.. code-block:: php
392388
393389
// ...
394-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
390+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;
395391
396-
/**
397-
* @Config(
398-
* routeName="oro_user_index"
399-
* )
400-
*/
392+
#[Config(
393+
routeName: "oro_user_index"
394+
)]
401395
class User
402396
{
403397
// ...
@@ -412,13 +406,11 @@ The route name of a controller that shows a particular object:
412406
.. code-block:: php
413407
414408
// ...
415-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
409+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;
416410
417-
/**
418-
* @Config(
419-
* routeView="oro_user_view"
420-
* )
421-
*/
411+
#[Config(
412+
routeView: "oro_user_view"
413+
)]
422414
class User
423415
{
424416
// ...
@@ -432,13 +424,11 @@ The route name of a controller that creates an object:
432424
.. code-block:: php
433425
434426
// ...
435-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
427+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;
436428
437-
/**
438-
* @Config(
439-
* routeCreate="oro_user_create"
440-
* )
441-
*/
429+
#[Config(
430+
routeCreate: "oro_user_create"
431+
)]
442432
class User
443433
{
444434
// ...
@@ -453,13 +443,11 @@ The route name of controller action that updates an object:
453443
.. code-block:: php
454444
455445
// ...
456-
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
446+
use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;
457447
458-
/**
459-
* @Config(
460-
* routeUpdate="oro_user_update"
461-
* )
462-
*/
448+
#[Config(
449+
routeUpdate: "oro_user_update"
450+
)]
463451
class User
464452
{
465453
// ...

‎backend/configuration/annotation/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _backend-configuration-annotation-config:
22

3-
Annotations
3+
Attributes
44
===========
55

66
.. toctree::

‎backend/configuration/annotation/title-template.rst

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
@TitleTemplate
2-
==============
1+
#[TitleTemplate]
2+
================
33

4-
This annotation is used to configure the template that is used to render the page title when the
5-
controller tagged with this annotation is accessed:
4+
This attribute is used to configure the template that is used to render the page title when the
5+
controller tagged with this attribute is accessed:
66

77
.. code-block:: php
88
99
1010
// ...
11-
use Oro\Bundle\NavigationBundle\Annotation\TitleTemplate;
11+
use Oro\Bundle\NavigationBundle\Attribute\TitleTemplate;
1212
13-
/**
14-
* @TitleTemplate("The page title")
15-
*/
13+
#[TitleTemplate("The page title")]
1614
public function demoAction()
1715
{
1816
// ...

‎backend/configuration/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:title: Annotations and YAML Configuration References in Oro Applications
1+
:title: Attributes and YAML Configuration References in Oro Applications
22

33
.. meta::
4-
:description: Examples of using annotations and YAML configuration references in the Oro applications
4+
:description: Examples of using attributes and YAML configuration references in the Oro applications
55

66
.. _dev-config-reference:
77

0 commit comments

Comments
 (0)