classPlatformFactory

packages/sql-fixture/src/Provider/PlatformFactory.php:37

final class PlatformFactory

Public API: explicitly declared with @visibility public.

Factory for creating platform-specific implementations.

Every platform is selected by its PDO driver name and, optionally, by the version tag of the release the statements are read for.

Resolve the release a version tag namesdoctest

\SqlFixture\Provider\PlatformFactory::resolveVersion('mysql', 'mysql-8.0.44')->number // => '8.0.44'

Read the release from a connectiondoctest

\SqlFixture\Provider\PlatformFactory::detectVersion(new \PDO('sqlite::memory:'))->tag // => 'sqlite-3.47.2'

Constants§

public const DRIVER_MYSQL = 'mysql'

source §

PDO driver name for MySQL.

public const DRIVER_SQLITE = 'sqlite'

source §

PDO driver name for SQLite.

public const DRIVER_PGSQL = 'pgsql'

source §

PDO driver name for PostgreSQL.

Methods§

public static function createSchemaParser(
    string $driver,
    string|null $version = null,
): SchemaParserInterface

source §

Create a schema parser for the given driver and release.

Parameters

`$driver`	`string`
`$version`	`string\|null`	Version tag such as `mysql-8.4.7`, or null for the default of the driver

Returns

SchemaParserInterface

Throws

UnsupportedDriverException If the driver is not supported

UnsupportedVersionException If the version tag is not a supported release of the driver

Test cases 5

Called from 4

Calls 8

static-call PlatformFactory::resolveVersion() line 62
class-const PlatformFactory::DRIVER_MYSQL() line 65
new MySqlSchemaParser line 65
class-const PlatformFactory::DRIVER_SQLITE() line 66
new SqliteSchemaParser line 66
class-const PlatformFactory::DRIVER_PGSQL() line 67
new PostgreSqlSchemaParser line 67
new UnsupportedDriverException line 68

public static function createTypeMapper(string $driver): TypeMapperInterface

source §

Create a type mapper for the given driver.

Parameters

$driver string

Returns

TypeMapperInterface

Throws

UnsupportedDriverException If the driver is not supported

Test cases 3

Called from 3

Calls 7

class-const PlatformFactory::DRIVER_MYSQL() line 80
new MySqlTypeMapper line 80
class-const PlatformFactory::DRIVER_SQLITE() line 81
new SqliteTypeMapper line 81
class-const PlatformFactory::DRIVER_PGSQL() line 82
new PostgreSqlTypeMapper line 82
new UnsupportedDriverException line 83

public static function createSchemaFetcher(
    string $driver,
    string|null $version = null,
): SchemaFetcherInterface

source §

Create a schema fetcher for the given driver and release.

Parameters

`$driver`	`string`
`$version`	`string\|null`	Version tag such as `mysql-8.4.7`, or null for the default of the driver

Returns

SchemaFetcherInterface

Throws

UnsupportedDriverException If the driver is not supported

UnsupportedVersionException If the version tag is not a supported release of the driver

Test cases 4

Called from 1

static-call SqlFixture\Provider\DatabaseFixtureProvider::__construct() packages/sql-fixture/src/Provider/DatabaseFixtureProvider.php:68

Calls 8

static-call PlatformFactory::resolveVersion() line 97
class-const PlatformFactory::DRIVER_MYSQL() line 100
new MySqlSchemaFetcher line 100
class-const PlatformFactory::DRIVER_SQLITE() line 101
new SqliteSchemaFetcher line 101
class-const PlatformFactory::DRIVER_PGSQL() line 102
new PostgreSqlSchemaFetcher line 102
new UnsupportedDriverException line 103

public static function resolveVersion(
    string $driver,
    string|null $version = null,
): ServerVersion

source §

Resolve the release a version tag names, the default of the driver when none is given.

Parameters

`$driver`	`string`
`$version`	`string\|null`	Version tag such as `mysql-8.4.7`, or null for the default of the driver

Returns

ServerVersion

Throws

UnsupportedDriverException If the driver is not supported

UnsupportedVersionException If the version tag is not a supported release of the driver

Test cases 2

Called from 5

Calls 4

function-call in_array line 117
static-call PlatformFactory::getSupportedDrivers() line 117
new UnsupportedDriverException line 118
static-call ServerVersion::resolve() line 121

public static function detectDriver(PDO $pdo): string

source §

Detect the driver name from a PDO connection.

Parameters

$pdo PDO

Returns

string

Throws

DriverDetectionException If the connection does not report a driver name

UnsupportedDriverException If the reported driver is not supported

Test cases 2

Called from 2

Calls 8

method-call PDO::getAttribute() line 132
class-const PDO::ATTR_DRIVER_NAME() line 132
function-call is_string line 134
new DriverDetectionException line 135
class-const PlatformFactory::DRIVER_MYSQL() line 139
class-const PlatformFactory::DRIVER_SQLITE() line 140
class-const PlatformFactory::DRIVER_PGSQL() line 141
new UnsupportedDriverException line 142

public static function detectVersion(PDO $pdo, string|null $version = null): ServerVersion

source §

Detect the release of the server behind a PDO connection.

The server version the connection reports is matched to the closest supported release, as ServerVersion::fromServer() describes. A version tag given explicitly is resolved against the detected driver instead.

Parameters

`$pdo`	`PDO`
`$version`	`string\|null`	Version tag such as `mysql-8.4.7`, or null to read the server version

Returns

ServerVersion

Throws

DriverDetectionException If the connection does not report a driver name or a server version

UnsupportedDriverException If the reported driver is not supported

UnsupportedVersionException If the version tag is not a supported release of the driver

Test cases 3

Called from 1

static-call SqlFixture\Provider\DatabaseFixtureProvider::__construct() packages/sql-fixture/src/Provider/DatabaseFixtureProvider.php:63

Calls 7

static-call PlatformFactory::detectDriver() line 161
static-call ServerVersion::resolve() line 163
method-call PDO::getAttribute() line 166
class-const PDO::ATTR_SERVER_VERSION() line 166
function-call is_string line 167
new DriverDetectionException line 168
static-call ServerVersion::fromServer() line 171

public static function getSupportedDrivers(): list<string>

source §

Get the list of supported drivers.

Returns

list<string>

Test cases 1

PlatformFactoryTest::testGetSupportedDrivers calls

Called from 2

Calls 3

class-const PlatformFactory::DRIVER_MYSQL() line 182
class-const PlatformFactory::DRIVER_SQLITE() line 183
class-const PlatformFactory::DRIVER_PGSQL() line 184

public static function getSupportedVersions(string $driver): non-empty-list<string>

source §

Get the version tags of the releases supported for a driver, oldest first.

Parameters

$driver string

Returns

non-empty-list<string> Version tags such as `mysql-8.4.7`

Throws

UnsupportedDriverException If the driver is not supported

Test cases 1

PlatformFactoryTest::testGetSupportedVersionsListsTheTagsOfADriver calls

Calls 4

function-call in_array line 197
static-call PlatformFactory::getSupportedDrivers() line 197
new UnsupportedDriverException line 198
static-call ServerVersion::tags() line 201

Test cases 38§

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

Dedicated tests 20

Other tests reaching this symbol 18

Relations§

Static calls 13

Constant reads 2