Dataset

final class StanislasPoisson\FrenchPostalCode\Core\Dataset

Reads the data files shipped with the package, without any framework.

Each table is a CSV file with a header. An empty value is read as null. The manifest announces the columns and the number of rows of every file, and the reader checks them: a truncated or altered file is an error, not a silent partial load.

Source: src/Core/Dataset.php

Constants

Name	Value	Description
TABLES	['regions', 'departments', 'communes', 'cities', 'commune_successions']	The tables, in the order they must be loaded: a table comes after the tables it refers to.

Methods

__construct()

public function __construct(string $directory = …, string $schemas = …)

chunks()

public function chunks(string $table, int $size = 1000): Generator

The rows of a table, in blocks, for the loaders that write them in several statements.

Returns Generator<int, list<array<string, string|null>>>

columns()

public function columns(string $table): array

Returns list<string>

count()

public function count(string $table): int

manifest()

public function manifest(): array

The versions of the sources the data was built from, and the date of the export.

Returns Manifest

path()

public function path(string $table): string

rows()

public function rows(string $table): Generator

The rows of a table, one at a time, indexed by column name.

Returns Generator<int, array<string, string|null>>

tables()

public function tables(): array

Returns list<string>

types()

public function types(string $table): array

The Table Schema type of each column of a table (integer, number, date or string).

Returns array<string, string>