Issue 137 - Allow formatter to set url_only and url_plain.

[rosiel]

GitHub Issue: #137

• Other Relevant Links (Google Groups discussion, related pull requests,
  Release pull requests, etc.)

What does this Pull Request do?

Puts the "URL only" and "Show URL as plain text" checkboxes on the field formatter settings page for authority links

What's new?

• The parent, LinkFormatter, "locked down" those fields from inheriting classes by setting their access to true only if you're in a Link Formatter. This PR does the same, setting their access to true if you're in an Authority Link formatter.
• Does this change require documentation to be updated? No
• Does this change add any new dependencies? No
• Does this change require any other modifications to be made to the repository
  (i.e. Regeneration activity, etc.)? No
• Could this change impact execution of existing code? No

How should this be tested?

A description of what steps someone could take to:

• Reproduce instructions are in [BUG] Authority Link field formatter's setting form doesn't allow you to set url_only or url_plain. #137.
• With this PR, the Authority Link formatter should also show "URL only" and, if that's checked, the other checkbox.

Additional Notes:

Any additional information that you think would be helpful when reviewing this
PR.

Interested parties

Tag (@ mention) interested parties or, if unsure, @Islandora/committers

[seth-shaw-asu]

As is, this throws an error:

PHP Fatal error: Could not check compatibility between Drupal\\controlled_access_terms\\Plugin\\Field\\FieldFormatter\\AuthorityLinkFormatter::settingsForm(array $form, Drupal\\controlled_access_terms\\Plugin\\Field\\FieldFormatter\\FormStateInterface $form_state) and Drupal\\link\\Plugin\\Field\\FieldFormatter\\LinkFormatter::settingsForm(array $form, Drupal\\Core\\Form\\FormStateInterface $form_state), because class Drupal\\controlled_access_terms\\Plugin\\Field\\FieldFormatter\\FormStateInterface is not available in /var/www/html/drupal/web/modules/contrib/controlled_access_terms/src/Plugin/Field/FieldFormatter/AuthorityLinkFormatter.php on line 35

Add the missing use Drupal\Core\Form\FormStateInterface; statement.

[seth-shaw-asu]

Okay, so, the form technically saves... but the formatter doesn't actually display the URL when I use the option.

See the form settings:

The item edit page:

The view page:

If we're going to include the options, we should make sure it works.

[seth-shaw-asu]

Looks like this is an old bug that we didn't realize because we didn't have the option to use it before now.

      if (!empty($settings['url_only']) && !empty($settings['url_plain'])) {
        $element[$delta] = [
          '#plain_text' => $link_title,
        ];

should be (untested)

      if (!empty($settings['url_only']) && !empty($settings['url_plain'])) {
        $element[$delta] = [
          '#plain_text' =>$url;
        ];

[rosiel]

oooh, thanks and sorry bout that. Here's the results of testing with the latest commit.

Note: I deliberately put the code to "set link text to the url" AFTER the link text was trimmed. I think that trimming URLs is probably universally a bad plan, but if you argue for edge cases then we can easily move it. Note this only applies when the URL is used as the link text. The plain text URL is never trimmed, ever, and still won't be if we choose to trim the Url-as-link-text.

Standard (no URL only) -> link text configured in field displayed.

With "URL Only" the url is the link text.

With "plain text" it shows as plain text.

With no link text in the field instance, the Source (in this case, FAST) is displayed. Also it gets trimmed if you set the trim too low.

But - my possibly off-kilter contribution - don't trim a URL if it's the link text.

[seth-shaw-asu]

👍