---

CSV

• Full name: \MammothPHP\WoollyM\IO\CSV
• Parent class: \MammothPHP\WoollyM\IO\Builder

Constants

Constant	Visibility	Type	Value
DEFAULT_DELIMITER	public		','
DEFAULT_ENCLOSURE	public		'"'
DEFAULT_ESCAPE	public		'\'
DEFAULT_HEADER_OFFSET	public		0
DEFAULT_COLUMNS	public		null
DEFAULT_ONLY_COLUMNS	public		false
DEFAULT_MAPPING	public		null

Properties

csvReader

public \League\Csv\Reader $csvReader

---

ressource

public mixed $ressource

---

delimiter

public string $delimiter

---

enclosure

public string $enclosure

---

escape

public string $escape

---

headerOffset

public ?int $headerOffset

---

columns

public ?array $columns

---

onlyColumns

public array|false $onlyColumns

---

mapping

public ?array $mapping

---

Methods

fromCsvReader

public static fromCsvReader(\League\Csv\Reader $csvReader): static

• This method is static.

Parameters:

Parameter	Type	Description
$csvReader	\League\Csv\Reader

---

fromStream

public static fromStream(mixed $stream): static

• This method is static.

Parameters:

Parameter	Type	Description
$stream	mixed

---

format

Format options. If a parameter is null, default value or set previous parameter set for object will be applied.

public format(string $delimiter = self::DEFAULT_DELIMITER, string $enclosure = self::DEFAULT_ENCLOSURE, string $escape = self::DEFAULT_ESCAPE, mixed $headerOffset = self::DEFAULT_HEADER_OFFSET, mixed $columns = self::DEFAULT_COLUMNS, mixed $mapping = self::DEFAULT_MAPPING): static

Parameters:

Parameter	Type	Description
$delimiter	string
$enclosure	string
$escape	string
$headerOffset	mixed	- To be 0 if no header line is present, else number of lines to ignore
$columns	mixed	- Ordered array of columns, only if $headerOffset is false
$mapping	mixed	- Change a colonne name to another

---

filter

Filter CSV input

public filter(mixed $onlyColumns): static

Parameters:

Parameter	Type	Description
$onlyColumns	mixed	- Restrict import to theses columns, as column string name from header or $columns

---

import

public import(\MammothPHP\WoollyM\DataFrame $to = new DataFrame()): \MammothPHP\WoollyM\DataFrame

Parameters:

Parameter	Type	Description
$to	\MammothPHP\WoollyM\DataFrame

---

applyOptions

protected applyOptions(\League\Csv\AbstractCsv $csv): void

Parameters:

Parameter	Type	Description
$csv	\League\Csv\AbstractCsv

---

ReaderFromFileObject

protected ReaderFromFileObject(bool& $applyOptions): void

Parameters:

Parameter	Type	Description
$applyOptions	bool

---

ReaderFromString

protected ReaderFromString(): void

---

ReaderFromStream

protected ReaderFromStream(): void

---

importFromCsvReader

protected importFromCsvReader(\MammothPHP\WoollyM\DataFrame $to): \MammothPHP\WoollyM\DataFrame

Parameters:

Parameter	Type	Description
$to	\MammothPHP\WoollyM\DataFrame

---

toFile

Write CSV from dataFrame to a file

public toFile(string|\SplFileInfo|\League\Csv\Writer $file, bool $overwriteFile = false, bool $writeHeader = true): void

Parameters:

Parameter	Type	Description
$file	string|\SplFileInfo|\League\Csv\Writer
$overwriteFile	bool
$writeHeader	bool

---

toStream

Write CSV from dataFrame to a stream resource

public toStream(mixed $phpStream, bool $writeHeader = true): void

Parameters:

Parameter	Type	Description
$phpStream	mixed
$writeHeader	bool

---

toString

Write CSV from dataFrame to a string

public toString(bool $writeHeader = true): string

Parameters:

Parameter	Type	Description
$writeHeader	bool

---

writeCsv

protected writeCsv(\League\Csv\Writer $writer, bool $writeHeader): void

Parameters:

Parameter	Type	Description
$writer	\League\Csv\Writer
$writeHeader	bool

---

Inherited methods

fromFilePath

public static fromFilePath(string $path): static

• This method is static.

Parameters:

Parameter	Type	Description
$path	string

---

fromFileInfo

public static fromFileInfo(\SplFileInfo $file): static

• This method is static.

Parameters:

Parameter	Type	Description
$file	\SplFileInfo

---

fromString

public static fromString(string $input): static

• This method is static.

Parameters:

Parameter	Type	Description
$input	string

---

convertSplFileToString

protected convertSplFileToString(): string

---

import

public import(\MammothPHP\WoollyM\DataFrame $to = new DataFrame()): \MammothPHP\WoollyM\DataFrame

• This method is abstract.

Parameters:

Parameter	Type	Description
$to	\MammothPHP\WoollyM\DataFrame

---

toArray

public toArray(): array

---

fromDataFrame

public static fromDataFrame(\MammothPHP\WoollyM\DataFrame $df): static

• This method is static.

Parameters:

Parameter	Type	Description
$df	\MammothPHP\WoollyM\DataFrame

---

prepareToFileInput

protected prepareToFileInput(mixed $file, bool $overwriteFile): \SplFileObject|false

Parameters:

Parameter	Type	Description
$file	mixed
$overwriteFile	bool

---

---

Automatically generated on 2024-07-03