Move things around and add doc

_config/types.yml

@@ -5,14 +5,14 @@ Name: linkfield-types
 SilverStripe\Link\Type\Registry:
   types:
     cms:
-      classname: SilverStripe\Link\SiteTreeLink
+      classname: SilverStripe\Link\Models\SiteTreeLink
       enabled: true
     external:
-      classname: SilverStripe\Link\ExternalLink
+      classname: SilverStripe\Link\Models\ExternalLink
       enabled: true
     file:
-      classname: SilverStripe\Link\FileLink
+      classname: SilverStripe\Link\Models\FileLink
       enabled: true
     email:
-      classname: SilverStripe\Link\EmailLink
+      classname: SilverStripe\Link\Models\EmailLink
       enabled: true

src/Extensions/AjaxField.php

@@ -4,12 +4,13 @@
 
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\FormField;
-use SilverStripe\Link;
 
 /**
- * Tweak fields that need to be serve through the DynamicLink form schema and need to be able to receive AJAX calls.
+ * Tweak fields that need to be served through the DynamicLink form schema and need to be able to receive AJAX calls.
  *
  * For example the TreeDropdownField need to be able to receive AJAX request to fetch the list of available SiteTrees.
+ *
+ * This is a bit hackish. There's probably a less dumb way of doing this.
  */
 class AjaxField extends Extension
 {

src/Extensions/ModalController.php

@@ -7,9 +7,8 @@
 use SilverStripe\Control\HTTPResponse_Exception;
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\Form;
-use SilverStripe\Link\FormFactory;
+use SilverStripe\Link\Form\FormFactory;
 use SilverStripe\Link\Type\Registry;
-use SilverStripe\View\Requirements;
 
 /**
  * Extensions to apply to ModalController so it knows how to handle the DynamicLink action.

src/FormFactory.php → src/Form/FormFactory.php

@@ -1,13 +1,15 @@
 <?php
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Form;
 
 use LogicException;
 use SilverStripe\Admin\Forms\LinkFormFactory;
 use SilverStripe\Forms\HiddenField;
-use SilverStripe\Link\Type\Registry;
 use SilverStripe\Link\Type\Type;
 
+/**
+ * Create Form schema for the LinkField based on a key provided by the request.
+ */
 class FormFactory extends LinkFormFactory
 {
     protected function getFormFields($controller, $name, $context)

src/JsonField.php → src/Form/JsonField.php

@@ -1,20 +1,16 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Form;
 
 use InvalidArgumentException;
-use SilverStripe\Assets\File;
-use SilverStripe\Forms\FileUploadReceiver;
 use SilverStripe\Forms\FormField;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
-use SilverStripe\ORM\RelationList;
-use SilverStripe\ORM\UnsavedRelationList;
 
 /**
- * Field design to edit complex data passed as a JSON string. Other FormFields can be built on top of this one.
+ * Field designed to edit complex data passed as a JSON string. Other FormFields can be built on top of this one.
  *
- * It will output an hidden input with serialize JSON Data.
+ * It will output a hidden input with serialize JSON Data.
  */
 abstract class JsonField extends FormField
 {
@@ -43,7 +39,7 @@ public function saveInto(DataObjectInterface $record)
         }
 
         $dataValue = $this->dataValue();
-        $value = is_array($dataValue) ? $dataValue : $this->parseString($this->dataValue());
+        $value = is_string($dataValue) ? $this->parseString($this->dataValue()) : $dataValue;
 
         if ($class = DataObject::getSchema()->hasOneComponent(get_class($record), $fieldname)) {
             /** @var JsonData|DataObject $jsonDataObject */

src/LinkField.php → src/Form/LinkField.php

@@ -1,11 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
-
-use InvalidArgumentException;
-use SilverStripe\Forms\FormField;
-use SilverStripe\Link\Type\Registry;
+namespace SilverStripe\Link\Form;
 
+/**
+ * Allows CMS users to edit a Link object.
+ */
 class LinkField extends JsonField
 {
     protected $schemaComponent = 'LinkField';

src/GraphQL/LinkDescriptionQuery.php

@@ -3,7 +3,6 @@
 
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type as GraphqlType;
-use SilverStripe\GraphQL\Pagination\Connection;
 use SilverStripe\GraphQL\QueryCreator;
 use SilverStripe\Link\Type\Registry;
 

src/GraphQL/LinkDescriptionType.php

@@ -4,7 +4,6 @@
 
 use GraphQL\Type\Definition\Type as GraphqlType;
 use SilverStripe\GraphQL\TypeCreator as GraphqlTypeCreator;
-use GraphQL\Type\Definition\ResolveInfo;
 
 /**
  * GraphQL type for serving a Link Description.

src/GraphQL/LinkTypeQuery.php

@@ -3,7 +3,6 @@
 
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type as GraphqlType;
-use SilverStripe\GraphQL\Pagination\Connection;
 use SilverStripe\GraphQL\QueryCreator;
 use SilverStripe\Link\Type\Registry;
 use SilverStripe\Link\Type\Type;

src/EmailLink.php → src/Models/EmailLink.php

@@ -1,16 +1,14 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Models;
 
-use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\Forms\EmailField;
-use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\TextField;
-use SilverStripe\Forms\TreeDropdownField;
-use SilverStripe\i18n\i18n;
-use SilverStripe\Link\Type\Type;
-use SilverStripe\View\Requirements;
 
+/**
+ * A link to an Email address.
+ *
+ * @property string $Email
+ */
 class EmailLink extends Link
 {
 

src/ExternalLink.php → src/Models/ExternalLink.php

@@ -1,15 +1,12 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
-
-use SilverStripe\CMS\Model\SiteTree;
-use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\TextField;
-use SilverStripe\Forms\TreeDropdownField;
-use SilverStripe\i18n\i18n;
-use SilverStripe\Link\Type\Type;
-use SilverStripe\View\Requirements;
+namespace SilverStripe\Link\Models;
 
+/**
+ * An link to an external URL.
+ *
+ * @property string $ExternalUrl
+ */
 class ExternalLink extends Link
 {
 

src/FileLink.php → src/Models/FileLink.php

@@ -1,14 +1,15 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Models;
 
 use SilverStripe\Assets\File;
 use SilverStripe\i18n\i18n;
 use SilverStripe\Link\Type\Type;
 
 /**
- * Class FileLink
- * @property File File
+ * A link to a File track in asset-admin
+ * @property File $File
+ * @property int $FileID
  */
 class FileLink extends Link
 {
@@ -37,19 +38,4 @@ public function getURL()
     {
         return $this->File ? $this->File->getURL() : '';
     }
-
-//    public function getCMSFields()
-//    {
-//        return parent::getCMSFields()
-//            ->addFieldToTab(
-//                'Root.Main',
-//                TreeDropdownField::create(
-//                    'SiteTreeID',
-//                    'Page',
-//                    SiteTree::class,
-//                    'ID',
-//                    'TreeTitle'
-//                )
-//            );
-//    }
 }

src/Link.php → src/Models/Link.php

@@ -1,18 +1,22 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Models;
 
 use InvalidArgumentException;
-use LogicException;
-use SilverStripe\CMS\Model\SiteTree;
-use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
 use SilverStripe\Forms\FieldList;
+use SilverStripe\Link\JsonData;
 use SilverStripe\Link\Type\Registry;
 use SilverStripe\Link\Type\Type;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\View\Requirements;
 
+/**
+ * A Link Data Object. This class should be subclass and you should never directly interact with a plain Link instance.
+ *
+ * @property string $Title
+ * @property bool $OpenInNew
+ */
 class Link extends DataObject implements JsonData, Type
 {
 

src/SiteTreeLink.php → src/Models/SiteTreeLink.php

@@ -1,20 +1,16 @@
 <?php declare(strict_types=1);
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\Models;
 
 use SilverStripe\CMS\Forms\AnchorSelectorField;
 use SilverStripe\CMS\Model\SiteTree;
-use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\TextField;
 use SilverStripe\Forms\TreeDropdownField;
-use SilverStripe\i18n\i18n;
-use SilverStripe\Link\Type\Type;
-use SilverStripe\View\Requirements;
 
 /**
- * Class SiteTreeLink
- * @property SiteTree Page
- * @property string Anchor
+ * A link to a Page in the CMS.
+ * @property SiteTree $Page
+ * @property int $PageID
+ * @property string $Anchor
  */
 class SiteTreeLink extends Link
 {

src/DBJson.php → src/ORM/DBJson.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\ORM;
 
 use SilverStripe\Core\Config\Config;
 use SilverStripe\ORM\DB;
 use SilverStripe\ORM\FieldType\DBField;
 
 /**
- * Represents a signed 32 bit integer field.
+ * Represents a DBField storing a JSON string
  */
 class DBJson extends DBField
 {

src/DBLink.php → src/ORM/DBLink.php

@@ -1,20 +1,18 @@
 <?php
 
-namespace SilverStripe\Link;
+namespace SilverStripe\Link\ORM;
 
 use SilverStripe\Link\Type\Registry;
-use SilverStripe\ORM\DB;
-use SilverStripe\ORM\ArrayList;
 use SilverStripe\ORM\FieldType\DBHTMLText;
-use SilverStripe\View\ArrayData;
+use SilverStripe\Link\Form\LinkField;
 
+/**
+ * Represent Link object stored as a JSON string
+ */
 class DBLink extends DBJson
 {
     /**
-     * Return a rendered version of this form.
-     *
-     * This is returned when you access a form as $FormObject rather
-     * than <% with FormObject %>
+     * Load the link data into a singleton Link Object
      *
      * @return DBHTMLText
      */