Merge pull request #12 from hchokshi/master

Refactor, add support for upload fields, change to SS4 standards

.gitignore

@@ -0,0 +1,4 @@
+/.idea/
+/vendor/
+/resources/
+/composer.lock

README.md

@@ -18,6 +18,21 @@ For example, say you have a `has_one` called `Show` and that `has_one` has a fie
 
 If you do not require that the outputted name of the field matches the value you supply, you can also use a colon as a separator instead of `-_1_-`.
 
+### Generating fields with the `ProvidesHasOneInlineFields` trait
+
+If you simply want to display all the CMS fields for a related object, you can add the `ProvidesHasOneInlineFields` trait to the object. This adds a method which calls `getCMSFields()` 
+on your `DataObject` and return the `FormField`s for that object. Those `FormField`s will be converted for use with this module by adding the relation name and separator to their name.
+
+In the owning object, where you want to display the fields, call `HasOneEdit::getInlineFields($this, 'my_has_one_name')`. This will return the fields for adding to the CMS - e.g. you 
+can display the related object's fields in their own tab by calling `$fields->addFieldsToTab('Root.RelatedObject', HasOneEdit::getInlineFields($this, 'Relation'))`.
+
+This has the advantage of running the entire `getCMSFields()` call tree (e.g. `updateCMSFields` for any functionality provided via extension) etc. without having to repeat logic 
+in a lot of places.
+
+You can also implement a method `public function provideHasOneInlineFields($relationName)` returning `FieldList|FormField[]` to provide a custom interface different 
+to `getCMSFields()` (e.g. just a small subset of fields). In this case, all the field names should be in the form `$relationName . HasOneEdit::FIELD_SEPARATOR . $dataObjectFieldName`.
+This method will be called by `HasOneEdit::getInlineFields` even if your class does not use the `ProvidesHasOneInlineFields` trait.
+
 ### Using with your own form
 
 To add support to your own forms, you need to add the `SGN\HasOneEdit\UpdateFormExtension` extension to your controller and call `$this->extend('updateEditForm', $form)` before returning the form to the template. Without this, the fields will not get populated with the values from the `has_one` though saving will work.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "stevie-mayhew/hasoneedit",
-    "type": "silverstripe-module",
+    "type": "silverstripe-vendormodule",
     "description": "Allows editing the fields of a has_one object directly in the CMS",
     "keywords": ["silverstripe", "has_one", "cms"],
     "license": "WTFPL",
@@ -10,13 +10,14 @@
         "homepage": "http://simon.geek.nz"
     }],
     "require": {
-        "silverstripe/framework": "~4.0.0-alpha3"
+        "silverstripe/framework": "^4.0",
+        "silverstripe/asset-admin": "^1.0"
     },
     "replace" : {
         "simonwelsh/hasoneedit": "*"
     },
     "autoload": {
-        "psr-4": {"SGN\\HasOneEdit\\": "code/"}
+        "psr-4": {"SGN\\HasOneEdit\\": "src/"}
     },
     "extra": {
         "branch-alias": {

src/DataObjectExtension.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace SGN\HasOneEdit;
+
+use SilverStripe\ORM\DataExtension;
+use SilverStripe\ORM\DataObject;
+
+class DataObjectExtension extends DataExtension
+{
+    /**
+     * @see \SilverStripe\ORM\DataObject::onBeforeWrite()
+     */
+    public function onBeforeWrite()
+    {
+        $changed = $this->owner->getChangedFields();
+        $toWrite = [];
+
+        foreach ($changed as $name => $value) {
+            if (!HasOneEdit::isHasOneEditField($name)) continue;
+
+            list($relationName, $fieldOnRelation) = HasOneEdit::getRelationNameAndField($name);
+            $relatedObject = HasOneEdit::getRelationRecord($this->owner, $relationName);
+            if ($relatedObject === null) continue;
+
+            $relatedObject->setCastedField($fieldOnRelation, $value['after']);
+            if ($relatedObject->isChanged(null, DataObject::CHANGE_VALUE)) {
+                $toWrite[$relationName] = $relatedObject;
+            }
+        }
+
+        foreach ($toWrite as $relationName => $obj) {
+            $obj->write();
+            $this->owner->setField("{$relationName}ID", $obj->ID);
+        }
+    }
+}

src/HasOneEdit.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace SGN\HasOneEdit;
+use SilverStripe\ORM\DataObject;
+
+/**
+ * Class HasOneEdit
+ * @package SGN\HasOneEdit
+ */
+class HasOneEdit
+{
+    /**
+     *
+     */
+    const FIELD_SEPARATOR = '-_1_-';
+
+    /**
+     *
+     */
+    const SUPPORTED_SEPARATORS = [
+        self::FIELD_SEPARATOR,
+        ':',
+        '/',
+    ];
+
+    /**
+     * @param \SilverStripe\Forms\FormField|string $field
+     * @return string[] Array of [relation name, field on relation]
+     */
+    public static function getRelationNameAndField($field)
+    {
+        if (!is_string($field)) {
+            $field = $field->getName();
+        }
+
+        return explode(static::FIELD_SEPARATOR, $field, 2);
+    }
+
+    /**
+     * @param \SilverStripe\ORM\DataObject $parent
+     * @param string $relationName
+     * @return \SilverStripe\ORM\DataObject|null
+     */
+    public static function getRelationRecord(DataObject $parent, $relationName)
+    {
+        return array_key_exists($relationName, $parent->hasOne()) || array_key_exists($relationName, $parent->belongsTo(false))
+            ? $parent->getComponent($relationName)
+            : null;
+    }
+
+    /**
+     * @param \SilverStripe\Forms\FormField|string $field
+     * @return bool
+     */
+    public static function isHasOneEditField($field)
+    {
+        if (!is_string($field)) {
+            $field = $field->getName();
+        }
+
+        return boolval(strpos($field, static::FIELD_SEPARATOR));
+    }
+
+    /**
+     * @param string $fieldName
+     * @return string
+     */
+    public static function normaliseSeparator($fieldName)
+    {
+        return str_replace(static::SUPPORTED_SEPARATORS, static::FIELD_SEPARATOR, $fieldName);
+    }
+
+    /**
+     * @param \SilverStripe\ORM\DataObject $parent
+     * @param string $relation
+     * @return \SilverStripe\Forms\FieldList|\SilverStripe\Forms\FormField[]
+     */
+    public static function getInlineFields(DataObject $parent, $relation)
+    {
+        /** @var \SilverStripe\ORM\DataObject|\SGN\HasOneEdit\ProvidesHasOneInlineFields $relatedObject */
+        $relatedObject = static::getRelationRecord($parent, $relation);
+        return $relatedObject->provideHasOneInlineFields($relation);
+    }
+}

src/HasOneUploadField.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace SGN\HasOneEdit;
+
+use SilverStripe\AssetAdmin\Forms\UploadField;
+use SilverStripe\Assets\File;
+use SilverStripe\ORM\DataObject;
+use SilverStripe\ORM\DataObjectInterface;
+use SilverStripe\ORM\Relation;
+
+/**
+ * Class HasOneUploadField
+ * @package App\Forms
+ */
+class HasOneUploadField extends UploadField
+{
+    /**
+     * @var null|bool
+     */
+    private $hasOneMultiUpload = null;
+
+    /**
+     * HasOneUploadField constructor.
+     * @param \SilverStripe\AssetAdmin\Forms\UploadField $original
+     */
+    public function __construct(UploadField $original)
+    {
+        if (!HasOneEdit::isHasOneEditField($original)) {
+            throw new \InvalidArgumentException('Original upload field passed to HasOneUploadField must have the has_one separator "' .
+                HasOneEdit::FIELD_SEPARATOR . '" in its name.');
+        }
+
+        parent::__construct($original->getName(), $original->title, $original->getItems());
+
+        // Copy state from original upload field
+        foreach (get_object_vars($original) as $prop => $value) {
+            $this->{$prop} = $value;
+        }
+    }
+
+    /**
+     * Check if allowed to upload more than one file
+     * @see \SilverStripe\AssetAdmin\Forms\UploadField::getIsMultiUpload()
+     * @return bool
+     */
+    public function getIsMultiUpload()
+    {
+        if ($this->hasOneMultiUpload === null) {
+            // Guess from record
+            list($relationName, $fieldOnRelation) = HasOneEdit::getRelationNameAndField($this);
+            $relatedObject = HasOneEdit::getRelationRecord($this->getRecord(), $relationName);
+
+            // Multi-upload disabled for has_one components
+            $this->hasOneMultiUpload = !($relatedObject && DataObject::getSchema()->hasOneComponent($relatedObject, $fieldOnRelation));
+        }
+
+        return $this->hasOneMultiUpload;
+    }
+
+    /**
+     * @see \SilverStripe\AssetAdmin\Forms\UploadField::saveInto()
+     * @inheritDoc
+     */
+    public function saveInto(DataObjectInterface $record)
+    {
+        list($relationName, $fieldOnRelation) = HasOneEdit::getRelationNameAndField($this);
+        $record = HasOneEdit::getRelationRecord($this->getRecord(), $relationName);
+
+        // Check type of relation
+        $relation = $record->hasMethod($fieldOnRelation) ? $record->$fieldOnRelation() : null;
+        if ($relation instanceof Relation) {
+            // has_many or many_many
+            $relation->setByIDList($this->getItemIDs());
+        } elseif ($class = DataObject::getSchema()->hasOneComponent($record, $fieldOnRelation)) {
+            // Get details to save
+            $idList = $this->getItemIDs();
+
+            // Assign has_one ID
+            $id = !empty($idList) ? reset($idList) : 0;
+            $record->setField("{$fieldOnRelation}ID", $id);
+
+            // Polymorphic asignment
+            if ($class === DataObject::class) {
+                $file = $id ? File::get()->byID($id) : null;
+                $fileClass = $file ? get_class($file) : File::class;
+                $record->{"{$fieldOnRelation}Class"} = $id ? $fileClass : null;
+            }
+
+            // Write has one record
+            $record->write();
+        }
+
+        return $this;
+    }
+}