Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 84bfc70

Browse files
Jeanne FrontainJeanne Frontain
Jeanne Frontain
authored and
Jeanne Frontain
committed
Merge branch 'master' of github.com:magento/devdocs into email-template-patch-october-14
2 parents e964780 + 80685e0 commit 84bfc70

File tree

18 files changed

+200
-309
lines changed

18 files changed

+200
-309
lines changed

‎_includes/backward-incompatible-changes/commerce/2.2.9-2.2.10.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
### ({{ site.data.var.ee }} only) Class API membership changes {#ee-class-api-membership-229-2210}
2+
3+
| What changed | How it changed |
4+
| --- | --- |
5+
| Magento\CustomerCustomAttributes\Block\Adminhtml\Customer\ValidationMessages | Class was added. |
6+
| Magento\Banner\Model\Banner | Class was added. |

‎_includes/backward-incompatible-changes/commerce/2.3.2-2.3.3.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
### {{ site.data.var.ee }} only changes in classes {#ee-class-232-233}
2+
3+
| What changed | How it changed |
4+
| --- | --- |
5+
| Magento\SalesArchive\Block\Adminhtml\Sales\Order\View\Buttons::\_\_construct | [public] Method parameter typing changed. |
6+
| Magento\Rma\Block\Adminhtml\Order\View\Buttons::\_\_construct | [public] Method parameter typing changed. |

‎_includes/backward-incompatible-changes/open-source/2.2.9-2.2.10.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### Class changes {#class-229-2210}
2+
3+
| What changed | How it changed |
4+
| --- | --- |
5+
| Magento\Tax\Block\Adminhtml\Rate\Form::\_construct | [protected] Method return typing changed. |
6+
| Magento\Sales\Block\Adminhtml\Items\Column\Name::truncateString | [public] Method parameter typing removed. |
7+
| Magento\Review\Block\Customer\View::\_toHtml | [protected] Method return typing changed. |
8+
| Magento\Eav\Model\Entity\Attribute\Source\Store::getAllOptions | [public] Method return typing changed. |
9+
| Magento\Directory\Model\Config\Source\Country\Full::toOptionArray | [public] Method return typing changed. |
10+
| Magento\Config\Console\Command\ConfigSetCommand::execute | [protected] Method return typing changed. |
11+
| Magento\Reports\Block\Adminhtml\Grid::\_\_construct | [public] Method has been added. |
12+
| Magento\Eav\Model\ResourceModel\Entity\Attribute::\_beforeDelete | [protected] Method has been added. |
13+
| Magento\Eav\Model\Entity\Attribute\Source\Store::getAllOptions | [public] Added optional parameter(s). |
14+
| Magento\Directory\Model\ResourceModel\Country::\_\_construct | [public] Method has been added. |
15+
| Magento\Directory\Model\Config\Source\Country\Full::toOptionArray | [public] Added optional parameter(s). |
16+
17+
### Interface changes {#interface-229-2210}
18+
19+
| What changed | How it changed |
20+
| --- | --- |
21+
| Magento\Vault\Api\PaymentTokenManagementInterface::getListByCustomerId | [public] Method return typing changed. |
22+
| Magento\Sales\Api\CreditmemoCommentRepositoryInterface::getList | [public] Method return typing changed. |
23+
| Magento\Sales\Api\CreditmemoManagementInterface::getCommentsList | [public] Method return typing changed. |
24+
| Magento\Sales\Api\OrderManagementInterface::getCommentsList | [public] Method return typing changed. |
25+
| Magento\Sales\Api\OrderStatusHistoryRepositoryInterface::getList | [public] Method return typing changed. |
26+
| Magento\Sales\Api\Data\CreditmemoInterface::getComments | [public] Method return typing changed. |

‎_includes/backward-incompatible-changes/open-source/2.3.2-2.3.3.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
### Class changes {#class-232-233}
2+
3+
| What changed | How it changed |
4+
| --- | --- |
5+
| Magento\Framework\Mail\Template\TransportBuilder::getTransport | [public] Method return typing changed. |
6+
| Magento\Framework\Mail\Template\TransportBuilder::getTemplate | [protected] Method return typing changed. |
7+
| Magento\Framework\DataObject\Copy::copyFieldsetToTarget | [public] Method return typing changed. |
8+
| Magento\Framework\Data\Collection\AbstractDb::\_renderFiltersBefore | [protected] Method return typing changed. |
9+
| Magento\Tax\Block\Adminhtml\Rate\Form::\_construct | [protected] Method return typing changed. |
10+
| Magento\Swatches\Block\Product\Renderer\Configurable::getHtmlOutput | [protected] Method return typing changed. |
11+
| Magento\Sales\Model\Order\Config::getStateDefaultStatus | [public] Method return typing changed. |
12+
| Magento\Sales\Model\Order\Config::getStatusFrontendLabel | [public] Method return typing changed. |
13+
| Magento\Sales\Block\Order\History::\_construct | [protected] Method return typing changed. |
14+
| Magento\Sales\Block\Order\History::\_prepareLayout | [protected] Method return typing changed. |
15+
| Magento\Sales\Block\Order\Recent::\_construct | [protected] Method return typing changed. |
16+
| Magento\Sales\Block\Order\Recent::\_toHtml | [protected] Method return typing changed. |
17+
| Magento\Sales\Block\Adminhtml\Order\View::\_\_construct | [public] Method parameter typing changed. |
18+
| Magento\Review\Block\Customer\View::\_toHtml | [protected] Method return typing changed. |
19+
| Magento\Newsletter\Model\Subscriber::received | [public] Method return typing changed. |
20+
| Magento\Newsletter\Block\Adminhtml\Problem::\_construct | [protected] Method return typing changed. |
21+
| Magento\Newsletter\Block\Adminhtml\Problem::getUnsubscribeButtonHtml | [public] Method return typing changed. |
22+
| Magento\Newsletter\Block\Adminhtml\Problem::getDeleteButtonHtml | [public] Method return typing changed. |
23+
| Magento\GraphQl\Controller\GraphQl::dispatch | [public] Method return typing changed. |
24+
| Magento\Config\Console\Command\ConfigSetCommand::execute | [protected] Method return typing changed. |
25+
| Magento\Checkout\Block\Cart\Totals::\_\_construct | [public] Method parameter typing changed. |
26+
| Magento\CatalogRule\Model\Indexer\IndexBuilder::getActiveRules | [protected] Method return typing changed. |
27+
| Magento\CatalogRule\Model\Indexer\IndexBuilder::getAllRules | [protected] Method return typing changed. |
28+
| Magento\Catalog\Model\ResourceModel\Product::getCategoryCollection | [public] Method return typing changed. |
29+
| Magento\Catalog\Model\Product\Visibility::getVisibleInCatalogIds | [public] Method return typing changed. |
30+
| Magento\Catalog\Model\Product\Visibility::getVisibleInSearchIds | [public] Method return typing changed. |
31+
| Magento\Catalog\Model\Product\Visibility::getVisibleInSiteIds | [public] Method return typing changed. |
32+
| Magento\Catalog\Block\Adminhtml\Product\Grid::\_construct | [protected] Method return typing changed. |
33+
| Magento\Catalog\Block\Adminhtml\Product\Grid::\_prepareCollection | [protected] Method return typing changed. |
34+
| Magento\Catalog\Block\Adminhtml\Product\Grid::\_addColumnFilterToCollection | [protected] Method return typing changed. |
35+
| Magento\Catalog\Block\Adminhtml\Product\Grid::\_prepareColumns | [protected] Method return typing changed. |
36+
| Magento\Catalog\Block\Adminhtml\Product\Grid::\_prepareMassaction | [protected] Method return typing changed. |
37+
| Magento\Catalog\Block\Adminhtml\Product\Grid::getGridUrl | [public] Method return typing changed. |
38+
| Magento\Catalog\Block\Adminhtml\Product\Grid::getRowUrl | [public] Method return typing changed. |
39+
| Magento\Backend\Block\Store\Switcher::\_construct | [protected] Method return typing changed. |
40+
| Magento\Wishlist\Model\ResourceModel\Item\Collection::\_renderFiltersBefore | [protected] Method has been added. |
41+
| Magento\Sales\Model\Order\Address::beforeSave | [public] Method has been added. |
42+
| Magento\Reports\Block\Adminhtml\Grid::\_\_construct | [public] Method has been added. |
43+
| Magento\PageCache\Model\Config::VARNISH\_6\_CONFIGURATION\_PATH | Constant has been added. |
44+
| Magento\Eav\Model\ResourceModel\Entity\Attribute::\_beforeDelete | [protected] Method has been added. |
45+
| Magento\Directory\Model\ResourceModel\Country::\_\_construct | [public] Method has been added. |
46+
| Magento\Backend\Model\Url::setScope | [public] Method has been added. |
47+
48+
### Interface changes {#interface-232-233}
49+
50+
| What changed | How it changed |
51+
| --- | --- |
52+
| Magento\Vault\Api\PaymentTokenManagementInterface::getListByCustomerId | [public] Method return typing changed. |
53+

‎guides/v2.2/cloud/env/variables-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ stage:
130130
- **Version**—Magento 2.1.4 and later
131131

132132
{{ .bs-callout-warning }}
133-
You must set the `CRYPT_KEY` value through the Project Web UI instead of the `.magento.env.yaml` file to avoid exposing the key in the source code repository for your environment. See [Set environment and project variables]{{ page.baseurl }}/cloud/project/project-webint-basic.html#project-conf-env-var).
133+
You must set the `CRYPT_KEY` value through the Project Web UI instead of the `.magento.env.yaml` file to avoid exposing the key in the source code repository for your environment. See [Set environment and project variables]({{ page.baseurl }}/cloud/project/project-webint-basic.html#project-conf-env-var).
134134

135135
When you move the database from one environment to another without an installation process, you need the corresponding cryptographic information. Magento uses the encryption key value set in the Web UI as the `crypt/key` value in the `env.php` file. This does not overwrite an existing encryption key value in the `env.php` file.
136136

‎guides/v2.2/cloud/project/project-conf-files_magento-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ web:
139139
```
140140

141141
{:.bs-callout-info}
142-
This example shows the default web configuration for a Cloud project configured to support a single domain. For a project that requires support for multiple websites or stores, the `web` configuration must be set up to support shared domains. See [Configure locations for shared domains]{{ page.baseurl }}/cloud/project-multi-sites.html#locations).
142+
This example shows the default web configuration for a Cloud project configured to support a single domain. For a project that requires support for multiple websites or stores, the `web` configuration must be set up to support shared domains. See [Configure locations for shared domains]({{ page.baseurl }}/cloud/project/project-multi-sites.html#locations).
143143

144144
### `disk`
145145

‎guides/v2.2/config-guide/cli/logging.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ functional_areas:
1212

1313
## Debug logging
1414

15-
By default, Magento writes to the debug log (`<install_directory>/var/log/debug.log`) when it is in default or developer mode, but not when it is in production mode. Use the `bin/magento setup:config:set --enable-debug-logging=true | false` command to change the default value.
15+
By default, Magento writes to the debug log (`<install_directory>/var/log/debug.log`) when it is in default or developer mode, but not when it is in production mode. Use the `bin/magento setup:config:set --enable-debug-logging` command to change the default value.
1616

17-
{:.bs-callout .bs-callout-info}
18-
As of Magento 2.2.8, you can no longer use the `bin/magento config:set dev/debug/debug_logging 1 | 0` command to enable or disable debug logging for the current mode.
17+
{: .bs-callout-info}
18+
As of Magento 2.2.8, you can no longer use the `bin/magento config:set dev/debug/debug_logging` command to enable or disable debug logging for the current mode.
1919

2020
### To enable debug logging
2121

@@ -25,7 +25,7 @@ As of Magento 2.2.8, you can no longer use the `bin/magento config:set dev/debug
2525
bin/magento setup:config:set --enable-debug-logging=true
2626
```
2727

28-
2. Flush the cache.
28+
1. Flush the cache.
2929

3030
```bash
3131
bin/magento cache:flush
@@ -86,7 +86,7 @@ By default, Magento writes _syslog_ logs to the operating system `syslog` file.
8686
bin/magento setup:config:set --enable-syslog-logging=true
8787
```
8888

89-
2. Flush the cache.
89+
1. Flush the cache.
9090

9191
```bash
9292
bin/magento cache:flush
@@ -104,4 +104,4 @@ By default, Magento writes _syslog_ logs to the operating system `syslog` file.
104104

105105
```bash
106106
bin/magento cache:flush
107-
```
107+
```

‎guides/v2.2/extension-dev-guide/indexing.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -31,37 +31,42 @@ This topic provides a high level description of how indexing is implemented from
3131
The following components are involved in the indexing process:
3232

3333
<table>
34-
<tbody>
35-
<tr>
36-
<th>Component</th>
37-
<th>Description</th>
38-
</tr>
39-
<tr>
40-
<td><a href="{{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Indexer" target="_blank">Magento_Indexer</a></td>
41-
<td>Implements:<ul>
42-
<li>indexer declaration</li>
43-
<li>indexer running</li>
44-
<li>indexer running mode configuration</li>
45-
<li>indexer status</li></ul></td>
46-
</tr>
47-
<tr>
48-
<td><a href="{{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Mview" target="_blank">Magento\Framework\Mview</a></td>
49-
<td><ul>
50-
<li>Allows tracking database changes for a certain [entity](https://glossary.magento.com/entity) (product, [category](https://glossary.magento.com/category), etc.) and running change handler.</li>
51-
<li>Emulates the <a href="http://en.wikipedia.org/wiki/Materialized_view" target="_blank">materialized view</a> technology for MySQL using triggers and separate materialization process (provides executing [PHP](https://glossary.magento.com/php) code instead of SQL queries, which allows materializing multiple queries).</li></ul></td>
52-
</tr>
53-
</tbody></table>
54-
55-
{: .bs-callout .bs-callout-warning }
34+
<tbody>
35+
<tr>
36+
<th>Component</th>
37+
<th>Description</th>
38+
</tr>
39+
<tr>
40+
<td><a href="{{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Indexer" target="_blank">Magento_Indexer</a></td>
41+
<td>Implements:
42+
<ul>
43+
<li>indexer declaration</li>
44+
<li>indexer running</li>
45+
<li>indexer running mode configuration</li>
46+
<li>indexer status</li>
47+
</ul>
48+
</td>
49+
</tr>
50+
<tr>
51+
<td><a href="{{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Mview" target="_blank">Magento\Framework\Mview</a></td>
52+
<td>
53+
<ul>
54+
<li>Allows tracking database changes for a certain <a href="https://glossary.magento.com/entity" target="_blank">entity</a> (product, <a href="https://glossary.magento.com/category" target="_blank">category</a>, etc.) and running change handler.</li>
55+
<li>Emulates the <a href="http://en.wikipedia.org/wiki/Materialized_view" target="_blank">materialized view</a> technology for MySQL using triggers and separate materialization process (provides executing <a href="https://glossary.magento.com/php" target="_blank">PHP</a> code instead of SQL queries, which allows materializing multiple queries).</li>
56+
</ul>
57+
</td>
58+
</tr>
59+
</tbody>
60+
</table>
61+
62+
{: .bs-callout-warning }
5663
`Magento_Indexer` replaces the Magento 1.x `Magento_Index` module. Use `Magento_Indexer` for all new development.
5764

5865
### Indexing types
5966

6067
Each index can perform the following types of reindex operations:
6168

62-
* Full reindex, which means rebuilding all the indexing-related database tables
63-
Full reindexing can be caused by a variety of things, including creating a new web store or new customer group.
64-
You can optionally fully reindex at any time using the [command line]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-index.html).
69+
* Full reindex, which means rebuilding all the indexing-related database tables. Full reindexing can be caused by a variety of things, including creating a new web store or new customer group. You can optionally fully reindex at any time using the [command line]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-index.html).
6570

6671
* Partial reindex, which means rebuilding the database tables only for the things that changed (like changing a single product attribute or price)
6772

@@ -88,7 +93,7 @@ Reindexing can be performed in two modes:
8893
* Update on Save - index tables are updated immediately after the dictionary data is changed.
8994
* Update by Schedule - index tables are updated by cron job according to the configured schedule.
9095

91-
{:.bs-callout .bs-callout-info}
96+
{: .bs-callout-info }
9297
**Update by Schedule** does not support the `customer_grid` indexer. You must either use **Update on Save** or reindex the customer grid manually (`bin/magento indexer:reindex customer_grid`). See the [Help Center article](https://support.magento.com/hc/en-us/articles/360025481892-New-customer-records-are-not-displayed-in-the-Customers-grid-after-importing-them-from-CSV).
9398

9499
To set these options:

‎guides/v2.2/frontend-dev-guide/themes/theme-create.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,10 @@ To learn more about theme layouts, refer to the [Layout section]({{page.baseurl}
260260

261261
## Troubleshooting {#trouble}
262262

263-
When your theme changes are not visible even after clearing the cache, try redeploying your static files using `magento setup:static-content:deploy en_US` (replacing the language/locale as appropriate).
263+
When your theme changes are not visible even after clearing the cache, try redeploying your static files using the `magento setup:static-content:deploy` command, or add the `-f` argument to force deploy static content in any deployment mode in case you are not in production mode.
264+
265+
{: .bs-callout-info }
266+
Running this command with the `-f` argument can fix issues regarding deployment of static content, but it removes **all** symlinks and deploys the actual static content files.
264267

265268
## What's next {#next}
266269

‎guides/v2.2/release-notes/backward-incompatible-changes/reference.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ All changes are generated automatically using the codebase of the corresponding
1414
The changes are aggregated into two tables:
1515

1616
1. **Changes in classes** that contains backward incompatible changes made to the Magento classes
17-
2. **Changes in interfaces** that contains backward incompatible changes made to the Magento interfaces
17+
1. **Changes in interfaces** that contains backward incompatible changes made to the Magento interfaces
18+
19+
## 2.2.9 - 2.2.10 {#releases-2_2_9-2_2_10}
20+
21+
{% include backward-incompatible-changes/open-source/2.2.9-2.2.10.md %}
22+
23+
{% include backward-incompatible-changes/commerce/2.2.9-2.2.10.md %}
1824

1925
## 2.2.8 - 2.2.9 {#releases-2_2_8-2_2_9}
2026

0 commit comments

Comments
 (0)