API CHANGE: Refactored ClassInfo::baseDataClass() to use inbuilt PHP methods, and throw an exception if the passed class is not a subclass of DataObject.

This commit is contained in:
ajshort 2011-03-24 20:14:38 +11:00
parent d187718a3f
commit 0d03348926
2 changed files with 34 additions and 18 deletions

View File

@ -88,25 +88,30 @@ class ClassInfo {
return $dataClasses;
}
/**
* Return the root data class for that class.
* This root table has a lot of special use in the DataObject system.
*
* @param mixed $class string of the classname or instance of the class
* @return array
* Returns the root class (the first to extend from DataObject) for the
* passed class.
*
* @param string|object $class
* @return string
*/
static function baseDataClass($class) {
global $_ALL_CLASSES;
public static function baseDataClass($class) {
if (is_object($class)) $class = get_class($class);
reset($_ALL_CLASSES['parents'][$class]);
while($val = next($_ALL_CLASSES['parents'][$class])) {
if($val == 'DataObject') break;
if (!self::is_subclass_of($class, 'DataObject')) {
throw new Exception("$class is not a subclass of DataObject");
}
while ($next = get_parent_class($class)) {
if ($next == 'DataObject') {
return $class;
}
$class = $next;
}
$baseDataClass = next($_ALL_CLASSES['parents'][$class]);
return $baseDataClass ? $baseDataClass : $class;
}
/**
* Returns a list of classes that inherit from the given class.
* The resulting array includes the base class passed

View File

@ -33,10 +33,22 @@ class ClassInfoTest extends SapphireTest {
// 'ClassInfo::classes_for_folder() returns additional classes not matching the filename'
// );
}
/**
* @covers ClassInfo::baseDataClass()
*/
public function testBaseDataClass() {
$this->assertEquals('ClassInfoTest_BaseClass', ClassInfo::baseDataClass('ClassInfoTest_BaseClass'));
$this->assertEquals('ClassInfoTest_BaseClass', ClassInfo::baseDataClass('ClassInfoTest_ChildClass'));
$this->assertEquals('ClassInfoTest_BaseClass', ClassInfo::baseDataClass('ClassInfoTest_GrandChildClass'));
$this->setExpectedException('Exception');
ClassInfo::baseDataClass('DataObject');
}
}
class ClassInfoTest_BaseClass {
class ClassInfoTest_BaseClass extends DataObject {
}
@ -46,5 +58,4 @@ class ClassInfoTest_ChildClass extends ClassInfoTest_BaseClass {
class ClassInfoTest_GrandChildClass extends ClassInfoTest_ChildClass {
}
?>
}