silverstripe-framework/tests/model/DBClassNameTest.php

<?php


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



class DBClassNameTest extends SapphireTest {

	protected $extraDataObjects = array(
		'DBClassNameTest_Object',
		'DBClassNameTest_ObjectSubClass',
		'DBClassNameTest_ObjectSubSubClass',
		'DBClassNameTest_OtherClass'
	);

	/**
	 * Test that custom subclasses generate the right hierarchy
	 */
	public function testEnumList() {
		// Object 1 fields
		$object = new DBClassNameTest_Object();
		$defaultClass = $object->dbObject('DefaultClass');
		$anyClass = $object->dbObject('AnyClass');
		$childClass = $object->dbObject('ChildClass');
		$leafClass = $object->dbObject('LeafClass');

		// Object 2 fields
		$object2 = new DBClassNameTest_ObjectSubClass();
		$midDefault = $object2->dbObject('MidClassDefault');
		$midClass = $object2->dbObject('MidClass');

		// Default fields always default to children of base class (even if put in a subclass)
		$mainSubclasses = array (
			'DBClassNameTest_Object' => 'DBClassNameTest_Object',
			'DBClassNameTest_ObjectSubClass' => 'DBClassNameTest_ObjectSubClass',
			'DBClassNameTest_ObjectSubSubClass' => 'DBClassNameTest_ObjectSubSubClass',
		);
		$this->assertEquals($mainSubclasses, $defaultClass->getEnumObsolete());
		$this->assertEquals($mainSubclasses, $midDefault->getEnumObsolete());

		// Unbound classes detect any
		$anyClasses = $anyClass->getEnumObsolete();
		$this->assertContains('DBClassNameTest_OtherClass', $anyClasses);
		$this->assertContains('DBClassNameTest_Object', $anyClasses);
		$this->assertContains('DBClassNameTest_ObjectSubClass', $anyClasses);
		$this->assertContains('DBClassNameTest_ObjectSubSubClass', $anyClasses);

		// Classes bound to the middle of a tree
		$midSubClasses = $mainSubclasses = array (
			'DBClassNameTest_ObjectSubClass' => 'DBClassNameTest_ObjectSubClass',
			'DBClassNameTest_ObjectSubSubClass' => 'DBClassNameTest_ObjectSubSubClass',
		);
		$this->assertEquals($midSubClasses, $childClass->getEnumObsolete());
		$this->assertEquals($midSubClasses, $midClass->getEnumObsolete());

		// Leaf clasess contain only exactly one node
		$this->assertEquals(
			array('DBClassNameTest_ObjectSubSubClass' => 'DBClassNameTest_ObjectSubSubClass',),
			$leafClass->getEnumObsolete()
		);
	}

	/**
	 * Test that the base class can be detected under various circumstances
	 */
	public function testBaseClassDetection() {
		// Explicit DataObject
		$field1 = new DBClassName('MyClass', 'SilverStripe\\ORM\\DataObject');
		$this->assertEquals('SilverStripe\\ORM\\DataObject', $field1->getBaseClass());
		$this->assertNotEquals('SilverStripe\\ORM\\DataObject', $field1->getDefault());

		// Explicit base class
		$field2 = new DBClassName('MyClass', 'DBClassNameTest_Object');
		$this->assertEquals('DBClassNameTest_Object', $field2->getBaseClass());
		$this->assertEquals('DBClassNameTest_Object', $field2->getDefault());

		// Explicit subclass
		$field3 = new DBClassName('MyClass');
		$field3->setValue(null, new DBClassNameTest_ObjectSubClass());
		$this->assertEquals('DBClassNameTest_Object', $field3->getBaseClass());
		$this->assertEquals('DBClassNameTest_Object', $field3->getDefault());

		// Implicit table
		$field4 = new DBClassName('MyClass');
		$field4->setTable('DBClassNameTest_ObjectSubClass_versions');
		$this->assertEquals('DBClassNameTest_Object', $field4->getBaseClass());
		$this->assertEquals('DBClassNameTest_Object', $field4->getDefault());

		// Missing
		$field5 = new DBClassName('MyClass');
		$this->assertEquals('SilverStripe\\ORM\\DataObject', $field5->getBaseClass());
		$this->assertNotEquals('SilverStripe\\ORM\\DataObject', $field5->getDefault());

		// Invalid class
		$field6 = new DBClassName('MyClass');
		$field6->setTable('InvalidTable');
		$this->assertEquals('SilverStripe\\ORM\\DataObject', $field6->getBaseClass());
		$this->assertNotEquals('SilverStripe\\ORM\\DataObject', $field6->getDefault());

		// Custom default_classname
		$field7 = new DBClassName('MyClass');
		$field7->setTable('DBClassNameTest_CustomDefault');
		$this->assertEquals('DBClassNameTest_CustomDefault', $field7->getBaseClass());
		$this->assertEquals('DBClassNameTest_CustomDefaultSubclass', $field7->getDefault());
	}
}

class DBClassNameTest_Object extends DataObject implements TestOnly {

	private static $extensions = array(
		'SilverStripe\\ORM\\Versioning\\Versioned'
	);

	private static $db = array(
		'DefaultClass' => 'DBClassName',
		'AnyClass' => "DBClassName('SilverStripe\\ORM\\DataObject')",
		'ChildClass' => 'DBClassName("DBClassNameTest_ObjectSubClass")',
		'LeafClass' => 'DBClassName("DBClassNameTest_ObjectSubSubClass")'
	);
}

class DBClassNameTest_ObjectSubClass extends DBClassNameTest_Object {
	private static $db = array(
		'MidClassDefault' => 'DBClassName',
		'MidClass' => 'DBClassName("DBClassNameTest_ObjectSubclass")'
	);

}

class DBClassNameTest_ObjectSubSubClass extends DBClassNameTest_ObjectSubclass {
}

class DBClassNameTest_OtherClass extends DataObject implements TestOnly {
	private static $db = array(
		'Title' => 'Varchar'
	);
}

class DBClassNameTest_CustomDefault extends DataObject implements TestOnly {

	private static $default_classname = 'DBClassNameTest_CustomDefaultSubclass';

	private static $db = array(
		'Title' => 'Varchar'
	);
}

class DBClassNameTest_CustomDefaultSubclass extends DBClassNameTest_CustomDefault implements TestOnly {
	private static $db = array(
		'Content' => 'HTMLText'
	);
}