interface DeployService in Deploy - Content Staging 7.2

Interface for all deploy service plugins.

Hierarchy

• interface \DeployService

File

includes/DeployService.inc, line 10

Interface definition for deploy service.

interface DeployService {

  /**
   * Constructor for a deploy service.
   *
   * @param array $config
   *   An associative array containing the settings for the service plugin.
   */
  public function __construct(array $config = array());

  // @ignore comment_comment_see:comment

  /**
   * Deploy all entities in the $iterator. This method should only move entities
   * over to the endpoint and create unpublished revisions (if supported). The
   * 'publish' method is responsible for publishing all successfully deployed
   * entities.
   *
   * @param Traverable $iterator
   *   This will usually be an object of a subclass of DeployAggregatorBase
   * @see DeployService::publish()
   */
  public function deploy(Traversable $iterator);

  // @ignore comment_comment_see:comment

  /**
   * Publish all entities in the $iterator. This method should only publish
   * entities on the endpoint (if supported). The 'deploy' method is
   * responsible for moving the entities to the endpoint, prior to the
   * publishing.
   *
   * @param Traverable $iterator
   *   This will usually be an object of a subclass of DeployAggregatorBase
   * @see DeployService::deploy()
   */
  public function publish(Traversable $iterator);

  /**
   * Configuration form.
   *
   * @param array $form_state
   *   The complete form state.
   */
  public function configForm(&$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
DeployService::configForm	public	function	Configuration form.	1
DeployService::deploy	public	function	Deploy all entities in the $iterator. This method should only move entities over to the endpoint and create unpublished revisions (if supported). The 'publish' method is responsible for publishing all successfully deployed entities.	1
DeployService::publish	public	function	Publish all entities in the $iterator. This method should only publish entities on the endpoint (if supported). The 'deploy' method is responsible for moving the entities to the endpoint, prior to the publishing.	1
DeployService::__construct	public	function	Constructor for a deploy service.	1