AbstractBase::open() - Code Metrics - bazzline/php_component_csv - Measure and Improve Code Quality continuously with Scrutinizer

AbstractBase::open() A
last analyzed 2018-11-08 17:57 UTC

↳ Parent: AbstractBase

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
/**
 * @author stev leibelt <[email protected]>
 * @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()
            );
        }
    }
}

1			<?php
2			/**
3			* @author stev leibelt <[email protected]>
4			* @since 2015-05-06
5			*/
6
7			namespace Net\Bazzline\Component\Csv;
8
9			use SplFileObject;
10
11			abstract class AbstractBase implements BaseInterface
12			{
13			/** @var string */
14			private $delimiter = ',';
15
16			/** @var string */
17			private $enclosure = '"';
18
19			/** @var string */
20			private $escapeCharacter = '\\';
21
22			/** @var false\|array */
23			private $headline = false;
24
25			/** @var SplFileObject */
26			private $handler;
27
28			/** @var string */
29			private $path;
30
31			/**
32			* @return bool
33			*/
34			public function hasHeadline()
35			{
36			return ($this->headline !== false);
37			}
38
39			/**
40			* @param string $delimiter
41			* @throws InvalidArgumentException
42			*/
43			public function setDelimiter($delimiter)
44			{
45			$this->assertIsASingleCharacterString($delimiter, 'delimiter');
46			$this->delimiter = $delimiter;
47			$this->updateCsvControl();
48			}
49
50			/**
51			* @param string $enclosure
52			* @throws InvalidArgumentException
53			*/
54			public function setEnclosure($enclosure)
55			{
56			$this->assertIsASingleCharacterString($enclosure, 'enclosure');
57			$this->enclosure = $enclosure;
58			$this->updateCsvControl();
59			}
60
61			/**
62			* @param string $escapeCharacter
63			* @throws InvalidArgumentException
64			*/
65			public function setEscapeCharacter($escapeCharacter)
66			{
67			$this->assertIsASingleCharacterString($escapeCharacter, 'escapeCharacter');
68			$this->escapeCharacter = $escapeCharacter;
69			$this->updateCsvControl();
70			}
71
72			/**
73			* @param string $path
74			* @return $this
75			* @throws InvalidArgumentException
76			* @todo implement validation
77			*/
78			public function setPath($path)
79			{
80			$this->path = $path;
81			$this->handler = $this->open($path);
82
83			return $this;
84			}
85
86			/**
87			* @return string
88			*/
89			protected function getDelimiter()
90			{
91			return $this->delimiter;
92			}
93
94			/**
95			* @return string
96			*/
97			protected function getEnclosure()
98			{
99			return $this->enclosure;
100			}
101
102			/**
103			* @return string
104			*/
105			protected function getEscapeCharacter()
106			{
107			return $this->escapeCharacter;
108			}
109
110			/**
111			* @return SplFileObject\|resource
112			*/
113			protected function getFileHandler()
114			{
115			return $this->handler;
116			}
117
118			/**
119			* @return string
120			*/
121			abstract protected function getFileHandlerOpenMode();
122
123			/**
124			* @return array\|false
125			*/
126			protected function getHeadline()
127			{
128			return $this->headline;
129			}
130
131			/**
132			* @return string
133			*/
134			protected function getPath()
135			{
136			return $this->path;
137			}
138
139			/**
140			* @return $this
141			*/
142			protected function resetHeadline()
143			{
144			$this->headline = false;
145
146			return $this;
147			}
148
149			/**
150			* @param array $headline
151			* @return $this
152			*/
153			protected function setHeadline(array $headline)
154			{
155			$this->headline = $headline;
156
157			return $this;
158			}
159
160			protected function close()
161			{
162			if (!is_null($this->handler)) {
163			$this->headline = null;
164			}
165			}
166
167			/**
168			* @param string $path
169			* @return SplFileObject
170			* @todo inject or inject factory
171			*/
172			protected function open($path)
173			{
174			$file = new SplFileObject($path, $this->getFileHandlerOpenMode());
175			$file->setFlags(SplFileObject::READ_CSV \| SplFileObject::DROP_NEW_LINE \| SplFileObject::SKIP_EMPTY);
176
177			return $file;
178			}
179
180			/**
181			* @param string $variable
182			* @param string $name
183			* @throws InvalidArgumentException
184			*/
185			private function assertIsASingleCharacterString($variable, $name)
186			{
187			if (!is_string($variable)) {
188			$message = $name . ' must be of type "string"';
189
190			throw new InvalidArgumentException($message);
191			}
192			if (strlen($variable) != 1) {
193			$message = $name . ' must be a single character';
194
195			throw new InvalidArgumentException($message);
196			}
197			}
198
199			private function updateCsvControl()
200			{
201			$file = $this->getFileHandler();
202
203			if ($file instanceof SplFileObject) {
204			$file->setCsvControl(
205			$this->getDelimiter(),
206			$this->getEnclosure(),
207			$this->getEscapeCharacter()
208			);
209			}
210			}
211			}

bazzline / php_component_csv

AbstractBase::open() A last analyzed 2018-11-08 17:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractBase::open() A
last analyzed 2018-11-08 17:57 UTC