From edb263a02a6f5ecfbc79ab72d0d73afa5b1aad14 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Mon, 14 Nov 2022 09:39:38 +0100 Subject: [PATCH] Document deprecation of entity slugs Signed-off-by: Christoph Wurst --- .../app_upgrade_guide/upgrade_to_24.rst | 10 +++++++++- developer_manual/basics/storage/database.rst | 7 +++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_24.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_24.rst index a2ede4b72..290370102 100644 --- a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_24.rst +++ b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_24.rst @@ -18,9 +18,11 @@ Make sure your ``appinfo/info.xml`` allows for Nextcloud 24. +Back-end changes +---------------- PHP8.1 ------- +^^^^^^ Nextcloud 24 is the first major Nextcloud release to work with PHP8.1. Follow the steps below to make your app compatible. @@ -47,3 +49,9 @@ Nextcloud 24 is the first major Nextcloud release to work with PHP8.1. Follow th 3. If you have :ref:`continuous integration ` set up, extend your test matrix with PHP8.1 tests and linters. Information about code changes can be found on `php.net `__ and `stitcher.io `__. + + +Entity slug deprecation +^^^^^^^^^^^^^^^^^^^^^^^ + +The usage of :ref:`entity slugs ` has been deprecated. There is no provided replacement. If your app needs slugs, add your own logic to create them. diff --git a/developer_manual/basics/storage/database.rst b/developer_manual/basics/storage/database.rst index 4b4cc0e1e..34442549e 100644 --- a/developer_manual/basics/storage/database.rst +++ b/developer_manual/basics/storage/database.rst @@ -312,9 +312,10 @@ mapping, simply override the **columnToProperty** and **propertyToColumn** metho } +.. _database-entity-slugs: -Slugs -^^^^^ +Slugs (deprecated) +^^^^^^^^^^^^^^^^^^ Slugs are used to identify resources in the URL by a string rather than integer id. Since the URL allows only certain values, the entity base class provides a slugify method for it: @@ -325,6 +326,8 @@ Slugs are used to identify resources in the URL by a string rather than integer $author->setName('Some*thing'); $author->slugify('name'); // Some-thing +.. note:: Entity slugs have been deprecated with the release of Nextcloud 24 + Table management tips -------------------------