classTableFile

packages/sql-parser/src/Table/TableFile.php:14

final class TableFile

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Stores parse tables as deflated files and loads them once per process.

Methods§

public function __construct(private TableCodec $codec = new \SqlParser\Table\TableCodec())

source §

Parameters

$codec TableCodec Converts between tables and bytes

Calls 1

new TableCodec line 24

public function save(ParseTable $table, string $path): void

source §

Writes a table to a file.

Parameters

`$table`	`ParseTable`	Table to store
`$path`	`string`	Where to write it

Throws

RuntimeException When the file cannot be written

Test cases 2

TableFileTest::testForget calls
TableFileTest::testSaveAndLoadRoundTrip calls

Called from 1

method-call SqlParser\Resource\ResourceWriter::writeTable() packages/sql-parser/src/Resource/ResourceWriter.php:36

Calls 4

function-call gzdeflate line 38
method-call TableCodec::encode() line 38
function-call file_put_contents line 39
new RuntimeException line 40

public function load(string $path): ParseTable

source §

Reads a table from a file, reusing it when the same file was read before.

Parameters

$path string File written by save()

Returns

ParseTable The table

Throws

RuntimeException When the file is missing, not deflated, or not an encoded table

Test cases 5

Called from 3

Calls 5

function-call is_file line 58
function-call file_get_contents line 58
new RuntimeException line 60
method-call TableFile::inflate() line 62
method-call TableCodec::decode() line 67

public function inflate(string $compressed): string|null

source §

Inflates deflated bytes, quietly answering null when they are not deflated.

Parameters

$compressed string Bytes read from the file

Returns

string|null The inflated bytes, or null when inflating fails

Test cases 1

TableFileTest::testInflate calls

Called from 1

method-call SqlParser\Table\TableFile::load() packages/sql-parser/src/Table/TableFile.php:62

Calls 3

function-call set_error_handler line 79
function-call gzinflate line 81
function-call restore_error_handler line 83

public static function forget(): void

source §

Forgets every table loaded so far, so a rewritten file is read again.

Test cases 2

ParseBench::benchLoadTable calls
TableFileTest::testForget calls

Private surface 2§

Implementation details, listed for orientation only.

private static array<string, ParseTable> $loaded = []

private TableCodec $codec = new \SqlParser\Table\TableCodec()

Test cases 10§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 5

Other tests reaching this symbol 5

ParseBench::benchLoadTable calls
MySqlParserTest calls
PostgreSqlParserTest calls
ResourceWriterTest::testWriteTable calls
SqliteParserTest calls

Relations§

Instantiated in 4

Method calls 4

Type declarations 1

type SqlParser\Resource\ResourceWriter packages/sql-parser/src/Resource/ResourceWriter.php:21