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: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 
<?php
namespace Apptus\ESales\Connector\Report;

use Apptus\ESales\Connector\Time\TimeInterval;
use Apptus\ESales\Connector\Time\TimePoint;

/**
 * Report for ads.
 *
 * Each section of the report contains all attributes for an ad together with timlines for click through rate and average order value for this ad.
 * This report can be seen in the Ads tab on the Reports page in eSales Manager and it is
 * described in the <i>Order Value</i> section on <a href="http://zone.apptus.com">Apptus Zone</a> (http://zone.apptus.com) .
 */
class AdOrderValueReport extends Report {

    /**
     * Creates an AdOrderValueReport from an XML document.
     *
     * @param string A string with the XML document to parse.
     * @param \DateTimeZone The time zone for the report.
     * @return AdConversionReport
     *            An AdConversionReport.
     * @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, 'sections');
        self::checkElem($report, 'timeline_type');

        $interval = TimeInterval::parse($report->time_interval);
        $timelineType = TimelineType::parse((string) $report->timeline_type);
        $sections = array();

        foreach ($report->sections->section as $sectionElem) {
            if ($sectionElem->getName() !== 'section') {
                throw new FormatException('Unknown element in XML: ' . $sectionElem->getName());
            }

            self::checkElem($sectionElem, 'ad');
            self::checkElem($sectionElem, 'timeline');

            $adElem = $sectionElem->ad;
            self::checkElem($adElem, 'ad_key');

            $adKey = $adElem->ad_key;
            $ad = new Ad($adKey);

            foreach ($adElem->children() as $attr) {
                $name = $attr->getName();

                if ($name != 'ad_key') {
                    $value = $attr;
                    $ad->addAttribute($name, $value);
                }
            }

            $timeline = $sectionElem->timeline;
            $ctrs = new Timeline();
            $aovs = new Timeline();

            $len = count($timeline->slot);

            if ($len > 0) {
                $slot = $timeline->slot[0];

                if ($slot->getName() != 'slot') {
                    throw new FormatException('Unknown element in XML: ' . $slot->getName());
                }

                for ($i = 1; $i < $len; $i++) {
                    $next = $timeline->slot[$i];

                    if ($next->getName() != 'slot') {
                        throw new FormatException('Unknown element in XML: ' . $slot->getName());
                    }

                    $nextStart = (string) $next->attributes()->start;
                    $end = $nextStart === '' ? '-1' : TimePoint::parse($nextStart, $tz)->toMillis();
                    self::addToTimeline($ctrs, $aovs, $slot, $end, $tz);
                    $slot = $next;
                }

                if ($slot->getName() != 'slot') {
                    throw new FormatException('Unknown element in XML: ' . $slot->getName());
                }

                $end = $interval->end($tz)->toMillis();
                self::addToTimeline($ctrs, $aovs, $slot, $end, $tz);
            }

            $section = new AdOrderValueReportSection($ad, $ctrs, $aovs);
            array_push($sections, $section);
        }

        return new AdOrderValueReport($root, $sections, $interval, $timelineType, $tz);
    }

    private static function addToTimeline(Timeline $ctrs, Timeline $aovs, \SimpleXMLElement $slot, $end, $tz) {
        $slotName = (string) $slot->attributes()->name;

        $startAttr = (string) $slot->attributes()->start;
        $start = $startAttr === '' ? '-1' : TimePoint::parse($startAttr, $tz)->toMillis();

        $aov = self::parseDouble($slot->aov[0]);
        $aovs->append(new TimeSlot($start, $end, $slotName, $aov));

        $ctr = new Rate(self::parseDouble($slot->ctr[0]));
        $ctrs->append(new TimeSlot($start, $end, $slotName, $ctr));
    }

    private $sections;
    private $timelineType;

    /**
     * Creates an AdOrderValueReport.
     *
     * @param \SimpleXMLElement
     *            An XmlTree to be used if the {@see exportToXml()} method is called. Can not be null.
     * @param array
     *            A list of {@see AdOrderValueReportSection} elements. One for each ad in the report. Can not be null.
     * @param TimeInterval
     *            The time range for the data in this report. Can not be null.
     * @param TimelineType
     *            The timeline type for the data in this report. Can not be null.
     * @param \DateTimeZone
     *            The time zone for the data in this report. Can not be null.
     */
    public function __construct(\SimpleXMLElement $asXml, array $sections, TimeInterval $interval, TimelineType $timelineType, \DateTimeZone $tz) {
        parent::__construct($interval, $asXml, $tz);

        $this->sections = $sections;
        $this->timelineType = $timelineType;
    }

    /**
     * @return TimelineType
     *            The timeline type used for the data in this report.
     */
    public function timelineType() {
        return $this->timelineType;
    }

    /**
     * @return array
     *            A list of {@see AdOrderValueReportSection} elements. One for each ad in the report.
     */
    public function sections() {
        return $this->sections;
    }

    public function exportToExcel($file) {
        $w = new ExcelWriter($file);
        $w->cell('Order Value for Ads')->nextRow();
        $w->cell('Timeline Type')->cell($this->timelineType)->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();

        foreach ($this->sections as $s) {
            $w->nextRow();
            $w->cell('Ad')->nextRow();
            $w->cell('ad_key')->cell($s->ad()->key())->nextRow();

            foreach ($s->ad()->attributes() as $a) {
                $w->cell($a->name())->cell($a->value())->nextRow();
            }

            $w->nextRow();
            $w->cell('Timeline')->nextRow();
            $w->cell('Time slot')
                ->cell('CTR')
                ->cell('Average Order Value')
                ->nextRow();

            for ($i = 0; $i < count($s->aovs()); $i++) {
                $start = $s->aovs()[$i]->slotStartTime();
                $aov = $s->aovs()[$i]->value();
                $formattedAov = $aov === null ? '' : sprintf('%01.2f', $aov);

                $name = (string) $s->aovs()[$i];
                if (strlen($name) === 0) {
                    $name = $start < 0 ?  $i + 1 : $this->isoDateTimeFormat(TimePoint::fromMillis($start)->toDateTime($this->tz));
                }

                $w->cell($name)
                    ->cell($s->ctrs()[$i]->value())
                    ->cell($formattedAov)
                    ->nextRow();
            }

            $w->nextRow();
        }

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