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: 
<?php
namespace Apptus\ESales\Connector\Report;

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

/**
 * Report for panel performance, one section for each public panel path.
 *
 * This report can be seen in the Site tab in eSales Manager and it is described
 * in the <i>Panel conversion</i> section on <a href="http://zone.apptus.com">Apptus Zone</a> (http://zone.apptus.com).
 */
class PanelConversionReport extends Report {

    const UNKNOWN_PANEL_TYPE = "unknown";

    /**
     * Creates an PanelConversionReport from an XML document.
     *
     * @param string
     *            A string with the XML document to parse.
     * @param \DateTimeZone
     *            The time zone for this report.
     * @return PanelConversionReport
     *            A PanelConversionReport.
     * @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');

        $interval = TimeInterval::parse($report->time_interval);
        $sections = array();

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

            self::checkElem($sectionElem, 'path');
            self::checkElem($sectionElem, 'display');
            self::checkElem($sectionElem, 'click');
            self::checkElem($sectionElem, 'adding_to_cart');
            self::checkElem($sectionElem, 'payment');
            self::checkElem($sectionElem, 'ctr');
            self::checkElem($sectionElem, 'atr');
            self::checkElem($sectionElem, 'ptr');

            $path = (string) $sectionElem->path[0];
            $display = $sectionElem->display;
            $click = $sectionElem->click;
            $addingToCart = $sectionElem->adding_to_cart;
            $payment = $sectionElem->payment;
            $revenue = self::getOptionalDouble($sectionElem->revenue, 0.0);//optional since it doesn't exist in order versions
            $units = self::getOptionalInt($sectionElem->units, 0);
            $ctr = new Rate(self::parseDouble($sectionElem->ctr[0]));
            $atr = new Rate(self::parseDouble($sectionElem->atr[0]));
            $ptr = new Rate(self::parseDouble($sectionElem->ptr[0]));

            $displayName = self::getOptionalString($sectionElem->display_name, Path::simpleName($path));
            $panelType = self::getOptionalString($sectionElem->panel_type, self::UNKNOWN_PANEL_TYPE);

            $section = new PanelConversionReportSection($path, $display, $click, $addingToCart, $payment, $ctr, $atr, $ptr,
                $ctr, $revenue, $units, $displayName, $panelType);
            array_push($sections, $section);
        }

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

    private static function getOptionalDouble(\SimpleXMLElement $elem, $defaultVal) {
        if ($elem != null) {
            return self::parseDouble($elem[0]);
        }
        return $defaultVal;
    }

    private static function getOptionalInt(\SimpleXMLElement $elem, $defaultVal) {
        if ($elem != null) {
            return (int) $elem;
        }
        return $defaultVal;
    }

    private static function getOptionalString(\SimpleXMLElement $elem, $defaultVal) {
        if ($elem != null) {
            return (string) $elem[0];
        }
        return $defaultVal;
    }

    private $sections;

    /**
     * Creates an PanelConversionReport.
     *
     * 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 array
     *            A list of {@see PanelConversionReportSection} elements. One for each public panel path in the report.
     * @param \DateTimeZone
     *            The time zone for the data in this report.
     */
    public function __construct(\SimpleXMLElement $asXml = null, TimeInterval $interval = null, array $sections = null,
                                \DateTimeZone $tz) {
        parent::__construct($interval, $asXml, $tz);

        $this->sections = $sections;
    }

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

    public function exportToExcel($file) {
        $w = new ExcelWriter($file);

        $w->cell('Conversion Rate for Panels')->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('Display Name')
                ->cell('Panel Type')
                ->cell('Path')
                ->cell('Displays')
                ->cell('Clicks')
                ->cell('Clicks/Displays')
                ->cell('Add to carts')
                ->cell('Add to carts/Displays')
                ->cell('Purchases')
                ->cell('Purchases/Displays')
                ->cell("Revenue")
                ->cell('Units')
                ->nextRow();
        foreach ($this->sections as $s) {
            /** @var $s PanelConversionReportSection */
            $w->cell($s->displayName())
                    ->cell($s->panelType())
                    ->cell($s->path())
                    ->cell($s->display())
                    ->cell($s->click())
                    ->cell($s->ctr())
                    ->cell($s->addingToCart())
                    ->cell($s->atr())
                    ->cell($s->payment())
                    ->cell($s->ptr())
                    ->cell($s->revenue())
                    ->cell($s->units())
                    ->nextRow();
        }

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