ENH More standardisation

src/Form/AbstractLinkField.php

@@ -80,7 +80,7 @@ public function getTypesProp(): string
             $typesList[$key] = [
                 'key' => $key,
                 'title' => $type->getMenuTitle(),
-                'handlerName' => $type->LinkTypeHandlerName(),
+                'handlerName' => $type->getLinkTypeHandlerName(),
                 'priority' => $class::config()->get('menu_priority'),
                 'icon' => $class::config()->get('icon'),
                 'allowed' => $allowed,

src/Models/FileLink.php

@@ -52,10 +52,10 @@ public function getURL(): string
         return $file->exists() ? (string) $file->getURL() : '';
     }
 
-    public function getDefaultTitle(): string
+    protected function getDefaultTitle(): string
     {
         $file = $this->File();
-        if (!$file->exists()) {
+        if (!$file?->exists()) {
             return _t(__CLASS__ . '.MISSING_DEFAULT_TITLE', '(File missing)');
         }
 

src/Models/Link.php

@@ -2,10 +2,8 @@
 
 namespace SilverStripe\LinkField\Models;
 
-use InvalidArgumentException;
 use ReflectionException;
 use SilverStripe\Core\ClassInfo;
-use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\LinkField\Services\LinkTypeService;
 use SilverStripe\ORM\DataObject;
@@ -69,17 +67,20 @@ class Link extends DataObject
      */
     private static $icon = 'font-icon-link';
 
+    /**
+     * Get a short description of the link.
+     *
+     * This is displayed in LinkField as an indication of what the link is pointing at.
+     */
     public function getDescription(): string
     {
         return '';
     }
 
-    public function scaffoldLinkFields(array $data): FieldList
-    {
-        return $this->getCMSFields();
-    }
-
-    public function LinkTypeHandlerName(): string
+    /**
+     * Get the react component used to render the modal form.
+     */
+    public function getLinkTypeHandlerName(): string
     {
         return 'FormBuilderModal';
     }
@@ -132,91 +133,9 @@ public function onBeforeWrite(): void
         parent::onBeforeWrite();
     }
 
-    function setData($data): Link
-    {
-        if (is_string($data)) {
-            $data = json_decode($data, true);
-
-            if (json_last_error() !== JSON_ERROR_NONE) {
-                throw new InvalidArgumentException(
-                    _t(
-                        __CLASS__ . '.INVALID_JSON',
-                        '"{class}": Decoding json string failred with "{error}"',
-                        [
-                            'class' => static::class,
-                            'error' => json_last_error_msg(),
-                        ],
-                        sprintf(
-                            '"%s": Decoding json string failred with "%s"',
-                            static::class,
-                            json_last_error_msg(),
-                        ),
-                    ),
-                );
-            }
-        } elseif ($data instanceof Link) {
-            $data = $data->jsonSerialize();
-        }
-
-        if (!is_array($data)) {
-            throw new InvalidArgumentException(
-                _t(
-                    __CLASS__ . '.INVALID_DATA_TO_ARRAY',
-                    '"{class}": Could not convert $data to an array.',
-                    ['class' => static::class],
-                    sprintf('%s: Could not convert $data to an array.', static::class),
-                ),
-            );
-        }
-
-        $typeKey = $data['typeKey'] ?? null;
-
-        if (!$typeKey) {
-            throw new InvalidArgumentException(
-                _t(
-                    __CLASS__ . '.DATA_HAS_NO_TYPEKEY',
-                    '"{class}": $data does not have a typeKey.',
-                    ['class' => static::class],
-                    sprintf('%s: $data does not have a typeKey.', static::class),
-                ),
-            );
-        }
-
-        $type = LinkTypeService::create()->byKey($typeKey);
-
-        if (!$type) {
-            throw new InvalidArgumentException(
-                _t(
-                    __CLASS__ . '.NOT_REGISTERED_LINKTYPE',
-                    '"{class}": "{typekey}" is not a registered Link Type.',
-                    [
-                        'class' => static::class,
-                        'typekey' => $typeKey
-                    ],
-                    sprintf('"%s": "%s" is not a registered Link Type.', static::class, $typeKey),
-                ),
-            );
-        }
-
-        $jsonData = $this;
-
-        if ($this->ClassName !== get_class($type)) {
-            if ($this->isInDB()) {
-                $jsonData = $this->newClassInstance(get_class($type));
-            } else {
-                $jsonData = Injector::inst()->create(get_class($type));
-            }
-        }
-
-        foreach ($data as $key => $value) {
-            if ($jsonData->hasField($key)) {
-                $jsonData->setField($key, $value);
-            }
-        }
-
-        return $jsonData;
-    }
-
+    /**
+     * Serialise the link data as a JSON string so it can be fetched from JavaScript.
+     */
     public function jsonSerialize(): mixed
     {
         $typeKey = LinkTypeService::create()->keyByClassName(static::class);
@@ -237,19 +156,6 @@ public function jsonSerialize(): mixed
         return $data;
     }
 
-    public function loadLinkData(array $data): Link
-    {
-        $link = new static();
-
-        foreach ($data as $key => $value) {
-            if ($link->hasField($key)) {
-                $link->setField($key, $value);
-            }
-        }
-
-        return $link;
-    }
-
     /**
      * Return a rendered version of this form.
      *
@@ -266,13 +172,18 @@ public function forTemplate()
     }
 
     /**
+     * Get the URL this Link links to.
+     *
      * This method should be overridden by any subclasses
      */
     public function getURL(): string
     {
         return '';
     }
 
+    /**
+     * Get a string representing the versioned state of the link.
+     */
     public function getVersionedState(): string
     {
         if (!$this->exists()) {
@@ -394,7 +305,10 @@ public function getTitle(): string
         return $defaultLinkTitle;
     }
 
-    public function getDefaultTitle(): string
+    /**
+     * Get the title that will be displayed if there is no LinkText.
+     */
+    protected function getDefaultTitle(): string
     {
         $default = $this->getDescription() ?: $this->getURL();
         if (!$default) {
@@ -406,6 +320,7 @@ public function getDefaultTitle(): string
     /**
      * This method process the defined singular_name of Link class
      * to get the short code of the Link class name.
+     *
      * Or If the name is not defined (by redefining $singular_name in the subclass),
      * this use the class name. The Link prefix is removed from the class name
      * and the resulting name is converted to lowercase.
@@ -419,6 +334,7 @@ public function getShortCode(): string
     /**
      * The title that will be displayed in the dropdown
      * for selecting the link type to create.
+     *
      * Subclasses should override this.
      * It will use the singular_name by default.
      */

src/Models/SiteTreeLink.php

@@ -122,7 +122,7 @@ public function getURL(): string
         return Controller::join_links($url, $anchorSegment, $queryStringSegment);
     }
 
-    public function getDefaultTitle(): string
+    protected function getDefaultTitle(): string
     {
         $page = $this->Page();
         if (!$page->exists()) {

tests/php/Models/FileLinkTest.php

@@ -2,6 +2,7 @@
 
 namespace SilverStripe\LinkField\Tests\Models;
 
+use ReflectionMethod;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\LinkField\Models\FileLink;
 use SilverStripe\LinkField\Tests\Models\FileLinkTest\TestFileCanView;
@@ -18,7 +19,7 @@ class FileLinkTest extends SapphireTest
     public function testGetDescription(): void
     {
         // FileLink without a page
-        $link = FileLink::create();
+        $link = new FileLink();
         $this->assertSame('File does not exist', $link->getDescription());
         // FileLink with a page though cannot view the page
         $file = new TestFileCannotView(['Name' => 'not-allowed']);
@@ -35,4 +36,26 @@ public function testGetDescription(): void
         $link->write();
         $this->assertSame('file-b.png', $link->getDescription());
     }
+
+    public function testGetDefaultTitle(): void
+    {
+        $reflectionGetDefaultTitle = new ReflectionMethod(FileLink::class, 'getDefaultTitle');
+        $reflectionGetDefaultTitle->setAccessible(true);
+
+        // File does not exist
+        $link = new FileLink();
+        $this->assertSame('(File missing)', $reflectionGetDefaultTitle->invoke($link));
+        // File exists in DB but not in filesystem
+        $file = new TestFileCanView(['Name' => 'My test file']);
+        $file->write();
+        $link->File = $file->ID;
+        $link->write();
+        $this->assertSame('(File missing)', $reflectionGetDefaultTitle->invoke($link));
+        // File actually exists
+        $file->setFromLocalFile(realpath(__DIR__ .'/FileLinkTest/file-b.png'), 'file-b.png');
+        $file->write();
+        $link->File = $file->ID;
+        $link->write();
+        $this->assertSame('file-b.png', $reflectionGetDefaultTitle->invoke($link));
+    }
 }

tests/php/Models/LinkTest.php

@@ -70,7 +70,7 @@ public function testLinkModel(): void
     {
         $model = $this->objFromFixture(Link::class, 'link-1');
 
-        $this->assertEquals('FormBuilderModal', $model->LinkTypeHandlerName());
+        $this->assertEquals('FormBuilderModal', $model->getLinkTypeHandlerName());
     }
 
     /**

tests/php/Models/SiteTreeLinkTest.php

@@ -2,6 +2,7 @@
 
 namespace SilverStripe\LinkField\Tests\Models;
 
+use ReflectionMethod;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\LinkField\Models\SiteTreeLink;
 use SilverStripe\LinkField\Tests\Models\SiteTreeLinkTest\TestSiteTreeCanView;
@@ -17,7 +18,7 @@ class SiteTreeLinkTest extends SapphireTest
     public function testGetDescription(): void
     {
         // SiteTreeLink without a page
-        $link = SiteTreeLink::create();
+        $link = new SiteTreeLink();
         $this->assertSame('Page does not exist', $link->getDescription());
         // SiteTreeLink with a page though cannot view the page
         $page = new TestSiteTreeCannotView(['URLSegment' => 'test-a']);
@@ -35,14 +36,17 @@ public function testGetDescription(): void
 
     public function testGetDefaultTitle(): void
     {
+        $reflectionGetDefaultTitle = new ReflectionMethod(SiteTreeLink::class, 'getDefaultTitle');
+        $reflectionGetDefaultTitle->setAccessible(true);
+
         // Page does not exist
-        $link = SiteTreeLink::create();
-        $this->assertSame('(Page missing)', $link->getDefaultTitle());
+        $link = new SiteTreeLink();
+        $this->assertSame('(Page missing)', $reflectionGetDefaultTitle->invoke($link));
         // Page exists
         $page = new TestSiteTreeCanView(['Title' => 'My test page']);
         $page->write();
         $link->Page = $page->ID;
         $link->write();
-        $this->assertSame('My test page', $link->getDefaultTitle());
+        $this->assertSame('My test page', $reflectionGetDefaultTitle->invoke($link));
     }
 }