class AcquiaLiftABReport in Acquia Lift Connector 7

Responsible for retrieving and generating Acquia Lift AB Reports.

Hierarchy

• class \AcquiaLiftReportBase implements \PersonalizeAgentReportInterface, AcquiaLiftReportInterface
  • class \AcquiaLiftABReport

File

plugins/agent_types/AcquiaLiftAgent.inc, line 2090

Provides an agent type for Acquia Lift

class AcquiaLiftABReport extends AcquiaLiftReportBase {

  /**
   * Implements PersonalizeAgentReportInterface::renderStatusForOptionSet().
   */
  public function renderStatsForOptionSet($option_set, $date_from, $date_to = NULL) {

    // Not applicable to A/B tests made up of page variations.
    return array();
  }

  /**
   * Generates report overview data.
   */
  public function generateOverviewData(&$report_data) {
    $this
      ->loadAgentStatusData($report_data);
    $report_data['status'] = $report = $this
      ->extractOverviewReportData($report_data['raw']['status']['data'][$report_data['machine_name']]);
    if ($report === FALSE) {
      return array();
    }
    if ($report_data['today_only']) {
      $overview_report = $report_data['status']['today'];
    }
    else {
      $overview_report = $report_data['status']['all'];
    }
    $report_data['has_data'] = $overview_report['total_shown'] > 0;
    return $report_data;
  }

  /**
   * Implements PersonalizeAgentReportInterface::buildCampaignReports().
   */
  public function buildCampaignReports($options) {
    $report_data = $this
      ->generateReportConfiguration($options);
    $this
      ->loadConversionReportData($report_data);
    $this
      ->generateOverviewData($report_data);
    $reports = $this
      ->buildAllConversionReports($report_data);
    $reports['#has_data'] = $report_data['has_data'];
    return $reports;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaLiftABReport::buildCampaignReports	public	function	Implements PersonalizeAgentReportInterface::buildCampaignReports().
AcquiaLiftABReport::generateOverviewData	public	function	Generates report overview data.
AcquiaLiftABReport::renderStatsForOptionSet	public	function	Implements PersonalizeAgentReportInterface::renderStatusForOptionSet().
AcquiaLiftReportBase::$agent	protected	property	The Acquia Lift agent instance for reporting on.
AcquiaLiftReportBase::$confidence_measure	protected	property	The confidence measure for determining statistical significance.
AcquiaLiftReportBase::$liftAPI	protected	property	An instance of AcquiaLiftAPI.
AcquiaLiftReportBase::$report_data	protected	property	The extracted report data for each of the Acquia Lift API calls keyed by date/feature set requested.
AcquiaLiftReportBase::buildAllConversionReports	protected	function	Builds the conversion reports to show basic conversion metrics for report requested in the report_data.
AcquiaLiftReportBase::buildConversionDetailReport	protected	function	Builds the render array for the metrics portion of the report.
AcquiaLiftReportBase::buildConversionReport	public	function	Implements AcquiaLiftReportInterface()::buildConversionReport(). Overrides AcquiaLiftReportInterface::buildConversionReport
AcquiaLiftReportBase::buildConversionReports	protected	function	Build a set of confidence reports from the report data.
AcquiaLiftReportBase::buildConversionSummaryReport	protected	function	Builds the render array for the summary portion of the report.
AcquiaLiftReportBase::DATA_NA		constant	The value to show when report data is not applicable.
AcquiaLiftReportBase::extractConversionReportData	protected	function	Extracts data from the raw confidence detail report that is prepared for use within the conversion report rendering process.
AcquiaLiftReportBase::extractConversionSummaryData	protected	function	Extracts data from the raw aggregate confidence report that is prepared for use within the report rendering process.
AcquiaLiftReportBase::extractOverviewReportData	protected	function	Extracts the required overview data from the report data returned by Acquia Lift.
AcquiaLiftReportBase::formatReportNumber	protected	function	Formats a number value for use in reports.
AcquiaLiftReportBase::formatReportPercentage	protected	function	Formats a percentage value for use in reports.
AcquiaLiftReportBase::generateReportConfiguration	protected	function	Generates the general report configuration that is used to load any report.
AcquiaLiftReportBase::getConfidenceDetailReportOptions	protected	function	Helper function to generate the report options necessary to get a detailed confidence report rather than a summary report.
AcquiaLiftReportBase::getConfidenceMeasure	public	function	Implements AcquiaLiftReportInterface()::getConfidenceMeasure(). Overrides AcquiaLiftReportInterface::getConfidenceMeasure
AcquiaLiftReportBase::getConfidenceReportRawName	protected	function	Generates an internal raw report name for a confidence report based on the options.
AcquiaLiftReportBase::getLowConfidenceMessage	protected	function	Generates a message to show when there is insufficient confidence in the test results.
AcquiaLiftReportBase::getVariationLabel	protected	function	Generates the variation abbreviated label.
AcquiaLiftReportBase::loadAgentStatusData	protected	function	Loads the agent status raw reporting data.
AcquiaLiftReportBase::loadConfidenceData	protected	function	Loads the agent confidence raw reporting data.
AcquiaLiftReportBase::loadContextFilterData	protected	function	Loads the context filter raw values into the report data.
AcquiaLiftReportBase::loadConversionReportData	protected	function	Loads and formats the necessary reporting data in order to generate a conversion metrics graph/report.
AcquiaLiftReportBase::loadConversionReportHelper	protected	function	Handles all of the logic to load and extract a conversion report.
AcquiaLiftReportBase::loadTargetingData	protected	function	Loads the agent targeting raw reporting data.
AcquiaLiftReportBase::NO_FEATURES		constant	The value representing no features applied to an experiment.
AcquiaLiftReportBase::setConfidenceMeasure	public	function	Implements AcquiaLiftReportInterface()::setConfidenceMeasure(). Overrides AcquiaLiftReportInterface::setConfidenceMeasure
AcquiaLiftReportBase::__construct		function	Constructs an AcquiaLiftReport object