silverstripe-framework/tests/core/ObjectStaticTest.php

<?php
/**
 * Tests various static getter and setter methods on {@link Object}
 *
 * @package framework
 * @subpackage tests
 */
class ObjectStaticTest extends SapphireTest {
	
	/**
	 * Tests {@link Object::get_static()}
	 */
	public function testGetStatic() {
		$this->assertEquals(Object::get_static('ObjectStaticTest_First',  'first'), array('test_1'));
		$this->assertEquals(Object::get_static('ObjectStaticTest_Second', 'first'), array('test_2'));
		$this->assertEquals(Object::get_static('ObjectStaticTest_Third',  'first'), array('test_3'));
		
		Object::addStaticVars('ObjectStaticTest_First',  array('first' => array('test_1_2')));
		Object::addStaticVars('ObjectStaticTest_Third',  array('first' => array('test_3_2')));
		Object::addStaticVars('ObjectStaticTest_Fourth', array('first' => array('test_4')));
		
		$this->assertEquals(Object::get_static('ObjectStaticTest_First',  'first', true), array('test_1_2', 'test_1'));
		// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
		// $this->assertEquals(Object::get_static('ObjectStaticTest_Second', 'first', true), array('test_1_2', 'test_2'));
		// $this->assertEquals(Object::get_static('ObjectStaticTest_Third',  'first', true), array('test_1_2', 'test_3_2', 'test_3'));
	}
	
	/**
	 * Test {@link Object::addStaticVar()} correctly replaces static vars
	 */
	public function testAddStaticReplace() {
		Object::addStaticVars('ObjectStaticTest_Fourth', array('second' => array('test_4')), true);
		Object::addStaticVars('ObjectStaticTest_Third',  array('second' => array('test_3_2')));
		
		$this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'second', true), array('test_4'));
		$this->assertEquals(Object::get_static('ObjectStaticTest_Third',  'second', true), array('test_3_2', 'test_3'));
		
		Object::addStaticVars('ObjectStaticTest_Third',  array('second' => array('test_3_2')), true);
		$this->assertEquals(Object::get_static('ObjectStaticTest_Third', 'second', true), array('test_3_2'));
		
		Object::add_static_var('ObjectStaticTest_Third', 'fourth', array('test_3_2'));
		// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
		// $this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_3_2', 'test_4'));

		Object::add_static_var('ObjectStaticTest_Third', 'fourth', array('test_3_2'), true);
		// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
		// $this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_4', 'test_3_2'));
	}
	
	/**
	 * Tests {@link Object::uninherited_static()}
	 */
	public function testUninherited() {
		$this->assertEquals(Object::uninherited_static('ObjectStaticTest_First',  'third', true), 'test_1');
		$this->assertEquals(Object::uninherited_static('ObjectStaticTest_Fourth', 'third', true), null);
	}
	
	public function testCombinedStatic() {
		// test basic operation
		$this->assertEquals (
			array('test_3', 'test_2', 'test_1'), Object::combined_static('ObjectStaticTest_Combined3', 'first')
		);
		
		// test that null values are ignored, but values on either side are still merged
		$this->assertEquals (
			array('test_3', 'test_1'), Object::combined_static('ObjectStaticTest_Combined3', 'second')
		);
		
		// test the $ceiling param
		// @todo - This fails, as it's been removed. Do we need it?
		// $this->assertEquals (
		//	  array('test_3', 'test_2'), Object::combined_static('ObjectStaticTest_Combined3', 'first', 'ObjectStaticTest_Combined2')
		// );
	}
	
	/**
	 * Checks that Object::add_static_var() also works for uninherited stats
	 */
	public function testAddStaticVarWorksForUninheritedStatics() {
		Object::add_static_var('ObjectStaticTest_First', 'first', array('test_1b'));
		Object::add_static_var('ObjectStaticTest_Second', 'first', array('test_2b'));
		
		// Check that it can be applied to parent and subclasses, and queried directly
		$this->assertContains('test_1b', Object::uninherited_static('ObjectStaticTest_First', 'first'));
		$this->assertContains('test_2b', Object::uninherited_static('ObjectStaticTest_Second', 'first'));

		// But it won't affect subclasses - this is *uninherited* static
		$this->assertNotContains('test_2b', Object::uninherited_static('ObjectStaticTest_Third', 'first'));
		$this->assertNotContains('test_2b', Object::uninherited_static('ObjectStaticTest_Fourth', 'first'));

		// Subclasses that don't have the static explicitly defined should allow definition, also
		// This also checks that add_static_var can be called after the first uninherited_static() 
		// call (which can be buggy due to caching) 
		Object::add_static_var('ObjectStaticTest_Fourth', 'first', array('test_4b'));
		$this->assertContains('test_4b', Object::uninherited_static('ObjectStaticTest_Fourth', 'first'));
	}
	
}

/**#@+
 * @ignore
 */
class ObjectStaticTest_First extends Object {
	public static $first  = array('test_1');
	public static $second = array('test_1');
	public static $third  = 'test_1';
}

class ObjectStaticTest_Second extends ObjectStaticTest_First {
	public static $first = array('test_2');
}

class ObjectStaticTest_Third extends ObjectStaticTest_Second {
	public static $first  = array('test_3');
	public static $second = array('test_3');
	public static $fourth = array('test_3');
}

class ObjectStaticTest_Fourth extends ObjectStaticTest_Third {
	public static $fourth = array('test_4');
}

class ObjectStaticTest_Combined1 extends Object {
	public static $first  = array('test_1');
	public static $second = array('test_1');
}

class ObjectStaticTest_Combined2 extends ObjectStaticTest_Combined1 {
	public static $first  = array('test_2');
	public static $second = null;
}

class ObjectStaticTest_Combined3 extends ObjectStaticTest_Combined2 {
	public static $first  = array('test_3');
	public static $second = array('test_3');
}