interface AcquiaLiftAgentInterface in Acquia Lift Connector 7

@file Provides an agent type for Acquia Lift

Hierarchy

• interface \AcquiaLiftAgentInterface

File

plugins/agent_types/AcquiaLiftAgent.inc, line 7

Provides an agent type for Acquia Lift

interface AcquiaLiftAgentInterface {

  /**
   * Synchronizes the decision structure for this agent to Acquia Lift.
   *
   * If decision names or decision points have been renamed or removed, they
   * need to be deleted in Acquia Lift and the new points and decisions
   * added.
   *
   * @param $old_decisions
   *   Array representing the old decision structure from when it was
   *   last sync'd to AcquiaLift.
   * @param $new_decisions
   *   Array representing the new decision structure.
   * @return mixed
   */
  public function syncDecisions($old_decisions, $new_decisions);

  /**
   * Synchronize the goals for this agent to Acquia Lift.
   *
   * @param $old_goals
   *   The old goals that Acquia Lift knows about, with goal names as
   *   keys and goal values as values.
   * @param $new_goals
   *   The new goals, with goal names as keys and goal values as values.
   */
  public function syncGoals($old_goals, $new_goals);

  /**
   * Syncs fixed targeting rules to Acquia Lift.
   *
   * @param $option_sets
   *   An array of option set objects whose options may have fixed targeting rules
   *   associated with them.
   */
  public function syncFixedTargeting($option_sets);

  /**
   * Syncs the agent's status to Acquia Lift.
   */
  public function syncAgentStatus();

  /**
   * Organizes an array of option sets into decision points.
   *
   * @param $option_sets
   *   An array of option sets.
   *
   * @return array
   *   An associative array keyed by decision points, whose values are associative
   *   arrays with decision names as keys and an array of choices as values.
   */
  public static function convertOptionSetsToDecisions($option_sets);

  /**
   * Retrieves a conversion report.
   *
   * @param $options
   *   An array of report options.
   *   - decision_name: (Optional) The decision to get conversion report for.
   *   - goal: (Optional) The goal for limiting the report, defaults to all goals.
   *   - start: (Optional) The start time for report data in Y-m-d format.
   *     Defaults to agent start.
   *   - end: (Optional) The end time for report data in Y-m-d format.  Defaults
   *     to the current date.
   * @return array
   *   A renderable array.
   */
  public function buildConversionReport($options);

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaLiftAgentInterface::buildConversionReport	public	function	Retrieves a conversion report.	1
AcquiaLiftAgentInterface::convertOptionSetsToDecisions	public static	function	Organizes an array of option sets into decision points.	1
AcquiaLiftAgentInterface::syncAgentStatus	public	function	Syncs the agent's status to Acquia Lift.	1
AcquiaLiftAgentInterface::syncDecisions	public	function	Synchronizes the decision structure for this agent to Acquia Lift.	1
AcquiaLiftAgentInterface::syncFixedTargeting	public	function	Syncs fixed targeting rules to Acquia Lift.	1
AcquiaLiftAgentInterface::syncGoals	public	function	Synchronize the goals for this agent to Acquia Lift.	1