Docs For Class atkDDL
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: general » AllTests » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkOneToManyRelationSessionGridHandler » atkPHPView » atkSessionStore » atkStatementIterator » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkCompatSelector » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkMLSelector » atkmlsplitter » atkRootFrameset » atkSelector » atkSelectorIterator » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHiddenAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlFckAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_saml » auth_server » auth_sspi cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm test » atkCacheTestCase » atkPluginTestCase » atkTestCase » test_sql_whereclause_blacklist_checker db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkdb2db » atkDb2DDL » atkDb2Query » atkDDL » atki5db » atki5DDL » atki5query » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer db-statement » atkCompatStatement » atkMySQLiStatement » atkStatement » atkStatementException » atkStatementParser console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToOneRelation » atkPolymorphicOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation session » atkMockSessionManager » atkSessionManager » atkState modules » atkModule » mod_test listeners » atkRecycleBin interface » atkServer » atkSoapServer wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » AllTests.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » bootstrap.inc » bootstrap.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atki5db.inc » class.atki5ddl.inc » class.atki5query.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atkmocksessionmanager.inc » class.atknode.inc » class.atknodevalidator.inc » class.atkonetomanyrelationsessiongridhandler.inc » class.atkphpview.inc » class.atkpolymorphiconetoonerelation.inc » class.atksessionstore.inc » class.atkstatementiterator.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » tooltip.tpl.php » upload.php » util.php » version.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhiddenattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlfckattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkdb2db.inc » class.atkdb2ddl.inc » class.atkdb2query.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc db-statement » class.atkcompatstatement.inc » class.atkmysqlistatement.inc » class.atkstatement.inc » class.atkstatementexception.inc » class.atkstatementparser.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc listeners » class.atkrecyclebin.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_saml.inc » class.auth_server.inc » class.auth_sspi.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » top.php » welcome.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkplugintestcase.inc » class.atktestcase.inc testcases » class.atkabstractsearchhandler.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconf.php » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkcompatselector.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlselector.inc » class.atkmlsplitter.inc » class.atkselector.inc » class.atkselectoriterator.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkDDL [ package: atk ]

Class: atkDDL

Source Location: /db/class.atkddl.inc

Class atkDDL

Descendants

Child Class Description
atkDb2DDL DB2 ddl driver.
atkMsSqlDDL MSSQL ddl driver.
atkMysqlDDL MySQL ddl driver.
atkOci8DDL Oracle 8i ddl driver.
atkPgsqlDDL PostgreSQL ddl driver.
atkMockDDL A mock data definition abstraction.

[ Top ]

Property Summary

mixed   $m_db  
mixed   $m_fields  
string   $m_idxnameFormat   Postfix for index names
mixed   $m_indexes  
mixed   $m_primarykey  
mixed   $m_remove_field  
mixed   $m_table  

[ Top ]

Method Summary

atkDDL   atkDDL()   Default constructor
void   addField()   Add a field to the table definition.
void   addFields()   Add multiple fields at once using the given metadata.
An   buildAlter()   Build one or more ALTER TABLE queries and return them as an array of strings.
String   buildConstraints()   Convert all constraints to a string that can be used in a CREATE TABLE statement.
The   buildCreate()   Build a CREATE TABLE query and return it as a string.
The   buildDrop()   Build a DROP TABLE query and return it as a string.
void   buildField()   Generate a string for a field, to be used inside a CREATE TABLE statement.
String   buildFields()   Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement.
void   buildPrimaryKey()   Generate a string that defines the primary key, for use inside the CREATE TABLE statement.
string   buildView()   Build CREATE VIEW query
string   calculateDecimalFieldSize()   Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals.
atkDDL   &create()   Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class.
boolean   createIndex()   Create an index
void   dropField()   Drop a field from the table definition.
boolean   dropIndex()   Drop an existing index
bool   dropSequence()   Drop sequence
string   dropView()   Build DROP VIEW query
true   executeAlter()   Build and execute ALTER TABLE queries.
true   executeCreate()   Build and execute the CREATE TABLE query.
true   executeCreateView()   Build and execute CREATE VIEW query
true   executeDrop()   Build and execute the DROP TABLE query.
true   executeDropView()   Build and execute DROP VIEW query
void   getGenericType()   Convert an database specific type to an ATK generic datatype.
string   getIndexName()   Get Indexname
void   getType()   Convert an ATK generic datatype to a database specific type.
void   loadMetaData()   Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.
true   needsQuotes()   Method to determine whether quotes are needed around the values for a given generic datatype.
true   needsSize()   Method to determine whether a given generic field type needs to have a size defined.
bool   renameSequence()   Rename sequence
bool   renameTable()   Rename table name
void   setTable()   Set the name of the table.
An   _buildConstraintsArray()   Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement.
void   _buildFieldsArray()   Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)

[ Top ]

Properties

mixed   $m_db [line 46]

[ Top ]
mixed   $m_fields = array() [line 42]

[ Top ]
string   $m_idxnameFormat = "%s_idx" [line 54]

Postfix for index names

API Tags:
Access:  protected


[ Top ]
mixed   $m_indexes = array() [line 44]

[ Top ]
mixed   $m_primarykey = array() [line 45]

[ Top ]
mixed   $m_remove_field [line 43]

[ Top ]
mixed   $m_table = array() [line 41]

[ Top ]

Methods

Constructor atkDDL  [line 61]

  atkDDL atkDDL( )

Default constructor



[ Top ]
addField  [line 116]

  void addField( string $name, string $generictype, [int $size = 0], [int $flags = 0], [mixed $default = NULL]  )

Add a field to the table definition.

Parameters:
string   $name:  The name of the field
string   $generictype:  The datatype of the field (should be one of the generic types supported by ATK).
int   $size:  The size of the field (if appropriate)
int   $flags:  The DDL_ flags for this field.
mixed   $default:  The default value to be used when inserting new rows.


[ Top ]
addFields  [line 169]

  void addFields( array $meta  )

Add multiple fields at once using the given metadata.

NOTE: defaults are not supported yet!

Parameters:
array   $meta:  The fields meta data.


[ Top ]
buildAlter  [line 267]

  An buildAlter( )

Build one or more ALTER TABLE queries and return them as an array of strings.

The default implementation assumes that multiple fields can be added with one single ALTER TABLE statement. If a database needs to be supported which doesn't have this ability, then an override for this function should be implemented in the appropriate atk<database>ddl class.


API Tags:
Return:  array of ALTER TABLE queries.


Redefined in descendants as:

[ Top ]
buildConstraints  [line 473]

  String buildConstraints( )

Convert all constraints to a string that can be used in a CREATE TABLE statement.


API Tags:
Return:  containing constraints to be used in a CREATE or ALTER TABLE statement


[ Top ]
buildCreate  [line 230]

  The buildCreate( )

Build a CREATE TABLE query and return it as a string.


API Tags:
Return:  CREATE TABLE query.


Redefined in descendants as:

[ Top ]
buildDrop  [line 308]

  The buildDrop( )

Build a DROP TABLE query and return it as a string.


API Tags:
Return:  DROP TABLE query.


[ Top ]
buildField  [line 334]

  void buildField( string $name, string $generictype, [int $size = 0], [int $flags = 0], [mixed $default = NULL]  )

Generate a string for a field, to be used inside a CREATE TABLE statement.

This function tries to be generic, so it will work in the largest number of databases. Databases that won't work with this syntax, should override this method in the database specific ddl class.

Parameters:
string   $name:  The name of the field
string   $generictype:  The datatype of the field (should be one of the generic types supported by ATK).
int   $size:  The size of the field (if appropriate)
int   $flags:  The DDL_ flags for this field.
mixed   $default:  The default value to be used when inserting new rows.


Redefined in descendants as:

[ Top ]
buildFields  [line 444]

  String buildFields( )

Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement.


API Tags:
Return:  containing fields to be used in a CREATE or ALTER TABLE statement


[ Top ]
buildPrimaryKey  [line 366]

  void buildPrimaryKey( [array $fieldlist = array()]  )

Generate a string that defines the primary key, for use inside the CREATE TABLE statement.

This function will be overrided by the database specific subclasses of atkDDL.

Parameters:
array   $fieldlist:  An array of fields that define the primary key.


[ Top ]
buildView  [line 593]

  string buildView( string $name, string $select, string $with_check_option  )

Build CREATE VIEW query

Parameters:
string   $name:  - name of view
string   $select:  - SQL SELECT statement
string   $with_check_option:  - use SQL WITH CHECK OPTION

API Tags:
Return:  CREATE VIEW query string


Redefined in descendants as:

[ Top ]
calculateDecimalFieldSize  [line 144]

  string calculateDecimalFieldSize( string $size  )

Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals.

Parameters:
string   $size:  Current size

API Tags:
Return:  New size


[ Top ]
create  [line 73]

  atkDDL &create( [String $database = NULL]  )

Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class.

Parameters:
String   $database:  The database driver to use

API Tags:
Return:  instance of db specific DDL driver


[ Top ]
createIndex  [line 649]

  boolean createIndex( string $name, array $definition  )

Create an index

Parameters:
string   $name:  Index name
array   $definition: 

associative array that defines properties of the index to be created.

example array('fields' => array('user_id' => array('sorting' => 'ascending' 'length' => 3 ), 'lastname' => array() ) )



[ Top ]
dropField  [line 157]

  void dropField( string $name  )

Drop a field from the table definition.

Parameters:
string   $name:  The name of the field


[ Top ]
dropIndex  [line 678]

  boolean dropIndex( string $name  )

Drop an existing index

Parameters:
string   $name:  Index name


[ Top ]
dropSequence  [line 715]

  bool dropSequence( string $name  )

Drop sequence

Parameters:
string   $name:  Sequence name


Redefined in descendants as:

[ Top ]
dropView  [line 628]

  string dropView( string $name  )

Build DROP VIEW query

Parameters:
string   $name:  - name of view

API Tags:
Return:  CREATE VIEW query string


Redefined in descendants as:

[ Top ]
executeAlter  [line 514]

  true executeAlter( )

Build and execute ALTER TABLE queries.

Note that more than one query might be performed, depending on the number of fields added, and the database capabilities (some databases are capable of adding several fields in one ALTER TABLE query, others aren't and need to perform multiple queries).


API Tags:
Return:  if the table was altered successfully false if anything went wrong, or if no table could be altered.


[ Top ]
executeCreate  [line 487]

  true executeCreate( )

Build and execute the CREATE TABLE query.


API Tags:
Return:  if the table was created successfully false if anything went wrong, or if no table could be created.


[ Top ]
executeCreateView  [line 569]

  true executeCreateView( string $name, string $select, string $with_check_option  )

Build and execute CREATE VIEW query

Parameters:
string   $name:  - name of view
string   $select:  - SQL SELECT statement
string   $with_check_option:  - use SQL WITH CHECK OPTION

API Tags:
Return:  if view create successfully false if error take place


[ Top ]
executeDrop  [line 544]

  true executeDrop( )

Build and execute the DROP TABLE query.


API Tags:
Return:  if the table was dropped successfully false if anything went wrong, or if no table could be dropped.


[ Top ]
executeDropView  [line 606]

  true executeDropView( string $name  )

Build and execute DROP VIEW query

Parameters:
string   $name:  - name of view

API Tags:
Return:  if view create successfully false if error take place


[ Top ]
getGenericType  [line 210]

  void getGenericType( string $type  )

Convert an database specific type to an ATK generic datatype.

This function will be overrided by the database specific subclasses of atkDb.

Parameters:
string   $type:  The database specific datatype to convert.

API Tags:
Abstract:  


Redefined in descendants as:

[ Top ]
getIndexName  [line 692]

  string getIndexName( string $name  )

Get Indexname

Parameters:
string   $name:  Indexname


[ Top ]
getType  [line 196]

  void getType( string $generictype  )

Convert an ATK generic datatype to a database specific type.

This function will be overrided by the database specific subclasses of atkDb. Note: in all derived subclasses, the following types *must* be supported: number, decimal, string, date, text, datetime, time, boolean. If the database does not have a proper field type, consider using a varchar or number to store the value.

Parameters:
string   $generictype:  The datatype to convert.

API Tags:
Abstract:  


Redefined in descendants as:

[ Top ]
loadMetaData  [line 99]

  void loadMetaData( array $tablemeta  )

Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

Parameters:
array   $tablemeta:  table meta data array


Redefined in descendants as:
  • atkDb2DDL::loadMetaData() : Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.
  • atkMysqlDDL::loadMetaData() : Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

[ Top ]
needsQuotes  [line 384]

  true needsQuotes( string $generictype  )

Method to determine whether quotes are needed around the values for a given generic datatype.

Parameters:
string   $generictype:  The type of field.

API Tags:
Return:  if quotes should be put around values for the given type of field. false if quotes should not be used.


Redefined in descendants as:

[ Top ]
needsSize  [line 397]

  true needsSize( string $generictype  )

Method to determine whether a given generic field type needs to have a size defined.

Parameters:
string   $generictype:  The type of field.

API Tags:
Return:  if a size should be specified for the given field type. false if a size does not have to be specified.


Redefined in descendants as:

[ Top ]
renameSequence  [line 704]

  bool renameSequence( string $name, string $new_name  )

Rename sequence

Parameters:
string   $name:  The current sequence name
string   $new_name:  The new sequence name


Redefined in descendants as:

[ Top ]
renameTable  [line 727]

  bool renameTable( string $name, string $new_name  )

Rename table name

Parameters:
string   $name:  Table name
string   $new_name:  New table name


Redefined in descendants as:

[ Top ]
setTable  [line 220]

  void setTable( string $tablename  )

Set the name of the table.

Parameters:
string   $tablename:  The name of the table


[ Top ]
_buildConstraintsArray  [line 459]

  An _buildConstraintsArray( )

Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement.


API Tags:
Return:  array of constraints
Access:  private


[ Top ]
_buildFieldsArray  [line 423]

  void _buildFieldsArray( )

Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)


API Tags:
Access:  private


[ Top ]
Home | About | Contact