abstract class LazyPluginCollectionTestBase in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/tests/Drupal/Tests/Core/Plugin/LazyPluginCollectionTestBase.php \Drupal\Tests\Core\Plugin\LazyPluginCollectionTestBase
Provides a base class for plugin collection tests.
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\Core\Plugin\LazyPluginCollectionTestBase
Expanded class hierarchy of LazyPluginCollectionTestBase
File
- core/
tests/ Drupal/ Tests/ Core/ Plugin/ LazyPluginCollectionTestBase.php, line 16 - Contains \Drupal\Tests\Core\Plugin\LazyPluginCollectionTestBase.
Namespace
Drupal\Tests\Core\PluginView source
abstract class LazyPluginCollectionTestBase extends UnitTestCase {
/**
* The mocked plugin manager.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $pluginManager;
/**
* The tested plugin collection.
*
* @var \Drupal\Core\Plugin\DefaultLazyPluginCollection|\PHPUnit_Framework_MockObject_MockObject
*/
protected $defaultPluginCollection;
/**
* Stores all setup plugin instances.
*
* @var \Drupal\Component\Plugin\PluginInspectionInterface[]
*/
protected $pluginInstances;
/**
* Contains the plugin configuration.
*
* @var array
*/
protected $config = array(
'banana' => array(
'id' => 'banana',
'key' => 'value',
),
'cherry' => array(
'id' => 'cherry',
'key' => 'value',
),
'apple' => array(
'id' => 'apple',
'key' => 'value',
),
);
protected function setUp() {
$this->pluginManager = $this
->getMock('Drupal\\Component\\Plugin\\PluginManagerInterface');
$this->pluginManager
->expects($this
->any())
->method('getDefinitions')
->will($this
->returnValue($this
->getPluginDefinitions()));
}
/**
* Sets up the default plugin collection.
*
* @param \PHPUnit_Framework_MockObject_Matcher_InvokedRecorder|null $create_count
* (optional) The number of times that createInstance() is expected to be
* called. For example, $this->any(), $this->once(), $this->exactly(6).
* Defaults to $this->never().
*/
protected function setupPluginCollection(\PHPUnit_Framework_MockObject_Matcher_InvokedRecorder $create_count = NULL) {
$this->pluginInstances = array();
$map = array();
foreach ($this
->getPluginDefinitions() as $plugin_id => $definition) {
// Create a mock plugin instance.
$this->pluginInstances[$plugin_id] = $this
->getPluginMock($plugin_id, $definition);
$map[] = array(
$plugin_id,
$this->config[$plugin_id],
$this->pluginInstances[$plugin_id],
);
}
$create_count = $create_count ?: $this
->never();
$this->pluginManager
->expects($create_count)
->method('createInstance')
->will($this
->returnCallback(array(
$this,
'returnPluginMap',
)));
$this->defaultPluginCollection = new DefaultLazyPluginCollection($this->pluginManager, $this->config);
}
/**
* Return callback for createInstance.
*
* @param string $plugin_id
* The plugin ID to return the mock plugin for.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface|\PHPUnit_Framework_MockObject_MockObject
* The mock plugin object.
*/
public function returnPluginMap($plugin_id) {
if (isset($this->pluginInstances[$plugin_id])) {
return $this->pluginInstances[$plugin_id];
}
}
/**
* Returns a mocked plugin object.
*
* @param string $plugin_id
* The plugin ID.
* @param array $definition
* The plugin definition.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected function getPluginMock($plugin_id, array $definition) {
// Create a mock plugin instance.
$mock = $this
->getMock('Drupal\\Component\\Plugin\\PluginInspectionInterface');
$mock
->expects($this
->any())
->method('getPluginId')
->will($this
->returnValue($plugin_id));
return $mock;
}
/**
* Returns some example plugin definitions.
*
* @return array
* The example plugin definitions.
*/
protected function getPluginDefinitions() {
$definitions = array(
'apple' => array(
'id' => 'apple',
'label' => 'Apple',
'color' => 'green',
'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Apple',
'provider' => 'plugin_test',
),
'banana' => array(
'id' => 'banana',
'label' => 'Banana',
'color' => 'yellow',
'uses' => array(
'bread' => 'Banana bread',
),
'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Banana',
'provider' => 'plugin_test',
),
'cherry' => array(
'id' => 'cherry',
'label' => 'Cherry',
'color' => 'red',
'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Cherry',
'provider' => 'plugin_test',
),
);
return $definitions;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
LazyPluginCollectionTestBase:: |
protected | property | Contains the plugin configuration. | |
LazyPluginCollectionTestBase:: |
protected | property | The tested plugin collection. | |
LazyPluginCollectionTestBase:: |
protected | property | Stores all setup plugin instances. | 1 |
LazyPluginCollectionTestBase:: |
protected | property | The mocked plugin manager. | |
LazyPluginCollectionTestBase:: |
protected | function | Returns some example plugin definitions. | |
LazyPluginCollectionTestBase:: |
protected | function | Returns a mocked plugin object. | 1 |
LazyPluginCollectionTestBase:: |
public | function | Return callback for createInstance. | |
LazyPluginCollectionTestBase:: |
protected | function |
Overrides UnitTestCase:: |
|
LazyPluginCollectionTestBase:: |
protected | function | Sets up the default plugin collection. | 1 |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |