[cough_generator] element index

Package indexes

• cough
• as_database
• as_query
• schema
• schema_generator

__construct

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

Construct with optional configuration parameters.

__construct

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

Construct with optional configuration parameters.

__construct

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

__construct

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

addGeneratedClass

CoughGenerator::addGeneratedClass() in CoughGenerator.class.php

Add to the generated classes.

$className

CoughClass::$className in CoughClass.class.php

$config

CoughWriter::$config in CoughWriter.class.php

Configuration object for this class

$config

CoughConfig::$config in CoughConfig.class.php

$config

CoughGenerator::$config in CoughGenerator.class.php

Configuration object for this class

$contents

CoughClass::$contents in CoughClass.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).

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).

CoughConfig

CoughConfig in CoughConfig.class.php

Base config class for other config classes to extend.

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.

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

$databaseName

CoughClass::$databaseName in CoughClass.class.php

disableVerbose

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

Disable verbose mode

$errorMessages

CoughWriter::$errorMessages in CoughWriter.class.php

Error message storage

enableVerbose

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

Enable verbose mode

$generatedClasses

CoughGenerator::$generatedClasses in CoughGenerator.class.php

Storage for the generated CoughClass objects

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.

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.

generateStarterCollection

CoughGenerator::generateStarterCollection() in CoughGenerator.class.php

Generates the starter collection class

generateStarterObject

CoughGenerator::generateStarterObject() in CoughGenerator.class.php

Generates the starter object class

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.

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

CoughClass::getClassName() in CoughClass.class.php

getClassName

CoughGeneratorConfig::getClassName() in CoughGeneratorConfig.class.php

getCollectionExtensionClassName

CoughGeneratorConfig::getCollectionExtensionClassName() in CoughGeneratorConfig.class.php

getConfigPath

CoughGeneratorFacade::getConfigPath() in CoughGeneratorFacade.class.php

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

getDatabaseName

CoughClass::getDatabaseName() in CoughClass.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.

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.

getForeignCollectionName

CoughGeneratorConfig::getForeignCollectionName() in CoughGeneratorConfig.class.php

getForeignObjectName

CoughGeneratorConfig::getForeignObjectName() in CoughGeneratorConfig.class.php

getForeignTableAliasName

CoughGeneratorConfig::getForeignTableAliasName() in CoughGeneratorConfig.class.php

getGeneratedClasses

CoughGenerator::getGeneratedClasses() in CoughGenerator.class.php

Get the generated classes

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.

getObjectExtensionClassName

CoughGeneratorConfig::getObjectExtensionClassName() in CoughGeneratorConfig.class.php

getPhpdocAuthor

CoughGeneratorConfig::getPhpdocAuthor() in CoughGeneratorConfig.class.php

getPhpdocCopyright

CoughGeneratorConfig::getPhpdocCopyright() in CoughGeneratorConfig.class.php

getPhpdocPackage

CoughGeneratorConfig::getPhpdocPackage() in CoughGeneratorConfig.class.php

getStarterCollectionClassName

CoughGeneratorConfig::getStarterCollectionClassName() in CoughGeneratorConfig.class.php

getStarterObjectClassName

CoughGeneratorConfig::getStarterObjectClassName() in CoughGeneratorConfig.class.php

getTableName

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

getTableNameWithoutPrefix

CoughGeneratorConfig::getTableNameWithoutPrefix() in CoughGeneratorConfig.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.

getWarnings

CoughGenerator::getWarnings() in CoughGenerator.class.php

$isCollectionClass

CoughClass::$isCollectionClass in CoughClass.class.php

$isStarterClass

CoughClass::$isStarterClass in CoughClass.class.php

initConfig

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

initConfig

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

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

initConfig

CoughWriter::initConfig() in CoughWriter.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

isCollectionClass

CoughClass::isCollectionClass() in CoughClass.class.php

isStarterClass

CoughClass::isStarterClass() in CoughClass.class.php

logException

CoughGenerator::logException() in CoughGenerator.class.php

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

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.

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

setClassName

CoughClass::setClassName() in CoughClass.class.php

setContents

CoughClass::setContents() in CoughClass.class.php

setDatabaseName

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

setIsCollectionClass

CoughClass::setIsCollectionClass() in CoughClass.class.php

setIsStarterClass

CoughClass::setIsStarterClass() in CoughClass.class.php

setTableName

CoughClass::setTableName() in CoughClass.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

showStatus

CoughGeneratorFacade::showStatus() in CoughGeneratorFacade.class.php

showStatusFromConfigPath

CoughGeneratorFacade::showStatusFromConfigPath() in CoughGeneratorFacade.class.php

$tableName

CoughClass::$tableName in CoughClass.class.php

$verbose

CoughGeneratorFacade::$verbose in CoughGeneratorFacade.class.php

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

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.