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: docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Fields for eCommerce data
2
2
3
-
eZ Commerce uses custom Fields to store eCommerce related data, for example for the catalog or basket.
3
+
[[= product_name_com =]] uses custom Fields to store eCommerce related data, for example for the catalog or basket.
4
4
5
5
The shop provides a flexible way to store data using concrete instances of classes implementing `FieldInterface` and inheriting from the `AbstractField` class.
6
6
Fields are used for fixed attributes of a product/catalog and for flexible attributes (property `dataMap` in [`CatalogElement`](../../../guide/catalog/catalog_api/catalog_element.md)).
Copy file name to clipboardExpand all lines: docs/api/creating_custom_rest_api_response.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Customized REST API response can be used in many situations, both for headless and more traditional setups. REST responses can be enriched in a clean way and limit client-to-server round trips.
4
4
5
-
To do this you can take advantage of eZ Platform's [HATEOAS-based](https://en.wikipedia.org/wiki/HATEOAS) REST API and extend it with custom Content Types for your own needs. In this section you will add comments count to `eZ\Publish\API\Repository\Values\Content\VersionInfo` responses.
5
+
To do this you can take advantage of [[= product_name_oss =]]'s [HATEOAS-based](https://en.wikipedia.org/wiki/HATEOAS) REST API and extend it with custom Content Types for your own needs. In this section you will add comments count to `eZ\Publish\API\Repository\Values\Content\VersionInfo` responses.
6
6
7
7
## Implementation of dedicated Visitor
8
8
@@ -246,7 +246,7 @@ Please note that you should set a proper `Accept` header value. For this example
Copy file name to clipboardExpand all lines: docs/api/field_type_api.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
## Basic information
4
4
5
5
Field Types are the smallest building blocks of content.
6
-
eZ Platform comes with many [built-in Field Types](field_type_reference.md#available-field-types) that cover most common needs e.g. Text line, Email address, Author list, Content relation, Map location, Float, etc.
6
+
[[= product_name_oss =]] comes with many [built-in Field Types](field_type_reference.md#available-field-types) that cover most common needs e.g. Text line, Email address, Author list, Content relation, Map location, Float, etc.
7
7
8
8
Field Types are responsible for:
9
9
@@ -14,7 +14,7 @@ Field Types are responsible for:
14
14
15
15
## Custom data
16
16
17
-
eZ Platform can support custom data to be stored in the Fields of a Content item.
17
+
[[= product_name_oss =]] can support custom data to be stored in the Fields of a Content item.
18
18
To do so, you need to create a custom Field Type.
19
19
20
20
A custom Field Type must implement the **FieldType Service Provider Interfaces**
@@ -25,7 +25,7 @@ available in the [`eZ\Publish\SPI\FieldType`](https://github.com/ezsystems/ezpla
25
25
Remember that all your custom Field Types must be registered in `config/services.yml`.
26
26
For more information see [Registration section](field_type_type_and_value.md#registration).
27
27
28
-
In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the eZ Platform architecture:
28
+
In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the [[= product_name_oss =]] architecture:
29
29
30
30

31
31
@@ -39,7 +39,7 @@ Below that, the Field Type must support the **Public API** implementation regard
39
39
40
40
On the bottom level, a Field Type can additionally hook into the **Persistence SPI**
41
41
in order to store data from a `FieldValue` in an external service.
42
-
Note that all non-standard eZ Platform database tables (e.g. `ezurl`)
42
+
Note that all non-standard [[= product_name_oss =]] database tables (e.g. `ezurl`)
43
43
will be treated as [external storage](field_type_storage.md#external-storage).
44
44
45
45
The following sequence diagrams visualize the process of creating and publishing new content across all layers, especially focused on the interaction with a Field Type.
Copy file name to clipboardExpand all lines: docs/api/field_type_reference.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
A Field Type is the underlying building block of the content model. It consists of two entities: Field value and Field definition. Field value is determined by values entered into the Content Field. Field definition is provided by the Content Type, and holds any user defined rules used by Field Type to determine how a Field Value is validated, stored, retrieved, formatted and so on.
4
4
5
-
eZ Platform comes with a collection of Field Types that can be used to build powerful and complex content structures. In addition, it is possible to extend the system by creating custom types for special needs.
5
+
[[= product_name_oss =]] comes with a collection of Field Types that can be used to build powerful and complex content structures. In addition, it is possible to extend the system by creating custom types for special needs.
6
6
7
7
!!! tip
8
8
9
9
For general Field Type documentation, see [Field Type API](../api/field_type_api.md).
10
10
11
-
Custom Field Types have to be programmed in PHP. However, the built-in Field Types are usually sufficient enough for typical scenarios. The following table gives an overview of the supported Field Types that come with eZ Platform.
11
+
Custom Field Types have to be programmed in PHP. However, the built-in Field Types are usually sufficient enough for typical scenarios. The following table gives an overview of the supported Field Types that come with [[= product_name_oss =]].
12
12
13
13
14
14
## Available Field Types
@@ -37,7 +37,7 @@ Custom Field Types have to be programmed in PHP. However, the built-in Field Ty
|[Relation](#relation-field-type)| Validates and stores a relation to a Content item. | Yes, with both [`Field`](../guide/search/criteria_reference/field_criterion.md) and [`FieldRelation`](../guide/search/criteria_reference/fieldrelation_criterion.md) Criteria | Yes |
39
39
|[RelationList](#relationlist-field-type)| Validates and stores a list of relations to Content items. | Yes, with [`FieldRelation` Criterion](../guide/search/criteria_reference/fieldrelation_criterion.md)| Yes |
40
-
|[RichText](#richtext-field-type)| Validates and stores structured rich text in DocBook xml format, and exposes it in several formats. Available via [eZ Platform RichTextBundle](https://github.com/ezsystems/ezplatform-richtext). | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
40
+
|[RichText](#richtext-field-type)| Validates and stores structured rich text in DocBook xml format, and exposes it in several formats. Available via [RichTextBundle](https://github.com/ezsystems/ezplatform-richtext). | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
41
41
|[Selection](#selection-field-type)| Validates and stores a single selection or multiple choices from a list of options. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
42
42
|[TextBlock](#textblock-field-type)| Validates and stores a larger block of text. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
43
43
|[TextLine](#textline-field-type)| Validates and stores a single line of text. | Yes | Yes |
@@ -57,7 +57,7 @@ Proper indexing of these Field Types is done with [Solr Search Bundle](../guide/
57
57
58
58
|FieldType|Description|Searchable|Editing support in Platform UI|Planned to be included in the future|
59
59
|------|------|------|------|------|
60
-
|[XmlText](#xmltext-field-type)|Validates and stores multiple lines of formatted text using XML format.|Yes|Partial *(Raw XML editing)*|No *(has been superseded by [RichText](#richtext-field-type))*</br>The XmlText Field Type is not enabled by default in eZ Platform.|
60
+
|[XmlText](#xmltext-field-type)|Validates and stores multiple lines of formatted text using XML format.|Yes|Partial *(Raw XML editing)*|No *(has been superseded by [RichText](#richtext-field-type))*</br>The XmlText Field Type is not enabled by default in [[= product_name_oss =]].|
61
61
62
62
### Field Types provided by Community
63
63
@@ -308,7 +308,7 @@ This Field Type maps an executable Repository query to a Field.
308
308
|-----------|---------------|----------------|
309
309
|`Content query`|`ezcontentquery`|`string`|
310
310
311
-
The Content query Field Type is available via the eZ Platform Query Field Type Bundle
311
+
The Content query Field Type is available via the Query Field Type Bundle
312
312
provided by the [ezplatform-query-fieldtype](https://github.com/ezsystems/ezplatform-query-fieldtype) package.
313
313
314
314
For information on the Field Type's usage, see [Query Field Type in controller documentation](../guide/controllers.md#query-field-type).
@@ -342,7 +342,7 @@ When you set an array directly on a Content field you don't need to provide all
342
342
343
343
#### Validation
344
344
345
-
This Field Type validates whether multiple countries are allowed by the Field definition, and whether the [Alpha2](https://www.iso.org/iso-3166-country-codes.html) is valid according to the countries configured in eZ Platform.
345
+
This Field Type validates whether multiple countries are allowed by the Field definition, and whether the [Alpha2](https://www.iso.org/iso-3166-country-codes.html) is valid according to the countries configured in [[= product_name_oss =]].
@@ -1458,7 +1458,7 @@ This Field represents and handles a table of rows and columns of data.
1458
1458
|----------|---------------|----------------|
1459
1459
| `Matrix` | `ezmatrix` | `array` |
1460
1460
1461
-
The Matrix Field Type is available via the eZ Platform Matrix Bundle
1461
+
The Matrix Field Type is available via the Matrix Bundle
1462
1462
provided by the [ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype) package.
1463
1463
1464
1464
### PHP API Field Type
@@ -1793,7 +1793,7 @@ This Field Type is used as fallback for migration scenarios, and for testing pur
1793
1793
1794
1794
### Description
1795
1795
1796
-
The Null Field Type serves as an aid when migrating from eZ Publish Platform and earlier legacy versions. It is a dummy for legacy Field Types that are not implemented in eZ Platform.
1796
+
The Null Field Type serves as an aid when migrating from eZ Publish Platform and earlier legacy versions. It is a dummy for legacy Field Types that are not implemented in [[= product_name_oss =]].
1797
1797
1798
1798
Null Field Type will accept anything provided as a value and is usually combined with:
1799
1799
- NullConverter: Makes it not store anything to the legacy storage engine (database), nor will it read any data.
The RichText Field Type is available via the eZ Platform RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package.
2107
+
The RichText Field Type is available via the RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package.
2108
2108
2109
2109
This Field Type validates and stores structured rich text, and exposes it in several formats.
2110
2110
@@ -2130,7 +2130,7 @@ Currently supported input formats are described in the table below:
|XHTML5 editing format|Typically used with in-browser HTML editor|
2135
2135
|Legacy eZXML format|Compatibility with legacy XML format, used by [XmlText Field Type](#xmltext-field-type)|
2136
2136
@@ -2150,7 +2150,7 @@ Currently supported input formats are described in the table below:
2150
2150
2151
2151
###### Example of the Field Type's XHTML5 edit format
2152
2152
2153
-
This format is used by eZ Platform's Online Editor.
2153
+
This format is used by [[= product_name_oss =]]'s Online Editor.
2154
2154
2155
2155
``` xml
2156
2156
<?xml version="1.0" encoding="UTF-8"?>
@@ -2587,7 +2587,7 @@ This Field Type validates and stores information about a user.
2587
2587
2588
2588
## XmlText Field Type
2589
2589
2590
-
The XmlText Field Type isn't officially supported by eZ Platform. It can be installed by requiring `ezsystems/ezplatform-xmltext-fieldtype`. PlatformUI does not support WYSIWYG editing of Fields of this type.
2590
+
The XmlText Field Type isn't officially supported by [[= product_name_oss =]]. It can be installed by requiring `ezsystems/ezplatform-xmltext-fieldtype`. PlatformUI does not support WYSIWYG editing of Fields of this type.
2591
2591
2592
2592
This Field Type validates and stores formatted text using the eZ Publish legacy format, eZXML.
Copy file name to clipboardExpand all lines: docs/api/field_type_storage.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Storage conversion
4
4
5
-
If you want to store Field values in regular eZ Platform database tables,
5
+
If you want to store Field values in regular [[= product_name_oss =]] database tables,
6
6
the `FieldValue` must be converted to the storage-specific format used by the Persistence SPI:
7
7
`eZ\Publish\SPI\Persistence\Content\FieldValue`.
8
8
After restoring a Field of the Field Type, you must reverse the conversion.
@@ -19,7 +19,7 @@ The SPI `FieldValue` struct has properties which the Field Type can use:
19
19
|Property|Description|
20
20
|--------|-----------|
21
21
|`$data`|The data to be stored in the database. This may be a scalar value, an associative array or a simple, serializable object.|
22
-
|`$externalData`|The arbitrary data stored in this field will not be touched by any of the eZ Platform components directly, but will be available for [Storing external data](#storing-external-data).|
22
+
|`$externalData`|The arbitrary data stored in this field will not be touched by any of the [[= product_name_oss =]] components directly, but will be available for [Storing external data](#storing-external-data).|
23
23
|`$sortKey`|A value which can be used to sort content by this Field.|
24
24
25
25
### Legacy storage engine
@@ -85,7 +85,7 @@ The tag has the following attribute:
85
85
86
86
A Field Type may store arbitrary data in external data sources.
87
87
External storage can be e.g. a web service, a file in the file system, another database
88
-
or even the eZ Platform database itself (in form of a non-standard table).
88
+
or even the [[= product_name_oss =]] database itself (in form of a non-standard table).
89
89
90
90
In order to store data in external storage, the Field Type will interact with the Persistence SPI
91
91
through the `eZ\Publish\SPI\FieldType\FieldStorage` interface.
@@ -102,7 +102,7 @@ calls one of the following methods to also access the external data:
102
102
|`getIndexData()`|Returns the actual index data for the provided `eZ\Publish\SPI\Persistence\Content\Field`. For more information, see [search service](field_type_search.md#search-field-values).|
103
103
104
104
Each of the above methods (except `hasFieldData`) receives a `$context` array with information on the underlying storage and the environment.
105
-
To retrieve and store data in the eZ Platform data storage,
105
+
To retrieve and store data in the [[= product_name_oss =]] data storage,
106
106
but outside of the normal structures (e.g. a custom table in an SQL database),
107
107
use [Gateway-based storage](#gateway-based-storage) with properly injected Doctrine Connection.
0 commit comments