silverstripe-framework/tests/model/DBCompositeTest.php

<?php



use SilverStripe\ORM\FieldType\DBMoney;
use SilverStripe\ORM\DataObject;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Dev\TestOnly;



/**
 * @package framework
 * @subpackage tests
 */
class DBCompositeTest extends SapphireTest {

	protected $extraDataObjects = array(
		'DBCompositeTest_DataObject',
		'SubclassedDBFieldObject',
	);

	public function testHasDatabaseFieldOnDataObject() {
		$obj = singleton('DBCompositeTest_DataObject');

		$this->assertTrue($obj->hasDatabaseField('MyMoneyAmount'));
		$this->assertTrue($obj->hasDatabaseField('MyMoneyCurrency'));
		$this->assertFalse($obj->hasDatabaseField('MyMoney'));

		// Check that nested fields are exposed properly
		$this->assertTrue($obj->dbObject('MyMoney')->hasField('Amount'));
		$this->assertTrue($obj->dbObject('MyMoney')->hasField('Currency'));

		// Test getField accessor
		$this->assertTrue($obj->MyMoney instanceof DBMoney);
		$this->assertTrue($obj->MyMoney->hasField('Amount'));
		$obj->MyMoney->Amount = 100.00;
		$this->assertEquals(100.00, $obj->MyMoney->Amount);
		$this->assertEquals(100.00, $obj->MyMoneyAmount);

		// Not strictly correct
		$this->assertFalse($obj->dbObject('MyMoney')->hasField('MyMoneyAmount'));
		$this->assertFalse($obj->dbObject('MyMoney')->hasField('MyMoneyCurrency'));
		$this->assertFalse($obj->dbObject('MyMoney')->hasField('MyMoney'));
	}

	/**
	 * Test DataObject::composite_fields() and DataObject::is_composite_field()
	 */
	public function testCompositeFieldMetaDataFunctions() {
		$schema = DataObject::getSchema();
		$this->assertEquals('Money', $schema->compositeField(DBCompositeTest_DataObject::class, 'MyMoney'));
		$this->assertNull($schema->compositeField(DBCompositeTest_DataObject::class, 'Title'));
		$this->assertEquals(
			array(
				'MyMoney' => 'Money',
				'OverriddenMoney' => 'Money'
			),
			$schema->compositeFields(DBCompositeTest_DataObject::class)
		);


		$this->assertEquals('Money', $schema->compositeField(SubclassedDBFieldObject::class, 'MyMoney'));
		$this->assertEquals('Money', $schema->compositeField(SubclassedDBFieldObject::class, 'OtherMoney'));
		$this->assertNull($schema->compositeField(SubclassedDBFieldObject::class, 'Title'));
		$this->assertNull($schema->compositeField(SubclassedDBFieldObject::class, 'OtherField'));
		$this->assertEquals(
			array(
				'MyMoney' => 'Money',
				'OtherMoney' => 'Money',
				'OverriddenMoney' => 'Money',
			),
			$schema->compositeFields(SubclassedDBFieldObject::class)
		);
	}

	/**
	 * Tests that changes to the fields affect the underlying dataobject, and vice versa
	 */
	public function testFieldBinding() {
		$object = new DBCompositeTest_DataObject();
		$object->MyMoney->Currency = 'NZD';
		$object->MyMoney->Amount = 100.0;
		$this->assertEquals('NZD', $object->MyMoneyCurrency);
		$this->assertEquals(100.0, $object->MyMoneyAmount);
		$object->write();

		$object2 = DBCompositeTest_DataObject::get()->byID($object->ID);
		$this->assertEquals('NZD', $object2->MyMoney->Currency);
		$this->assertEquals(100.0, $object2->MyMoney->Amount);

		$object2->MyMoneyCurrency = 'USD';
		$this->assertEquals('USD', $object2->MyMoney->Currency);

		$object2->MyMoney->setValue(array('Currency' => 'EUR', 'Amount' => 200.0));
		$this->assertEquals('EUR', $object2->MyMoneyCurrency);
		$this->assertEquals(200.0, $object2->MyMoneyAmount);
	}

	/**
	 * Ensures that composite fields are assigned to the correct tables
	 */
	public function testInheritedTables() {
		$object1 = new DBCompositeTest_DataObject();
		$object2 = new SubclassedDBFieldObject();

		$this->assertEquals('DBCompositeTest_DataObject', $object1->dbObject('MyMoney')->getTable());
		$this->assertEquals('DBCompositeTest_DataObject', $object1->dbObject('OverriddenMoney')->getTable());
		$this->assertEquals('DBCompositeTest_DataObject', $object2->dbObject('MyMoney')->getTable());
		$this->assertEquals('SubclassedDBFieldObject', $object2->dbObject('OtherMoney')->getTable());
		$this->assertEquals('SubclassedDBFieldObject', $object2->dbObject('OverriddenMoney')->getTable());
	}
}

class DBCompositeTest_DataObject extends DataObject implements TestOnly {
	private static $db = array(
		'Title' => 'Text',
		'MyMoney' => 'Money',
		'OverriddenMoney' => 'Money'
	);
}

class SubclassedDBFieldObject extends DBCompositeTest_DataObject {
	private static $db = array(
		'OtherField' => 'Text',
		'OtherMoney' => 'Money',
		'OverriddenMoney' => 'Money'
	);
}