Silverstripe 4 Upgrade - Unversioned DataObjects in ModelAdmin lose their image objects

Question

Been pulling my hair out over this for a day and exhausted my google foo. I have inherited a Silverstripe 3.4 site that we have upgraded to 4.4. But something odd has been going on with certain images after running MigrateFilesTask.

I think this is something to do with a file being attached to an unversioned objects that are accessed via ModelAdmin. But I have not been able to find a definitive solution.

Code for this object below. Problems experienced are under it.

<?php

use SilverStripe\Assets\Image;
use gorriecoe\Link\Models\Link;
use SilverStripe\Security\Member;
use SilverStripe\Control\Controller;
use SilverStripe\View\Parsers\URLSegmentFilter;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\FieldGroup;
use gorriecoe\LinkField\LinkField;
use SilverStripe\TagField\TagField;
use SilverStripe\ORM\DataObject;
use SilverStripe\SelectUpload\SelectUploadField;

class Person extends DataObject
{

  private static $db = array(
    'FirstName'        => 'Varchar(128)',
    'LastName'         => 'Varchar(128)',
    'Role'             => 'Varchar(128)',
    'DirectDialNumber' => 'Varchar(128)',
    'Email'            => 'Varchar(128)',
    'CellphoneNumber'  => 'Varchar(30)',
    'DirectDial'       => 'Varchar(30)',
    'UrlSegment'       => 'Varchar(255)',
    'Blurb'            => 'HTMLText',
    'SortOrder'        => 'Int'
  );

  private static $has_one = array(
    'Image' => Image::class,
    'Office' => 'Office',
    'LinkedIn' => Link::class,
    'Member' => Member::class
  );

  private static $many_many = array(
    'Interests' => 'Section'
  );

  private static $belongs_many_many = array(
    'ElementCollection' => 'ElementCollection'
  );

  static $sort_fields = array(
    'FirstName' => 'First name',
    'LastName' => 'Last name',
    'Role' => 'Role'
  );

  private static $summary_fields = array(
    'Name' => 'Name',
    'Role' => 'Role',
    'Office.Name' => 'Office'
  );

  private static $searchable_fields = array(
    'FirstName',
    'LastName',
    'Role'
  );

  // For use with the ElementCollection
  public static $templates = array(
    'ElementPeople' => 'Default',
    'ElementPeopleAlternative' => 'Alternative'
  );


  public function getCMSFields() {
    $fields = parent::getCMSFields();
    $fields->removeByName( ['SortOrder', 'ElementCollection', 'FirstName', 'LastName', 'Interests'] );

    $firstname = TextField::create('FirstName', 'First name');
    $lastname = TextField::create('LastName', 'Last name');

    $fields->addFieldsToTab('Root.Main', FieldGroup::create($firstname, $lastname)->setTitle('Name')->setName('Name'), 'Role');

    $image = UploadField::create('Image', 'Photo');
    $image->setFolderName('Uploads/People');
    $image->setCanSelectFolder(false);
    $fields->addFieldToTab('Root.Main', $image);

    $linkedin = LinkField::create('LinkedIn', 'LinkedIn', $this);
    $fields->addFieldToTab('Root.Main', $linkedin);

    $interests = TagField::create(
      'Interests',
      'Interests Tags',
      Section::get(),
      $this->Interests()
    )->setShouldLazyLoad(true)
     ->setCanCreate(false);

    $fields->addFieldToTab('Root.Main', $interests);

    return $fields;
  }

  public function onBeforeWrite()
  {

    $count = 1;
    $this->UrlSegment = $this->generateURLSegment();
    while (!$this->validURLSegment()) {
      $this->UrlSegment = preg_replace('/-[0-9]+$/', null, $this->UrlSegment) . '-' . $count;
      $count++;
    }
    parent::onBeforeWrite();
  }
}

Problem #1 is after running MigrateFileTask, ALL existing images attached to instances of this class get moved from /assets/Uploads/People to /assets/.protected/Uploads/People. The confusing part here is that there is one other class called Company that is structurally near identical, yet images for that remain in /assets/Uploads/Companies as expected.

Problem #2 is if I create a new Person object and attach an image, that image is in Draft, sitting in /assets/.protected/Uploads/People with no method of actually publishing it. Meanwhile, if I do the same with a Company object, the image is still in Draft, but I can see it in the CMS.

Can someone offer some guidance on the above? At this point I'd be happy to just be able for images to be published when the DO is and I'll manually go through every single Person record and hit save myself just to get this upgrade over the line.

PsychoMo PsychoMo · Accepted Answer · 2019-09-03T16:11:12

You should be able to fix this issue by adding the image to your DataObejct's owns property. Basically add this:

    private static $owns = [
        'Image'
    ];

Basically owns tells a DataObject which objects to publish when it is saved:

More info in the docs: https://docs.silverstripe.org/en/4/developer_guides/model/versioning/#defining-ownership-between-related-versioned-dataobjects

Silverstripe 4 Upgrade - Unversioned DataObjects in ModelAdmin lose their image objects

3 Answers