interface DeployAuthenticator in Deploy - Content Staging 7.2

Interface for deploy authenticators.

Hierarchy

• interface \DeployAuthenticator

File

includes/DeployAuthenticator.inc, line 10

Interface definition for deploy authenticators.

interface DeployAuthenticator {

  /**
   * Constructor for a deploy authenticator.
   *
   * @param DeployService $service
   *   The service object that we need to authenticate for.
   *
   * @param array $config
   *   An associative array representing the configration options for the
   *   authenticator.
   */
  public function __construct(DeployService $service, array $config = array());

  /**
   * Initiates an authenticated deployment.
   *
   * @param Traversable $iterator
   *   Usually this will be an object from a subclass of DeployAggregatorBase.
   */
  public function deploy(Traversable $iterator);

  /**
   * Defines the configuration form for the authenticator.
   *
   * @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
DeployAuthenticator::configForm	public	function	Defines the configuration form for the authenticator.	2
DeployAuthenticator::deploy	public	function	Initiates an authenticated deployment.	2
DeployAuthenticator::__construct	public	function	Constructor for a deploy authenticator.	2