NEW Allow developers to exclude LinkText field (#215)

README.md

@@ -125,6 +125,24 @@ $fields->addFieldsToTab(
 );
 ```
 
+## Excluding the `LinkText` field
+
+Sometimes you might want to have a link which doesn't have text, or for which you handle the text elsewhere. For example you might have a banner with a link, and you only want to use `LinkField` to control where the banner links to.
+
+You can call the `setExcludeLinkTextField()` method to remove the `LinkText` field from the link modal for all links connected to that link field.
+
+```php
+$fields->addFieldsToTab(
+    'Root.Main',
+    [
+        MultiLinkField::create('LinkList')
+            ->setExcludeLinkTextField(true),
+        Link::create('Link')
+            ->setExcludeLinkTextField(true),
+    ],
+);
+```
+
 ## Unversioned links
 
 The `Link` model has the `Versioned` extension applied to it by default. If you wish for links to not be versioned, then remove the extension from the `Link` model in the projects `app/_config.php` file.

client/src/components/LinkField/LinkField.js

@@ -52,6 +52,7 @@ const LinkField = ({
   ownerID,
   ownerClass,
   ownerRelation,
+  excludeLinkTextField = false,
 }) => {
   const [data, setData] = useState({});
   const [editingID, setEditingID] = useState(0);
@@ -260,14 +261,14 @@ const LinkField = ({
           onDragStart={handleDragStart}
           onDragEnd={handleDragEnd}
         >
-          <SortableContext 
+          <SortableContext
             items={linkIDs}
             strategy={verticalListSortingStrategy}
           >
             {links}
           </SortableContext>
         </DndContext>
-      </div> 
+      </div>
     }
     return <div>{links}</div>
   };
@@ -321,7 +322,7 @@ const LinkField = ({
   const saveRecordFirstText = i18n._t('LinkField.SAVE_RECORD_FIRST', 'Cannot add links until the record has been saved');
   const links = renderLinks();
 
-  return <LinkFieldContext.Provider value={{ ownerID, ownerClass, ownerRelation, actions, loading }}>
+  return <LinkFieldContext.Provider value={{ ownerID, ownerClass, ownerRelation, actions, loading, excludeLinkTextField }}>
     <div className="link-field__container">
       { saveRecordFirst && <div className="link-field__save-record-first">{saveRecordFirstText}</div>}
       { loading && !isSorting && !saveRecordFirst && <Loading containerClass="link-field__loading"/> }
@@ -359,6 +360,7 @@ LinkField.propTypes = {
   ownerID: PropTypes.number.isRequired,
   ownerClass: PropTypes.string.isRequired,
   ownerRelation: PropTypes.string.isRequired,
+  excludeLinkTextField: PropTypes.bool,
 };
 
 // redux actions loaded into props - used to get toast notifications

client/src/components/LinkModal/LinkModal.js

@@ -13,10 +13,13 @@ const buildSchemaUrl = (typeKey, linkID) => {
   const parsedURL = url.parse(schemaUrl);
   const parsedQs = qs.parse(parsedURL.query);
   parsedQs.typeKey = typeKey;
-  const { ownerID, ownerClass, ownerRelation } = useContext(LinkFieldContext);
+  const { ownerID, ownerClass, ownerRelation, excludeLinkTextField } = useContext(LinkFieldContext);
   parsedQs.ownerID = ownerID;
   parsedQs.ownerClass = ownerClass;
   parsedQs.ownerRelation = ownerRelation;
+  if (excludeLinkTextField) {
+    parsedQs.excludeLinkTextField = true;
+  }
   for (const prop of ['href', 'path', 'pathname']) {
     parsedURL[prop] = joinUrlPaths(parsedURL[prop], linkID.toString());
   }

client/src/entwine/LinkField.js

@@ -51,6 +51,7 @@ jQuery.entwine('ss', ($) => {
         ownerID: inputField.data('owner-id'),
         ownerClass: inputField.data('owner-class'),
         ownerRelation: inputField.data('owner-relation'),
+        excludeLinkTextField: inputField.data('exclude-linktext-field'),
         onChange: this.handleChange.bind(this),
         isMulti: this.data('is-multi') ?? false,
         types: this.data('types') ?? {},

src/Controllers/LinkFieldController.php

@@ -88,7 +88,8 @@ public function linkForm(): Form
             }
             $operation = 'create';
         }
-        return $this->createLinkForm($link, $operation);
+        $excludeLinkTextField = (bool) $this->getRequest()->getVar('excludeLinkTextField');
+        return $this->createLinkForm($link, $operation, $excludeLinkTextField);
     }
 
     /**
@@ -319,7 +320,7 @@ public function linkSort()
     /**
      * Create the Form used to content manage a Link in a modal
      */
-    private function createLinkForm(Link $link, string $operation): Form
+    private function createLinkForm(Link $link, string $operation, bool $excludeLinkTextField = false): Form
     {
         $id = $link->ID;
 
@@ -333,6 +334,11 @@ private function createLinkForm(Link $link, string $operation): Form
         $ownerClassName = $owner->ClassName;
         $ownerRelation = $this->getOwnerRelationFromRequest();
 
+        // Remove LinkText if appropriate
+        if ($excludeLinkTextField) {
+            $form->Fields()->removeByName('LinkText');
+        }
+
         // Add hidden form fields for OwnerID, OwnerClass and OwnerRelation
         if ($operation === 'create') {
             $form->Fields()->push(HiddenField::create('OwnerID')->setValue($ownerID));

src/Form/LinkField.php

@@ -51,6 +51,7 @@ protected function getDefaultAttributes(): array
         $attributes['data-owner-id'] = $ownerFields['ID'];
         $attributes['data-owner-class'] = $ownerFields['Class'];
         $attributes['data-owner-relation'] = $ownerFields['Relation'];
+        $attributes['data-exclude-linktext-field'] = $this->getExcludeLinkTextField();
         return $attributes;
     }
 
@@ -62,6 +63,7 @@ public function getSchemaDataDefaults()
         $data['ownerID'] = $ownerFields['ID'];
         $data['ownerClass'] = $ownerFields['Class'];
         $data['ownerRelation'] = $ownerFields['Relation'];
+        $data['excludeLinkTextField'] = $this->getExcludeLinkTextField();
         return $data;
     }
 

src/Form/MultiLinkField.php

@@ -46,6 +46,7 @@ public function getSchemaDataDefaults()
         $data['ownerID'] = $ownerFields['ID'];
         $data['ownerClass'] = $ownerFields['Class'];
         $data['ownerRelation'] = $ownerFields['Relation'];
+        $data['excludeLinkTextField'] = $this->getExcludeLinkTextField();
         return $data;
     }
 
@@ -70,6 +71,7 @@ protected function getDefaultAttributes(): array
         $attributes['data-owner-id'] = $ownerFields['ID'];
         $attributes['data-owner-class'] = $ownerFields['Class'];
         $attributes['data-owner-relation'] = $ownerFields['Relation'];
+        $attributes['data-exclude-linktext-field'] = $this->getExcludeLinkTextField();
         return $attributes;
     }
 

src/Form/Traits/AllowedLinkClassesTrait.php

@@ -15,6 +15,19 @@ trait AllowedLinkClassesTrait
 {
     private array $allowed_types = [];
 
+    private bool $excludeLinkTextField = false;
+
+    public function setExcludeLinkTextField(bool $include): static
+    {
+        $this->excludeLinkTextField = $include;
+        return $this;
+    }
+
+    public function getExcludeLinkTextField(): bool
+    {
+        return $this->excludeLinkTextField;
+    }
+
     /**
      * Set allowed types for LinkField
      * @param string[] $types

tests/php/Controllers/LinkFieldControllerTest.php

@@ -2,12 +2,13 @@
 
 namespace SilverStripe\LinkField\Tests\Controllers;
 
-use SilverStripe\CMS\Model\SiteTree;
+use ReflectionMethod;
 use SilverStripe\Dev\FunctionalTest;
 use SilverStripe\LinkField\Tests\Controllers\LinkFieldControllerTest\TestPhoneLink;
-use SilverStripe\Core\Config\Config;
 use SilverStripe\Security\SecurityToken;
 use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\Session;
+use SilverStripe\LinkField\Controllers\LinkFieldController;
 use SilverStripe\LinkField\Tests\Models\LinkTest\LinkOwner;
 
 class LinkFieldControllerTest extends FunctionalTest
@@ -156,6 +157,50 @@ public function provideLinkFormGetSchema(): array
         ];
     }
 
+    /**
+     * @dataProvider provideExcludeLinkTextField
+     */
+    public function testExcludeLinkTextField(bool $excludeLinkTextField): void
+    {
+        $owner = $this->getFixtureLinkOwner();
+        $itemID = $this->getID('existing');
+        $vars = [
+            'ownerID' => $owner->ID,
+            'ownerClass' => $owner->ClassName,
+            'ownerRelation' => 'Link',
+        ];
+        if ($excludeLinkTextField) {
+            $vars['excludeLinkTextField'] = true;
+        }
+        // Build request and controller to get the scaffolded form
+        $request = new HTTPRequest('GET', 'linkForm/' . $itemID, getVars: $vars);
+        $request->setSession(new Session([]));
+        $controller = new LinkFieldController();
+        $reflectionFindAction = new ReflectionMethod($controller, 'findAction');
+        $reflectionFindAction->setAccessible(true);
+        $reflectionFindAction->invoke($controller, $request);
+        $controller->setRequest($request);
+        $form = $controller->linkForm();
+        // Check if the field is there or not
+        if ($excludeLinkTextField) {
+            $this->assertNull($form->Fields()->dataFieldByName('LinkText'));
+        } else {
+            $this->assertNotNull($form->Fields()->dataFieldByName('LinkText'));
+        }
+    }
+
+    public function provideExcludeLinkTextField(): array
+    {
+        return [
+            'exclude field' => [
+                'excludeLinkTextField' => true,
+            ],
+            'dont exclude field' => [
+                'excludeLinkTextField' => false,
+            ],
+        ];
+    }
+
     /**
      * @dataProvider provideLinkFormPost
      */