Deprecate comment_uri()

Open on Drupal.org →

Created on 2 June 2013, about 11 years ago

Updated 30 August 2023, 10 months ago

Problem/Motivation

Part of 📌 [meta] convert ‘uri_callback’ entities param to EntityInterface::uri() method Active

Current state: the functions is not used after #1970360-78: Entities should define URI templates and standard links →

Needs to implement Plugin\Entity\Comment.php uri() method and deprercate comment_uri() function replacing it's calls to $comment->uri() and clean-up Comment annotation uri_callback

1 usage in contrib found http://grep.xnddx.ru/search?text=comment_uri&filename=

Proposed resolution

- deprecate comment_uri() in favor of Comment::toUrl()
- probably it needs to update docs because Comment::permalink() should be deprecated too 📌 Rename Comment::permalink() to not be ambiguous with ::uri() Needs work

Remaining tasks

- add deprecation test
- review, commit

User interface changes

no

API changes

deprecated comment_uri()

Data model changes

no

Release notes snippet

no

📌 Task

Status

Needs work

Version

11.0 🔥

Component

Last updated 5 days ago

Maintained by
🇦🇺Australia @larowlan
🇫🇷France @andypost

Created by

🇺🇦Ukraine InternetDevels

Live updates comments and jobs are added and updated live.

DX (Developer Experience)
Enhances developer experience.

API clean-up
Refactors an existing API or subsystem for consistency, performance, modularization, flexibility, third-party integration, etc. May imply an API change. Frequently used during the Code Slush phase of the release cycle.

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 10 months ago →
🇬🇧United Kingdom catch
Updated the issue title, this is just a straightforward deprecation now. Needs a re-roll updating the deprecation version.
Comment 10 months ago →
🇫🇷France andypost
Filed CR https://www.drupal.org/node/3384294 →

and updated patch, looks there's no test for uri_callback annotation in comment entity

Also it needs update hook to clear entity definition cache, and let's see if something will be broken with deprecation only

Looking for better wording as Comment::permalink() is useless 📌 Rename Comment::permalink() to not be ambiguous with ::uri() Needs work

That's reason why issue used to have such title
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.2 & MySQL 8
last update 10 months ago
30,098 pass
Comment 10 months ago →
🇫🇷France andypost
updated IS
Comment 10 months ago →
🇬🇧United Kingdom catch
Comment::permalink() isn't useless, it's necessary to link to a comment in the context of the thread (with the correct page and comment fragment). I think we can just tell people to use that until it's renamed. However why not recommend $comment->uri() here?

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024