Skip to content

Commit

Permalink
[Docs] Refactor v11.1 upgrade notes (#16101)
Browse files Browse the repository at this point in the history
* [Docs] Refactor v11.1 upgrade notes

* Update doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md

Co-authored-by: Manon Cassier <127942915+mcassier31@users.noreply.github.com>

* Update doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md

Co-authored-by: Manon Cassier <127942915+mcassier31@users.noreply.github.com>

* Update doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md

Co-authored-by: Manon Cassier <127942915+mcassier31@users.noreply.github.com>

---------

Co-authored-by: robertSt7 <104770750+robertSt7@users.noreply.github.com>
Co-authored-by: Manon Cassier <127942915+mcassier31@users.noreply.github.com>
  • Loading branch information
3 people committed Oct 16, 2023
1 parent 8949fc9 commit d25b5f5
Showing 1 changed file with 56 additions and 21 deletions.
77 changes: 56 additions & 21 deletions doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,66 @@
# Upgrade Notes

## Pimcore 11.1.0
### [Documents]:
- Removed `allow list` filter from `Pimcore\Model\Document\Editable\Link` to allow passing any valid attributes in the config.
- Property `Pimcore\Navigation\Page::$_defaultPageType` is deprecated.

### [DataObjects]:
- Property `$fieldtype` of the `Pimcore\Model\DataObject\Data` class is deprecated now. Use the `getFieldType()` method instead.
- [DataObject] Method `getSiblings()` output is now sorted based on the parent sorting parameters (same as `getChildren`) instead of alphabetical.
- Method `getSiblings()` output is now sorted based on the parent sorting parameters (same as `getChildren`) instead of alphabetical.
- Input fields `CheckValidity` checks the column length.

### [Assets]:
- Asset Documents background processing (e.g. page count, thumbnails & search text) can be disabled with config:
```yaml
pimcore:
assets:
document:
thumbnails:
enabled: false #disable generating thumbnail for Asset Documents
process_page_count: false #disable processing page count
process_text: false #disable processing text extraction
scan_pdf: false #disable scanning PDF documents for unsafe JavaScript.
```
- Video Assets spherical metadata is now calculated in the backfground instead of on load.

### [Elements]:
- Properties are now only updated in the database with dirty state (when calling `setProperties` or `setProperty`).
- Added hint for second parameter `array $params = []` to `Element/ElementInterface::getById`

### [General]:
- `Pimcore\Helper\CsvFormulaFormatter` has been deprecated. Use `League\Csv\EscapeFormula` instead.
- [Maintenance Mode]
- Deprecated following maintenance-mode methods in `Pimcore\Tool\Admin`:
- `activateMaintenanceMode`, use `MaintenanceModeHelperInterface::activate` instead.
- `deactivateMaintenanceMode`, use `MaintenanceModeHelperInterface::deactivate` instead.
- `isInMaintenanceMode`, use `MaintenanceModeHelperInterface::isActive instead.
- `isMaintenanceModeScheduledForLogin`, `scheduleMaintenanceModeOnLogin`, `unscheduleMaintenanceModeOnLogin` will be removed in Pimcore 12
- Maintenance mode check is handled via `tmp_store` in database. Using maintenance mode files is deprecated.
- Deprecated following maintenance-mode methods in `Pimcore\Tool\Admin`:
- `activateMaintenanceMode`, use `MaintenanceModeHelperInterface::activate` instead.
- `deactivateMaintenanceMode`, use `MaintenanceModeHelperInterface::deactivate` instead.
- `isInMaintenanceMode`, use `MaintenanceModeHelperInterface::isActive instead.
- `isMaintenanceModeScheduledForLogin`, `scheduleMaintenanceModeOnLogin`, `unscheduleMaintenanceModeOnLogin` will be removed in Pimcore 12
- [CoreCacheHandler] Remove redundant cache item tagging with own key
- [Auth] The tokens for password reset are now stored in the DB and are one time use only (gets expired whenever a new one is generated or when consumed).
- [Assets] Asset Documents background processing (e.g. page count, thumbnails & search text) can be disabled with config:
```yaml
pimcore:
assets:
document:
thumbnails:
enabled: false #disable generating thumbnail for asset documents
process_page_count: false #disable processing page count
process_text: false #disable processing text extraction
scan_pdf: false #disable scanning PDF documents for unsafe JavaScript.

```
- [Elements] Properties are now only updated in the database with dirty state (when calling `setProperties` or `setProperty`).
- `Pimcore\Helper\CsvFormulaFormatter` has been deprecated. Use `League\Csv\EscapeFormula` instead.
- [Navigation]: The property `Pimcore\Navigation\Page::$_defaultPageType` is deprecated.
- [Static Page Generator]: Static pages can be generated based on sub-sites main domain using below config:
```yaml
pimcore:
documents:
static_page_router:
use_main_domain: true #generates pages in path /public/var/tmp/pages/my-domain.com/en.html
```
and adapting NGINX config:
```nginx
map $args $static_page_root {
default /var/tmp/pages/$host;
"~*(^|&)pimcore_editmode=true(&|$)" /var/nonexistent;
"~*(^|&)pimcore_preview=true(&|$)" /var/nonexistent;
"~*(^|&)pimcore_version=[^&]+(&|$)" /var/nonexistent;
}
map $uri $static_page_uri {
default $uri;
"/" /%home;
}
```

- [Installer]: Passing `--install-bundles` as empty option now installs the required bundles.

## Pimcore 11.0.7
- Putting `null` to the `Pimcore\Model\DataObject\Data::setIndex()` method is deprecated now. Only booleans are allowed.
Expand Down

0 comments on commit d25b5f5

Please sign in to comment.