[schema] element index

Package indexes

• cough
• cough_generator
• as_database
• as_query
• schema_generator

__construct

SchemaManipulator::__construct() in SchemaManipulator.class.php

Construct with optional configuration parameters.

__construct

SchemaForeignKey::__construct() in SchemaForeignKey.class.php

addColumn

SchemaTable::addColumn() in SchemaTable.class.php

addDatabase

Schema::addDatabase() in Schema.class.php

Add a database to the pile.

addForeignKey

SchemaTable::addForeignKey() in SchemaTable.class.php

Add a foreign key hash to the table.

addHabtmRelationshis

SchemaTable::addHabtmRelationshis() in SchemaTable.class.php

addHasManyRelationship

SchemaTable::addHasManyRelationship() in SchemaTable.class.php

addHasOneRelationship

SchemaTable::addHasOneRelationship() in SchemaTable.class.php

addTable

SchemaDatabase::addTable() in SchemaDatabase.class.php

$columnName

SchemaColumn::$columnName in SchemaColumn.class.php

$columns

SchemaTable::$columns in SchemaTable.class.php

$config

SchemaManipulator::$config in SchemaManipulator.class.php

Configuration object for this class

$database

SchemaTable::$database in SchemaTable.class.php

$databaseName

SchemaDatabase::$databaseName in SchemaDatabase.class.php

$databases

Schema::$databases in Schema.class.php

Stores the databases (SchemaDatabase) that have been loaded into memory so far.

$debug

SchemaManipulator::$debug in SchemaManipulator.class.php

$defaultValue

SchemaColumn::$defaultValue in SchemaColumn.class.php

disableVerbose

SchemaManipulator::disableVerbose() in SchemaManipulator.class.php

Disable verbose mode

enableVerbose

SchemaManipulator::enableVerbose() in SchemaManipulator.class.php

Enable verbose mode

$foreignKeys

SchemaTable::$foreignKeys in SchemaTable.class.php

Format of

findTable

SchemaManipulator::findTable() in SchemaManipulator.class.php

Scans the schema for the specified table name (or prefix + table name), starting with the given database and only scanning other databases if the table is not found there.

findTableInDatabase

SchemaManipulator::findTableInDatabase() in SchemaManipulator.class.php

Scans the specified database for the specified table name (using the match_table_name_prefixes config setting to scan for more table names in the event the given one is not found.)

getColumn

SchemaTable::getColumn() in SchemaTable.class.php

getColumnName

SchemaColumn::getColumnName() in SchemaColumn.class.php

getColumns

SchemaTable::getColumns() in SchemaTable.class.php

getDatabase

Schema::getDatabase() in Schema.class.php

Get the specified database name, or null if it hasn't been set yet.

getDatabase

SchemaColumn::getDatabase() in SchemaColumn.class.php

getDatabase

SchemaTable::getDatabase() in SchemaTable.class.php

getDatabaseName

SchemaDatabase::getDatabaseName() in SchemaDatabase.class.php

getDatabases

Schema::getDatabases() in Schema.class.php

Returns the databases that were loaded from the server's DSN.

getDefaultValue

SchemaColumn::getDefaultValue() in SchemaColumn.class.php

getForeignKey

SchemaTable::getForeignKey() in SchemaTable.class.php

Returns the existing foreign key (with same local key name) if one exists, otherwise returns null.

getForeignKeys

SchemaTable::getForeignKeys() in SchemaTable.class.php

getHabtmRelationships

SchemaTable::getHabtmRelationships() in SchemaTable.class.php

getHasManyRelationship

SchemaRelationshipHasOne::getHasManyRelationship() in SchemaRelationshipHasOne.class.php

getHasManyRelationships

SchemaTable::getHasManyRelationships() in SchemaTable.class.php

getHasOneRelationship

SchemaRelationshipHasMany::getHasOneRelationship() in SchemaRelationshipHasMany.class.php

getHasOneRelationships

SchemaTable::getHasOneRelationships() in SchemaTable.class.php

getLocalDatabaseName

SchemaForeignKey::getLocalDatabaseName() in SchemaForeignKey.class.php

getLocalKey

SchemaRelationship::getLocalKey() in SchemaRelationship.class.php

getLocalKeyName

SchemaForeignKey::getLocalKeyName() in SchemaForeignKey.class.php

getLocalObjectName

SchemaForeignKey::getLocalObjectName() in SchemaForeignKey.class.php

getLocalObjectName

SchemaRelationship::getLocalObjectName() in SchemaRelationship.class.php

getLocalTable

SchemaRelationship::getLocalTable() in SchemaRelationship.class.php

getLocalTableName

SchemaForeignKey::getLocalTableName() in SchemaForeignKey.class.php

getLocalTableName

SchemaRelationship::getLocalTableName() in SchemaRelationship.class.php

getNumberOfHasManyRelationships

Schema::getNumberOfHasManyRelationships() in Schema.class.php

getNumberOfHasOneRelationships

Schema::getNumberOfHasOneRelationships() in Schema.class.php

getPrimaryKey

SchemaTable::getPrimaryKey() in SchemaTable.class.php

getRefDatabaseName

SchemaForeignKey::getRefDatabaseName() in SchemaForeignKey.class.php

getRefKey

SchemaRelationship::getRefKey() in SchemaRelationship.class.php

getRefKeyName

SchemaForeignKey::getRefKeyName() in SchemaForeignKey.class.php

getRefObjectName

SchemaForeignKey::getRefObjectName() in SchemaForeignKey.class.php

getRefObjectName

SchemaRelationship::getRefObjectName() in SchemaRelationship.class.php

getRefTable

SchemaRelationship::getRefTable() in SchemaRelationship.class.php

getRefTableName

SchemaRelationship::getRefTableName() in SchemaRelationship.class.php

getRefTableName

SchemaForeignKey::getRefTableName() in SchemaForeignKey.class.php

getSchema

SchemaDatabase::getSchema() in SchemaDatabase.class.php

getSchema

SchemaColumn::getSchema() in SchemaColumn.class.php

getSchema

SchemaTable::getSchema() in SchemaTable.class.php

getServer

SchemaDatabase::getServer() in SchemaDatabase.class.php

getSize

SchemaColumn::getSize() in SchemaColumn.class.php

getTable

SchemaColumn::getTable() in SchemaColumn.class.php

getTable

SchemaDatabase::getTable() in SchemaDatabase.class.php

getTableName

SchemaTable::getTableName() in SchemaTable.class.php

getTables

SchemaDatabase::getTables() in SchemaDatabase.class.php

getType

SchemaColumn::getType() in SchemaColumn.class.php

$habtmRelationships

SchemaTable::$habtmRelationships in SchemaTable.class.php

many-to-many relationships (habtm = has and belongs to many)

$hasManyRelationship

SchemaRelationshipHasOne::$hasManyRelationship in SchemaRelationshipHasOne.class.php

$hasManyRelationships

SchemaTable::$hasManyRelationships in SchemaTable.class.php

one-to-many relationships

$hasOneRelationship

SchemaRelationshipHasMany::$hasOneRelationship in SchemaRelationshipHasMany.class.php

$hasOneRelationships

SchemaTable::$hasOneRelationships in SchemaTable.class.php

one-to-one relationships

hasForeignKey

SchemaTable::hasForeignKey() in SchemaTable.class.php

Check if the specified foreign key already exists (by comparing it's local key name)

hasLocalObjectName

SchemaForeignKey::hasLocalObjectName() in SchemaForeignKey.class.php

hasPrimaryKey

SchemaTable::hasPrimaryKey() in SchemaTable.class.php

hasRefDatabaseName

SchemaForeignKey::hasRefDatabaseName() in SchemaForeignKey.class.php

hasRefObjectName

SchemaForeignKey::hasRefObjectName() in SchemaForeignKey.class.php

$isLinked

SchemaForeignKey::$isLinked in SchemaForeignKey.class.php

$isNullAllowed

SchemaColumn::$isNullAllowed in SchemaColumn.class.php

$isPrimaryKey

SchemaColumn::$isPrimaryKey in SchemaColumn.class.php

initConfig

SchemaManipulator::initConfig() in SchemaManipulator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.

isKeyNullable

SchemaRelationship::isKeyNullable() in SchemaRelationship.class.php

Returns false if all keys are NOT NULL, true otherwise.

isLinked

SchemaForeignKey::isLinked() in SchemaForeignKey.class.php

isNullAllowed

SchemaColumn::isNullAllowed() in SchemaColumn.class.php

isPrimaryKey

SchemaColumn::isPrimaryKey() in SchemaColumn.class.php

$localDatabaseName

SchemaForeignKey::$localDatabaseName in SchemaForeignKey.class.php

$localKey

SchemaRelationship::$localKey in SchemaRelationship.class.php

$localKeyName

SchemaForeignKey::$localKeyName in SchemaForeignKey.class.php

$localObjectName

SchemaForeignKey::$localObjectName in SchemaForeignKey.class.php

$localRefObjectName

SchemaRelationship::$localRefObjectName in SchemaRelationship.class.php

$localTable

SchemaRelationship::$localTable in SchemaRelationship.class.php

$localTableName

SchemaForeignKey::$localTableName in SchemaForeignKey.class.php

linkRelationships

Schema::linkRelationships() in Schema.class.php

Traverses all tables and uses any Foreign Key information to generate

manipulateSchema

SchemaManipulator::manipulateSchema() in SchemaManipulator.class.php

Scans the schema and manipulates it by detecting FKs adding them to tables.

outputRelationshipCounts

Schema::outputRelationshipCounts() in Schema.class.php

$refDatabaseName

SchemaForeignKey::$refDatabaseName in SchemaForeignKey.class.php

$refKey

SchemaRelationship::$refKey in SchemaRelationship.class.php

$refKeyName

SchemaForeignKey::$refKeyName in SchemaForeignKey.class.php

$refObjectName

SchemaRelationship::$refObjectName in SchemaRelationship.class.php

$refObjectName

SchemaForeignKey::$refObjectName in SchemaForeignKey.class.php

$refTable

SchemaRelationship::$refTable in SchemaRelationship.class.php

$refTableName

SchemaForeignKey::$refTableName in SchemaForeignKey.class.php

$schema

SchemaManipulator::$schema in SchemaManipulator.class.php

A reference to the schema to manipulate

$server

SchemaDatabase::$server in SchemaDatabase.class.php

$size

SchemaColumn::$size in SchemaColumn.class.php

Schema

Schema in Schema.class.php

Schema contains one or more databases, which each may have info about one or more tables, which each may have info about one or more columns, which each have info about whether it is a primary key, null is allowed, its type, etc.

Schema.class.php

Schema.class.php in Schema.class.php

SchemaColumn.class.php

SchemaColumn.class.php in SchemaColumn.class.php

SchemaDatabase.class.php

SchemaDatabase.class.php in SchemaDatabase.class.php

SchemaForeignKey.class.php

SchemaForeignKey.class.php in SchemaForeignKey.class.php

SchemaManipulator.class.php

SchemaManipulator.class.php in SchemaManipulator.class.php

SchemaRelationship.class.php

SchemaRelationship.class.php in SchemaRelationship.class.php

SchemaRelationshipHasMany.class.php

SchemaRelationshipHasMany.class.php in SchemaRelationshipHasMany.class.php

SchemaRelationshipHasOne.class.php

SchemaRelationshipHasOne.class.php in SchemaRelationshipHasOne.class.php

SchemaTable.class.php

SchemaTable.class.php in SchemaTable.class.php

SchemaColumn

SchemaColumn in SchemaColumn.class.php

SchemaColumn contains information about one column (its attributes).

SchemaDatabase

SchemaDatabase in SchemaDatabase.class.php

SchemaDatabase contains information about one database (its tables).

SchemaForeignKey

SchemaForeignKey in SchemaForeignKey.class.php

undocumented class

SchemaManipulator

SchemaManipulator in SchemaManipulator.class.php

Takes a schema (and config) and runs through the schema in an effort to detect foreign keys that may have been missed (or simply weren't specified at the database level).

SchemaRelationship

SchemaRelationship in SchemaRelationship.class.php

The base SchemaRelationship class contains and provides accessors to the local table object and key and the reference (foreign) table object and key.

SchemaRelationshipHasMany

SchemaRelationshipHasMany in SchemaRelationshipHasMany.class.php

SchemaRelationshipHasMany adds methods to pull it's "has one" counterpart.

SchemaRelationshipHasOne

SchemaRelationshipHasOne in SchemaRelationshipHasOne.class.php

SchemaRelationshipHasOne adds methods to pull it's "has many" counterpart.

SchemaTable

SchemaTable in SchemaTable.class.php

SchemaTable contains information about one table (its columns).

setColumnName

SchemaColumn::setColumnName() in SchemaColumn.class.php

setDatabase

SchemaTable::setDatabase() in SchemaTable.class.php

setDatabaseName

SchemaDatabase::setDatabaseName() in SchemaDatabase.class.php

setDefaultValue

SchemaColumn::setDefaultValue() in SchemaColumn.class.php

setHasManyRelationship

SchemaRelationshipHasOne::setHasManyRelationship() in SchemaRelationshipHasOne.class.php

setHasOneRelationship

SchemaRelationshipHasMany::setHasOneRelationship() in SchemaRelationshipHasMany.class.php

setIsLinked

SchemaForeignKey::setIsLinked() in SchemaForeignKey.class.php

setIsNullAllowed

SchemaColumn::setIsNullAllowed() in SchemaColumn.class.php

setIsPrimaryKey

SchemaColumn::setIsPrimaryKey() in SchemaColumn.class.php

setLocalDatabaseName

SchemaForeignKey::setLocalDatabaseName() in SchemaForeignKey.class.php

setLocalKey

SchemaRelationship::setLocalKey() in SchemaRelationship.class.php

setLocalKeyName

SchemaForeignKey::setLocalKeyName() in SchemaForeignKey.class.php

setLocalObjectName

SchemaForeignKey::setLocalObjectName() in SchemaForeignKey.class.php

setLocalObjectName

SchemaRelationship::setLocalObjectName() in SchemaRelationship.class.php

setLocalTable

SchemaRelationship::setLocalTable() in SchemaRelationship.class.php

setLocalTableName

SchemaForeignKey::setLocalTableName() in SchemaForeignKey.class.php

setRefDatabaseName

SchemaForeignKey::setRefDatabaseName() in SchemaForeignKey.class.php

setRefKey

SchemaRelationship::setRefKey() in SchemaRelationship.class.php

setRefKeyName

SchemaForeignKey::setRefKeyName() in SchemaForeignKey.class.php

setRefObjectName

SchemaForeignKey::setRefObjectName() in SchemaForeignKey.class.php

setRefObjectName

SchemaRelationship::setRefObjectName() in SchemaRelationship.class.php

setRefTable

SchemaRelationship::setRefTable() in SchemaRelationship.class.php

setRefTableName

SchemaForeignKey::setRefTableName() in SchemaForeignKey.class.php

setServer

SchemaDatabase::setServer() in SchemaDatabase.class.php

setSize

SchemaColumn::setSize() in SchemaColumn.class.php

setTable

SchemaColumn::setTable() in SchemaColumn.class.php

setTableName

SchemaTable::setTableName() in SchemaTable.class.php

setType

SchemaColumn::setType() in SchemaColumn.class.php

$table

SchemaColumn::$table in SchemaColumn.class.php

$tableName

SchemaTable::$tableName in SchemaTable.class.php

$tables

SchemaDatabase::$tables in SchemaDatabase.class.php

$type

SchemaColumn::$type in SchemaColumn.class.php

$verbose

SchemaManipulator::$verbose in SchemaManipulator.class.php

Whether or not to echo what's happening to the screen.