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 ProductSalesByTimeReport

Report containing aggregated sales statistics. This report contains five Apptus\ESales\Connector\Report\Timeline's:

  • purchasedUnits - A timeline with the number of purchased units.
  • abandonedUnits - A timeline with the number of abandoned units.
  • revenue - A timeline with aggregated net selling price.
  • margin - A timeline with the aggregated margin.
  • discount - A timeline with the aggregated discount.

Each timeline has a number of slots with data. The number of slots depends on the specified time line type.

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

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

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

Parameters

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

Returns

Apptus\ESales\Connector\Report\ProductSalesByTimeReport
A Apptus\ESales\Connector\Report\ProductSalesByTimeReport.

Throws

Apptus\ESales\Connector\Report\FormatException
if the XML document does not match the expected format.
public
# __construct( SimpleXMLElement $asXml, Apptus\ESales\Connector\Time\TimeInterval $interval, Apptus\ESales\Connector\Report\Timeline $discount, Apptus\ESales\Connector\Report\Timeline $purchasedUnits, Apptus\ESales\Connector\Report\Timeline $abandonedUnits, Apptus\ESales\Connector\Report\Timeline $revenue, Apptus\ESales\Connector\Report\Timeline $margin, Apptus\ESales\Connector\Report\TimelineType $timelineType, DateTimeZone $tz )

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

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

Parameters

$asXml
XmlTree to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called.
$interval
time range for the data in this report.
$discount
Apptus\ESales\Connector\Report\Timeline of discount values.
$purchasedUnits
Apptus\ESales\Connector\Report\Timeline containing the number of purchased units.
$abandonedUnits
Apptus\ESales\Connector\Report\Timeline containing the number of abandoned units.
$revenue
Apptus\ESales\Connector\Report\Timeline of revenue values.
$margin
Apptus\ESales\Connector\Report\Timeline of margin values.
$timelineType
timeline type used for this report.
$tz
time zone for the data in this report.
public Apptus\ESales\Connector\Report\Timeline
# discount( )

Returns

Apptus\ESales\Connector\Report\Timeline
A Apptus\ESales\Connector\Report\Timeline of discount values.
public Apptus\ESales\Connector\Report\Timeline
# purchasedUnits( )

Returns

Apptus\ESales\Connector\Report\Timeline
A Apptus\ESales\Connector\Report\Timeline of purchased units values.
public Apptus\ESales\Connector\Report\Timeline
# abandonedUnits( )

Returns

Apptus\ESales\Connector\Report\Timeline
A Apptus\ESales\Connector\Report\Timeline of abandoned units values.
public Apptus\ESales\Connector\Report\Timeline
# revenue( )

Returns

Apptus\ESales\Connector\Report\Timeline
A Apptus\ESales\Connector\Report\Timeline of revenue values.
public Apptus\ESales\Connector\Report\Timeline
# margin( )

Returns

Apptus\ESales\Connector\Report\Timeline
A Apptus\ESales\Connector\Report\Timeline of margin values.
public Apptus\ESales\Connector\Report\TimelineType
# timelineType( )

Returns

Apptus\ESales\Connector\Report\TimelineType
The timeline type used in this report.
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