Skip to content

[stable24] Document deprecation of entity slugs #9333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2022
Merged

[stable24] Document deprecation of entity slugs #9333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_24.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Make sure your ``appinfo/info.xml`` allows for Nextcloud 24.
<nextcloud min-version="21" max-version="24" />
</dependencies>

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.

Expand All @@ -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 <app-ci>` set up, extend your test matrix with PHP8.1 tests and linters.

Information about code changes can be found on `php.net <https://www.php.net/migration81>`__ and `stitcher.io <https://stitcher.io/blog/new-in-php-81#breaking-changes>`__.


Entity slug deprecation
^^^^^^^^^^^^^^^^^^^^^^^

The usage of :ref:`entity slugs <database-entity-slugs>` has been deprecated. There is no provided replacement. If your app needs slugs, add your own logic to create them.
6 changes: 4 additions & 2 deletions developer_manual/basics/storage/database.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -325,6 +326,7 @@ 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

Supporting more databases
-------------------------
Expand Down