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

use Apptus\ESales\Connector\Time\TimeInterval;

/**
 * Report containing sales statistics aggregated by product attribute values during the specified time interval.
 * The report contains a list of Sections. One section for each available attribute value.
 */
class ProductSalesByAttributeReport extends Report {

    private $sections;

    /**
     * Creates a {@see ProductSalesByAttributeReport} from an XML document.
     *
     * @param string
     *            A string with an XML document to parse.
     * @param \DateTimeZone
     *            A time zone for the report.
     * @return ProductSalesByAttributeReport
     *            A {@see ProductSalesByAttributeReport}.
     * @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((string) $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, 'name');
            self::checkElem($sectionElem, 'discount');
            self::checkElem($sectionElem, 'purchased_units');
            self::checkElem($sectionElem, 'abandoned_units');
            self::checkElem($sectionElem, 'revenue');
            self::checkElem($sectionElem, 'margin');

            $name = (string) $sectionElem->name;
            $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 ProductSalesByAttributeReportSection($name, $discount, $purchasedUnits, $abandonedUnits, $revenue, $margin);
            $sections[] = $section;
        }

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

    /**
     * Creates a {@see ProductSalesByAttributeReport}. Note that null is illegal for all input parameters.
     *
     * @param \SimpleXMLElement $asXml A XmlTree to be used if the {@see exportToXml()} method is called.
     * @param array $sections A list of {@see ProductSalesByAttributeReportSection} elements. One
     *            for each attribute value in the report.
     * @param TimeInterval $interval The time range for the data in this report.
     * @param \DateTimeZone $tz The time zone for the data in this report.
     */
    public function __construct(\SimpleXMLElement $asXml, array $sections, TimeInterval $interval, \DateTimeZone $tz) {
        parent::__construct($interval, $asXml, $tz);
        $this->sections = $sections; // TODO: Unmodifiable?
    }

    /**
     * @return array An indexed array of all sections in this report. One for each attribute value.
     */
    public function sections() {
        return $this->sections;
    }

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

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

        $w->cell('Name');
        $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->name());
            $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