NEW Allowed link types

client/src/boot/index.js

@@ -1,9 +1,7 @@
 /* global document */
 /* eslint-disable */
 import registerComponents from './registerComponents';
-import registerQueries from './registerQueries';
 
 document.addEventListener('DOMContentLoaded', () => {
   registerComponents();
-  registerQueries();
 });

client/src/components/LinkField/LinkField.js

@@ -183,7 +183,6 @@ const mapDispatchToProps = (dispatch) => ({
 });
 
 export default compose(
-  injectGraphql('readLinkTypes'),
   fieldHolder,
   connect(null, mapDispatchToProps)
 )(LinkField);

client/src/entwine/LinkField.js

@@ -50,6 +50,7 @@ jQuery.entwine('ss', ($) => {
         value,
         onChange: this.handleChange.bind(this),
         isMulti: this.data('is-multi') ?? false,
+        types: this.data('types') ?? [],
       };
     },
 

src/Controllers/LinkFieldController.php

@@ -8,7 +8,6 @@
 use SilverStripe\Forms\DefaultFormFactory;
 use SilverStripe\Forms\Form;
 use SilverStripe\LinkField\Models\Link;
-use SilverStripe\LinkField\Type\Registry;
 use SilverStripe\Security\SecurityToken;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\FormAction;
@@ -19,6 +18,8 @@
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\HiddenField;
+use SilverStripe\LinkField\Form\LinkField;
+use SilverStripe\LinkField\Services\LinkTypeService;
 use SilverStripe\ORM\DataList;
 
 class LinkFieldController extends LeftAndMain
@@ -74,7 +75,7 @@ public function linkForm(): Form
             }
         } else {
             $typeKey = $this->typeKeyFromRequest();
-            $link = Registry::create()->byKey($typeKey);
+            $link = LinkTypeService::byKey($typeKey);
             if (!$link) {
                 $this->jsonError(404, _t('LinkField.INVALID_TYPEKEY', 'Invalid typeKey'));
             }
@@ -174,7 +175,7 @@ public function save(array $data, Form $form): HTTPResponse
             // Creating a new Link
             $operation = 'create';
             $typeKey = $this->typeKeyFromRequest();
-            $className = Registry::create()->list()[$typeKey] ?? '';
+            $className = LinkTypeService::byKey($typeKey) ?? '';
             if (!$className) {
                 $this->jsonError(404, _t('LinkField.INVALID_TYPEKEY', 'Invalid typeKey'));
             }
@@ -239,7 +240,7 @@ private function createLinkForm(Link $link, string $operation): Form
         $form = $formFactory->getForm($this, $name, ['Record' => $link]);
 
         // Set where the form is submitted to
-        $typeKey = Registry::create()->keyByClassName($link->ClassName);
+        $typeKey = LinkTypeService::keyByClassName($link->ClassName);
         $form->setFormAction($this->Link("linkForm/$id?typeKey=$typeKey"));
 
         // Add save action button

src/Form/LinkField.php

@@ -7,12 +7,15 @@
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\LinkField\Models\Link;
+use SilverStripe\LinkField\Traits\AllowedLinkClassesTrait;
 
 /**
  * Allows CMS users to edit a Link object.
  */
 class LinkField extends FormField
 {
+    use AllowedLinkClassesTrait;
+
     protected $schemaComponent = 'LinkField';
 
     protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_CUSTOM;

src/Form/MultiLinkField.php

@@ -4,6 +4,7 @@
 
 use LogicException;
 use SilverStripe\Forms\FormField;
+use SilverStripe\LinkField\Traits\AllowedLinkClassesTrait;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\Relation;
@@ -16,6 +17,8 @@
  */
 class MultiLinkField extends FormField
 {
+    use AllowedLinkClassesTrait;
+
     protected $schemaComponent = 'LinkField';
 
     protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_CUSTOM;

src/Models/Link.php

@@ -11,7 +11,8 @@
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\RequiredFields;
-use SilverStripe\LinkField\Type\Registry;
+use SilverStripe\LinkField\Form\LinkField;
+use SilverStripe\LinkField\Services\LinkTypeService;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 
@@ -188,7 +189,7 @@ function setData($data): Link
             );
         }
 
-        $type = Registry::singleton()->byKey($typeKey);
+        $type = LinkTypeService::byKey($typeKey);
 
         if (!$type) {
             throw new InvalidArgumentException(
@@ -225,7 +226,7 @@ function setData($data): Link
 
     public function jsonSerialize(): mixed
     {
-        $typeKey = Registry::singleton()->keyByClassName(static::class);
+        $typeKey = LinkTypeService::keyByClassName(static::class);
 
         if (!$typeKey) {
             return [];
@@ -320,4 +321,9 @@ public function getDefaultTitle(): string
         }
         return $default;
     }
+
+    public function getShortCode(): string
+    {
+        return strtolower(str_replace([' ', 'Link'], '', $this->LinkTypeTile()));
+    }
 }

src/Services/LinkTypeService.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace SilverStripe\LinkField\Services;
+
+use InvalidArgumentException;
+use SilverStripe\Core\ClassInfo;
+use SilverStripe\Core\Injector\Injectable;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\LinkField\Models\Link;
+
+class LinkTypeService
+{
+    use Injectable;
+
+    /**
+     * Generate all link types that are subclasses of Link::class
+     */
+    public static function generateAllLinkTypes(): array
+    {
+        $typeDefinitions = ClassInfo::subclassesFor(Link::class);
+
+        $result = array();
+        foreach ($typeDefinitions as $class) {
+            if (is_subclass_of($class, Link::class)) {
+                $type = Injector::inst()->get($class)->getShortCode();
+                $result[$type] = $class;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * Return a Link instance by key
+     * @throws InvalidArgumentException
+     */
+    public static function byKey(string $key): ?Link
+    {
+        $typeDefinitions = static::generateAllLinkTypes();
+        $definition = $typeDefinitions[$key] ?? null;
+
+        if (!$definition) {
+            return null;
+        }
+
+        return static::definitionToType($definition);
+    }
+
+    /**
+     * Return a key for link type by classname
+     * @throws InvalidArgumentException
+     */
+    public static function keyByClassName(string $classname): ?string
+    {
+        $typeDefinitions = static::generateAllLinkTypes();
+
+        foreach ($typeDefinitions as $key => $class) {
+            if ($class === $classname) {
+                return $key;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @throws InvalidArgumentException
+     */
+    public static function definitionToType(string $className): Link
+    {
+        if (!$className && !($className instanceof Link)) {
+            throw new InvalidArgumentException(
+                _t(
+                    'LinkField.NO_CLASSNAME',
+                    '"{class}": All types should reference a valid classname',
+                    ['class' => static::class],
+                    sprintf('%s: All types should reference a valid classname', static::class),
+                ),
+            );
+        }
+
+        /** @var Link $type */
+        $type = Injector::inst()->get($className);
+
+        if (!$type instanceof Link) {
+            throw new InvalidArgumentException(
+                _t(
+                    'LinkField.INVALID_TYPENAME',
+                    '"{class}": {typename} is not a valid link type',
+                    [
+                        'class' => static::class,
+                        'typename' => $className,
+                    ],
+                    sprintf('%s: %s is not a valid link type', static::class, $className),
+                ),
+            );
+        }
+
+        return $type;
+    }
+}