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

use Apptus\ESales\Connector\Time\TimeInterval;

/**
 * Report for products. Each section of the report contains sales statistics for a product that matches the filter.
 */
class ProductTopSellersReport extends Report {
    private $sections;
    private $windowFirst;
    private $windowLast;

    /**
     * Creates a {@see ProductTopSellersReport} from an XML document.
     *
     * @param string
     *          A string with an XML document to parse.
     * @param \DateTimeZone
     *          The time zone for this report.
     * @return ProductTopSellersReport
     *            A {@see ProductTopSellersReport}.
     * @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);
        $windowFirst = self::parseLong($report->window_first);
        $windowLast = self::parseLong($report->window_last);
        $sections = array();

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

                self::checkElem($sectionElem, 'product_key');
                self::checkElem($sectionElem, 'discount');
                self::checkElem($sectionElem, 'purchased_units');
                self::checkElem($sectionElem, 'abandoned_units');
                self::checkElem($sectionElem, 'revenue');
                self::checkElem($sectionElem, 'margin');

                $rank = self::parseLong($sectionElem->rank);

                $productKey = (string) $sectionElem->product_key;

                $variantKey = empty($sectionElem->variant_key) ? null : (string) $sectionElem->variant_key;

                $discount = self::parseDouble($sectionElem->discount);

                $purchasedUnits = self::parseLong($sectionElem->purchased_units);

                $abandonedUnits = self::parseLong($sectionElem->abandoned_units);

                $revenue = self::parseDouble($sectionElem->revenue);

                $margin = self::parseDouble($sectionElem->margin);

                $section = new ProductTopSellersReportSection($rank, $productKey, $variantKey, $discount, $purchasedUnits, $abandonedUnits, $revenue, $margin);
                $sections[] = $section;
            }
        }

        return new ProductTopSellersReport($root, $sections, $interval, $windowFirst, $windowLast, $tz);
    }

    /**
     * @return array An indexed array with all sections in this report, one for each product (or variant), sorted according to the specified sort order.
     */
    public function sections() {
        return $this->sections;
    }

    /**
     * @return int The lowest of the different ranks contained in this report.
     */
    public function windowFirst() {
        return $this->windowFirst;
    }

    /**
     * @return int The highest of the different ranks contained in this report.
     */
    public function windowLast() {
        return $this->windowLast;
    }

    /**
     * Creates a {@see ProductTopSellersReport}. Note that null is illegal for all input parameters.
     *
     * @param \SimpleXMLElement
     *          XML to be used if the {@see exportToXml()} method is called.
     * @param array
     *          An indexed array of {@see ProductTopSellersReportSection} elements. One for each product in the report.
     * @param TimeInterval
     *          The time range for the data in this report.
     * @param int
     *          The start of the rank range for this report.
     * @param int
     *          The end of the rank range for this report.
     * @param \DateTimeZone The time zone for the data in this report.
     */
    function __construct(\SimpleXMLElement $asXml, array $sections, TimeInterval $interval, $windowFirst, $windowLast, \DateTimeZone $tz) {
        parent::__construct($interval, $asXml, $tz);
        $this->sections = $sections; // TODO: Unmodifiable?
        $this->windowFirst = $windowFirst;
        $this->windowLast = $windowLast;
    }

    public function exportToExcel($file) {
        $w = new ExcelWriter($file);
        $w->cell('Product sales report')->nextRow();

        $w->cell('Time interval')
            ->cell(self::isoDateTimeFormat($this->timeInterval()->start($this->tz)->toDateTime($this->tz)))
            ->cell(self::isoDateTimeFormat($this->timeInterval()->end($this->tz)->toDateTime($this->tz)))->nextRow();

        $w->cell('Window first')->cell($this->windowFirst)->nextRow();
        $w->cell('Window last')->cell($this->windowLast)->nextRow();

        $w->nextRow();

        $w->cell('Rank');
        $w->cell('Product key');
        $w->cell('Variant key');
        $w->cell('Purchased units');
        $w->cell('Abandoned units');
        $w->cell('Revenue');
        $w->cell('Margin');
        $w->cell('Discount');

        foreach ($this->sections as $s) {
            $w->nextRow();
            $w->cell($s->rank());
            $w->cell($s->productKey());
            $w->cell($s->variantKey());
            $w->cell($s->purchasedUnits());
            $w->cell($s->abandonedUnits());
            $w->cell(sprintf('%.2f', $s->revenue()));
            $w->cell(sprintf('%.2f', $s->margin()));
            $w->cell(sprintf('%.2f', $s->discount()));
        }

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