summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/Iterators/CsvFileIterator.php
blob: fb8581a5f28e35a7cca934bf5e25def6c7f76d53 (plain)
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
<?php

namespace SMW\Iterators;

use Exception;
use Iterator;
use SMW\Exception\FileNotFoundException;

/**
 * @see http://php.net/manual/en/function.fgetcsv.php
 *
 * @license GNU GPL v2+
 * @since 3.0
 */
class CsvFileIterator implements Iterator {

	/**
	 * @var Resource
	 */
	private $handle;

	/**
	 * @var boolean
	 */
	private $parseHeader;

	/**
	 * @var []
	 */
	private $header = [];

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

	/**
	 * @var integer
	 */
	private $length;

	/**
	 * @var int
	 */
	private $key = 0;

	/**
	 * @since 3.0
	 *
	 * @param string $file
	 * @param boolean $parseHeader
	 * @param string  $delimiter
	 * @param integer $length
	 */
	public function __construct( $file, $parseHeader = false, $delimiter = ",", $length = 8000 ) {

		try {
			$this->handle = fopen( $file, "r" );
		} catch ( Exception $e ) {
			throw new FileNotFoundException( 'File "'. $file . '" is not accessible.' );
		}

		$this->parseHeader = $parseHeader;
		$this->delimiter = $delimiter;
		$this->length = $length;
	}

	/**
	 * @since 3.0
	 */
	public function __destruct() {
		if( is_resource( $this->handle ) ) {
			fclose( $this->handle );
		}
	}

	/**
	 * @since 3.0
	 *
	 * @return []
	 */
	public function getHeader() {
		return $this->header;
	}

	/**
	 * Resets the file handle
	 *
	 * @since 3.0
	 *
	 * {@inheritDoc}
	 */
	public function rewind() {
		$this->key = 0;
		rewind( $this->handle );
	}

	/**
	 * Returns the current CSV row as a 2 dimensional array
	 *
	 * @since 3.0
	 *
	 * {@inheritDoc}
	 */
	public function current() {

		// First iteration to match the header
		if ( $this->parseHeader && $this->key == 0 ) {
			$this->header = fgetcsv( $this->handle, $this->length, $this->delimiter );
		}

		$currentElement = fgetcsv( $this->handle, $this->length, $this->delimiter );
		$this->key++;

		return $currentElement;
	}

	/**
	 * Returns the current row number.
	 *
	 * @since 3.0
	 *
	 * {@inheritDoc}
	 */
	public function key() {
		return $this->key;
	}

	/**
	 * Checks if the end of file is reached.
	 *
	 * @since 3.0
	 *
	 * {@inheritDoc}
	 */
	public function next() {
		return !feof( $this->handle );
	}

	/**
	 * Checks if the next row is a valid row.
	 *
	 * @since 3.0
	 *
	 * {@inheritDoc}
	 */
	public function valid() {

		if ( $this->next() ) {
			return true;
		}

		fclose( $this->handle );
		return false;
	}

}