You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/architecture/basics/diagrams.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Visualize the architectural layers of Adobe Commerce and Magento Op
5
5
6
6
# Architectural diagram
7
7
8
-
Depending upon your role and purpose for learning more about Adobe Commerce and Magento Open Source, there are several different ways to view the architecture. For example, a developer who wants to create new modules or perhaps customize an existing [module](https://glossary.magento.com/module) will want to understand the architecture of a module itself, and how it fits into the larger view, with the Adobe Commerce and Magento Open Source framework (Commerce framework) and other components. However, a merchant who wants to quickly build an online storefront wants to view the collection of components from a higher level, and understand the components that impact the look, feel, and user interaction components.
8
+
Depending upon your role and purpose for learning more about Adobe Commerce and Magento Open Source, there are several different ways to view the architecture. For example, a developer who wants to create new modules or perhaps customize an existing module will want to understand the architecture of a module itself, and how it fits into the larger view, with the Adobe Commerce and Magento Open Source framework (Commerce framework) and other components. However, a merchant who wants to quickly build an online storefront wants to view the collection of components from a higher level, and understand the components that impact the look, feel, and user interaction components.
9
9
10
10
The following diagram illustrates the components and shows the "layers" or tiers in the Commerce framework.
Copy file name to clipboardExpand all lines: src/pages/architecture/basics/frontend-customization.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ description: Discover tools designed to help you customize your Adobe Commerce o
5
5
6
6
# Frontend customization
7
7
8
-
The [frontend](https://glossary.magento.com/frontend) is designed to optimize [storefront](https://glossary.magento.com/storefront) customization, with highly extensible *themes* being the central customization mechanism.
8
+
The frontend is designed to optimize storefront customization, with highly extensible *themes* being the central customization mechanism.
9
9
10
10
Merchants are encouraged to use components and themes to extend and transform the appearance of their storefronts.
11
11
12
12
## Storefront customization tools
13
13
14
14
Adobe provides several tools to help you significantly jumpstart the storefront customization process:
@@ -32,25 +32,25 @@ Using standard coding and styling tools can help:
32
32
* Enforce for consistency in design across your storefronts
33
33
* Simplify (and speed up) the design process
34
34
35
-
This component [library](https://glossary.magento.com/library) contains standard reusable components for form features, such as fields and buttons, and navigation elements. The UI library is a set of generic web components and Commerce-specific patterns, which simplifies the process of theme creation and customization.
35
+
This component library contains standard reusable components for form features, such as fields and buttons, and navigation elements. The UI library is a set of generic web components and Commerce-specific patterns, which simplifies the process of theme creation and customization.
36
36
37
37
See [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/) for details about this library.
38
38
39
39
### Admin pattern library
40
40
41
41
A *pattern library* is a collection of user interface (UI) design patterns that can be re-used in locations throughout your product installation. The [Admin Pattern Library](https://developer.adobe.com/commerce/admin-developer/pattern-library/) defines examples of components that administrators working with the storefront can use.
42
42
43
-
Form elements included in the [Admin](https://glossary.magento.com/magento-admin) pattern library include:
43
+
Form elements included in the Admin pattern library include:
44
44
45
45
* address form
46
46
* button bar
47
47
* container
48
48
* tabs
49
49
* sign-in form
50
50
51
-
Users of the default storefront encounter examples of these form elements throughout the product. These patterns provide a valuable language of software components (and indirectly, user experiences) for [extension](https://glossary.magento.com/extension) developers and administrators.
51
+
Users of the default storefront encounter examples of these form elements throughout the product. These patterns provide a valuable language of software components (and indirectly, user experiences) for extension developers and administrators.
52
52
53
-
The [Admin Pattern library](https://glossary.magento.com/admin) is built on the Less preprocessor and implemented as a [module](https://glossary.magento.com/module). You can download a free, current version of this module from [Commerce Marketplace](https://marketplace.magento.com/).
53
+
The Admin Pattern library is built on the Less preprocessor and implemented as a module. You can download a free, current version of this module from [Commerce Marketplace](https://marketplace.magento.com/).
54
54
55
55
See [Admin Pattern Library](https://developer.adobe.com/commerce/admin-developer/pattern-library/) for more information on using this library.
56
56
@@ -60,11 +60,11 @@ These four levels of potential storefront customization are listed in order to i
60
60
61
61
### Extend CSS
62
62
63
-
Commerce supplies a default [theme](https://glossary.magento.com/theme) and a Less-based CSS. You can substantially change a storefront using CSS only. This uncomplicated strategy might suit projects with a limited budget, or might interest developers who create different skins for a site. A small business enter this process of storefront customization by buying a third-party developed theme from Commerce Marketplace to extend the default values.
63
+
Commerce supplies a default theme and a Less-based CSS. You can substantially change a storefront using CSS only. This uncomplicated strategy might suit projects with a limited budget, or might interest developers who create different skins for a site. A small business enter this process of storefront customization by buying a third-party developed theme from Commerce Marketplace to extend the default values.
64
64
65
65
### Replace PHTML template files
66
66
67
-
In addition to extending the default CSS, you can generate different HTML [markup](https://glossary.magento.com/markup). For example, you might need to add a missing CSS class name, or add an extra `<div>` tag to achieve some visual effect. You might also need to tweak some [JavaScript](https://glossary.magento.com/javascript/) to cope with different HTML markup. This change is more demanding than simply extending CSS, but is still within the grasp of smaller projects and leaner teams.
67
+
In addition to extending the default CSS, you can generate different HTML markup. For example, you might need to add a missing CSS class name, or add an extra `<div>` tag to achieve some visual effect. You might also need to tweak some JavaScript to cope with different HTML markup. This change is more demanding than simply extending CSS, but is still within the grasp of smaller projects and leaner teams.
68
68
69
69
### Replace CSS
70
70
@@ -78,4 +78,4 @@ Delivering a sharply different shopping experience than the default Commerce ins
78
78
79
79
<InlineAlertvariant="success"slots="text"/>
80
80
81
-
Any customization of your storefront will work optimally, and provide the easiest path for later upgrades, if you follow the best practice of consistently compartmentalizing code by type. For example, keep all HTML in [PHTML](https://glossary.magento.com/phtml) files; keep all JavaScript in JavaScript files.
81
+
Any customization of your storefront will work optimally, and provide the easiest path for later upgrades, if you follow the best practice of consistently compartmentalizing code by type. For example, keep all HTML in PHTML files; keep all JavaScript in JavaScript files.
Copy file name to clipboardExpand all lines: src/pages/architecture/basics/security.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Adobe has strengthened the hashing algorithms (SHA-256) used in password managem
17
17
18
18
### Improved prevention of cross-site scripting (XSS) attacks by making escaped data the default
19
19
20
-
The Commerce framework has adopted conventions that regulate the escaping of data in output. These conventions include the ability to escape output for [HTML](https://glossary.magento.com/html) pages (HTML, JSON, and JavaScript) and email. Where possible, escaping is transparent to client code. See [Security measures against XSS attacks](https://developer.adobe.com/commerce/php/development/security/cross-site-scripting/) in the [Frontend](https://glossary.magento.com/frontend) Developer Guide.
20
+
The Commerce framework has adopted conventions that regulate the escaping of data in output. These conventions include the ability to escape output for HTML pages (HTML, JSON, and JavaScript) and email. Where possible, escaping is transparent to client code. See [Security measures against XSS attacks](https://developer.adobe.com/commerce/php/development/security/cross-site-scripting/) in the Frontend Developer Guide.
21
21
22
22
### More flexible file system ownership and permissions
23
23
@@ -35,4 +35,4 @@ The Commerce framework safeguards your store from clickjacking attacks by using
35
35
36
36
### Use of non-default Admin URL
37
37
38
-
A simple [Admin](https://glossary.magento.com/magento-admin)[URL](https://glossary.magento.com/url) (like `admin` or `backend`) makes it easy to target attacks on specific locations using automated password guessing. To prevent against this type of attack, the Commerce framework by default creates a random Admin URI when you install the product. The CLI command `php bin/magento info:adminuri` is provided so that you can see the URI if you forget it. You can also use the CLI to change this URI. Although the use of a non-default admin URL will not secure the site, its use will help prevent large-scale automated attacks. See [Display or change the Admin URI](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-adminurl.html) in Configuration Guide for more information.
38
+
A simple AdminURL (like `admin` or `backend`) makes it easy to target attacks on specific locations using automated password guessing. To prevent against this type of attack, the Commerce framework by default creates a random Admin URI when you install the product. The CLI command `php bin/magento info:adminuri` is provided so that you can see the URI if you forget it. You can also use the CLI to change this URI. Although the use of a non-default admin URL will not secure the site, its use will help prevent large-scale automated attacks. See [Display or change the Admin URI](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-adminurl.html) in Configuration Guide for more information.
Copy file name to clipboardExpand all lines: src/pages/architecture/framework.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@ description: Learn how the Commerce framework controls the way application compo
5
5
6
6
# Commerce framework
7
7
8
-
The Adobe Commerce and Magento Open Source framework (Commerce framework) controls how application components interact, including request flow, routing, indexing, caching, and [exception](https://glossary.magento.com/exception) handling. It provides services that reduce the effort of creating modules that contain business logic, contributing to the goal of both making Commerce code more modular as well as decreasing dependencies.
8
+
The Adobe Commerce and Magento Open Source framework (Commerce framework) controls how application components interact, including request flow, routing, indexing, caching, and exception handling. It provides services that reduce the effort of creating modules that contain business logic, contributing to the goal of both making Commerce code more modular as well as decreasing dependencies.
9
9
10
-
This primarily [PHP](https://glossary.magento.com/php) software component is organized into logical groups called *libraries*, which all modules can call. Most of the framework code sits under the domain layer or encloses the presentation, service, and domain layers. The framework contains no business logic.
11
-
(Although the Commerce framework does not contain resource models, it does contain a [library](https://glossary.magento.com/library) of code to help implement a resource model.)
10
+
This primarily PHP software component is organized into logical groups called *libraries*, which all modules can call. Most of the framework code sits under the domain layer or encloses the presentation, service, and domain layers. The framework contains no business logic.
11
+
(Although the Commerce framework does not contain resource models, it does contain a library of code to help implement a resource model.)
12
12
13
13
<InlineAlertvariant="success"slots="text"/>
14
14
@@ -42,19 +42,19 @@ lib/
42
42
../web
43
43
```
44
44
45
-
*`/vendor/magento/framework` contains only PHP code. These are libraries of code plus the application entry point that routes requests to modules (that in turn call the Framework libraries). For example, libraries in the Framework help implement a resource model (base classes and interfaces to inherit from) but not the resource models themselves. Certain libraries also support [CSS](https://glossary.magento.com/css) rendering.
45
+
*`/vendor/magento/framework` contains only PHP code. These are libraries of code plus the application entry point that routes requests to modules (that in turn call the Framework libraries). For example, libraries in the Framework help implement a resource model (base classes and interfaces to inherit from) but not the resource models themselves. Certain libraries also support CSS rendering.
46
46
47
-
*`/lib/internal` contains some non-PHP as well as PHP components. Non-PHP framework libraries includes [JavaScript](https://glossary.magento.com/javascript) and LESS/CSS.
47
+
*`/lib/internal` contains some non-PHP as well as PHP components. Non-PHP framework libraries includes JavaScript and LESS/CSS.
48
48
49
49
*`/lib/web` contains JavaScript and CSS/LESS files. These files reside under `web` and not `internal` because they are accessible from a web browser, while the PHP code under `internal` is not. (Any code that a web browser must access should be under `web`, while everything else under `internal`.)
50
50
51
51
<InlineAlertvariant="success"slots="text"/>
52
52
53
-
The `vendor/magento/framework` directory maps to the `Magento\Framework`[namespace](https://glossary.magento.com/namespace).
53
+
The `vendor/magento/framework` directory maps to the `Magento\Framework` namespace.
54
54
55
55
## Framework highlights
56
56
57
-
The Commerce framework (`lib/internal/Magento/Framework/`) provides a robust range of functionality. If you are an [extension](https://glossary.magento.com/extension) developer, you may be interested in this subset of Framework namespaces.
57
+
The Commerce framework (`lib/internal/Magento/Framework/`) provides a robust range of functionality. If you are an extension developer, you may be interested in this subset of Framework namespaces.
Copy file name to clipboardExpand all lines: src/pages/architecture/layers/domain.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn about the architectural domain layer of the Commerce framewor
5
5
6
6
# Domain layer
7
7
8
-
The domain layer holds the business logic layer of a [module](https://glossary.magento.com/module). It typically does not contain resource-specific or database-specific information. Its primary functions include:
8
+
The domain layer holds the business logic layer of a module. It typically does not contain resource-specific or database-specific information. Its primary functions include:
9
9
10
10
* Defining the generic data objects, or models, that contain business logic. This logic defines which operations can be performed on particular types of data, such as a Customer object. These models contain generic information only. Applications can also use SOAP or RESTful endpoints to request data from models.
Copy file name to clipboardExpand all lines: src/pages/architecture/layers/index.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: Learn about layered application design and details about each layer
7
7
8
8
At its highest level, the Adobe Commerce and Magento Open Source framework (Commerce framework) architecture consists of the core product code plus optional *modules*. These optional modules enhance or replace the basic product code.
9
9
10
-
If you are substantially customizing the basic Adobe Commerce or Magento Open Source product, [module](https://glossary.magento.com/module) development will be your central focus. Modules organize code that supports a particular task or feature. A module can include code to change the look-and-feel of your [storefront](https://glossary.magento.com/storefront) as well as its fundamental behavior.
10
+
If you are substantially customizing the basic Adobe Commerce or Magento Open Source product, module development will be your central focus. Modules organize code that supports a particular task or feature. A module can include code to change the look-and-feel of your storefront as well as its fundamental behavior.
11
11
12
12
Your modules function with the core product code, which is organized into layers. Understanding layered software pattern is essential for understanding basic Adobe Commerce and Magento Open Source product organization.
13
13
@@ -17,6 +17,6 @@ Layered software is a popular, widely discussed principle in software developmen
17
17
18
18
Layered application design offers many advantages, but users of the Commerce framework will appreciate:
19
19
20
-
* Stringent separation of business logic from presentation logic simplifies the customization process. For example, you can alter your storefront appearance without affecting any of the [backend](https://glossary.magento.com/backend) business logic.
20
+
* Stringent separation of business logic from presentation logic simplifies the customization process. For example, you can alter your storefront appearance without affecting any of the backend business logic.
21
21
22
-
* Clear organization of code predictably points [extension](https://glossary.magento.com/extension) developers to code location.
22
+
* Clear organization of code predictably points extension developers to code location.
0 commit comments