FIX #309 Support ManyManyThroughList in EditableColumns

[ntd]

The ManyManyThrough fields must be specified without comma, hence its
name must be unique in the joined set of fields. For example, given the
following DataObjects:

class Team extends DataObject
{
    private static $many_many = [
        "Supporters" => [
            'through' => TeamSupporter::class,
            'from' => 'Team',
            'to' => 'Supporter',
        ]
    ];
}
class Supporter extends DataObject
{
    private static $belongs_many_many = [
        'Supports' => Team::class,
    ];
}
class TeamSupporter extends DataObject
{
    private static $db = [
        'Ranking' => 'Int',
    ];
    private static $has_one = [
        'Team' => Team::class,
        'Supporter' => Supporter::class,
    ];
}

you should refer to the ranking field with Ranking, not with
TeamSupporter.Ranking.

[nyeholt]

Hi Nicola, does https://github.com/symbiote/silverstripe-gridfieldextensions/pull/294/files fix your issue too? I'm looking to merge that in as it also fixes an issue with the way loadDataFrom executes during save, but it may also fix your problem if you're able to check and confirm for me?

[ntd]

Hi @nyeholt,

unfortunately I am still unable to edit my extra fields. For your convenience I paste here the full-blown code that I used for testing.
The data model is the classic Team-Supporter relation and I want to edit the rankings.

use SilverStripe\Admin\ModelAdmin;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldButtonRow;
use SilverStripe\Forms\GridField\GridFieldDetailForm;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\DataObject;
use Symbiote\GridFieldExtensions\GridFieldEditableColumns;

class TestAdmin extends ModelAdmin
{
    private static $url_segment = 'editable-test';
    private static $managed_models = [
        Team::class,
    ];
}

class Team extends DataObject
{
    private static $db = [ 'TeamName' => 'Varchar(100)' ];
    private static $summary_fields = [ 'TeamName' ];
    private static $many_many = [
        'Supporters' => [
            'through' => TeamSupporter::class,
            'from' => 'Team',
            'to' => 'Supporter',
        ]
    ];

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $grid = $fields->fieldByName('Root.Supporters.Supporters');
        if ($grid) {
            // Needed: Readonly team + Readonly supporter + Editable ranking

            // (1) Implicit scope: ('none') + Editable supporter + ('none')
            //$display = [
            //    'TeamName' => 'Team',
            //    'SupporterName' => 'Supporter',
            //    'Ranking' => 'Ranking',
            //];

            // (2) Explicit scope: Readonly team + Editable supporter + Readonly ranking
            //$display = [
            //    'TeamSupporter.Team.TeamName' => 'Team',
            //    'SupporterName' => 'Supporter',
            //    'TeamSupporter.Ranking' => 'Ranking',
            //];

            // (3) Handcrafted: Readonly team + Readonly supporter + Editable ranking
            //     Almost there *but* in this case the rankings are not
            //     properly saved!
            $display = [
                'TeamSupporter.Team.TeamName' => 'Team',
                'SupporterName' => [
                    'title' => 'Supporter',
                    'field' => ReadonlyField::class,
                ],
                'TeamSupporter.Ranking' => [
                    'title' => 'Supporter',
                    'field' => NumericField::class,
                ],
            ];

            $config = GridFieldConfig::create()
                ->addComponent(new GridFieldButtonRow('before'))
                ->addComponent(new GridFieldAddNewButton('buttons-before-left'))
                ->addComponent(new GridFieldEditableColumns())
                ->addComponent(new GridFieldDetailForm(null, false, true));
            $config->getComponentByType(GridFieldEditableColumns::class)
                ->setDisplayFields($display);
            $grid->setConfig($config);
        }

       return $fields;
    }
}

class Supporter extends DataObject
{
    private static $db = [ 'SupporterName' => 'Varchar(100)' ];
    private static $belongs_many_many = [ 'Supports' => Team::class ];
    private static $summary_fields = [ 'SupporterName' ];
}

class TeamSupporter extends DataObject
{
    private static $db = [ 'Ranking' => 'Int' ];
    private static $has_one = [
        'Team' => Team::class,
        'Supporter' => Supporter::class,
    ];
}

[sminnee]

It's possible that you also need this unmerged change, @ntd, which I pull into my project via composer-patches silverstripe/silverstripe-framework#9192

I can't recall if it was only needed for detail forms or for editable gridfields too, sorry. But give it a go, maybe?

[ntd]

Yessss, thank you @sminnee: your PR fixes the issue.