Completed
Push — master ( 0a5b37...5c1aea )
by Luke
02:18
created

IsWritable   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 37
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 3
c 0
b 0
f 0
lcom 0
cbo 1
dl 0
loc 37
ccs 6
cts 6
cp 1
rs 10

5 Methods

Rating   Name   Duplication   Size   Complexity  
A writeLine() 0 4 1
A assertIsWritable() 0 6 2
getName() 0 1 ?
isWritable() 0 1 ?
write() 0 1 ?
1
<?php
2
/**
3
 * CSVelte: Slender, elegant CSV for PHP.
4
 *
5
 * Inspired by Python's CSV module and Frictionless Data and the W3C's CSV
6
 * standardization efforts, CSVelte was written in an effort to take all the
7
 * suck out of working with CSV.
8
 *
9
 * @version   v0.2
10
 * @copyright Copyright (c) 2016 Luke Visinoni <[email protected]>
11
 * @author    Luke Visinoni <[email protected]>
12
 * @license   https://github.com/deni-zen/csvelte/blob/master/LICENSE The MIT License (MIT)
13
 */
14
namespace CSVelte\Traits;
15
16
use CSVelte\Exception\IOException;
17
18
/**
19
 * IO IsWritable Trait.
20
 *
21
 * Write methods shared between CSVelte\IO classes.
22
 *
23
 * @package    CSVelte
24
 * @subpackage CSVelte\Traits
25
 * @copyright  (c) 2016, Luke Visinoni <[email protected]>
26
 * @author     Luke Visinoni <[email protected]>
27
 * @since      v0.2
28
 */
29
trait IsWritable
30
{
31
    /**
32
     * Write single line to file/stream
33
     *
34
     * Writes a line to the file/stream (if it is writable)
35
     *
36
     * @param string $line The line to be written to the stream
37
     * @param string $eol The end of line string
38
     * @return int The number of bytes written to the stream
39
     * @throws CSVelte\Exception\IOException
40
     */
41 14
    public function writeLine($line, $eol = PHP_EOL)
42
    {
43 14
        return $this->write($line . $eol);
44
    }
45
46
    /**
47
     * Assert that this file/stream object is readable.
48
     *
49
     * @return void
50
     * @throws CSVelte\Exception\IOException if stream isn't readable
51
     */
52 18
    protected function assertIsWritable()
53
    {
54 18
        if (!$this->isWritable()) {
55 2
            throw new IOException("Stream not writable: " . $this->getName(), IOException::ERR_NOT_WRITABLE);
56
        }
57 16
    }
58
59
    abstract public function getName();
60
61
    abstract public function isWritable();
62
63
    abstract public function write($str);
64
65
}
66