Merge branch '8.x' into customizeCrud

PrestaShop · Nov 7, 2023 · c77c8b0 · c77c8b0
2 parents 903a4a3 + 8b1fa2c
commit c77c8b0
Show file tree

Hide file tree

Showing 438 changed files with 5,442 additions and 7,809 deletions.
diff --git a/README.md b/README.md
@@ -23,3 +23,57 @@ The deployment pipeline is documented on the [sources repository for DevDocs](ht
 ## License
 
 Content from this documentation is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
+
+## Maintaining Hook list referential
+
+A complete referential of hook and informations on each hook is located in `modules/concepts/hooks/list-of-hooks/`. 
+
+This referential can be generated with a script, crawling all: 
+
+- PrestaShop (core) codebase
+- all native modules
+- all native themes
+
+In the documentation, a hook is described in yaml format: 
+
+```yaml
+---
+Title: string #name of the hook
+hidden: boolean[true] #must be true
+hookTitle: string #title for the description
+description: string #description sentence
+origin: string #core, module or theme
+files:
+    -
+        theme: string #theme name only if origin=theme
+        module: string #module name only if origin=module
+        url: string #url of the file on github
+        file: string #path of the file
+locations:
+    - string #back office, front office or both
+type: string #action or display
+hookAliases:
+    - string #old hook name or alias
+array_return: boolean #true or false if the hook has an `$array_return` parameter set to `true`
+check_exceptions: boolean #true or false if the hook has a `$check_exceptions` parameter set to `false`
+chain: boolean #true or false if the hook has a `$chain` parameter set to `true` 
+---
+```
+
+This YAML structure enables the shortcode `hookDescriptor` to generate an HTML page with condensed information for documentation, and allows the search script to search within this metadata.
+
+Next, add the shortcode in the page's content: 
+
+```
+{{% hookDescriptor %}}
+```
+
+Finally, if available, add a section with a code example and parameters details: 
+
+```
+## Parameters details
+[...]
+
+## Call of the Hook in the origin file
+[...]
+```
diff --git a/_index.md b/_index.md
@@ -10,4 +10,4 @@ hookListUrl: "/8/modules/concepts/hooks/list-of-hooks"  # this allows for dynami
 
 # PrestaShop 8 Documentation
 
-{{% children %}}
+{{% children /%}}
diff --git a/basics/_index.md b/basics/_index.md
@@ -13,4 +13,4 @@ icon: fa-play
 
 Discover what PrestaShop is all about and the core concepts behind it.
 
-{{% children %}}
+{{% children /%}}
diff --git a/basics/deployment/_index.md b/basics/deployment/_index.md
@@ -6,4 +6,4 @@ showOnHomepage: true
 
 # Deployment
 
-{{% children %}}
+{{% children /%}}
diff --git a/basics/installation/_index.md b/basics/installation/_index.md
@@ -155,7 +155,7 @@ PrestaShop comes in two "flavors":
 - **Release package**. A zip package, tuned for production environments.
 - **Development version**. The raw source code as it is on the GitHub repository, including automated test suites, build scripts and source codes for assets that are otherwise compiled (like javascript and css files).
 
-![Download files](../img/Prestashop_1.7.8.6_release.png)
+![Download files](img/Prestashop_1.7.8.6_release.png)
 
 {{% notice tip %}}
 **Prefer cloning the repository using git for the development version.**

diff --git a/basics/installation/advanced/_index.md b/basics/installation/advanced/_index.md
@@ -6,4 +6,4 @@ chapter: true
 
 # Advanced topics on PrestaShop Installation
 
-{{% children %}}
+{{% children /%}}
diff --git a/basics/keeping-up-to-date/_index.md b/basics/keeping-up-to-date/_index.md
@@ -91,5 +91,5 @@ A migration consists in:
 
 ## Read more
 
-{{% children %}}
+{{% children /%}}
 
diff --git a/basics/keeping-up-to-date/upgrade-module/_index.md b/basics/keeping-up-to-date/upgrade-module/_index.md
@@ -11,7 +11,7 @@ Also known as the "Autoupgrade module" or the "1-click upgrade module", PrestaSh
 
 Details on how to use the web interface are documented in [Keep up-to-date: Upgrade Assistant page]({{< ref "/8/basics/keeping-up-to-date/use-autoupgrade-module.md" >}}).
 
-{{% children %}}
+{{% children /%}}
 
 ## How to download it
 

diff --git a/contribute/_index.md b/contribute/_index.md
@@ -15,4 +15,4 @@ PrestaShop is a community project, made by hundreds of people collaborating arou
 
 - [How to get involved in the project](https://www.prestashop-project.org/get-involved/)
 
-{{% children %}}
+{{% children /%}}
diff --git a/contribute/contribute-pull-requests/_index.md b/contribute/contribute-pull-requests/_index.md
@@ -37,4 +37,4 @@ If you wish to start contributing smoothly, have a look at [issues labelled "goo
 
 We explain two ways to run PrestaShop from the sources: using docker or localhost
 
-{{% children %}}
+{{% children /%}}
diff --git a/contribute/contribution-process/_index.md b/contribute/contribution-process/_index.md
@@ -10,4 +10,4 @@ showOnHomepage: true
 
 The PrestaShop project receives a great number of new issues and Pull Requests every week. Each new submission goes through a process where PrestaShop maintainers analyze, qualify and prioritize them.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/_index.md b/development/_index.md
@@ -14,4 +14,4 @@ icon: fa-book
 
 This section describes technical aspects of the PrestaShop Core.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/_index.md b/development/architecture/_index.md
@@ -13,5 +13,5 @@ PrestaShop has been built as a monolith following traditional object-oriented PH
 
 ## Topics
 
-{{% children description="true" %}}
+{{% children description="true" /%}}
 
diff --git a/development/architecture/domain/_index.md b/development/architecture/domain/_index.md
@@ -18,4 +18,4 @@ One of the main features at the heart of this design is _Command-Query Responsib
 
 ## Read more
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/domain/references/_index.md b/development/architecture/domain/references/_index.md
@@ -5,4 +5,4 @@ weight: 60
 
 # List of available Commands and Queries
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/legacy/_index.md b/development/architecture/legacy/_index.md
@@ -9,4 +9,4 @@ summary: "This section describes components from the Legacy architecture."
 
 This section describes components from the Legacy architecture.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/migration-guide/_index.md b/development/architecture/migration-guide/_index.md
@@ -35,4 +35,4 @@ This is the list of items that usually need to be done in order to complete the
 
 ## Contents of this guide
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/migration-guide/forms/_index.md b/development/architecture/migration-guide/forms/_index.md
@@ -71,5 +71,5 @@ Forms are created and declared [as services](https://symfony.com/doc/4.4/form/fo
 
 ## Learn more
 
-{{% children %}}
+{{% children /%}}
 
diff --git a/development/architecture/migration-guide/forms/settings-forms.md b/development/architecture/migration-guide/forms/settings-forms.md
@@ -126,7 +126,6 @@ So, there are basically three steps:
 Every form in modern controllers must be handled this way, and the controller code should be kept minimalist and easy to read and understand.
 {{% /notice %}}
 
-{{% callout %}}
 ##### Summary with a schema
 
 The following schemas sums up how Form Handlers, Form Builders, Controllers and Data Providers are wired together.

diff --git a/development/architecture/migration-guide/testing/_index.md b/development/architecture/migration-guide/testing/_index.md
@@ -10,4 +10,4 @@ you have created.
 
 You **must** add a [smoke test]({{< relref "/8/development/architecture/migration-guide/testing/unit#smoke-testing" >}}) (also called "survival") for every new page you migrate.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/architecture/modern/_index.md b/development/architecture/modern/_index.md
@@ -9,4 +9,4 @@ summary: "This section describes components from the Modern architecture."
 
 This section describes components from the Modern architecture.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/_index.md b/development/components/_index.md
@@ -8,4 +8,4 @@ showOnHomepage: true
 
 # Components
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/configuration/_index.md b/development/components/configuration/_index.md
@@ -147,3 +147,4 @@ $configuration->set(
 {{% notice note %}}
 Check the [config console command]({{< relref "/8/development/components/console/prestashop-config" >}}) for setting values from CLI
 
+{{% /notice %}}
diff --git a/development/components/console/_index.md b/development/components/console/_index.md
@@ -7,4 +7,4 @@ menuTitle: Console
 
 PrestaShop uses the [Symfony Console](https://symfony.com/doc/current/components/console.html) component and provides its own set of commands.
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/database/db.md b/development/components/database/db.md
@@ -18,7 +18,7 @@ The first call to this method initializes the link to the database, and return t
 In some cases, you might encounter this alternative:
 
 ```php
-$db = Db::getInstance(_PS_USE_SQL_SLAVE_);
+$db = \Db::getInstance(_PS_USE_SQL_SLAVE_);
 ```
 
 If PrestaShop's database user allows the use of MySQL slave servers in its architecture, then this last instance's connection can be done on the slave servers.
@@ -56,7 +56,7 @@ It should only be used for read only queries: SELECT, SHOW, etc.
 Using getRow() method will retrieve the first row of your query:
 
 ```php
-$request = "SELECT `id_table` FROM `' . _DB_PREFIX_ . 'some_table` ...";
+$request = 'SELECT `id_table` FROM `' . _DB_PREFIX_ . 'some_table` ...';
 
 /** @var array $result */
 $result = $db->getRow($request);
@@ -70,7 +70,7 @@ This function automatically adds "LIMIT 1" to the query.
 #### Retrieving only a single value
 
 ```php
-$request = "SELECT `count('sales')` FROM `' . _DB_PREFIX_ . 'some_table` ...";
+$request = 'SELECT `count('sales')` FROM `' . _DB_PREFIX_ . 'some_table` ...';
 
 /** @var string|false $salesCount */
 $salesCount = $db->getValue($request);
@@ -103,7 +103,7 @@ Returns the number of rows impacted by the latest `INSERT`, `UPDATE`, `REPLACE`
 ### Execute a raw SQL request (UPDATE, INSERT...)
 
 ```php
-$request = "INSERT INTO `' . _DB_PREFIX_ . 'some_table` (`id_table`) VALUES (10)";
+$request = 'INSERT INTO `' . _DB_PREFIX_ . 'some_table` (`id_table`) VALUES (10)';
 
 /** @var bool $result */
 $result = $db->execute($request);
@@ -141,7 +141,7 @@ The result is a boolean whose state indicates if the request was properly execut
 : If false, PrestaShop's cache management is disabled during this query. Do not change this parameter unless you knew exactly what you are doing.
 
 `$type`
-: If you wish to change the insertion, this parameter can take the following constants: `Db::INSERT`, `Db::INSERT_IGNORE` or `Db::REPLACE`.
+: If you wish to change the insertion, this parameter can take the following constants: `Db::INSERT`, `Db::INSERT_IGNORE`, `Db::REPLACE` or `Db::ON_DUPLICATE_KEY`.
 
 `$add_prefix`
 : If false, table prefix will not be automatically added to the table name.

diff --git a/development/components/export/_index.md b/development/components/export/_index.md
@@ -5,4 +5,4 @@ menuTitle: Export
 
 # Export Components
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/faceted-search/_index.md b/development/components/faceted-search/_index.md
@@ -24,4 +24,4 @@ Any change in the behavior of the `CategoryController` or a template renaming re
 {{< figure src="img/facetedsearch.png" title="Faceted search screenshot" >}}
 
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/grid/_index.md b/development/components/grid/_index.md
@@ -414,4 +414,4 @@ You can update this schema using the [source XML file](/8/schemas/grid_workflow_
 
 ## Learn more
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/components/grid/tutorials/_index.md b/development/components/grid/tutorials/_index.md
@@ -6,4 +6,4 @@ chapter: true
 
 # Grid tutorials
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/configuration/_index.md b/development/configuration/_index.md
@@ -8,4 +8,4 @@ showOnHomepage: true
 
 # PrestaShop configuration reference
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/internationalization/_index.md b/development/internationalization/_index.md
@@ -22,4 +22,4 @@ In this section you'll learn more about how to work with PrestaShop's internatio
 
 #### In this section
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/internationalization/translation/introduction.md b/development/internationalization/translation/introduction.md
@@ -42,7 +42,7 @@ PrestaShop uses Symfony's [Translator Component](https://symfony.com/doc/4.4/tra
 
 This component is initialized for the configured language by loading five Catalogue Resources:
 
-* **Customized translations database** - Located in the `ps_translations` table.
+* **Customized translations database** - Located in the `ps_translation` table.
 * **Active theme** – XLF files in `./themes/<themename>/translations`.
 * **Core** – XLF files in `./translations`.
 * **Active modules** – XLF files in `./modules/<modulename>/translations`.

diff --git a/development/multistore/_index.md b/development/multistore/_index.md
@@ -13,4 +13,4 @@ Moreover the Back Office interface is modified to allow Back Office users to man
 
 ## Topics
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/naming-conventions/_index.md b/development/naming-conventions/_index.md
@@ -192,8 +192,7 @@ services:
 
 ### Named arguments
 
-**Do NOT** use "named argument" syntax in service declaration:
-
+**Do NOT** use "named argument" syntax in your front services declaration:
 
 ```yaml
 services:
@@ -206,9 +205,13 @@ services:
   wrong_foo_bar:
       class: 'Foo\Bar'
       arguments:
-        - $baz: 'baz'
+        $baz: 'baz'
 ```
 
+If you do try to use named arguments in your front services definition you will end up with the following error:
+
+> Fatal error: Uncaught Symfony\Component\DependencyInjection\Exception\RuntimeException: Invalid service "wrong_foo_bar": class "Foo\Bar" does not exist.
+
 ## Grid
 
 PrestaShop comes with a lot of Grids (Products, Customers, Orders & etc) and keeping consistency between them is very important, thats why it follows these naming conventions:

diff --git a/development/page-reference/_index.md b/development/page-reference/_index.md
@@ -6,4 +6,4 @@ chapter: true
 
 # Page Reference
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/page-reference/back-office/_index.md b/development/page-reference/back-office/_index.md
@@ -6,4 +6,4 @@ chapter: true
 
 # Back Office Pages
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/page-reference/back-office/order/_index.md b/development/page-reference/back-office/order/_index.md
@@ -7,4 +7,4 @@ chapter: true
 
 # Order Detail Page
 
-{{% children %}}
+{{% children /%}}
diff --git a/development/page-reference/back-office/product/_index.md b/development/page-reference/back-office/product/_index.md
@@ -7,4 +7,4 @@ chapter: true
 
 # Product Page
 
-{{% children %}}
+{{% children /%}}
diff --git a/faq/_index.md b/faq/_index.md
@@ -16,4 +16,4 @@ This section aim is to become the source of truth for the PrestaShop community t
 
 If someone asks you similar questions and you know answers, please do not hesitate - create a pull request and help to fill this section up! 
 
-{{% children %}}
+{{% children /%}}
diff --git a/faq/tips-and-tricks/_index.md b/faq/tips-and-tricks/_index.md
@@ -8,4 +8,4 @@ showOnHomepage: true
 
 # Tips & tricks
 
-{{% children %}}
+{{% children /%}}
diff --git a/modules/_index.md b/modules/_index.md
@@ -17,4 +17,4 @@ programs that make use of PrestaShop's functionalities and changes them
 or add to them in order to make PrestaShop easier to use or more
 tailored to the merchant's needs.
 
-{{% children %}}
+{{% children /%}}
diff --git a/modules/concepts/_index.md b/modules/concepts/_index.md
@@ -7,4 +7,4 @@ showOnHomepage: true
 
 # Extension concepts
 
-{{% children %}}
+{{% children /%}}