Wikimedia\Rdbms\DoctrineSchemaBuilder Class Reference

@experimental @unstable More...

Inheritance diagram for Wikimedia\Rdbms\DoctrineSchemaBuilder:

Collaboration diagram for Wikimedia\Rdbms\DoctrineSchemaBuilder:

Public Member Functions
	__construct (AbstractPlatform $platform)
	A builder object that take abstract schema definition and produces sql to create the tables.
	addTable (array $schema)
	An example of $schema value: [ 'name' => 'actor', 'columns' => [ [ 'actor_id', 'bigint', [ 'Unsigned' => true, 'Notnull' => true ] ], [ 'actor_user', 'integer', [ 'Unsigned' => true ] ], [ 'actor_name', 'string', [ 'Length' => 255, 'Notnull' => true ] ], ], 'indexes' => [ [ 'actor_user', [ 'actor_user' ], 'unique' => true ], [ 'actor_name', [ 'actor_name' ], 'unique' => true ] ], 'pk' => [ 'actor_id' ] ],. Parameters array $schema Returns void
	getSql ()
	Returns string[] SQLs to run

Public Attributes
const	TABLE_PREFIX = '/*_*/'

Private Attributes
	$platform
	$schema

Detailed Description

@experimental @unstable

Definition at line 12 of file DoctrineSchemaBuilder.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Rdbms\DoctrineSchemaBuilder::__construct

(

AbstractPlatform

$platform

)

A builder object that take abstract schema definition and produces sql to create the tables.

Parameters

AbstractPlatform

$platform

A Doctrine Platform object, Can be Mysql, Sqlite, etc.

Definition at line 23 of file DoctrineSchemaBuilder.php.

References Wikimedia\Rdbms\DoctrineSchemaBuilder\$platform.

Member Function Documentation

addTable()

Wikimedia\Rdbms\DoctrineSchemaBuilder::addTable

(

array

$schema

)

An example of $schema value: [ 'name' => 'actor', 'columns' => [ [ 'actor_id', 'bigint', [ 'Unsigned' => true, 'Notnull' => true ] ], [ 'actor_user', 'integer', [ 'Unsigned' => true ] ], [ 'actor_name', 'string', [ 'Length' => 255, 'Notnull' => true ] ], ], 'indexes' => [ [ 'actor_user', [ 'actor_user' ], 'unique' => true ], [ 'actor_name', [ 'actor_name' ], 'unique' => true ] ], 'pk' => [ 'actor_id' ] ],.

Parameters

array

$schema

Returns

void

Implements Wikimedia\Rdbms\SchemaBuilder.

Definition at line 31 of file DoctrineSchemaBuilder.php.

References Wikimedia\Rdbms\DoctrineSchemaBuilder\$schema.

getSql()

Wikimedia\Rdbms\DoctrineSchemaBuilder::getSql

(

)

Returns

string[] SQLs to run

Implements Wikimedia\Rdbms\SchemaBuilder.

Definition at line 50 of file DoctrineSchemaBuilder.php.

Member Data Documentation

$platform

Wikimedia\Rdbms\DoctrineSchemaBuilder::$platform

private

Definition at line 14 of file DoctrineSchemaBuilder.php.

Referenced by Wikimedia\Rdbms\DoctrineSchemaBuilder\__construct().

$schema

Wikimedia\Rdbms\DoctrineSchemaBuilder::$schema

private

Definition at line 13 of file DoctrineSchemaBuilder.php.

Referenced by Wikimedia\Rdbms\DoctrineSchemaBuilder\addTable().

TABLE_PREFIX

const Wikimedia\Rdbms\DoctrineSchemaBuilder::TABLE_PREFIX = '/*_*/'

Definition at line 16 of file DoctrineSchemaBuilder.php.

---

The documentation for this class was generated from the following file:

• includes/libs/rdbms/database/DoctrineSchemaBuilder.php