• Home
• MetaModels
• Helper
• TableManipulation

PHP Class MetaModels\Helper\TableManipulation

Show file Open project: metamodels/core Class Usage Examples

Protected Properties

Property	Type	Description
$reservedWords	string[]	List of reserved MySQL identifiers.
$systemColumns	string[]	When you alter this, ensure to also change @link{TableManipulation::STATEMENT_CREATE_TABLE} above.

Public Methods

Method	Description
addIndex ( string $strTableName, string $strIndexType, string $strColName ) : void	Add a index to given tablename for specified columnname
checkColumnDoesNotExist ( string $strTableName, string $strColName, boolean $blnAllowSystemCol = false ) : void	Checks whether the given column does not exist.
checkColumnExists ( string $strTableName, string $strColName, boolean $blnAllowSystemCol = false ) : void	Checks whether the given table exists.
checkColumnName ( string $strColName, boolean $blnAllowSystemCol = false ) : void	Checks whether the column with the given name is not a MetaModel system column and is a valid column name.
checkTableDoesNotExist ( string $strTableName ) : void	Ensures that the given table does not exist.
checkTableExists ( string $strTableName ) : void	Checks whether the given table exists.
checkTablename ( string $strTableName ) : void	Checks whether the given table name is valid.
createColumn ( string $strTableName, string $strColumnName, string $strType, boolean $blnAllowSystemCol = false ) : void	Add a column to a table.
createTable ( string $strTableName ) : void	Creates a table with the given name.
deleteTable ( string $strTableName ) : void	Deletes the table with the given name.
dropColumn ( string $strTableName, string $strColumnName, boolean $blnAllowSystemCol = false ) : void	Delete a column from a table.
isReservedWord ( string $word ) : boolean	Test if the given word is a reserved MySQL word.
isSystemColumn ( string $strColName ) : boolean	Checks whether the column with the given name is a MetaModel system column.
isValidColumnName ( string $strColName ) : boolean	Checks whether the column with the given name is a MetaModel system column.
isValidMySQLIdentifier ( string $strName ) : boolean	Ensure that an identifier is valid in MySQL context.
isValidTablename ( string $strTableName ) : boolean	Checks whether the given table name is valid.
renameColumn ( string $strTableName, string $strColumnName, string $strNewColumnName, string $strNewType, boolean $blnAllowSystemCol = false ) : void	Rename a column and/or change it's type in a table.
renameTable ( string $strTableName, string $strNewTableName ) : void	Renames a table with the given name to the given new name.
setVariantSupport ( string $strTableName, boolean $blnVariantSupport ) : void	Enables or disables Variant support on a certain MetaModel table.

Protected Methods

Method	Description
getDB ( ) : Database	Returns the Contao database instance to use.

Method Details

Property Details