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 TopSellingSearchesReport

Report for search phrases associated with the products and variants that matches a filter. Each section of the report contains a search phrase together with the total number of times the search phrase has lead to a purchase of a product or variant that matches the filter.

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

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

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

Parameters

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

Returns

Apptus\ESales\Connector\Report\TopSellingSearchesReport
A Apptus\ESales\Connector\Report\TopSellingSearchesReport.

Throws

Apptus\ESales\Connector\Report\FormatException
if the XML document does not match the expected format.
public array
# sections( )

Returns

array

An indexed array with all sections in this report, one for each search phrase, sorted descending by the number of purchased units associated with the phrase.

public integer
# windowFirst( )

Returns

integer
The lowest of the different ranks contained in this report.
public integer
# windowLast( )

Returns

integer
The highest of the different ranks contained in this report.
public
# __construct( SimpleXMLElement $asXml, array $sections, Apptus\ESales\Connector\Time\TimeInterval $interval, integer $windowFirst, integer $windowLast, DateTimeZone $tz )

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

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

Parameters

$asXml
to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called.
$sections
indexed array of Apptus\ESales\Connector\Report\TopSellingSearchesReportSection elements. One for each search phrase in the report.
$interval
time range for the data in this report.
$windowFirst
start of the rank range for this report.
$windowLast
end of the rank range for this report.
$tz
time zone for the data 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