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: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 

<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-05-06 
 */

namespace Net\Bazzline\Component\Csv;

use SplFileObject;

abstract class AbstractBase implements BaseInterface
{
    /** @var string */
    private $delimiter = ',';

    /** @var string */
    private $enclosure = '"';

    /** @var string */
    private $escapeCharacter = '\\';

    /** @var false|array */
    private $headline = false;

    /** @var SplFileObject */
    private $handler;

    /** @var string */
    private $path;

    /**
     * @return bool
     */
    public function hasHeadline()
    {
        return ($this->headline !== false);
    }

    /**
     * @param string $delimiter
     * @throws InvalidArgumentException
     */
    public function setDelimiter($delimiter)
    {
        $this->assertIsASingleCharacterString($delimiter, 'delimiter');
        $this->delimiter = $delimiter;
        $this->updateCsvControl();
    }

    /**
     * @param string $enclosure
     * @throws InvalidArgumentException
     */
    public function setEnclosure($enclosure)
    {
        $this->assertIsASingleCharacterString($enclosure, 'enclosure');
        $this->enclosure = $enclosure;
        $this->updateCsvControl();
    }

    /**
     * @param string $escapeCharacter
     * @throws InvalidArgumentException
     */
    public function setEscapeCharacter($escapeCharacter)
    {
        $this->assertIsASingleCharacterString($escapeCharacter, 'escapeCharacter');
        $this->escapeCharacter = $escapeCharacter;
        $this->updateCsvControl();
    }

    /**
     * @param string $path
     * @return $this
     * @throws InvalidArgumentException
     * @todo implement validation
     */
    public function setPath($path)
    {
        $this->path     = $path;
        $this->handler  = $this->open($path);

        return $this;
    }

    /**
     * @return string
     */
    protected function getDelimiter()
    {
        return $this->delimiter;
    }

    /**
     * @return string
     */
    protected function getEnclosure()
    {
        return $this->enclosure;
    }

    /**
     * @return string
     */
    protected function getEscapeCharacter()
    {
        return $this->escapeCharacter;
    }

    /**
     * @return SplFileObject|resource
     */
    protected function getFileHandler()
    {
        return $this->handler;
    }

    /**
     * @return string
     */
    abstract protected function getFileHandlerOpenMode();

    /**
     * @return array|false
     */
    protected function getHeadline()
    {
        return $this->headline;
    }

    /**
     * @return string
     */
    protected function getPath()
    {
        return $this->path;
    }

    /**
     * @return $this
     */
    protected function resetHeadline()
    {
        $this->headline = false;

        return $this;
    }

    /**
     * @param array $headline
     * @return $this
     */
    protected function setHeadline(array $headline)
    {
        $this->headline = $headline;

        return $this;
    }

    protected function close()
    {
        if (!is_null($this->handler)) {
            $this->headline = null;
        }
    }

    /**
     * @param string $path
     * @return SplFileObject
     * @todo inject or inject factory
     */
    protected function open($path)
    {
        $file = new SplFileObject($path, $this->getFileHandlerOpenMode());
        $file->setFlags(SplFileObject::READ_CSV | SplFileObject::DROP_NEW_LINE | SplFileObject::SKIP_EMPTY);

        return $file;
    }

    /**
     * @param string $variable
     * @param string $name
     * @throws InvalidArgumentException
     */
    private function assertIsASingleCharacterString($variable, $name)
    {
        if (!is_string($variable)) {
            $message = $name . ' must be of type "string"';

            throw new InvalidArgumentException($message);
        }
        if (strlen($variable) != 1) {
            $message = $name . ' must be a single character';

            throw new InvalidArgumentException($message);
        }
    }

    private function updateCsvControl()
    {
        $file = $this->getFileHandler();

        if ($file instanceof SplFileObject) {
            $file->setCsvControl(
                $this->getDelimiter(),
                $this->getEnclosure(),
                $this->getEscapeCharacter()
            );
        }
    }
}