Xls\BIFFwriter

Complexity

Total Complexity

16

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	12
Bugs	1	Features	3

14 Methods

Rating	Name	Duplication	Size	Complexity
A	addContinueIfNeeded()	0	8	2
A	append()	0	5	1
A	appendRaw()	0	9	2
A	appendRecord()	0	4	1
A	addContinue()	0	4	1
A	getDataSize()	0	4	1
A	getRecord()	0	6	1
A	createRecord()	0	5	1
A	isBufferedWriteOn()	0	4	1
A	startBufferedWrite()	0	5	1
A	endBufferedWrite()	0	4	1
A	getBuffer()	0	4	1
A	getBufferSize()	0	4	1
A	getDataAndFlush()	0	8	1

<?php

namespace Xls;

use Xls\Record\AbstractRecord;

class BIFFwriter
{
    /**
     * This flag indicates write to temporary buffer mode
     * instead of $data
     * @var bool
     */
    protected $bufferedWrite = false;

    /**
     * Temporary buffer
     * @var string
     */
    protected $buffer = '';

    /**
     * The string containing the data of the BIFF stream
     * @var string
     */
    protected $data = '';

    /**
     * The size of the data in bytes. Should be the same as strlen($this->data)
     * But this is not true for Worksheet, cause it writes directly to file
     * @var integer
     */
    protected $datasize = 0;

    /**
     * @param $data
     *
     * @return string
     */
    protected function addContinueIfNeeded($data)
    {
        if (strlen($data) > Biff8::LIMIT) {
            $data = $this->addContinue($data);
        }

        return $data;
    }

    /**
     * @param string $data binary data to append
     */
    protected function append($data)
    {
        $data = $this->addContinueIfNeeded($data);
        $this->appendRaw($data);
    }

    /**
     * @param string $data binary data to append
     */
    protected function appendRaw($data)
    {
        if ($this->isBufferedWriteOn()) {
            $this->buffer .= $data;
        } else {
            $this->data .= $data;
            $this->datasize += strlen($data);
        }
    }

    /**
     * @param string $type
     * @param array $params
     */
    protected function appendRecord($type, array $params = array())
    {
        $this->append($this->getRecord($type, $params));
    }

    /**
     * This function takes a long BIFF record and inserts CONTINUE records as
     * necessary.
     *
     * @param  string $data The original binary data to be written
     * @return string Сonvenient string of continue blocks
     */
    protected function addContinue($data)
    {
        return $this->getRecord('ContinueRecord', array($data));
    }

    /**
     * @return int
     */
    public function getDataSize()
    {
        return $this->datasize;
    }

    /**
     * @param string $type
     * @param array $params
     *
     * @return mixed
     */
    protected function getRecord($type, array $params = array())
    {
        $record = $this->createRecord($type);

        return call_user_func_array(array($record, 'getData'), $params);
    }

    /**
     * @param $type
     *
     * @return AbstractRecord
     */
    protected function createRecord($type)
    {
        $className = "\\Xls\\Record\\$type";
        return new $className();
    }

    protected function isBufferedWriteOn()
    {
        return $this->bufferedWrite;
    }

    protected function startBufferedWrite()
    {
        $this->bufferedWrite = true;
        $this->buffer = '';
    }

    protected function endBufferedWrite()
    {
        $this->bufferedWrite = false;
    }

    protected function getBuffer()
    {
        return $this->buffer;
    }

    protected function getBufferSize()
    {
        return strlen($this->buffer);
    }

    /**
     * @return string
     */
    protected function getDataAndFlush()
    {
        $data = $this->data;
        $this->data = '';
        $this->datasize = 0;

        return $data;
    }
}