silverstripe-framework/tests/php/ORM/ManyManyThroughListTest.php

<?php

namespace SilverStripe\ORM\Tests;

use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ManyManyThroughList;
use SilverStripe\ORM\Versioning\Versioned;
use InvalidArgumentException;

class ManyManyThroughListTest extends SapphireTest
{
    protected static $fixture_file = 'ManyManyThroughListTest.yml';

    protected $extraDataObjects = [
        ManyManyThroughListTest\Item::class,
        ManyManyThroughListTest\JoinObject::class,
        ManyManyThroughListTest\TestObject::class,
        ManyManyThroughListTest\VersionedItem::class,
        ManyManyThroughListTest\VersionedJoinObject::class,
        ManyManyThroughListTest\VersionedObject::class,
    ];

    public function setUp()
    {
        parent::setUp();
        DataObject::reset();
    }

    public function tearDown()
    {
        DataObject::reset();
        parent::tearDown();
    }

    public function testSelectJoin()
    {
        /**
 * @var \SilverStripe\ORM\Tests\ManyManyThroughListTest\ManyManyThroughListTest_Object $parent
*/
        $parent = $this->objFromFixture(ManyManyThroughListTest\TestObject::class, 'parent1');
        $this->assertDOSEquals(
            [
                ['Title' => 'item 1'],
                ['Title' => 'item 2']
            ],
            $parent->Items()
        );
        // Check filters on list work
        $item1 = $parent->Items()->filter('Title', 'item 1')->first();
        $this->assertNotNull($item1);
        $this->assertNotNull($item1->getJoin());
        $this->assertEquals('join 1', $item1->getJoin()->Title);
        $this->assertInstanceOf(
            ManyManyThroughListTest\JoinObject::class,
            $item1->ManyManyThroughListTest_JoinObject
        );
        $this->assertEquals('join 1', $item1->ManyManyThroughListTest_JoinObject->Title);

        // Check filters on list work
        $item2 = $parent->Items()->filter('Title', 'item 2')->first();
        $this->assertNotNull($item2);
        $this->assertNotNull($item2->getJoin());
        $this->assertEquals('join 2', $item2->getJoin()->Title);
        $this->assertEquals('join 2', $item2->ManyManyThroughListTest_JoinObject->Title);

        // To filter on join table need to use some raw sql
        $item2 = $parent->Items()->where(['"ManyManyThroughListTest_JoinObject"."Title"' => 'join 2'])->first();
        $this->assertNotNull($item2);
        $this->assertEquals('item 2', $item2->Title);
        $this->assertNotNull($item2->getJoin());
        $this->assertEquals('join 2', $item2->getJoin()->Title);
        $this->assertEquals('join 2', $item2->ManyManyThroughListTest_JoinObject->Title);

        // Test sorting on join table
        $items = $parent->Items()->sort('"ManyManyThroughListTest_JoinObject"."Sort"');
        $this->assertDOSEquals(
            [
                ['Title' => 'item 2'],
                ['Title' => 'item 1'],
            ],
            $items
        );

        $items = $parent->Items()->sort('"ManyManyThroughListTest_JoinObject"."Sort" ASC');
        $this->assertDOSEquals(
            [
                ['Title' => 'item 1'],
                ['Title' => 'item 2'],
            ],
            $items
        );
        $items = $parent->Items()->sort('"ManyManyThroughListTest_JoinObject"."Title" DESC');
        $this->assertDOSEquals(
            [
                ['Title' => 'item 2'],
                ['Title' => 'item 1'],
            ],
            $items
        );
    }

    public function testAdd()
    {
        /**
 * @var \SilverStripe\ORM\Tests\ManyManyThroughListTest\ManyManyThroughListTest_Object $parent
*/
        $parent = $this->objFromFixture(ManyManyThroughListTest\TestObject::class, 'parent1');
        $newItem = new ManyManyThroughListTest\Item();
        $newItem->Title = 'my new item';
        $newItem->write();
        $parent->Items()->add($newItem, ['Title' => 'new join record']);

        // Check select
        $newItem = $parent->Items()->filter(['Title' => 'my new item'])->first();
        $this->assertNotNull($newItem);
        $this->assertEquals('my new item', $newItem->Title);
        $this->assertInstanceOf(
            ManyManyThroughListTest\JoinObject::class,
            $newItem->getJoin()
        );
        $this->assertInstanceOf(
            ManyManyThroughListTest\JoinObject::class,
            $newItem->ManyManyThroughListTest_JoinObject
        );
        $this->assertEquals('new join record', $newItem->ManyManyThroughListTest_JoinObject->Title);
    }

    public function testRemove()
    {
        /**
 * @var \SilverStripe\ORM\Tests\ManyManyThroughListTest\ManyManyThroughListTest_Object $parent
*/
        $parent = $this->objFromFixture(ManyManyThroughListTest\TestObject::class, 'parent1');
        $this->assertDOSEquals(
            [
                ['Title' => 'item 1'],
                ['Title' => 'item 2']
            ],
            $parent->Items()
        );
        $item1 = $parent->Items()->filter(['Title' => 'item 1'])->first();
        $parent->Items()->remove($item1);
        $this->assertDOSEquals(
            [['Title' => 'item 2']],
            $parent->Items()
        );
    }

    public function testPublishing()
    {
        /**
 * @var \SilverStripe\ORM\Tests\ManyManyThroughListTest\ManyManyThroughListTest_VersionedObject $draftParent
*/
        $draftParent = $this->objFromFixture(ManyManyThroughListTest\VersionedObject::class, 'parent1');
        $draftParent->publishRecursive();

        // Modify draft stage
        $item1 = $draftParent->Items()->filter(['Title' => 'versioned item 1'])->first();
        $item1->Title = 'new versioned item 1';
        $item1->getJoin()->Title = 'new versioned join 1';
        $item1->write(false, false, false, true); // Write joined components
        $draftParent->Title = 'new versioned title';
        $draftParent->write();

        // Check owned objects on stage
        $draftOwnedObjects = $draftParent->findOwned(true);
        $this->assertDOSEquals(
            [
                ['Title' => 'new versioned join 1'],
                ['Title' => 'versioned join 2'],
                ['Title' => 'new versioned item 1'],
                ['Title' => 'versioned item 2'],
            ],
            $draftOwnedObjects
        );

        // Check live record is still old values
        // This tests that both the join table and many_many tables
        // inherit the necessary query parameters from the parent object.
        /**
 * @var \SilverStripe\ORM\Tests\ManyManyThroughListTest\ManyManyThroughListTest_VersionedObject $liveParent
*/
        $liveParent = Versioned::get_by_stage(
            ManyManyThroughListTest\VersionedObject::class,
            Versioned::LIVE
        )->byID($draftParent->ID);
        $liveOwnedObjects = $liveParent->findOwned(true);
        $this->assertDOSEquals(
            [
                ['Title' => 'versioned join 1'],
                ['Title' => 'versioned join 2'],
                ['Title' => 'versioned item 1'],
                ['Title' => 'versioned item 2'],
            ],
            $liveOwnedObjects
        );

        // Publish draft changes
        $draftParent->publishRecursive();
        $liveParent = Versioned::get_by_stage(
            ManyManyThroughListTest\VersionedObject::class,
            Versioned::LIVE
        )->byID($draftParent->ID);
        $liveOwnedObjects = $liveParent->findOwned(true);
        $this->assertDOSEquals(
            [
                ['Title' => 'new versioned join 1'],
                ['Title' => 'versioned join 2'],
                ['Title' => 'new versioned item 1'],
                ['Title' => 'versioned item 2'],
            ],
            $liveOwnedObjects
        );
    }

    /**
     * Test validation
     */
    public function testValidateModelValidatesJoinType()
    {
        DataObject::reset();
        ManyManyThroughListTest\Item::config()->update(
            'db',
            [
            ManyManyThroughListTest\JoinObject::class => 'Text'
            ]
        );
        $this->setExpectedException(InvalidArgumentException::class);
        DataObject::getSchema()->manyManyComponent(ManyManyThroughListTest\TestObject::class, 'Items');
    }

    public function testRelationParsing()
    {
        $schema = DataObject::getSchema();

        // Parent components
        $this->assertEquals(
            [
                ManyManyThroughList::class,
                ManyManyThroughListTest\TestObject::class,
                ManyManyThroughListTest\Item::class,
                'ParentID',
                'ChildID',
                ManyManyThroughListTest\JoinObject::class
            ],
            $schema->manyManyComponent(ManyManyThroughListTest\TestObject::class, 'Items')
        );

        // Belongs_many_many is the same, but with parent/child substituted
        $this->assertEquals(
            [
                ManyManyThroughList::class,
                ManyManyThroughListTest\Item::class,
                ManyManyThroughListTest\TestObject::class,
                'ChildID',
                'ParentID',
                ManyManyThroughListTest\JoinObject::class
            ],
            $schema->manyManyComponent(ManyManyThroughListTest\Item::class, 'Objects')
        );
    }
}