interface DeployAggregator in Deploy - Content Staging 7.3

Interface for all deploy aggregators.

Hierarchy

• interface \DeployAggregator extends \IteratorAggregate

File

includes/DeployAggregator.inc, line 10

Interface definition for deploy aggregators.

interface DeployAggregator extends IteratorAggregate {

  /**
   * 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());

  /**
   * Returns an iterator with entities for deployment.
   *
   * Since we are dealing with resursive iteration (entities with references),
   * we need to run DeployIterator through DeployIteratorIterator and return the
   * latter one.
   *
   * @return DeployIteratorIterator
   *
   * @see http://giorgiosironi.blogspot.com/2010/02/practical-php-patterns-iterator.html
   */

  //function getIterator();

  /**
   * 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);

}

Members

Name	Modifiers	Type	Description	Overrides
DeployAggregator::configForm	public	function	Defines the configuration form for the aggregator.	1
DeployAggregator::__construct	public	function	Constructor for a deploy aggregator.	1