PHP Класс Eccube\Service\CsvImportService

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Наследование: implements Iterator, implements SeekableIterator, implements Countable

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$columnHeaders	array	Column headers as read from the CSV file
$count	integer	Total number of rows in the CSV file
$duplicateHeadersFlag	integer	How to handle duplicate headers
$errors	array	Faulty CSV rows
$file	SplFileObject	CSV file
$headerRowNumber	integer	Number of the row that contains the column names
$headersCount	integer	In case of duplicate headers, this is always the number of unmerged headers.

Открытые методы

Метод	Описание
__construct ( SplFileObject $file, string $delimiter = ',', string $enclosure = '"', string $escape = '\' )
count ( )
current ( ) : array	Return the current row as an array
getColumnHeaders ( ) : array	Get column headers
getErrors ( ) : array	Get rows that have an invalid number of columns
getFields ( )
getRow ( integer $number ) : array	Get a row
hasErrors ( ) : boolean	Does the reader contain any invalid rows?
key ( )
next ( )
rewind ( )	Rewind the file pointer
seek ( $pointer )
setColumnHeaders ( array $columnHeaders )	Set column headers
setHeaderRowNumber ( integer $rowNumber, integer $duplicates = null ) : boolean	Set header row number
valid ( )

Защищенные методы

Метод	Описание
convertEncodingRows ( $row )	行の文字エンコーディングを変換する.
incrementHeaders ( array $headers ) : array	Add an increment to duplicate headers
mergeDuplicates ( array $line ) : array	Merges values for duplicate headers into an array
readHeaderRow ( integer $rowNumber ) : array	Read header row from CSV file

Описание методов

__construct() публичный Метод

public __construct ( SplFileObject $file, string $delimiter = ',', string $enclosure = '"', string $escape = '\' )
$file	SplFileObject
$delimiter	string
$enclosure	string
$escape	string

convertEncodingRows() защищенный Метод

Windows 版 PHP7 環境では、ファイルエンコーディングが CP932 になるため UTF-8 に変換する. それ以外の環境では何もしない。

protected convertEncodingRows ( $row )

count() публичный Метод

public count ( )

current() публичный Метод

If a header row has been set, an associative array will be returned

public current ( ) : array
Результат	array

getColumnHeaders() публичный Метод

Get column headers

public getColumnHeaders ( ) : array
Результат	array

getErrors() публичный Метод

Get rows that have an invalid number of columns

public getErrors ( ) : array
Результат	array

getFields() публичный Метод

public getFields ( )

getRow() публичный Метод

Get a row

public getRow ( integer $number ) : array
$number	integer	Row number
Результат	array

hasErrors() публичный Метод

Does the reader contain any invalid rows?

public hasErrors ( ) : boolean
Результат	boolean

incrementHeaders() защищенный Метод

protected incrementHeaders ( array $headers ) : array
$headers	array
Результат	array

key() публичный Метод

public key ( )

mergeDuplicates() защищенный Метод

protected mergeDuplicates ( array $line ) : array
$line	array
Результат	array

next() публичный Метод

public next ( )

readHeaderRow() защищенный Метод

Read header row from CSV file

protected readHeaderRow ( integer $rowNumber ) : array
$rowNumber	integer	Row number
Результат	array

rewind() публичный Метод

If a header row has been set, the pointer is set just below the header row. That way, when you iterate over the rows, that header row is skipped.

public rewind ( )

seek() публичный Метод

public seek ( $pointer )

setColumnHeaders() публичный Метод

Set column headers

public setColumnHeaders ( array $columnHeaders )
$columnHeaders	array

setHeaderRowNumber() публичный Метод

Set header row number

public setHeaderRowNumber ( integer $rowNumber, integer $duplicates = null ) : boolean
$rowNumber	integer	Number of the row that contains column header names
$duplicates	integer	How to handle duplicates (optional). One of: - CsvReader::DUPLICATE_HEADERS_INCREMENT; increments duplicates (dup, dup1, dup2 etc.) - CsvReader::DUPLICATE_HEADERS_MERGE; merges values for duplicate headers into an array (dup => [value1, value2, value3])
Результат	boolean

valid() публичный Метод

public valid ( )

Описание свойств

$columnHeaders защищенное свойство

Column headers as read from the CSV file

protected array $columnHeaders
Результат	array

$count защищенное свойство

Total number of rows in the CSV file

protected int $count
Результат	integer

$duplicateHeadersFlag защищенное свойство

How to handle duplicate headers

protected int $duplicateHeadersFlag
Результат	integer

$errors защищенное свойство

Faulty CSV rows

protected array $errors
Результат	array

$file защищенное свойство

CSV file

protected SplFileObject $file
Результат	SplFileObject

$headerRowNumber защищенное свойство

Number of the row that contains the column names

protected int $headerRowNumber
Результат	integer

$headersCount защищенное свойство

In case of duplicate headers, this is always the number of unmerged headers.

protected int $headersCount
Результат	integer