Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Commerce Field Types

eZ Commerce uses special ecommerce-related Field Types:
[[= product_name_com =]] uses special ecommerce-related Field Types:

- [sesselection](sesselection.md) - offers a selection using options from a YAML file
- [sesexternaldata](sesexternaldata.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fields for eCommerce data

eZ Commerce uses custom Fields to store eCommerce related data, for example for the catalog or basket.
[[= product_name_com =]] uses custom Fields to store eCommerce related data, for example for the catalog or basket.

The shop provides a flexible way to store data using concrete instances of classes implementing `FieldInterface` and inheriting from the `AbstractField` class.
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)).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/commerce_api/helper_services/mailhelperservice.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MailHelperService

`MailHelperService` is used to create, render and send emails from eZ Commerce.
`MailHelperService` is used to create, render and send emails from [[= product_name_com =]].

## Interface and implementations

Expand Down
2 changes: 1 addition & 1 deletion docs/api/commerce_rest_api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Commerce REST API

eZ Commerce extends the REST API of eZ Platform with the following features:
[[= product_name_com =]] extends the REST API of [[= product_name_oss =]] with the following features:

## Basket API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ As for the response, it's possible to use either JSON or XML in input.
The following examples use JSON (and assume [HTTP Basic Auth](general_rest_usage.md#http-basic-authentication) is enabled).

``` php
// URL to eZ Platform installation
// URL to [[= product_name_oss =]] installation
$base_url = "http://127.0.0.1";
// User credentials
$username = "admin";
Expand Down Expand Up @@ -99,7 +99,7 @@ curl_close($curl);
To publish the image use the following code:

``` php
// URL to eZ Platform installation
// URL to [[= product_name_oss =]] installation
$base_url = "http://127.0.0.1";
// User credentials
$username = "admin";
Expand Down
4 changes: 2 additions & 2 deletions docs/api/creating_custom_rest_api_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.

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.
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.

## Implementation of dedicated Visitor

Expand Down Expand Up @@ -246,7 +246,7 @@ Please note that you should set a proper `Accept` header value. For this example
"value": [
{
"_languageCode": "eng-GB",
"#text": "eZ Platform"
"#text": "Ibexa Platform"
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions docs/api/extending_the_rest_api.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Extending the REST API

The eZ Platform REST API comes with a framework that makes it easy to extend the API for your own needs.
The [[= product_name_oss =]] REST API comes with a framework that makes it easy to extend the API for your own needs.

## Requirements

REST routes are required to use the eZ Platform REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix.
REST routes are required to use the [[= product_name_oss =]] REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix.

To do so, you will/may need to create:

Expand Down
8 changes: 4 additions & 4 deletions docs/api/field_type_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Basic information

Field Types are the smallest building blocks of content.
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.
[[= 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.

Field Types are responsible for:

Expand All @@ -14,7 +14,7 @@ Field Types are responsible for:

## Custom data

eZ Platform can support custom data to be stored in the Fields of a Content item.
[[= product_name_oss =]] can support custom data to be stored in the Fields of a Content item.
To do so, you need to create a custom Field Type.

A custom Field Type must implement the **FieldType Service Provider Interfaces**
Expand All @@ -25,7 +25,7 @@ available in the [`eZ\Publish\SPI\FieldType`](https://github.com/ezsystems/ezpla
Remember that all your custom Field Types must be registered in `config/services.yml`.
For more information see [Registration section](field_type_type_and_value.md#registration).

In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the eZ Platform architecture:
In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the [[= product_name_oss =]] architecture:

![Field Type Overview](img/field_type_overview.png)

Expand All @@ -39,7 +39,7 @@ Below that, the Field Type must support the **Public API** implementation regard

On the bottom level, a Field Type can additionally hook into the **Persistence SPI**
in order to store data from a `FieldValue` in an external service.
Note that all non-standard eZ Platform database tables (e.g. `ezurl`)
Note that all non-standard [[= product_name_oss =]] database tables (e.g. `ezurl`)
will be treated as [external storage](field_type_storage.md#external-storage).

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.
Expand Down
34 changes: 17 additions & 17 deletions docs/api/field_type_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

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.

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.
[[= 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.

!!! tip

For general Field Type documentation, see [Field Type API](../api/field_type_api.md).

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.
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 =]].


## Available Field Types
Expand Down Expand Up @@ -37,7 +37,7 @@ Custom Field Types have to be programmed in PHP. However, the built-in Field Ty
| [Rating](#rating-field-type) | **Deprecated** | N/A | N/A |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [TextBlock](#textblock-field-type) | Validates and stores a larger block of text. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
| [TextLine](#textline-field-type) | Validates and stores a single line of text. | Yes | Yes |
Expand All @@ -57,7 +57,7 @@ Proper indexing of these Field Types is done with [Solr Search Bundle](../guide/

|FieldType|Description|Searchable|Editing support in Platform UI|Planned to be included in the future|
|------|------|------|------|------|
| [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.|
| [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 =]].|

### Field Types provided by Community

Expand Down Expand Up @@ -308,7 +308,7 @@ This Field Type maps an executable Repository query to a Field.
|-----------|---------------|----------------|
| `Content query` | `ezcontentquery` | `string` |

The Content query Field Type is available via the eZ Platform Query Field Type Bundle
The Content query Field Type is available via the Query Field Type Bundle
provided by the [ezplatform-query-fieldtype](https://github.com/ezsystems/ezplatform-query-fieldtype) package.

For information on the Field Type's usage, see [Query Field Type in controller documentation](../guide/controllers.md#query-field-type).
Expand Down Expand Up @@ -342,7 +342,7 @@ When you set an array directly on a Content field you don't need to provide all

#### Validation

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.
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 =]].

#### Settings

Expand Down Expand Up @@ -790,7 +790,7 @@ $floatFieldCreateStruct->validatorConfiguration = [

This Field Type does not support settings.

!!! enterprise
!!! dxp

## Form Field Type

Expand Down Expand Up @@ -1317,7 +1317,7 @@ This Field Type stores one or several comma-separated keywords as a string or ar
|Type|Example|
|------|------|
|`string`|`"documentation"`|
|`string`|`"php, eZ Platform, html5"`|
|`string`|`"php, Ibexa Platform, html5"`|
|`string[]`|`[ "Ibexa", "Enterprise", "User Experience Management" ]`|

#### Value object
Expand All @@ -1338,7 +1338,7 @@ use eZ\Publish\Core\FieldType\Keyword\Value;
$keywordValue = new Value();

// Sets an array of keywords as a value
$keyword->value = [ "php", "css3", "html5", "eZ Platform" ];
$keyword->value = [ "php", "css3", "html5", "Ibexa Platform" ];
```

##### Constructor
Expand Down Expand Up @@ -1458,7 +1458,7 @@ This Field represents and handles a table of rows and columns of data.
|----------|---------------|----------------|
| `Matrix` | `ezmatrix` | `array` |

The Matrix Field Type is available via the eZ Platform Matrix Bundle
The Matrix Field Type is available via the Matrix Bundle
provided by the [ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype) package.

### PHP API Field Type
Expand Down Expand Up @@ -1793,7 +1793,7 @@ This Field Type is used as fallback for migration scenarios, and for testing pur

### Description

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.
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 =]].

Null Field Type will accept anything provided as a value and is usually combined with:
- NullConverter: Makes it not store anything to the legacy storage engine (database), nor will it read any data.
Expand Down Expand Up @@ -1822,13 +1822,13 @@ services:
tags: [{name: ezplatform.field_type.indexable, alias: example}]
```

!!! enterprise
!!! dxp

## Page Field Type

Page Field Type represents a Page with a layout consisting of multiple zones. Each zone can in turn contain blocks.

Page Field Type is only used in the Page Content Type that is included in eZ Enterprise.
Page Field Type is only used in the Page Content Type that is included in [[= product_name_ee =]].

| Name | Internal name | Expected input |
|----------------|-----------------|-----------------|
Expand Down Expand Up @@ -2104,7 +2104,7 @@ $validators = [

## RichText Field Type

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.
The RichText Field Type is available via the RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package.

This Field Type validates and stores structured rich text, and exposes it in several formats.

Expand All @@ -2130,7 +2130,7 @@ Currently supported input formats are described in the table below:

|Name|Description|
|------|------|
|eZ Platform's DocBook variant|Field Type's internal format|
|[[= product_name_oss =]]'s DocBook variant|Field Type's internal format|
|XHTML5 editing format|Typically used with in-browser HTML editor|
|Legacy eZXML format|Compatibility with legacy XML format, used by [XmlText Field Type](#xmltext-field-type)|

Expand All @@ -2150,7 +2150,7 @@ Currently supported input formats are described in the table below:

###### Example of the Field Type's XHTML5 edit format

This format is used by eZ Platform's Online Editor.
This format is used by [[= product_name_oss =]]'s Online Editor.

``` xml
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -2587,7 +2587,7 @@ This Field Type validates and stores information about a user.

## XmlText Field Type

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.
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.

This Field Type validates and stores formatted text using the eZ Publish legacy format, eZXML. 

Expand Down
8 changes: 4 additions & 4 deletions docs/api/field_type_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Storage conversion

If you want to store Field values in regular eZ Platform database tables,
If you want to store Field values in regular [[= product_name_oss =]] database tables,
the `FieldValue` must be converted to the storage-specific format used by the Persistence SPI:
`eZ\Publish\SPI\Persistence\Content\FieldValue`.
After restoring a Field of the Field Type, you must reverse the conversion.
Expand All @@ -19,7 +19,7 @@ The SPI `FieldValue` struct has properties which the Field Type can use:
|Property|Description|
|--------|-----------|
|`$data`|The data to be stored in the database. This may be a scalar value, an associative array or a simple, serializable object.|
|`$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).|
|`$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).|
|`$sortKey`|A value which can be used to sort content by this Field.|

### Legacy storage engine
Expand Down Expand Up @@ -85,7 +85,7 @@ The tag has the following attribute:

A Field Type may store arbitrary data in external data sources.
External storage can be e.g. a web service, a file in the file system, another database
or even the eZ Platform database itself (in form of a non-standard table).
or even the [[= product_name_oss =]] database itself (in form of a non-standard table).

In order to store data in external storage, the Field Type will interact with the Persistence SPI
through the `eZ\Publish\SPI\FieldType\FieldStorage` interface.
Expand All @@ -102,7 +102,7 @@ calls one of the following methods to also access the external data:
|`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).|

Each of the above methods (except `hasFieldData`) receives a `$context` array with information on the underlying storage and the environment.
To retrieve and store data in the eZ Platform data storage,
To retrieve and store data in the [[= product_name_oss =]] data storage,
but outside of the normal structures (e.g. a custom table in an SQL database),
use [Gateway-based storage](#gateway-based-storage) with properly injected Doctrine Connection.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/field_type_type_and_value.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Since the Public API cannot know anything about these, their handling is delegat
#### `getFieldTypeIdentifier()`

Returns a unique identifier for the custom Field Type which is used to assign the type to a Field definition.
By convention it should be prefixed by a unique vendor shortcut (e.g. `ez` for eZ Platform).
By convention it should be prefixed by a unique vendor shortcut (e.g. `ibexa` for [[= product_name_oss =]]).

#### `getSettingsSchema()`

Expand Down
Loading