Full index

Package indexes

top

add: As_Query::add() in As_Query.class.php

Adds $stringOrArray to $dest using $delin as a separator.
add: CoughCollection::add() in CoughCollection.class.php

Adds a single element (even if it doesn't have a key ID yet).
add: CoughInstancePool::add() in CoughInstancePool.class.php
addColumn: SchemaTable::addColumn() in SchemaTable.class.php
addConfig: CoughDatabaseFactory::addConfig() in CoughDatabaseFactory.class.php

Adds the database config for later use. Make sure to specified the 'aliases' or the 'db_name_hash' value.
addDatabase: CoughDatabaseFactory::addDatabase() in CoughDatabaseFactory.class.php

Adds the database object for the specified alias name.
addDatabase: Schema::addDatabase() in Schema.class.php

Add a database to the pile.
addDatabase: As_DatabaseFactory::addDatabase() in As_DatabaseFactory.class.php
addDatabaseConfig: As_DatabaseFactory::addDatabaseConfig() in As_DatabaseFactory.class.php

Sets the database config for the specified database object name.
addForeignKey: SchemaTable::addForeignKey() in SchemaTable.class.php

Add a foreign key hash to the table.
addFrom: As_SelectQuery::addFrom() in As_SelectQuery.class.php
addGeneratedClass: CoughGenerator::addGeneratedClass() in CoughGenerator.class.php

Add to the generated classes.
addGroupBy: As_SelectQuery::addGroupBy() in As_SelectQuery.class.php
addHabtmRelationshis: SchemaTable::addHabtmRelationshis() in SchemaTable.class.php
addHasManyRelationship: SchemaTable::addHasManyRelationship() in SchemaTable.class.php
addHasOneRelationship: SchemaTable::addHasOneRelationship() in SchemaTable.class.php
addHaving: As_SelectQuery::addHaving() in As_SelectQuery.class.php
addOrderBy: As_SelectQuery::addOrderBy() in As_SelectQuery.class.php
addSelect: As_SelectQuery::addSelect() in As_SelectQuery.class.php
addSelectOption: As_SelectQuery::addSelectOption() in As_SelectQuery.class.php

Add optional select options, e.g. SQL_CALC_FOUND_ROWS, SQL_NO_CACHE
addTable: SchemaDatabase::addTable() in SchemaDatabase.class.php
addWhere: As_UpdateQuery::addWhere() in As_UpdateQuery.class.php
addWhere: As_SelectQuery::addWhere() in As_SelectQuery.class.php
As_Database: As_Database in As_Database.class.php

This is a cleaned up version of the Database (MySQL at the moment) in use at Academic Superstore.
As_Database.class.php: As_Database.class.php in As_Database.class.php
As_DatabaseFactory.class.php: As_DatabaseFactory.class.php in As_DatabaseFactory.class.php
As_DatabaseResult.class.php: As_DatabaseResult.class.php in As_DatabaseResult.class.php
As_SqlFunction.class.php: As_SqlFunction.class.php in As_SqlFunction.class.php
As_DatabaseFactory: As_DatabaseFactory in As_DatabaseFactory.class.php

THIS FILE IS NOT USED BY COUGH -- CoughDatabaseFactory is used instead. This is simply part of the original "as_database" module.
As_DatabaseResult: As_DatabaseResult in As_DatabaseResult.class.php

Database Result class which the As_Database::query() returns.
As_InsertQuery: As_InsertQuery in As_InsertQuery.class.php

Insert specific query
As_Query: As_Query in As_Query.class.php

Base class used by the insert, update, select classes.
As_InsertQuery.class.php: As_InsertQuery.class.php in As_InsertQuery.class.php
As_Query.class.php: As_Query.class.php in As_Query.class.php
As_SelectQuery.class.php: As_SelectQuery.class.php in As_SelectQuery.class.php
As_UpdateQuery.class.php: As_UpdateQuery.class.php in As_UpdateQuery.class.php
As_SelectQuery: As_SelectQuery in As_SelectQuery.class.php

A simple SQL query object for SELECT statements.
As_SqlFunction: As_SqlFunction in As_SqlFunction.class.php

Provides a way to insert SQL functions into queries.
As_UpdateQuery: As_UpdateQuery in As_UpdateQuery.class.php

Update specific query

top

buildSelectQuery: CoughObject::buildSelectQuery() in CoughObject.class.php

Builds a basic SELECT table.* FROM db.table query object (making it easy to inject joins, where criteria, order by, group by, etc.)
buildWhereSql: As_Query::buildWhereSql() in As_Query.class.php

builds a WHERE clause from the supplied array

top

$className: CoughClass::$className in CoughClass.class.php
$clientFlags: As_Database::$clientFlags in As_Database.class.php
$collections: CoughObject::$collections in CoughObject.class.php

An array of all the loaded collections in form [collectionName] => [CoughCollection]
$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
$config: CoughGenerator::$config in CoughGenerator.class.php

Configuration object for this class
$config: CoughWriter::$config in CoughWriter.class.php

Configuration object for this class
$config: CoughConfig::$config in CoughConfig.class.php
$config: DatabaseSchemaGenerator::$config in DatabaseSchemaGenerator.class.php

Configuration object for this class
$config: XmlSchemaGenerator::$config in XmlSchemaGenerator.class.php

Configuration object for this class
$configs: CoughDatabaseFactory::$configs in CoughDatabaseFactory.class.php

An array of database config info.
$connected: MysqlServer::$connected in MysqlServer.class.php
$connection: As_Database::$connection in As_Database.class.php
$contents: CoughClass::$contents in CoughClass.class.php
clearQueryLog: As_Database::clearQueryLog() in As_Database.class.php
clearValidationErrors: CoughObject::clearValidationErrors() in CoughObject.class.php

Clear validation status.
commit: As_Database::commit() in As_Database.class.php

Commit a transaction.
constructByConfig: CoughDatabaseInterface::constructByConfig() in CoughDatabaseInterface.class.php
constructByConfig: CoughAsDatabase::constructByConfig() in CoughAsDatabase.class.php

creates a new As_Database connection from a DSN
constructByFields: CoughObjectStaticInterface::constructByFields() in CoughObjectStaticInterface.class.php
constructByKey: CoughObjectStaticInterface::constructByKey() in CoughObjectStaticInterface.class.php
constructByKey: CoughObject::constructByKey() in CoughObject.class.php

Constructs a new object from a single id (for single key PKs) or a hash of [field_name] => [field_value].
constructBySql: CoughObject::constructBySql() in CoughObject.class.php

Constructs a new object from custom SQL.
constructBySql: CoughObjectStaticInterface::constructBySql() in CoughObjectStaticInterface.class.php
constructDatabaseByConfig: CoughDatabaseFactory::constructDatabaseByConfig() in CoughDatabaseFactory.class.php

returns the correct database adapter object
constructFromFile: DatabaseSchemaGeneratorConfig::constructFromFile() in DatabaseSchemaGeneratorConfig.class.php
constructFromFile: XmlSchemaGeneratorConfig::constructFromFile() in XmlSchemaGeneratorConfig.class.php
constructFromFile: CoughGeneratorConfig::constructFromFile() in CoughGeneratorConfig.class.php
convertIdToEntityName: CoughGeneratorConfig::convertIdToEntityName() in CoughGeneratorConfig.class.php

Converts an id field into an object name (in most cases this simply involves stripping off an "_id" suffix).
CoughCollection.class.php: CoughCollection.class.php in CoughCollection.class.php
CoughDatabaseFactory.class.php: CoughDatabaseFactory.class.php in CoughDatabaseFactory.class.php
CoughDatabaseInterface.class.php: CoughDatabaseInterface.class.php in CoughDatabaseInterface.class.php
CoughDatabaseResultInterface.class.php: CoughDatabaseResultInterface.class.php in CoughDatabaseResultInterface.class.php
CoughInstancePool.class.php: CoughInstancePool.class.php in CoughInstancePool.class.php
CoughIterator.class.php: CoughIterator.class.php in CoughIterator.class.php
CoughKeyValueIterator.class.php: CoughKeyValueIterator.class.php in CoughKeyValueIterator.class.php
CoughObject.class.php: CoughObject.class.php in CoughObject.class.php
CoughObjectStaticInterface.class.php: CoughObjectStaticInterface.class.php in CoughObjectStaticInterface.class.php
CoughAsDatabase: CoughAsDatabase in CoughAsDatabase.class.php

Cough DAL (Database Adapter Layer) for the "as_database" module.
CoughAsDatabaseResult: CoughAsDatabaseResult in CoughAsDatabaseResult.class.php

The query result object returned by CoughAsDatabase::query().
CoughClass: CoughClass in CoughClass.class.php

CoughGenerator creates these, CoughWriter compares them to what's on disk and chooses which ones to write to disk (and where).
CoughCollection: CoughCollection in CoughCollection.class.php

CoughCollection collects CoughObjects.
CoughConfig: CoughConfig in CoughConfig.class.php

Base config class for other config classes to extend.
CoughDatabaseFactory: CoughDatabaseFactory in CoughDatabaseFactory.class.php

A simple factory that provides access to an application's database objects.
CoughDatabaseInterface: CoughDatabaseInterface in CoughDatabaseInterface.class.php

Any database object that Cough uses must implement this interface.
CoughDatabaseResultInterface: CoughDatabaseResultInterface in CoughDatabaseResultInterface.class.php

Any database result object that Cough uses must implement this interface.
CoughGenerator: CoughGenerator in CoughGenerator.class.php

CoughGenerator takes config and schema and generates CoughClass objects.
CoughGeneratorConfig: CoughGeneratorConfig in CoughGeneratorConfig.class.php

Config class for CoughGenerator.
CoughGeneratorFacade: CoughGeneratorFacade in CoughGeneratorFacade.class.php

The CoughGeneratorFacade class provides a simple interface to the process of generating a schema from a database, manipulating it and converting FKs to relationships, and passing that info to the CoughGenerator which generates the classes.
CoughInstancePool: CoughInstancePool in CoughInstancePool.class.php

Unused class, but will be available in the future.
CoughIterator: CoughIterator in CoughIterator.class.php

CoughCollection objects use CoughIterator
CoughKeyValueIterator: CoughKeyValueIterator in CoughKeyValueIterator.class.php

Custom iterator constructed by CoughCollection::getKeyValueIterator()
CoughObject: CoughObject in CoughObject.class.php

CoughObject is the foundation for which all other "Model" / "ORM" classes extend. There will usually be one class extending CoughObject for each table in the database that an ORM is needed for.
CoughObjectStaticInterface: CoughObjectStaticInterface in CoughObjectStaticInterface.class.php

This interface must be implemented in the concrete/generated classes.
CoughWriter: CoughWriter in CoughWriter.class.php

Takes CoughClass objects and writes them disk.
CoughClass.class.php: CoughClass.class.php in CoughClass.class.php
CoughConfig.class.php: CoughConfig.class.php in CoughConfig.class.php
CoughGenerator.class.php: CoughGenerator.class.php in CoughGenerator.class.php
CoughGeneratorConfig.class.php: CoughGeneratorConfig.class.php in CoughGeneratorConfig.class.php
CoughGeneratorFacade.class.php: CoughGeneratorFacade.class.php in CoughGeneratorFacade.class.php
CoughWriter.class.php: CoughWriter.class.php in CoughWriter.class.php
current: CoughKeyValueIterator::current() in CoughKeyValueIterator.class.php
CoughAsDatabase.class.php: CoughAsDatabase.class.php in CoughAsDatabase.class.php
CoughAsDatabaseResult.class.php: CoughAsDatabaseResult.class.php in CoughAsDatabaseResult.class.php

top

$database: SchemaTable::$database in SchemaTable.class.php
$databaseName: CoughClass::$databaseName in CoughClass.class.php
$databaseName: SchemaDatabase::$databaseName in SchemaDatabase.class.php
$databaseNames: CoughDatabaseFactory::$databaseNames in CoughDatabaseFactory.class.php

Format:
$databases: As_DatabaseFactory::$databases in As_DatabaseFactory.class.php
$databases: Schema::$databases in Schema.class.php

Stores the databases (SchemaDatabase) that have been loaded into memory so far.
$databases: CoughDatabaseFactory::$databases in CoughDatabaseFactory.class.php

Format:
$db: As_Query::$db in As_Query.class.php
$dbConfigs: As_DatabaseFactory::$dbConfigs in As_DatabaseFactory.class.php

An array of database config info.
$dbHost: As_Database::$dbHost in As_Database.class.php
$dbLink: MysqlDatabase::$dbLink in MysqlDatabase.class.php
$dbLink: MysqlTable::$dbLink in MysqlTable.class.php
$dbLink: MysqlServer::$dbLink in MysqlServer.class.php
$dbName: As_Database::$dbName in As_Database.class.php
$dbPassword: As_Database::$dbPassword in As_Database.class.php
$dbPort: As_Database::$dbPort in As_Database.class.php
$dbUser: As_Database::$dbUser in As_Database.class.php
$debug: SchemaManipulator::$debug in SchemaManipulator.class.php
$defaultValue: SchemaColumn::$defaultValue in SchemaColumn.class.php
$derivedFieldDefinitions: CoughObject::$derivedFieldDefinitions in CoughObject.class.php

An array of derived field definitions
$derivedFields: CoughObject::$derivedFields in CoughObject.class.php

An array of derived fields (read-only, as in not saved back to the database).
DatabaseSchemaGenerator: DatabaseSchemaGenerator in DatabaseSchemaGenerator.class.php

Takes database config info and generates a schema (a collection of databases each containing a collection of tables each containing a collection of columns)
DatabaseSchemaGeneratorConfig: DatabaseSchemaGeneratorConfig in DatabaseSchemaGeneratorConfig.class.php

Config class for DatabaseSchemaGenerator.
defineDerivedFields: CoughObject::defineDerivedFields() in CoughObject.class.php

Override in sub-class to define derived fields the object may possess.
defineFields: CoughObject::defineFields() in CoughObject.class.php

Override in sub-class to define fields the object possesses, including $pkFieldNames.
defineObjects: CoughObject::defineObjects() in CoughObject.class.php

Override in sub-class to define objects the object possesses.
deflate: CoughObject::deflate() in CoughObject.class.php

Returns object to it's own state, except what you want to keep. By default it empties everything; overridden version only empties yours.
delete: As_Database::delete() in As_Database.class.php
delete: CoughObject::delete() in CoughObject.class.php

Deletes the record from the database, if hasKeyId returns true.
disableVerbose: CoughGeneratorFacade::disableVerbose() in CoughGeneratorFacade.class.php

Disable verbose mode
disableVerbose: DatabaseSchemaGenerator::disableVerbose() in DatabaseSchemaGenerator.class.php

Disable verbose mode
disableVerbose: SchemaManipulator::disableVerbose() in SchemaManipulator.class.php

Disable verbose mode
doValidateData: CoughObject::doValidateData() in CoughObject.class.php

Do the actual data validation. Override in sub classes.
DriverDatabase: DriverDatabase in DriverDatabase.class.php

Defines the interface for a Database Driver.
DriverServer: DriverServer in DriverServer.class.php

Defines the interface for a Server Driver.
DriverTable: DriverTable in DriverTable.class.php

Defines the interface for a Table Driver, which should:
DatabaseSchemaGenerator.class.php: DatabaseSchemaGenerator.class.php in DatabaseSchemaGenerator.class.php
DatabaseSchemaGeneratorConfig.class.php: DatabaseSchemaGeneratorConfig.class.php in DatabaseSchemaGeneratorConfig.class.php
DriverDatabase.class.php: DriverDatabase.class.php in DriverDatabase.class.php
DriverServer.class.php: DriverServer.class.php in DriverServer.class.php
DriverTable.class.php: DriverTable.class.php in DriverTable.class.php

top

$elementClassName: CoughCollection::$elementClassName in CoughCollection.class.php

The name of the element class that will be used when adding new elements to the collection
$errorMessages: CoughWriter::$errorMessages in CoughWriter.class.php

Error message storage
enableVerbose: SchemaManipulator::enableVerbose() in SchemaManipulator.class.php

Enable verbose mode
enableVerbose: DatabaseSchemaGenerator::enableVerbose() in DatabaseSchemaGenerator.class.php

Enable verbose mode
enableVerbose: CoughGeneratorFacade::enableVerbose() in CoughGeneratorFacade.class.php

Enable verbose mode
ERROR_CONNECT: As_Database::ERROR_CONNECT in As_Database.class.php
ERROR_DB_SELECT: As_Database::ERROR_DB_SELECT in As_Database.class.php
ERROR_INSERT: As_Database::ERROR_INSERT in As_Database.class.php
ERROR_QUERY: As_Database::ERROR_QUERY in As_Database.class.php
ERROR_UPDATE: As_Database::ERROR_UPDATE in As_Database.class.php
escape: As_Database::escape() in As_Database.class.php
execute: As_Query::execute() in As_Query.class.php
execute: CoughAsDatabase::execute() in CoughAsDatabase.class.php
execute: CoughDatabaseInterface::execute() in CoughDatabaseInterface.class.php

top

$fieldDefinitions: CoughObject::$fieldDefinitions in CoughObject.class.php

An array of all the columns in the database, including the primary key column and name columns.
$fields: CoughObject::$fields in CoughObject.class.php

An array of all the currently initialized or set fields.
$fields: As_InsertQuery::$fields in As_InsertQuery.class.php
$foreignKeys: SchemaTable::$foreignKeys in SchemaTable.class.php

Format of
$from: As_SelectQuery::$from in As_SelectQuery.class.php
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.)
finishConstruction: CoughObject::finishConstruction() in CoughObject.class.php

Called at the end of __construct(). Override for special construction behavior that is dependent on the object's state.
freeResult: As_DatabaseResult::freeResult() in As_DatabaseResult.class.php

top

$generatedClasses: CoughGenerator::$generatedClasses in CoughGenerator.class.php

Storage for the generated CoughClass objects
$groupBy: As_SelectQuery::$groupBy in As_SelectQuery.class.php
generate: CoughGeneratorFacade::generate() in CoughGeneratorFacade.class.php
generateBaseCollection: CoughGenerator::generateBaseCollection() in CoughGenerator.class.php

Generates the base collection class
generateBaseObject: CoughGenerator::generateBaseObject() in CoughGenerator.class.php

Generates the base object class
generateCoughClasses: CoughGenerator::generateCoughClasses() in CoughGenerator.class.php

Generates Cough classes from a Schema or SchemaTable object. (It just calls the appropriate generation method based on the object type.)
generateCoughClassesFromSchema: CoughGenerator::generateCoughClassesFromSchema() in CoughGenerator.class.php

Generates Cough classes from a Schema object.
generateCoughClassesFromSchemaTable: CoughGenerator::generateCoughClassesFromSchemaTable() in CoughGenerator.class.php

Generates Cough classes from a SchemaTable object.
generateError: MysqlTable::generateError() in MysqlTable.class.php
generateError: MysqlDatabase::generateError() in MysqlDatabase.class.php
generateError: As_Database::generateError() in As_Database.class.php
generateFromConfigPath: CoughGeneratorFacade::generateFromConfigPath() in CoughGeneratorFacade.class.php
generateLoadSql: CoughGenerator::generateLoadSql() in CoughGenerator.class.php

Generate the loadSql for a given SchemaTable object (excluding WHERE clause).
generatePhpdocTags: CoughGenerator::generatePhpdocTags() in CoughGenerator.class.php

Generates an array of common phpDoc tags.
generateSchema: DatabaseSchemaGenerator::generateSchema() in DatabaseSchemaGenerator.class.php

Traverse all the databases, tables, and columns to build a schema, which basically contains the same information with the addition of relationships between tables.
generateSchema: SchemaGenerator::generateSchema() in SchemaGenerator.class.php
generateSchema: XmlSchemaGenerator::generateSchema() in XmlSchemaGenerator.class.php

Generate/load the schema and return it.
generateSet: As_Database::generateSet() in As_Database.class.php
generateStarterCollection: CoughGenerator::generateStarterCollection() in CoughGenerator.class.php

Generates the starter collection class
generateStarterObject: CoughGenerator::generateStarterObject() in CoughGenerator.class.php

Generates the starter object class
generateWhere: As_Database::generateWhere() in As_Database.class.php
get: CoughCollection::get() in CoughCollection.class.php

Returns the element at the given key.
get: CoughInstancePool::get() in CoughInstancePool.class.php
getAffectedRows: As_Database::getAffectedRows() in As_Database.class.php
getArrayValueFromMultiKey: CoughConfig::getArrayValueFromMultiKey() in CoughConfig.class.php

Takes a source array and an array of keys and attempts to traverse the source array using the keys. It's a way to dynamically retrieve a value deep in an array using keys that are not none until runtime.
getAvailableDatabaseNames: DriverServer::getAvailableDatabaseNames() in DriverServer.class.php

Get a list of available database names.
getAvailableDatabaseNames: MysqlServer::getAvailableDatabaseNames() in MysqlServer.class.php

Get a list of available database names.
getAvailableTableNames: DriverDatabase::getAvailableTableNames() in DriverDatabase.class.php
getAvailableTableNames: MysqlDatabase::getAvailableTableNames() in MysqlDatabase.class.php
getBaseCollectionClassName: CoughGeneratorConfig::getBaseCollectionClassName() in CoughGeneratorConfig.class.php
getBaseObjectClassName: CoughGeneratorConfig::getBaseObjectClassName() in CoughGeneratorConfig.class.php
getCamelCase: CoughGeneratorConfig::getCamelCase() in CoughGeneratorConfig.class.php

getCamelCase takes the given string and returns it in camelCase format, with underscores removed.
getClassFileName: CoughGeneratorConfig::getClassFileName() in CoughGeneratorConfig.class.php
getClassFilePath: CoughGeneratorConfig::getClassFilePath() in CoughGeneratorConfig.class.php
getClassName: CoughGeneratorConfig::getClassName() in CoughGeneratorConfig.class.php
getClassName: CoughClass::getClassName() in CoughClass.class.php
getClone: As_SelectQuery::getClone() in As_SelectQuery.class.php

Hack for versions of PHP that do not work with clone
getCollectionExtensionClassName: CoughGeneratorConfig::getCollectionExtensionClassName() in CoughGeneratorConfig.class.php
getColumn: SchemaTable::getColumn() in SchemaTable.class.php
getColumnName: SchemaColumn::getColumnName() in SchemaColumn.class.php
getColumns: SchemaTable::getColumns() in SchemaTable.class.php
getConfigPath: CoughGeneratorFacade::getConfigPath() in CoughGeneratorFacade.class.php
getConfigs: CoughDatabaseFactory::getConfigs() in CoughDatabaseFactory.class.php

Get all the database configs CoughDatabaseFactory is currently aware of.
getConfigValue: CoughConfig::getConfigValue() in CoughConfig.class.php

Internal method to get a configuration setting. If a database name is given,
getContents: CoughClass::getContents() in CoughClass.class.php
getDatabase: Schema::getDatabase() in Schema.class.php

Get the specified database name, or null if it hasn't been set yet.
getDatabase: CoughDatabaseFactory::getDatabase() in CoughDatabaseFactory.class.php

Get the database object for the specified alias
getDatabase: SchemaTable::getDatabase() in SchemaTable.class.php
getDatabase: As_DatabaseFactory::getDatabase() in As_DatabaseFactory.class.php
getDatabase: SchemaColumn::getDatabase() in SchemaColumn.class.php
getDatabaseName: CoughDatabaseFactory::getDatabaseName() in CoughDatabaseFactory.class.php

Get the actual database name for the specified alias.
getDatabaseName: CoughClass::getDatabaseName() in CoughClass.class.php
getDatabaseName: SchemaDatabase::getDatabaseName() in SchemaDatabase.class.php
getDatabases: CoughDatabaseFactory::getDatabases() in CoughDatabaseFactory.class.php

Get all the currently constructed database objects.
getDatabases: Schema::getDatabases() in Schema.class.php

Returns the databases that were loaded from the server's DSN.
getDb: CoughObjectStaticInterface::getDb() in CoughObjectStaticInterface.class.php
getDb: CoughCollection::getDb() in CoughCollection.class.php

Returns a reference to the database object to use for queries.
getDbName: CoughObjectStaticInterface::getDbName() in CoughObjectStaticInterface.class.php
getDefaultValue: SchemaColumn::getDefaultValue() in SchemaColumn.class.php
getDerivedField: CoughObject::getDerivedField() in CoughObject.class.php

Returns the specified derived field name.
getDsn: DatabaseSchemaGeneratorConfig::getDsn() in DatabaseSchemaGeneratorConfig.class.php
getEntityName: CoughGeneratorConfig::getEntityName() in CoughGeneratorConfig.class.php

Given a table object, it gets the "entity name", currently just strips any prefixes specified in the config from the table name, otherwise just returns the table name.
getEqualityOperatorFromValue: As_Query::getEqualityOperatorFromValue() in As_Query.class.php

returns the proper equality operator from the value being tested
getError: As_Database::getError() in As_Database.class.php

Returns the error message from the last query run.
getErrorMessages: CoughGenerator::getErrorMessages() in CoughGenerator.class.php

getErrorMesages() returns an array of error messages, if any.
getErrorMessages: CoughWriter::getErrorMessages() in CoughWriter.class.php

Retrieve any error messages set by other methods.
getField: CoughObject::getField() in CoughObject.class.php

Returns the current value of the requested field name.
getFieldAliases: CoughObject::getFieldAliases() in CoughObject.class.php

Helper method for generating SELECT criteria for other join tables.
getFields: CoughObject::getFields() in CoughObject.class.php

Returns the object's fields as an array of [key] => [value] pairs.
getFieldsWithoutPk: CoughObject::getFieldsWithoutPk() in CoughObject.class.php

Get all non-primary key related fields and their values.
getFirst: CoughCollection::getFirst() in CoughCollection.class.php

The first element in the array/collection.
getForeignCollectionName: CoughGeneratorConfig::getForeignCollectionName() in CoughGeneratorConfig.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
getForeignObjectName: CoughGeneratorConfig::getForeignObjectName() in CoughGeneratorConfig.class.php
getForeignTableAliasName: CoughGeneratorConfig::getForeignTableAliasName() in CoughGeneratorConfig.class.php
getFoundRows: As_Database::getFoundRows() in As_Database.class.php

Returns the number of found rows from the last run query.
getFrom: As_SelectQuery::getFrom() in As_SelectQuery.class.php
getGeneratedClasses: CoughGenerator::getGeneratedClasses() in CoughGenerator.class.php

Get the generated classes
getGroupBy: As_SelectQuery::getGroupBy() in As_SelectQuery.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
getHaving: As_SelectQuery::getHaving() in As_SelectQuery.class.php
getIdRegex: CoughGeneratorConfig::getIdRegex() in CoughGeneratorConfig.class.php

Returns an array of regexes to match against in order to determine if a field should be considered an ID field, in order of precedence.
getIdToTableRegex: DatabaseSchemaGeneratorConfig::getIdToTableRegex() in DatabaseSchemaGeneratorConfig.class.php

Returns an array of regexes to match against in order to determine if a field can be mapped to a table name, in order of precedence.
getInsertFields: CoughObject::getInsertFields() in CoughObject.class.php

Returns the fields that should be used for inserting. This logic is separate from the insert method to make it easy to override the behavior.
getInsertID: As_Database::getInsertID() in As_Database.class.php
getInsertQuery: As_Query::getInsertQuery() in As_Query.class.php
getIterator: CoughCollection::getIterator() in CoughCollection.class.php

Returns a new iterator for the collection.
getKeyId: CoughObject::getKeyId() in CoughObject.class.php

Returns the current value of the object's primary key id.
getKeysWithPrefix: CoughObject::getKeysWithPrefix() in CoughObject.class.php

Returns a sub array of the given array containing all elements that have keys starting with the specified prefix. The resulting array's keys have the prefix removed.
getKeyValueIterator: CoughCollection::getKeyValueIterator() in CoughCollection.class.php

Returns a new key-value iterator for the collection.
getLast: CoughCollection::getLast() in CoughCollection.class.php

The last element in the array/collection.
getLastInsertId: CoughAsDatabase::getLastInsertId() in CoughAsDatabase.class.php
getLastInsertId: CoughDatabaseInterface::getLastInsertId() in CoughDatabaseInterface.class.php
getLimit: As_SelectQuery::getLimit() in As_SelectQuery.class.php
getLoadSql: CoughObjectStaticInterface::getLoadSql() in CoughObjectStaticInterface.class.php
getLoadSql: CoughCollection::getLoadSql() in CoughCollection.class.php

Returns the base SQL to use for the collection.
getLocalDatabaseName: SchemaForeignKey::getLocalDatabaseName() in SchemaForeignKey.class.php
getLocalKey: SchemaRelationship::getLocalKey() in SchemaRelationship.class.php
getLocalKeyName: SchemaForeignKey::getLocalKeyName() in SchemaForeignKey.class.php
getLocalObjectName: SchemaRelationship::getLocalObjectName() in SchemaRelationship.class.php
getLocalObjectName: SchemaForeignKey::getLocalObjectName() in SchemaForeignKey.class.php
getLocalTable: SchemaRelationship::getLocalTable() in SchemaRelationship.class.php
getLocalTableName: SchemaForeignKey::getLocalTableName() in SchemaForeignKey.class.php
getLocalTableName: SchemaRelationship::getLocalTableName() in SchemaRelationship.class.php
getModifiedFields: CoughObject::getModifiedFields() in CoughObject.class.php

Get a list of all of this object's modified values.
getNumberOfHasManyRelationships: Schema::getNumberOfHasManyRelationships() in Schema.class.php
getNumberOfHasOneRelationships: Schema::getNumberOfHasOneRelationships() in Schema.class.php
getNumRows: As_DatabaseResult::getNumRows() in As_DatabaseResult.class.php
getObjectExtensionClassName: CoughGeneratorConfig::getObjectExtensionClassName() in CoughGeneratorConfig.class.php
getOffset: As_SelectQuery::getOffset() in As_SelectQuery.class.php
getOrderBy: As_SelectQuery::getOrderBy() in As_SelectQuery.class.php
getPhpdocAuthor: CoughGeneratorConfig::getPhpdocAuthor() in CoughGeneratorConfig.class.php
getPhpdocCopyright: CoughGeneratorConfig::getPhpdocCopyright() in CoughGeneratorConfig.class.php
getPhpdocPackage: CoughGeneratorConfig::getPhpdocPackage() in CoughGeneratorConfig.class.php
getPk: CoughObject::getPk() in CoughObject.class.php

Returns the primary key as an array of [field_name] => field_value pairs
getPkFieldNames: CoughObjectStaticInterface::getPkFieldNames() in CoughObjectStaticInterface.class.php
getPosition: CoughCollection::getPosition() in CoughCollection.class.php

Get the $n-th position in the array, regardless of key indices.
getPrimaryKey: SchemaTable::getPrimaryKey() in SchemaTable.class.php
getPrimaryKeyOverride: DatabaseSchemaGeneratorConfig::getPrimaryKeyOverride() in DatabaseSchemaGeneratorConfig.class.php
getQuery: As_Database::getQuery() in As_Database.class.php
getQueryLog: As_Database::getQueryLog() in As_Database.class.php
getQueryLogTime: As_Database::getQueryLogTime() in As_Database.class.php
getRefDatabaseName: SchemaForeignKey::getRefDatabaseName() in SchemaForeignKey.class.php
getRefKey: SchemaRelationship::getRefKey() in SchemaRelationship.class.php
getRefKeyName: SchemaForeignKey::getRefKeyName() in SchemaForeignKey.class.php
getRefObjectName: SchemaRelationship::getRefObjectName() in SchemaRelationship.class.php
getRefObjectName: SchemaForeignKey::getRefObjectName() in SchemaForeignKey.class.php
getRefTable: SchemaRelationship::getRefTable() in SchemaRelationship.class.php
getRefTableName: SchemaForeignKey::getRefTableName() in SchemaForeignKey.class.php
getRefTableName: SchemaRelationship::getRefTableName() in SchemaRelationship.class.php
getResultObjectFromResource: As_Database::getResultObjectFromResource() in As_Database.class.php
getResultObjectFromResource: CoughAsDatabase::getResultObjectFromResource() in CoughAsDatabase.class.php
getRow: CoughDatabaseResultInterface::getRow() in CoughDatabaseResultInterface.class.php
getRow: As_DatabaseResult::getRow() in As_DatabaseResult.class.php
getRows: As_DatabaseResult::getRows() in As_DatabaseResult.class.php
getSchema: SchemaTable::getSchema() in SchemaTable.class.php
getSchema: SchemaColumn::getSchema() in SchemaColumn.class.php
getSchema: SchemaDatabase::getSchema() in SchemaDatabase.class.php
getSchema: DatabaseSchemaGenerator::getSchema() in DatabaseSchemaGenerator.class.php

Get the Schema / DriverServer object.
getSecondsBehindMaster: As_Database::getSecondsBehindMaster() in As_Database.class.php
getSelect: As_SelectQuery::getSelect() in As_SelectQuery.class.php
getSelectOptions: As_SelectQuery::getSelectOptions() in As_SelectQuery.class.php
getSelectQuery: As_Query::getSelectQuery() in As_Query.class.php
getServer: SchemaDatabase::getServer() in SchemaDatabase.class.php
getSize: SchemaColumn::getSize() in SchemaColumn.class.php
getStarterCollectionClassName: CoughGeneratorConfig::getStarterCollectionClassName() in CoughGeneratorConfig.class.php
getStarterObjectClassName: CoughGeneratorConfig::getStarterObjectClassName() in CoughGeneratorConfig.class.php
getString: As_InsertQuery::getString() in As_InsertQuery.class.php
getString: As_SelectQuery::getString() in As_SelectQuery.class.php
getString: As_Query::getString() in As_Query.class.php
getString: As_UpdateQuery::getString() in As_UpdateQuery.class.php
getString: As_SqlFunction::getString() in As_SqlFunction.class.php
getTable: SchemaColumn::getTable() in SchemaColumn.class.php
getTable: SchemaDatabase::getTable() in SchemaDatabase.class.php
getTableName: SchemaTable::getTableName() in SchemaTable.class.php
getTableName: CoughClass::getTableName() in CoughClass.class.php
getTableName: CoughObjectStaticInterface::getTableName() in CoughObjectStaticInterface.class.php
getTableNamePrefixes: DatabaseSchemaGeneratorConfig::getTableNamePrefixes() in DatabaseSchemaGeneratorConfig.class.php
getTableNameWithoutPrefix: CoughGeneratorConfig::getTableNameWithoutPrefix() in CoughGeneratorConfig.class.php
getTables: SchemaDatabase::getTables() in SchemaDatabase.class.php
getTemporaryKey: CoughCollection::getTemporaryKey() in CoughCollection.class.php

Returns a temporary key for adding an object that does not have a key ID yet.
getTestForMatch: As_Database::getTestForMatch() in As_Database.class.php
getTestForNonMatch: As_Database::getTestForNonMatch() in As_Database.class.php
getTitleCase: CoughGeneratorConfig::getTitleCase() in CoughGeneratorConfig.class.php

getTitleCase() takes the given string and returns it in TitleCase format (sometimes called UpperCamelCase), with underscores removed.
getType: SchemaColumn::getType() in SchemaColumn.class.php
getUniqueDatabases: CoughDatabaseFactory::getUniqueDatabases() in CoughDatabaseFactory.class.php

Same as getDatabases(), except it rolls up all aliases using the same connection into one array entry.
getUniqueQueryLog: As_Database::getUniqueQueryLog() in As_Database.class.php

Like the query log, but it rolls up all duplicate queries into only one entry in the array. It adds a count value equal to the number of times the query was run, and the time value is equal to the total time of each query run.
getUpdateFields: CoughObject::getUpdateFields() in CoughObject.class.php

Returns the fields that should be used for updating. This logic is separate from the update method to make it easy to override the behavior.
getUpdateQuery: As_Query::getUpdateQuery() in As_Query.class.php
getValidationErrors: CoughObject::getValidationErrors() in CoughObject.class.php

Returns the validation errors set by `validateData()`.
getWarnings: CoughGenerator::getWarnings() in CoughGenerator.class.php
getWhere: As_SelectQuery::getWhere() in As_SelectQuery.class.php

top

$habtmRelationships: SchemaTable::$habtmRelationships in SchemaTable.class.php

many-to-many relationships (habtm = has and belongs to many)
$hasLoadedBaseDrivers: DatabaseSchemaGenerator::$hasLoadedBaseDrivers in DatabaseSchemaGenerator.class.php

Keep track of whether or not the base database drivers have been loaded.
$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
$having: As_SelectQuery::$having in As_SelectQuery.class.php
has: CoughInstancePool::has() in CoughInstancePool.class.php
hasForeignKey: SchemaTable::hasForeignKey() in SchemaTable.class.php

Check if the specified foreign key already exists (by comparing it's local key name)
hasKeyId: CoughObject::hasKeyId() in CoughObject.class.php

Returns true if all the key fields that make up the primary key are set to non-null values.
hasLocalObjectName: SchemaForeignKey::hasLocalObjectName() in SchemaForeignKey.class.php
hasModifiedFields: CoughObject::hasModifiedFields() in CoughObject.class.php

Whether or not there is at least one modified field.
hasPrimaryKey: SchemaTable::hasPrimaryKey() in SchemaTable.class.php
hasRefDatabaseName: SchemaForeignKey::hasRefDatabaseName() in SchemaForeignKey.class.php
hasRefObjectName: SchemaForeignKey::hasRefObjectName() in SchemaForeignKey.class.php

top

$instances: CoughInstancePool::$instances in CoughInstancePool.class.php
$inTransaction: As_Database::$inTransaction in As_Database.class.php

Whether or not we are currently in a transaction.
$isCollectionClass: CoughClass::$isCollectionClass in CoughClass.class.php
$isDeleted: CoughObject::$isDeleted in CoughObject.class.php

Stores whether or not the object has been deleted from the database.
$isLinked: SchemaForeignKey::$isLinked in SchemaForeignKey.class.php
$isNew: CoughObject::$isNew in CoughObject.class.php

Stores whether or not the object is new (i.e. not in database yet).
$isNullAllowed: SchemaColumn::$isNullAllowed in SchemaColumn.class.php
$isPrimaryKey: SchemaColumn::$isPrimaryKey in SchemaColumn.class.php
$isStarterClass: CoughClass::$isStarterClass in CoughClass.class.php
inflate: CoughObject::inflate() in CoughObject.class.php

Inflate/Invigorate the object with data.
inflateObject: CoughObject::inflateObject() in CoughObject.class.php

This helper method for inflate() handles inflation of related objects.
initConfig: CoughGeneratorConfig::initConfig() in CoughGeneratorConfig.class.php
initConfig: XmlSchemaGenerator::initConfig() in XmlSchemaGenerator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.
initConfig: XmlSchemaGeneratorConfig::initConfig() in XmlSchemaGeneratorConfig.class.php
initConfig: CoughGenerator::initConfig() in CoughGenerator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.
initConfig: CoughConfig::initConfig() in CoughConfig.class.php

Initializes config to the defaults
initConfig: DatabaseSchemaGenerator::initConfig() in DatabaseSchemaGenerator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.
initConfig: DatabaseSchemaGeneratorConfig::initConfig() in DatabaseSchemaGeneratorConfig.class.php
initConfig: CoughWriter::initConfig() in CoughWriter.class.php

Initialize the configuration object given an array or pre-constructed configuration object.
initConfig: SchemaManipulator::initConfig() in SchemaManipulator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.
initConnection: As_Database::initConnection() in As_Database.class.php
initializeDefinitions: CoughObject::initializeDefinitions() in CoughObject.class.php

Sets the cough object's basic identity:
insert: As_Database::insert() in As_Database.class.php

Perform an INSERT.
INSERT: As_Database::INSERT in As_Database.class.php
insert: CoughObject::insert() in CoughObject.class.php

Inserts a new row to the database and sets the object's key id with the returned database insert id.
insertMultiple: As_Database::insertMultiple() in As_Database.class.php
insertOnDupUpdate: As_Database::insertOnDupUpdate() in As_Database.class.php

Like insertOrUpdate, except a WHERE clause is not required
insertOrCancel: As_Database::insertOrCancel() in As_Database.class.php
insertOrUpdate: As_Database::insertOrUpdate() in As_Database.class.php
invalidateField: CoughObject::invalidateField() in CoughObject.class.php

Invalidates a field with an optional message.
isCollectionClass: CoughClass::isCollectionClass() in CoughClass.class.php
isDataValid: CoughObject::isDataValid() in CoughObject.class.php

Returns true if the data is valid (i.e. no validation errors set), otherwise it returns false.
isDeleted: CoughObject::isDeleted() in CoughObject.class.php

Specifies whether or not the object has been deleted from the database.
isEmpty: CoughCollection::isEmpty() in CoughCollection.class.php

Find out whether or not the collection is empty.
isEqualTo: CoughObject::isEqualTo() in CoughObject.class.php

This will compare two CoughObjects and return true if they are of the same type and have the same field values (excluding the primary key).
isFieldModified: CoughObject::isFieldModified() in CoughObject.class.php

Whether or not the specified field has been modified.
isFieldValid: CoughObject::isFieldValid() in CoughObject.class.php

Returns true if the field is valid (i.e. no validation errors set), otherwise it returns false.
isInflated: CoughObject::isInflated() in CoughObject.class.php

Returns whether or not the object is inflated (i.e. pulled from persistent storage)
isInTransaction: As_Database::isInTransaction() in As_Database.class.php
isKeyNullable: SchemaRelationship::isKeyNullable() in SchemaRelationship.class.php

Returns false if all keys are NOT NULL, true otherwise.
isLinked: SchemaForeignKey::isLinked() in SchemaForeignKey.class.php
isNew: CoughObject::isNew() in CoughObject.class.php

Returns whether or not the object is new (i.e. not in persistent storage)
isNullAllowed: SchemaColumn::isNullAllowed() in SchemaColumn.class.php
isPrimaryKey: SchemaColumn::isPrimaryKey() in SchemaColumn.class.php
isStarterClass: CoughClass::isStarterClass() in CoughClass.class.php

top

$keyMethod: CoughKeyValueIterator::$keyMethod in CoughKeyValueIterator.class.php
key: CoughKeyValueIterator::key() in CoughKeyValueIterator.class.php

top

$limit: As_SelectQuery::$limit in As_SelectQuery.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
$logBacktraces: As_Database::$logBacktraces in As_Database.class.php

Whether or not to log backtraces when logging queries
$logQueries: As_Database::$logQueries in As_Database.class.php

Whether or not to log all queries (to variable)
linkRelationships: Schema::linkRelationships() in Schema.class.php

Traverses all tables and uses any Foreign Key information to generate
load: CoughCollection::load() in CoughCollection.class.php

Loads the collection using the SQL provided by getLoadSql()
loadBySql: CoughCollection::loadBySql() in CoughCollection.class.php

Loads the collection using the provided SQL
loadColumns: DriverTable::loadColumns() in DriverTable.class.php
loadColumns: MysqlTable::loadColumns() in MysqlTable.class.php
loadDatabase: DriverServer::loadDatabase() in DriverServer.class.php

Load a specific database schema into memory.
loadDatabase: MysqlServer::loadDatabase() in MysqlServer.class.php

Load a specific database schema into memory.
loadDatabases: MysqlServer::loadDatabases() in MysqlServer.class.php

Load all database schemas for the currently connected server into memory.
loadDatabases: DriverServer::loadDatabases() in DriverServer.class.php

Load all database schemas for the currently connected server into memory.
loadDrivers: DatabaseSchemaGenerator::loadDrivers() in DatabaseSchemaGenerator.class.php

Load database schema drivers for the specified path and driver prefix.
loadSchema: XmlSchemaGenerator::loadSchema() in XmlSchemaGenerator.class.php

Loads the schema into memory according to the config (e.g. only includes databases and tables the config allows).
loadSchema: DatabaseSchemaGenerator::loadSchema() in DatabaseSchemaGenerator.class.php

Loads the schema into memory according to the config (e.g. only includes databases and tables the config allows).
loadTable: MysqlDatabase::loadTable() in MysqlDatabase.class.php

Load a specific database table into memory.
loadTable: DriverDatabase::loadTable() in DriverDatabase.class.php
loadTables: DriverDatabase::loadTables() in DriverDatabase.class.php

Load all tables for the database into memory.
loadTables: MysqlDatabase::loadTables() in MysqlDatabase.class.php
logException: CoughGenerator::logException() in CoughGenerator.class.php

Logs the given exception (currently just saves the message to the error array)

top

$modifiedFields: CoughObject::$modifiedFields in CoughObject.class.php

An array of fields that have been modified.
manipulateSchema: SchemaManipulator::manipulateSchema() in SchemaManipulator.class.php

Scans the schema and manipulates it by detecting FKs adding them to tables.
mergeIntoConfig: CoughConfig::mergeIntoConfig() in CoughConfig.class.php

Merges the given config into the current config, overriding any of the current config values to new ones.
MysqlDatabase: MysqlDatabase in MysqlDatabase.class.php

Implements the interface for the Database Driver.
MysqlServer: MysqlServer in MysqlServer.class.php

Implements the interface for Server Driver, which:
MysqlTable: MysqlTable in MysqlTable.class.php

Implements the interface for Table Driver, which:
MysqlDatabase.class.php: MysqlDatabase.class.php in MysqlDatabase.class.php
MysqlServer.class.php: MysqlServer.class.php in MysqlServer.class.php
MysqlTable.class.php: MysqlTable.class.php in MysqlTable.class.php

top

notifyChildrenOfKeyChange: CoughObject::notifyChildrenOfKeyChange() in CoughObject.class.php

This method's job is to notify related collections (if any) of the key change.
numRows: As_DatabaseResult::numRows() in As_DatabaseResult.class.php

top

$objectDefinitions: CoughObject::$objectDefinitions in CoughObject.class.php

An array of all the objects and their attributes.
$objects: CoughObject::$objects in CoughObject.class.php

An array of all the loaded objects in form [objectName] => [CoughObject]
$offset: As_SelectQuery::$offset in As_SelectQuery.class.php
$orderBy: As_SelectQuery::$orderBy in As_SelectQuery.class.php
outputRelationshipCounts: Schema::outputRelationshipCounts() in Schema.class.php

top

parseCreateStatement: MysqlTable::parseCreateStatement() in MysqlTable.class.php
parseForeignKeyReferences: MysqlTable::parseForeignKeyReferences() in MysqlTable.class.php

top

$query: As_Database::$query in As_Database.class.php
$queryLog: As_Database::$queryLog in As_Database.class.php

Logged queries since logQueries was turned on
query: CoughDatabaseInterface::query() in CoughDatabaseInterface.class.php
query: As_Database::query() in As_Database.class.php
query: MysqlTable::query() in MysqlTable.class.php
quote: As_Database::quote() in As_Database.class.php
quote: CoughDatabaseInterface::quote() in CoughDatabaseInterface.class.php

top

$refDatabaseName: SchemaForeignKey::$refDatabaseName in SchemaForeignKey.class.php
$refKey: SchemaRelationship::$refKey in SchemaRelationship.class.php
$refKeyName: SchemaForeignKey::$refKeyName in SchemaForeignKey.class.php
$refObjectName: SchemaForeignKey::$refObjectName in SchemaForeignKey.class.php
$refObjectName: SchemaRelationship::$refObjectName in SchemaRelationship.class.php
$refTable: SchemaRelationship::$refTable in SchemaRelationship.class.php
$refTableName: SchemaForeignKey::$refTableName in SchemaForeignKey.class.php
$removedElements: CoughCollection::$removedElements in CoughCollection.class.php

Holds all the (unsaved) removed elements
remapCriteria: As_Query::remapCriteria() in As_Query.class.php

Re-map the given array to allow for multiple formats.
remove: CoughInstancePool::remove() in CoughInstancePool.class.php
remove: CoughCollection::remove() in CoughCollection.class.php

Removes a single element given either an ID or the object itself.
removeAll: CoughInstancePool::removeAll() in CoughInstancePool.class.php
removeByKey: CoughCollection::removeByKey() in CoughCollection.class.php

Removes a single element from the collection by key.
removeByReference: CoughCollection::removeByReference() in CoughCollection.class.php

Removes a single element from the collection by comparing references.
replace: As_Database::replace() in As_Database.class.php
replaceMultiple: As_Database::replaceMultiple() in As_Database.class.php
reset: CoughDatabaseFactory::reset() in CoughDatabaseFactory.class.php

Restore CoughDatabaseFactory to its initial state (no configs, no database objects).
resetModified: CoughObject::resetModified() in CoughObject.class.php

Clear the list of modified fields and other modified flags.
result: As_DatabaseResult::result() in As_DatabaseResult.class.php
result: As_Database::result() in As_Database.class.php

result function
rollback: As_Database::rollback() in As_Database.class.php

Rollback a non-committed transaction.
run: As_Query::run() in As_Query.class.php

top

$schema: DatabaseSchemaGenerator::$schema in DatabaseSchemaGenerator.class.php

Schema object (mostly likely an instanceof Schema)
$schema: XmlSchemaGenerator::$schema in XmlSchemaGenerator.class.php

Schema object (mostly likely an instanceof Schema)
$schema: SchemaManipulator::$schema in SchemaManipulator.class.php

A reference to the schema to manipulate
$select: As_SelectQuery::$select in As_SelectQuery.class.php
$selectOptions: As_SelectQuery::$selectOptions in As_SelectQuery.class.php
$server: SchemaDatabase::$server in SchemaDatabase.class.php
$size: SchemaColumn::$size in SchemaColumn.class.php
$sqlFunction: As_SqlFunction::$sqlFunction in As_SqlFunction.class.php
save: CoughObject::save() in CoughObject.class.php

Creates a new entry if needed, otherwise it updates an existing one.
save: CoughCollection::save() in CoughCollection.class.php

Run save on each collected (or removed) element.
saveLoadedCollections: CoughObject::saveLoadedCollections() in CoughObject.class.php

Saves all the loaded collections (if it wasn't loaded there would be nothing to save)
saveLoadedObjects: CoughObject::saveLoadedObjects() in CoughObject.class.php

Saves all the loaded objects (if it wasn't loaded there would be nothing to save)
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
SchemaGenerator: SchemaGenerator in SchemaGenerator.class.php

Defines the interface for all SchemaGenerators.
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).
SchemaGenerator.class.php: SchemaGenerator.class.php in SchemaGenerator.class.php
SCOPE_DATABASE: CoughConfig::SCOPE_DATABASE in CoughConfig.class.php
SCOPE_GLOBAL: CoughConfig::SCOPE_GLOBAL in CoughConfig.class.php
SCOPE_TABLE: CoughConfig::SCOPE_TABLE in CoughConfig.class.php
select: As_Database::select() in As_Database.class.php
selectDb: DriverDatabase::selectDb() in DriverDatabase.class.php
selectDb: CoughDatabaseInterface::selectDb() in CoughDatabaseInterface.class.php
selectDb: MysqlDatabase::selectDb() in MysqlDatabase.class.php
selectDB: As_Database::selectDB() in As_Database.class.php
setClassName: CoughClass::setClassName() in CoughClass.class.php
setColumnName: SchemaColumn::setColumnName() in SchemaColumn.class.php
setConfigs: CoughDatabaseFactory::setConfigs() in CoughDatabaseFactory.class.php

Sets all the database configs at once.
setContents: CoughClass::setContents() in CoughClass.class.php
setDatabase: SchemaTable::setDatabase() in SchemaTable.class.php
setDatabaseConfigs: As_DatabaseFactory::setDatabaseConfigs() in As_DatabaseFactory.class.php

Sets all the database configs at once.
setDatabaseName: CoughClass::setDatabaseName() in CoughClass.class.php
setDatabaseName: SchemaDatabase::setDatabaseName() in SchemaDatabase.class.php
setDb: As_Query::setDb() in As_Query.class.php
setDefaultValue: SchemaColumn::setDefaultValue() in SchemaColumn.class.php
setDerivedField: CoughObject::setDerivedField() in CoughObject.class.php

Sets a read-only field; It's usually a derived field from a complex SQL query such as when overriding the getLoadSql() function.
setField: CoughObject::setField() in CoughObject.class.php

Sets the current value of $fieldName to $value.
setFields: CoughObject::setFields() in CoughObject.class.php

Sets the current value of the all the object's defined fields equal to the values passed in the $fields associative array.
setFields: As_InsertQuery::setFields() in As_InsertQuery.class.php
setFieldsIfDifferent: CoughObject::setFieldsIfDifferent() in CoughObject.class.php

Sets fields in the given hash, but only if they new values are different from the existing values
setFrom: As_SelectQuery::setFrom() in As_SelectQuery.class.php
setGroupBy: As_SelectQuery::setGroupBy() in As_SelectQuery.class.php
setHasManyRelationship: SchemaRelationshipHasOne::setHasManyRelationship() in SchemaRelationshipHasOne.class.php
setHasOneRelationship: SchemaRelationshipHasMany::setHasOneRelationship() in SchemaRelationshipHasMany.class.php
setHaving: As_SelectQuery::setHaving() in As_SelectQuery.class.php
setIsCollectionClass: CoughClass::setIsCollectionClass() in CoughClass.class.php
setIsLinked: SchemaForeignKey::setIsLinked() in SchemaForeignKey.class.php
setIsNullAllowed: SchemaColumn::setIsNullAllowed() in SchemaColumn.class.php
setIsPrimaryKey: SchemaColumn::setIsPrimaryKey() in SchemaColumn.class.php
setIsStarterClass: CoughClass::setIsStarterClass() in CoughClass.class.php
setKeyId: CoughObject::setKeyId() in CoughObject.class.php

Sets the object's primary key id to the passed value.
setLimit: As_SelectQuery::setLimit() in As_SelectQuery.class.php
setLocalDatabaseName: SchemaForeignKey::setLocalDatabaseName() in SchemaForeignKey.class.php
setLocalKey: SchemaRelationship::setLocalKey() in SchemaRelationship.class.php
setLocalKeyName: SchemaForeignKey::setLocalKeyName() in SchemaForeignKey.class.php
setLocalObjectName: SchemaRelationship::setLocalObjectName() in SchemaRelationship.class.php
setLocalObjectName: SchemaForeignKey::setLocalObjectName() in SchemaForeignKey.class.php
setLocalTable: SchemaRelationship::setLocalTable() in SchemaRelationship.class.php
setLocalTableName: SchemaForeignKey::setLocalTableName() in SchemaForeignKey.class.php
setModifiedField: CoughObject::setModifiedField() in CoughObject.class.php

Add a field to the list of modified fields
setOffset: As_SelectQuery::setOffset() in As_SelectQuery.class.php
setOrderBy: As_SelectQuery::setOrderBy() in As_SelectQuery.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
setSchema: DatabaseSchemaGenerator::setSchema() in DatabaseSchemaGenerator.class.php

Set the Schema / DriverServer object.
setSelect: As_SelectQuery::setSelect() in As_SelectQuery.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
setTableName: CoughClass::setTableName() in CoughClass.class.php
setTableName: As_InsertQuery::setTableName() in As_InsertQuery.class.php
setType: SchemaColumn::setType() in SchemaColumn.class.php
setWhere: As_UpdateQuery::setWhere() in As_UpdateQuery.class.php
setWhere: As_SelectQuery::setWhere() in As_SelectQuery.class.php
shouldGenerateForTable: CoughGeneratorConfig::shouldGenerateForTable() in CoughGeneratorConfig.class.php
shouldGenerateHasManyMethods: CoughGeneratorConfig::shouldGenerateHasManyMethods() in CoughGeneratorConfig.class.php
shouldGenerateHasOneMethods: CoughGeneratorConfig::shouldGenerateHasOneMethods() in CoughGeneratorConfig.class.php
shouldGenerateLoadSqlInnerJoins: CoughGeneratorConfig::shouldGenerateLoadSqlInnerJoins() in CoughGeneratorConfig.class.php
shouldInsert: CoughObject::shouldInsert() in CoughObject.class.php

Indicates whether or not a save should insert a new record or update an existing one.
shouldProcessDatabase: DatabaseSchemaGeneratorConfig::shouldProcessDatabase() in DatabaseSchemaGeneratorConfig.class.php

Returns whether not the given database name should be processed.
shouldProcessTable: DatabaseSchemaGeneratorConfig::shouldProcessTable() in DatabaseSchemaGeneratorConfig.class.php

Returns whether not the given table name (for the given database name) should be processed.
shouldScanForJoin: DatabaseSchemaGeneratorConfig::shouldScanForJoin() in DatabaseSchemaGeneratorConfig.class.php

Returns whether or not a the $sourceTable cares about the $refDatabase when looking for joins.
showStatus: CoughGeneratorFacade::showStatus() in CoughGeneratorFacade.class.php
showStatusFromConfigPath: CoughGeneratorFacade::showStatusFromConfigPath() in CoughGeneratorFacade.class.php
sortByKeys: CoughCollection::sortByKeys() in CoughCollection.class.php

Sort the collection from an array of keys (where the keys are in the desired order).
sortByMethod: CoughCollection::sortByMethod() in CoughCollection.class.php

Sort the collection from the return value of the specified method name of the collected objects.
sortByMethods: CoughCollection::sortByMethods() in CoughCollection.class.php

Sort the collection from the return value of the specified method names of the collected objects.
splitArrayWithPrefix: CoughObject::splitArrayWithPrefix() in CoughObject.class.php

Returns a sub array of the given array containing all elements that have keys starting with the specified prefix. The resulting array's keys have the prefix removed.
startLoggingQueries: As_Database::startLoggingQueries() in As_Database.class.php
startTransaction: As_Database::startTransaction() in As_Database.class.php

Starts a transaction.
stopLoggingQueries: As_Database::stopLoggingQueries() in As_Database.class.php

top

$table: SchemaColumn::$table in SchemaColumn.class.php
$tableName: SchemaTable::$tableName in SchemaTable.class.php
$tableName: As_InsertQuery::$tableName in As_InsertQuery.class.php
$tableName: CoughClass::$tableName in CoughClass.class.php
$tables: SchemaDatabase::$tables in SchemaDatabase.class.php
$type: SchemaColumn::$type in SchemaColumn.class.php
titleCase: CoughObject::titleCase() in CoughObject.class.php
trimBackticks: MysqlTable::trimBackticks() in MysqlTable.class.php

Trim whitespace, and THEN backticks (leaving any whitespice within the backticks)

top

underscore: CoughObject::underscore() in CoughObject.class.php
unsetKeysWithPrefix: CoughObject::unsetKeysWithPrefix() in CoughObject.class.php

Unsets all keys on the given array that start with the specified prefix.
update: CoughObject::update() in CoughObject.class.php

Updates the database with modified values, if any.
update: As_Database::update() in As_Database.class.php
UPDATE: As_Database::UPDATE in As_Database.class.php

top

$validatedData: CoughObject::$validatedData in CoughObject.class.php

Keep track of whether or not data has been validated.
$validationErrors: CoughObject::$validationErrors in CoughObject.class.php

Stores validation errors set by `validateData` function.
$valueMethod: CoughKeyValueIterator::$valueMethod in CoughKeyValueIterator.class.php
$verbose: DatabaseSchemaGenerator::$verbose in DatabaseSchemaGenerator.class.php

Whether or not to echo what's happening to the screen.
$verbose: CoughGeneratorFacade::$verbose in CoughGeneratorFacade.class.php

Whether or not to echo what's happening to the screen.
$verbose: SchemaManipulator::$verbose in SchemaManipulator.class.php

Whether or not to echo what's happening to the screen.
validateData: CoughObject::validateData() in CoughObject.class.php

Validates data stored in the model. It is called automatically by `save`, which will return false if this function sets any errors.

top

$where: As_SelectQuery::$where in As_SelectQuery.class.php
$where: As_UpdateQuery::$where in As_UpdateQuery.class.php
writeClasses: CoughWriter::writeClasses() in CoughWriter.class.php

Writes all the classes to disk, skipping starter classes if they already exist.
writeToFile: CoughWriter::writeToFile() in CoughWriter.class.php

Puts the given contents into the given file name.

top

XmlSchemaGenerator.class.php: XmlSchemaGenerator.class.php in XmlSchemaGenerator.class.php
XmlSchemaGeneratorConfig.class.php: XmlSchemaGeneratorConfig.class.php in XmlSchemaGeneratorConfig.class.php
XmlSchemaGenerator: XmlSchemaGenerator in XmlSchemaGenerator.class.php

Takes XML config info and generates a schema (a collection of databases each containing a collection of tables each containing a collection of columns)
XmlSchemaGeneratorConfig: XmlSchemaGeneratorConfig in XmlSchemaGeneratorConfig.class.php

XML Schema Generator takes an XML schema file and generates the Schema objects that CoughGenerator takes.

top

__clone: CoughObject::__clone() in CoughObject.class.php

Clone only the non-primary key fields.
__construct: DatabaseSchemaGenerator::__construct() in DatabaseSchemaGenerator.class.php

Construct with optional configuration parameters.
__construct: CoughWriter::__construct() in CoughWriter.class.php

Construct with optional configuration parameters.
__construct: MysqlDatabase::__construct() in MysqlDatabase.class.php
__construct: CoughObject::__construct() in CoughObject.class.php

Construct an empty CoughObject or an object with pre-initialized data.
__construct: MysqlServer::__construct() in MysqlServer.class.php

Construct with a DSN, an array containing host, user, pass, and port (optional).
__construct: XmlSchemaGenerator::__construct() in XmlSchemaGenerator.class.php

Construct with optional configuration parameters.
__construct: SchemaManipulator::__construct() in SchemaManipulator.class.php

Construct with optional configuration parameters.
__construct: SchemaForeignKey::__construct() in SchemaForeignKey.class.php
__construct: MysqlTable::__construct() in MysqlTable.class.php
__construct: CoughKeyValueIterator::__construct() in CoughKeyValueIterator.class.php
__construct: CoughGenerator::__construct() in CoughGenerator.class.php

Construct with optional configuration parameters.
__construct: As_Query::__construct() in As_Query.class.php

Pass in a database object that provides a quote() method.
__construct: As_DatabaseResult::__construct() in As_DatabaseResult.class.php
__construct: As_Database::__construct() in As_Database.class.php
__construct: As_SqlFunction::__construct() in As_SqlFunction.class.php
__construct: CoughCollection::__construct() in CoughCollection.class.php
__construct: CoughClass::__construct() in CoughClass.class.php
__construct: CoughConfig::__construct() in CoughConfig.class.php
__destruct: As_Database::__destruct() in As_Database.class.php
__destruct: As_DatabaseResult::__destruct() in As_DatabaseResult.class.php
__destruct: MysqlServer::__destruct() in MysqlServer.class.php
__toString: As_Query::__toString() in As_Query.class.php
__toString: As_SqlFunction::__toString() in As_SqlFunction.class.php