Skip to content
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
f99fcc0
mkdocs.yml: target 3.3 instead of master
adriendupuis Feb 17, 2025
a022393
Merge branch '3.3' into fix-links-3.3
adriendupuis Feb 25, 2025
aa634c5
mkdocs.yml: symfony.com/doc/5.4 → 5.x
adriendupuis Feb 26, 2025
b6345e4
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
eb5c83f
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
65a5253
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
7d21356
use [[= user_doc =]]
adriendupuis Feb 26, 2025
6b0bd14
mkdocs.yml + user_doc_4_6
adriendupuis Feb 27, 2025
9babee2
create_custom_page_block.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
b544209
basic_integration.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
2c9b9f5
content_api.md: Fix internal links
adriendupuis Feb 27, 2025
d3544e6
recommendation_api.md: Fix user doc links
adriendupuis Feb 27, 2025
8a74a1b
tracking_api.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
d913e30
Fix some redirections to trailing slash
adriendupuis Feb 27, 2025
a22a76f
Fix several `[[= symfony_doc =]]` links
adriendupuis Mar 3, 2025
37cabc2
public_php_api_search.md: Fix ezsystems/ezplatform-kernel links
adriendupuis Mar 3, 2025
e0d6eaf
support_maintenance_faq.md: Fix links
adriendupuis Mar 3, 2025
373438d
extending_online_editor.md: Follow redirect
adriendupuis Mar 3, 2025
b30fea4
troubleshooting.md: use updates.ibexa.co with HTTPS
adriendupuis Mar 3, 2025
c062c93
Update twig.symfony.com links
adriendupuis Mar 3, 2025
76d1c4a
use https
adriendupuis Mar 3, 2025
397e5bc
persistence_cache.md: Update links
adriendupuis Mar 3, 2025
3806f5e
Update RFC links
adriendupuis Mar 3, 2025
3024888
rest_api_usage.md: Fix ISO 3166
adriendupuis Mar 3, 2025
cc33ccc
docs/guide/cache/*.md: Fix links
adriendupuis Mar 3, 2025
18e24ee
docs/guide/catalog/*.md: Fix links
adriendupuis Mar 3, 2025
20325d9
Fix links
adriendupuis Mar 3, 2025
6c7768b
docs/guide/payment/*.md: Fix links
adriendupuis Mar 3, 2025
8511fd5
Merge branch '3.3' into fix-links-3.3
adriendupuis Mar 5, 2025
cea1606
Twig doc 2.x → 3.x
adriendupuis Mar 5, 2025
9b22fdb
Do not change table formatting
adriendupuis Mar 5, 2025
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
2 changes: 1 addition & 1 deletion docs/api/field_type_form_and_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@

### Reusing blocks

For easier Field Type template development you can take advantage of all defined blocks by using the [`block()` function](http://twig.sensiolabs.org/doc/functions/block.html).
For easier Field Type template development you can take advantage of all defined blocks by using the [`block()` function](https://twig.symfony.com/doc/2.x/functions/block.html).

Check warning on line 159 in docs/api/field_type_form_and_template.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_type_form_and_template.md#L159

[Ibexa.DontCapitalize] Don't capitalize 'Field Type' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Field Type' if inside the sentence.", "location": {"path": "docs/api/field_type_form_and_template.md", "range": {"start": {"line": 159, "column": 12}}}, "severity": "WARNING"}

You can for example use `simple_block_field`, `simple_inline_field` or `field_attributes` blocks provided in [`content_fields.html.twig`](https://github.com/ezsystems/ezplatform-kernel/blob/v1.0.0/eZ/Bundle/EzPublishCoreBundle/Resources/views/content_fields.html.twig#L477).

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

#### `parent`

As described in the [Symfony service container documentation]([[= symfony_doc =]]/components/dependency_injection/parentservices.html), the `parent` config key indicates that you want your service to inherit from the parent's dependencies, including constructor arguments and method calls. This helps avoiding repetition in your Field Type configuration and keeps consistency between all Field Types.
As described in the [Symfony service container documentation]([[= symfony_doc =]]/service_container/parent_services.html), the `parent` config key indicates that you want your service to inherit from the parent's dependencies, including constructor arguments and method calls. This helps avoiding repetition in your Field Type configuration and keeps consistency between all Field Types.

Check warning on line 121 in docs/api/field_type_type_and_value.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_type_type_and_value.md#L121

[Ibexa.DontCapitalize] Don't capitalize 'Field Type' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Field Type' if inside the sentence.", "location": {"path": "docs/api/field_type_type_and_value.md", "range": {"start": {"line": 121, "column": 317}}}, "severity": "WARNING"}

Check warning on line 121 in docs/api/field_type_type_and_value.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_type_type_and_value.md#L121

[Ibexa.DontCapitalize] Don't capitalize 'Field Types' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Field Types' if inside the sentence.", "location": {"path": "docs/api/field_type_type_and_value.md", "range": {"start": {"line": 121, "column": 376}}}, "severity": "WARNING"}
If you need to inject other services into your Type class, skip using the `parent` config key.

#### `tags`
Expand All @@ -128,7 +128,7 @@
A service can be assigned one or several tags, with specific parameters.
When the [service container](../api/public_php_api.md#service-container) is compiled into a PHP file,
tags are read by `CompilerPass` implementations that add extra handling for tagged services.
Each service tagged as `ezplatform.field_type` is added to a [registry](http://martinfowler.com/eaaCatalog/registry.html) using the `alias` key as its unique `fieldTypeIdentifier` e.g. `ezstring`.
Each service tagged as `ezplatform.field_type` is added to a [registry](https://martinfowler.com/eaaCatalog/registry.html) using the `alias` key as its unique `fieldTypeIdentifier` e.g. `ezstring`.
Each Field Type must also inherit from the abstract `ezplatform.field_type` service.
This ensures that the initialization steps shared by all Field Types are executed.

Expand Down
12 changes: 6 additions & 6 deletions docs/api/field_types_reference/dateandtimefield.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

### Input expectations

If input value is of type `string` or `integer`, it will be passed directly to the [PHP's built-in `\DateTime` class constructor](http://www.php.net/manual/en/datetime.construct.php), therefore the same input format expectations apply.
If input value is of type `string` or `integer`, it will be passed directly to the [PHP's built-in `\DateTime` class constructor](https://www.php.net/manual/en/datetime.construct.php), therefore the same input format expectations apply.

Check warning on line 13 in docs/api/field_types_reference/dateandtimefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/dateandtimefield.md#L13

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/dateandtimefield.md", "range": {"start": {"line": 13, "column": 53}}}, "severity": "WARNING"}

It is also possible to directly pass an instance of `\DateTime`.

Expand All @@ -36,7 +36,7 @@

##### String representation

String representation of the date value will generate the date string in the format `D Y-d-m H:i:s` as accepted by [PHP's built-in `date()` function](http://www.php.net/manual/en/function.date.php).
String representation of the date value will generate the date string in the format `D Y-d-m H:i:s` as accepted by [PHP's built-in `date()` function](https://www.php.net/manual/en/function.date.php).

Check warning on line 39 in docs/api/field_types_reference/dateandtimefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/dateandtimefield.md#L39

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/dateandtimefield.md", "range": {"start": {"line": 39, "column": 41}}}, "severity": "WARNING"}

|Character|Description|Example|
|---------|----------|--------|
Expand All @@ -54,10 +54,10 @@

Hash value of this Field Type is an array with two keys:

|Key|Type|Description|Example|
|------|------|------|------|
|`timestamp`|`integer`|Time information in [Unix format timestamp](http://en.wikipedia.org/wiki/Unix_time).|`1400856992`|
|`rfc850`|`string`|Time information as a string in [RFC 850 date format](http://tools.ietf.org/html/rfc850). As input, this will have precedence over the timestamp value.|`"Friday, 23-May-14 14:56:14 GMT+0000"`|
|Key|Type| Description |Example|
|------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------|------|
|`timestamp`|`integer`| Time information in [Unix format timestamp](https://en.wikipedia.org/wiki/Unix_time). |`1400856992`|
|`rfc850`|`string`| Time information as a string in [RFC 850 date format](https://datatracker.ietf.org/doc/html/rfc850). As input, this will have precedence over the timestamp value. |`"Friday, 23-May-14 14:56:14 GMT+0000"`|

Check warning on line 60 in docs/api/field_types_reference/dateandtimefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/dateandtimefield.md#L60

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/dateandtimefield.md", "range": {"start": {"line": 60, "column": 137}}}, "severity": "WARNING"}

``` php
$hash = [
Expand Down
14 changes: 7 additions & 7 deletions docs/api/field_types_reference/datefield.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

### Input expectations

If input value is in `string` or `integer` format, it will be passed directly to [PHP's built-in `\DateTime` class constructor](http://www.php.net/manual/en/datetime.construct.php), therefore the same input format expectations apply.
If input value is in `string` or `integer` format, it will be passed directly to [PHP's built-in `\DateTime` class constructor](https://www.php.net/manual/en/datetime.construct.php), therefore the same input format expectations apply.

It is also possible to directly pass an instance of `\DateTime`.

Expand All @@ -36,7 +36,7 @@

##### String representation

String representation of the date value will generate the date string in the format "l d F Y" as accepted by [PHP's built-in `date()` function](http://www.php.net/manual/en/function.date.php).
String representation of the date value will generate the date string in the format "l d F Y" as accepted by [PHP's built-in `date()` function](https://www.php.net/manual/en/function.date.php).

Check warning on line 39 in docs/api/field_types_reference/datefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/datefield.md#L39

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/datefield.md", "range": {"start": {"line": 39, "column": 41}}}, "severity": "WARNING"}

|Character|Description|Example|
|---------|----------|--------|
Expand All @@ -49,16 +49,16 @@

##### Constructor

The constructor for this value object will initialize a new Value object with the value provided. It accepts an instance of [PHP's built-in `\DateTime` class](http://www.php.net/manual/en/datetime.construct.php).
The constructor for this value object will initialize a new Value object with the value provided. It accepts an instance of [PHP's built-in `\DateTime` class](https://www.php.net/manual/en/datetime.construct.php).

Check warning on line 52 in docs/api/field_types_reference/datefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/datefield.md#L52

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/datefield.md", "range": {"start": {"line": 52, "column": 39}}}, "severity": "WARNING"}

Check warning on line 52 in docs/api/field_types_reference/datefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/datefield.md#L52

[Ibexa.DontCapitalize] Don't capitalize 'Value object' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Value object' if inside the sentence.", "location": {"path": "docs/api/field_types_reference/datefield.md", "range": {"start": {"line": 52, "column": 61}}}, "severity": "WARNING"}

### Hash format

Hash value of this Field Type is an array with two keys:

|Key|Type|Description|Example|
|------|------|------|------|
|`timestamp`|`integer`|Time information in [unix format timestamp](http://en.wikipedia.org/wiki/Unix_time).|`1400856992`|
|`rfc850`|`string`|Time information as a string in [RFC 850 date format](http://tools.ietf.org/html/rfc850). As input, this will have higher precedence over the timestamp value.|`"Friday, 23-May-14 14:56:14 GMT+0000"`|
|Key|Type| Description |Example|
|------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
|`timestamp`|`integer`| Time information in [unix format timestamp](https://en.wikipedia.org/wiki/Unix_time). |`1400856992`|
|`rfc850`|`string`| Time information as a string in [RFC 850 date format](https://datatracker.ietf.org/doc/html/rfc850). As input, this will have higher precedence over the timestamp value. |`"Friday, 23-May-14 14:56:14 GMT+0000"`|

Check warning on line 61 in docs/api/field_types_reference/datefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/datefield.md#L61

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/datefield.md", "range": {"start": {"line": 61, "column": 137}}}, "severity": "WARNING"}

``` php
// Example of the hash value in PHP
Expand Down
4 changes: 2 additions & 2 deletions docs/api/field_types_reference/timefield.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

### Input expectations

If input value is of type `string` or `integer`, it will be passed directly to the [PHP's built-in `\DateTime` class](http://www.php.net/manual/en/datetime.construct.php) constructor, therefore the same input format expectations apply.
If input value is of type `string` or `integer`, it will be passed directly to the [PHP's built-in `\DateTime` class](https://www.php.net/manual/en/datetime.construct.php) constructor, therefore the same input format expectations apply.

Check warning on line 17 in docs/api/field_types_reference/timefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/timefield.md#L17

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/timefield.md", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

It is also possible to directly pass an instance of `\DateTime`.

Expand All @@ -40,7 +40,7 @@

##### String representation

String representation of the date value will generate the date string in the format "H:i:s" as accepted by [PHP's built-in `date()` function](http://www.php.net/manual/en/function.date.php).
String representation of the date value will generate the date string in the format "H:i:s" as accepted by [PHP's built-in `date()` function](https://www.php.net/manual/en/function.date.php).

Check warning on line 43 in docs/api/field_types_reference/timefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/field_types_reference/timefield.md#L43

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/api/field_types_reference/timefield.md", "range": {"start": {"line": 43, "column": 41}}}, "severity": "WARNING"}

|Character|Description|Example|
|---------|----------|--------|
Expand Down
8 changes: 4 additions & 4 deletions docs/api/public_php_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ $permissionResolver->setCurrentUserReference($user);

## Exception handling

PHP API uses [Exceptions](http://php.net/exceptions) to handle errors.
PHP API uses [Exceptions](https://www.php.net/exceptions) to handle errors.
Each API method may throw different exceptions, depending on what it does.

It is good practice to cover every exception you expect to happen.
Expand All @@ -156,9 +156,9 @@ try {

## Service container

[[= product_name =]] uses the [Symfony service container]([[=symfony_doc=]]/service_container.html) for dependency resolution.
[[= product_name =]] uses the [Symfony service container]([[= symfony_doc =]]/service_container.html) for dependency resolution.

[Symfony dependency injection]([[=symfony_doc=]]/components/dependency_injection.html) ensures that any required services are available in your custom code
[Symfony dependency injection]([[= symfony_doc =]]/components/dependency_injection.html) ensures that any required services are available in your custom code
(for example, controllers) when you inject them into the constructor.

Symfony service container uses service tags to dedicate services to a specific purpose. They are usually used for extension points.
Expand All @@ -167,4 +167,4 @@ Symfony service container uses service tags to dedicate services to a specific p

!!! tip

For a list of all service tags exposed by Symfony, see its [reference documentation]([[=symfony_doc=]]/reference/dic_tags.html).
For a list of all service tags exposed by Symfony, see its [reference documentation]([[= symfony_doc =]]/reference/dic_tags.html).
Loading
Loading