Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP
  • Overview
  • Namespace
  • Class
  • Tree
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 
<?php
namespace Apptus\ESales\Connector\Report;

use Apptus\ESales\Connector\Time\TimeInterval;

/**
 * Report with a summary of session statistics for the entire site as well as grouped by searches and recommendations.
 *
 * This report can be seen at the top of the Site Summary tab on the Reports page in eSales Manager and it is described
 * in the <i>Session summary</i> section on <a href="http://zone.apptus.com">Apptus Zone</a> (http://zone.apptus.com).
 */
class SessionSummaryReport extends Report {

    /**
     * Creates an SessionSummaryReport from an XML document.
     *
     * @param string
     *            A string with the XML document to parse.
     * @param \DateTimeZone
     *            The time zone for this report.
     * @return AdPlacementReport
     *            An AdPlacementReport.
     * @throws FormatException if the XML document does not match the expected format.
     */
    public static function parse($data, \DateTimeZone $tz) {
        $root = new \SimpleXMLElement($data);

        self::checkElem($root, 'function');
        self::checkElem($root->function, 'report');

        $report = $root->function->report;

        self::checkElem($report, 'time_interval');
        self::checkElem($report, 'site');
        self::checkElem($report, 'search');
        self::checkElem($report, 'recommendation');

        $interval = TimeInterval::parse((string) $report->time_interval);
        $site = self::parseSummary($report->site);
        $search = self::parseSummary($report->search);
        $recommendation = self::parseSummary($report->recommendation);
        return new SessionSummaryReport($root, $interval, $site, $search, $recommendation, $tz);
    }

    private static function parseSummary(\SimpleXMLElement $summary) {
        self::checkElem($summary, 'visits');
        self::checkElem($summary, 'orders');
        $brElem = $summary->bounce_rate;
        $bounceRate = new Rate($brElem === null ? NAN : self::parseDouble($brElem[0]));
        $visits = self::parseLong((string) $summary->visits);
        $orders = self::parseLong((string) $summary->orders);
        $crElem = $summary->conversion_rate;
        $conversionRate = new Rate(self::parseDouble($crElem[0]));
        return new Summary($bounceRate, $visits, $orders, $conversionRate);
    }

    private $site;
    private $search;
    private $recommendation;

    /**
     * Creates an SessionSummaryReport. Note that null is illegal for all input parameters.
     *
     * @param \SimpleXMLElement
     *            An XmlTree to be used if the {@see exportToXml()} method is called.
     * @param TimeInterval
     *            The time range for the data in this report.
     * @param Summary
     *            A summary containing bounce rate, number of visits, number of orders and conversion rate for the site.
     * @param Summary
     *            A summary containing number of visits, number of orders and conversion rate for the search panels.
     * @param Summary
     *            A summary containing number of visits, number of orders and conversion rate for the recommendation panels.
     * @param \DateTimeZone
     *            The time zone for the data in this report.
     */
    public function __construct(\SimpleXMLElement $asXml, TimeInterval $interval, Summary $site, Summary $search, Summary $recommendation, \DateTimeZone $tz) {
        parent::__construct($interval, $asXml, $tz);

        $this->site = $site;
        $this->search = $search;
        $this->recommendation = $recommendation;
    }

    /**
     * @return Summary
     *            A summary containing bounce rate, number of visits, number of orders and conversion rate for the site.
     */
    public function site() {
        return $this->site;
    }

    /**
     * @return Summary
     *            A summary containing number of visits, number of orders and conversion rate for the search panels.
     */
    public function search() {
        return $this->search;
    }

    /**
     * @return Summary
     *            A summary containing number of visits, number of orders and conversion rate for the recommendation panels.
     */
    public function recommendation() {
        return $this->recommendation;
    }

    public function exportToExcel($file) {
        $w = new ExcelWriter($file);
        $w->cell('Session Summary')->nextRow();
        $w->cell('Time interval');
        $w->cell($this->isoDateTimeFormat($this->timeInterval()->start($this->tz)->toDateTime($this->tz)));
        $w->cell($this->isoDateTimeFormat($this->timeInterval()->end($this->tz)->toDateTime($this->tz)))->nextRow();
        $w->nextRow();

        $w->cell("Summary")->cell("Bounce Rate")->cell("Visits")->cell("Orders")->cell("Conversion Rate")->nextRow();
        $w->cell("Site")->cell($this->site->bounceRate())->cell($this->site->visits())->cell($this->site->orders())->cell($this->site->conversionRate())->nextRow();
        $w->cell("Search")->cell($this->search->bounceRate())->cell($this->search->visits())->cell($this->search->orders())->cell($this->search->conversionRate())->nextRow();
        $w->cell("Recommendations")->cell($this->recommendation->bounceRate())->cell($this->recommendation->visits())->cell($this->recommendation->orders())->cell($this->recommendation->conversionRate())->nextRow();

        $w->flush();
        $w->close();
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen