Pim\Bundle\ExcelConnectorBundle\Writer\Excel2003XmlWriter

Complexity

Total Complexity

17

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	write()	0	6	2
A	initialize()	0	5	1
A	flush()	0	12	1
B	writeItem()	0	24	5
A	getContext()	0	4	1
A	writeHeader()	0	4	1
A	writeFooter()	0	4	1
A	writeColumns()	0	8	2
A	writeLabels()	0	4	1
A	appendFile()	0	6	1

<?php

namespace Pim\Bundle\ExcelConnectorBundle\Writer;

use Pim\Bundle\BaseConnectorBundle\Writer\File\FileWriter;
use Symfony\Component\Serializer\Encoder\EncoderInterface;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Excel 2003 XML writer
 *
 * @author    Antoine Guigan <antoine@akeneo.com>
 * @copyright 2013 Akeneo SAS (http://www.akeneo.com)
 * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */
class Excel2003XmlWriter extends FileWriter
{
    /** @const string */
    const COLUMN_XML = '<Column ss:Span="1" ss:Width="64"/>';

    /** @var EncoderInterface */
    protected $encoder;

    /** @var string */
    protected $format;

    /** @var string */
    protected $headerTemplate;

    /** @var string */
    protected $footerTemplate;

    /**
     * @var string
     * @Assert\NotBlank(groups={"Execution"})
     */
    protected $filePath = '/tmp/export_%datetime%.xml';

    /** @var array */
    protected $labels;

    /** @var int */
    protected $tempHandler;

    /** @var int */
    protected $handler;

    /**
     * @param EncoderInterface $encoder
     * @param string           $format
     * @param string           $headerTemplate
     * @param string           $footerTemplate
     */
    public function __construct(EncoderInterface $encoder, $format, $headerTemplate, $footerTemplate)
    {
        $this->encoder = $encoder;
        $this->format = $format;
        $this->headerTemplate = $headerTemplate;
        $this->footerTemplate = $footerTemplate;
    }

    /**
     * {@inheritdoc}
     */
    public function write(array $items)
    {
        foreach ($items as $item) {
            $this->writeItem($item);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function initialize()
    {
        $this->labels = [];
        $this->tempHandler = fopen('php://temp', 'rw');
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $this->handler = fopen($this->getPath(), 'w');
        $this->writeHeader();
        $this->writeColumns();
        $this->writeLabels();
        fseek($this->tempHandler, 0);
        stream_copy_to_stream($this->tempHandler, $this->handler);
        $this->writeFooter();
        fclose($this->tempHandler);
        fclose($this->handler);
    }

    /**
     * Writes an item
     *
     * @param array $item
     */
    protected function writeItem(array $item)
    {
        $context = $this->getContext($item);
        $row = [];
        foreach ($this->labels as $header) {
            if (array_key_exists($header, $item)) {
                $row[] = $item[$header];
                unset($item[$header]);
            } else {
                $row[] = '';
            }
        }

        foreach ($item as $header => $value) {
            $this->labels[] = $header;
            $row[] = $value;
        }

        fwrite($this->tempHandler, $this->encoder->encode($row, $this->format, $context));

        if ($this->stepExecution) {
            $this->stepExecution->incrementSummaryInfo('write');
        }
    }

    /**
     * Returns the context for an encoder
     *
     * @param array $item
     *
     * @return array
     */
    protected function getContext(array $item)
    {
        return [];
    }

    /**
     * Writes the header of the XML file
     */
    protected function writeHeader()
    {
        $this->appendFile($this->headerTemplate);
    }

    /**
     * Writes the footer of the XML file
     */
    protected function writeFooter()
    {
        $this->appendFile($this->footerTemplate);
    }

    /**
     * Writes the Columns section of the XML file
     *
     * @return null
     */
    protected function writeColumns()
    {
        if (!count($this->labels)) {
            return;
        }

        fwrite($this->handler, implode('', array_fill(0, count($this->labels), static::COLUMN_XML)));
    }

    /**
     * Writes the labels row of the XML file
     */
    protected function writeLabels()
    {
        fwrite($this->handler, $this->encoder->encode($this->labels, $this->format));
    }

    /**
     * Appends the contents of a file to the XML file
     *
     * @param string $fileName
     */
    protected function appendFile($fileName)
    {
        $fd = fopen($fileName, 'r');
        stream_copy_to_stream($fd, $this->handler);
        fclose($fd);
    }
}