class DeployAggregatorBase in Deploy - Content Staging 7.3
Same name and namespace in other branches
- 7.2 includes/DeployAggregator.inc \DeployAggregatorBase
Base class implementing the DeployAggregator interface. All aggregator plugins should extend this class.
Hierarchy
- class \DeployAggregatorBase implements DeployAggregator
Expanded class hierarchy of DeployAggregatorBase
File
- includes/
DeployAggregator.inc, line 54 - Interface definition for deploy aggregators.
View source
class DeployAggregatorBase implements DeployAggregator {
/**
* Constructor for a deploy aggregator.
*
* @param DeployPlan $plan
* The plan that will use this aggregator.
*
* @param array $config
* An associative array representing the configuration settings for the
* aggregator.
*/
public function __construct(DeployPlan $plan = NULL, array $config = array()) {
}
/**
* Defines the configuration form for the aggregator.
*
* @param array $form_state
* The complete form state.
*
* @return array
* An array representing the configuation form.
*/
public function configForm(&$form_state) {
}
/**
* Returns an array of entities.
*
* @return array()
* An array of entities structured as follows:
* @code
* $entities = array(
* 'node' => array(
* 10 => TRUE,
* 12 => array(
* 'taxonomy_term' => array(
* 14 => TRUE,
* ),
* 'user' => array(
* 8 => TRUE,
* ),
* ),
* ),
* 'taxonomy_term' => array(
* 16 => TRUE,
* ),
* );
* @endcode
*/
public function getEntities() {
}
/**
* Returns a DeployIteratorIterator, which can iterate through recursive
* iterators
*
* @return DeployIteratorIterator
*/
public function getIterator() {
$entities = $this
->getEntities();
return deploy_iterator($entities, $this->plan);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DeployAggregatorBase:: |
public | function |
Defines the configuration form for the aggregator. Overrides DeployAggregator:: |
2 |
DeployAggregatorBase:: |
public | function | Returns an array of entities. | 2 |
DeployAggregatorBase:: |
public | function | Returns a DeployIteratorIterator, which can iterate through recursive iterators | |
DeployAggregatorBase:: |
public | function |
Constructor for a deploy aggregator. Overrides DeployAggregator:: |
2 |