mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
ENHANCEMENT Added GridFieldConfig->getComponentsByType() and getComponentByType()
This commit is contained in:
parent
2d898cab63
commit
5fe86be311
@ -23,7 +23,7 @@ class GridFieldConfig {
|
||||
*
|
||||
*/
|
||||
public function __construct() {
|
||||
;
|
||||
$this->components = new ArrayList();
|
||||
}
|
||||
|
||||
public function addComponent(GridFieldComponent $component) {
|
||||
@ -32,8 +32,7 @@ class GridFieldConfig {
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return ArrayList
|
||||
* @return ArrayList Of GridFieldComponent
|
||||
*/
|
||||
public function getComponents() {
|
||||
if(!$this->components) {
|
||||
@ -41,6 +40,32 @@ class GridFieldConfig {
|
||||
}
|
||||
return $this->components;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all components extending a certain class, or implementing a certain interface.
|
||||
*
|
||||
* @param String Class name or interface
|
||||
* @return ArrayList Of GridFieldComponent
|
||||
*/
|
||||
public function getComponentsByType($type) {
|
||||
$components = new ArrayList();
|
||||
foreach($this->components as $component) {
|
||||
if($component instanceof $type) $components->push($component);
|
||||
}
|
||||
return $components;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the first available component with the given class or interface.
|
||||
*
|
||||
* @param String ClassName
|
||||
* @return GridFieldComponent
|
||||
*/
|
||||
public function getComponentByType($type) {
|
||||
foreach($this->components as $component) {
|
||||
if($component instanceof $type) return $component;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class GridFieldConfig_Base extends GridFieldConfig {
|
||||
|
76
tests/forms/gridfield/GridFieldConfigTest.php
Normal file
76
tests/forms/gridfield/GridFieldConfigTest.php
Normal file
@ -0,0 +1,76 @@
|
||||
<?php
|
||||
/**
|
||||
* @package sapphire
|
||||
* @subpackage tests
|
||||
*/
|
||||
|
||||
class GridFieldConfigTest extends SapphireTest {
|
||||
|
||||
function testGetComponents() {
|
||||
$config = GridFieldConfig::create();
|
||||
$this->assertType('ArrayList', $config->getComponents());
|
||||
$this->assertEquals($config->getComponents()->Count(), 0);
|
||||
|
||||
$config
|
||||
->addComponent($c1 = new GridFieldConfigTest_MyComponent())
|
||||
->addComponent($c2 = new GridFieldConfigTest_MyOtherComponent())
|
||||
->addComponent($c3 = new GridFieldConfigTest_MyOtherComponent());
|
||||
|
||||
$this->assertEquals(
|
||||
new ArrayList(array($c1, $c2, $c3)),
|
||||
$config->getComponents()
|
||||
);
|
||||
}
|
||||
|
||||
function testGetComponentsByType() {
|
||||
$config = GridFieldConfig::create()
|
||||
->addComponent($c1 = new GridFieldConfigTest_MyComponent())
|
||||
->addComponent($c2 = new GridFieldConfigTest_MyOtherComponent())
|
||||
->addComponent($c3 = new GridFieldConfigTest_MyOtherComponent());
|
||||
|
||||
$this->assertEquals(
|
||||
new ArrayList(array($c1)),
|
||||
$config->getComponentsByType('GridFieldConfigTest_MyComponent')
|
||||
);
|
||||
$this->assertEquals(
|
||||
new ArrayList(array($c2, $c3)),
|
||||
$config->getComponentsByType('GridFieldConfigTest_MyOtherComponent')
|
||||
);
|
||||
$this->assertEquals(
|
||||
new ArrayList(array($c1, $c2, $c3)),
|
||||
$config->getComponentsByType('GridField_URLHandler')
|
||||
);
|
||||
$this->assertEquals(
|
||||
new ArrayList(),
|
||||
$config->getComponentsByType('GridFieldConfigTest_UnknownComponent')
|
||||
);
|
||||
}
|
||||
|
||||
function testGetComponentByType() {
|
||||
$config = GridFieldConfig::create()
|
||||
->addComponent($c1 = new GridFieldConfigTest_MyComponent())
|
||||
->addComponent($c2 = new GridFieldConfigTest_MyOtherComponent())
|
||||
->addComponent($c3 = new GridFieldConfigTest_MyOtherComponent());
|
||||
|
||||
$this->assertEquals(
|
||||
$c1,
|
||||
$config->getComponentByType('GridFieldConfigTest_MyComponent')
|
||||
);
|
||||
$this->assertEquals(
|
||||
$c2,
|
||||
$config->getComponentByType('GridFieldConfigTest_MyOtherComponent')
|
||||
);
|
||||
$this->assertNull(
|
||||
$config->getComponentByType('GridFieldConfigTest_UnknownComponent')
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
class GridFieldConfigTest_MyComponent implements GridField_URLHandler, TestOnly {
|
||||
function getURLHandlers($gridField) {return array();}
|
||||
}
|
||||
|
||||
class GridFieldConfigTest_MyOtherComponent implements GridField_URLHandler, TestOnly {
|
||||
function getURLHandlers($gridField) {return array();}
|
||||
}
|
Loading…
Reference in New Issue
Block a user