Problem/Motivation

There's 7 usages in CORE using same code to encode the Tags. We copy and paste it over and over again. It makes hard to maintain the code. And less possible to add custom encode rule to the Tags.

Proposed resolution

Add a shared method to \Drupal\Component\Utility\Tags class

Remaining tasks

- Review patch

User interface changes

- N / A

API changes

- added a new method in \Drupal\Component\Utility\Tags class

CommentFileSizeAuthor
#10 interdiff_do-not-test.patch517 bytesdroplet
#10 tags-encode-10.patch8.2 KBdroplet
#7 tags-encode-7.patch8.22 KBdroplet
#5 tags-encode-5.patch8.24 KBdroplet
#3 tags-encode-3.patch8.24 KBdroplet
tags-encode.patch8.1 KBdroplet

Comments

amateescu’s picture

amateescu commented

This makes perfect sense.

+++ b/core/lib/Drupal/Component/Utility/Tags.php
@@ -43,6 +43,22 @@ public static function explode($tags) {
+   * @param array $tag
+   *   An string of tag.

The function receives a string, not an array :) And the text might be changed to "A tag string."

Status: Needs review » Needs work

The last submitted patch, tags-encode.patch, failed testing.

droplet’s picture

droplet commented
Status: Needs work » Needs review
StatusFileSize
new tags-encode-3.patch8.24 KB

Fixed the errors

Status: Needs review » Needs work

The last submitted patch, 3: tags-encode-3.patch, failed testing.

droplet’s picture

droplet commented
Status: Needs work » Needs review
StatusFileSize
new tags-encode-5.patch8.24 KB

remove extra end quote

Status: Needs review » Needs work

The last submitted patch, 5: tags-encode-5.patch, failed testing.

droplet’s picture

droplet commented
StatusFileSize
new tags-encode-7.patch8.22 KB

It should work this time.

droplet’s picture

droplet commented
Status: Needs work » Needs review
amateescu’s picture

amateescu commented
Status: Needs review » Needs work

Please see #1. Also, the method description should be something like: Encodes a tag string, taking care of special cases like commas and quotes.

droplet’s picture

droplet commented
Status: Needs work » Needs review
StatusFileSize
new tags-encode-10.patch8.2 KB
new interdiff_do-not-test.patch517 bytes

Update the comments.

amateescu’s picture

amateescu commented
Status: Needs review » Reviewed & tested by the community

Looks good now.

catch’s picture

catch
he/him
Primary language English
commented
Title: Improve consistency of Tags encode » Change record: Improve consistency of Tags encode
Status: Reviewed & tested by the community » Active
Issue tags: +API addition, +Missing change record

Committed/pushed to 8.x, thanks!

Could use a change record for the API addition.

jessebeach’s picture

jessebeach commented
Status: Active » Fixed
Issue tags: -Missing change record

Change record added and reviewed. This was a simple API method addition.

jessebeach’s picture

jessebeach commented
Title: Change record: Improve consistency of Tags encode » Improve consistency of Tags encode

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.