Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • Ad
  • AdConversionReport
  • AdConversionReportSection
  • AdList
  • AdListSection
  • AdOrderValueReport
  • AdOrderValueReportSection
  • AdPlacementReport
  • AdPlacementReportSection
  • Attribute
  • PanelConversionReport
  • PanelConversionReportSection
  • Placement
  • ProductSalesByAttributeReport
  • ProductSalesByAttributeReportSection
  • ProductSalesByTimeReport
  • ProductTopSellersReport
  • ProductTopSellersReportSection
  • Rate
  • Report
  • SearchConversion
  • SearchCount
  • SearchStatisticsReport
  • SessionStatistics
  • SessionStatisticsReport
  • SessionSummaryReport
  • Summary
  • Timeline
  • TimelineType
  • TimeSlot
  • TopSellingSearchesReport
  • TopSellingSearchesReportSection

Exceptions

  • FormatException
  • Overview
  • Namespace
  • Class
  • Tree

Class ProductSalesByAttributeReport

Report containing sales statistics aggregated by product attribute values during the specified time interval. The report contains a list of Sections. One section for each available attribute value.

Apptus\ESales\Connector\Report\Report
Extended by Apptus\ESales\Connector\Report\ProductSalesByAttributeReport
Namespace: Apptus\ESales\Connector\Report
Located at Connector/Report/ProductSalesByAttributeReport.php
Methods summary
public static Apptus\ESales\Connector\Report\ProductSalesByAttributeReport
# parse( string $data, DateTimeZone $tz )

Creates a Apptus\ESales\Connector\Report\ProductSalesByAttributeReport from an XML document.

Creates a Apptus\ESales\Connector\Report\ProductSalesByAttributeReport from an XML document.

Parameters

$data
string with an XML document to parse.
$tz
time zone for the report.

Returns

Apptus\ESales\Connector\Report\ProductSalesByAttributeReport
A Apptus\ESales\Connector\Report\ProductSalesByAttributeReport.

Throws

Apptus\ESales\Connector\Report\FormatException
if the XML document does not match the expected format.
public
# __construct( SimpleXMLElement $asXml, array $sections, Apptus\ESales\Connector\Time\TimeInterval $interval, DateTimeZone $tz )

Creates a Apptus\ESales\Connector\Report\ProductSalesByAttributeReport. Note that null is illegal for all input parameters.

Creates a Apptus\ESales\Connector\Report\ProductSalesByAttributeReport. Note that null is illegal for all input parameters.

Parameters

$asXml
A XmlTree to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called.
$sections

A list of Apptus\ESales\Connector\Report\ProductSalesByAttributeReportSection elements. One for each attribute value in the report.

$interval
The time range for the data in this report.
$tz
The time zone for the data in this report.
public array
# sections( )

Returns

array
An indexed array of all sections in this report. One for each attribute value.
public
# exportToExcel( string $file )

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Parameters

$file
file to write the report to.
Methods inherited from Apptus\ESales\Connector\Report\Report
exportToXml(), timeInterval()
Apptus ESales Connector PHP API documentation generated by ApiGen