• Главная
• Gdn_DatabaseStructure

PHP Класс Gdn_DatabaseStructure, vanilla

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$CaptureOnly		Whether or not to only capture the sql, rather than execute it. When this property is true then a property called CapturedSql will be added to this class which is an array of all the Sql statements.
$Database		The instance of the database singleton.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_CharacterEncoding		The character encoding to set as default for the table being created.
$_Columns	array
$_DatabasePrefix	string
$_ExistingColumns		The existing columns in the database.
$_TableExists		Whether or not this table exists in the database.
$_TableName		The name of the table to create or modify.
$_TableStorageEngine		The name of the storage engine for this table.

Открытые методы

Метод	Описание
__construct ( string $Database = null )	The constructor for this class. Automatically fills $this->ClassName.
column ( string $Name, mixed $Type, boolean $NullDefault = false, string $KeyType = false )	Defines a column to be added to $this->Table().
columnExists ( string $ColumnName ) : boolean	Returns whether or not a column exists in the database.
columnTypeString ( mixed $Column ) : string	Return the definition string for a column.
columns ( $Name = '' ) : array	An associative array of $ColumnName => $ColumnProperties columns for the table.
databasePrefix ( string $DatabasePrefix = '' )	Gets and/or sets the database prefix.
drop ( )	Drops $this->Table() from the database.
dropColumn ( string $Name )	Drops $Name column from $this->Table().
engine ( $Engine, boolean $CheckAvailability = true )
existingColumns ( ) : array	Gets the column definitions for the columns in the database.
get ( string $TableName = '' ) : Gdn_DatabaseStructure	Load the schema for this table from the database.
getAlterTableThreshold ( ) : integer	Get the alter table threshold.
getIssues ( ) : array	Get a list of issues that occurred during the last call to {@link Gdn_DatabaseStructure::set()}.
getRowCountEstimate ( string $tableName ) : integer | null	Get the estimated number of rows in a table.
primaryKey ( string $Name, string $Type = 'int' ) : Gdn_DatabaseStructure	Defines a primary key column on a table.
query ( string $sql, boolean $checkTreshold = false ) : Gdn_Dataset	Send a query to the database and return the result.
renameColumn ( string $OldName, string $NewName )	Renames a column in $this->Table().
renameTable ( string $OldName, string $NewName, boolean $UsePrefix = false )	Renames a table in the database.
reset ( ) : Gdn_DatabaseStructure	Reset the internal state of this object so that it can be reused.
set ( boolean $Explicit = false, boolean $Drop = false )	Creates the table and columns specified with $this->Table() and $this->Column(). If no table or columns have been specified, this method will throw a fatal error.
setAlterTableThreshold ( integer $alterTableThreshold ) : Gdn_MySQLStructure	Set the alterTableThreshold.
table ( string $Name = '', string $CharacterEncoding = '' )	Specifies the name of the table to create or modify.
tableExists ( $TableName = null ) : boolean	Whether or not the table exists in the database.
tableName ( ) : string	Returns the name of the table being defined in this object.
types ( string $Class = 'all' )	Gets an array of type names allowed in the structure.
view ( string $Name, string $Query )	Specifies the name of the view to create or modify.

Защищенные методы

Метод	Описание
_create ( )	Creates the table defined with $this->Table() and $this->Column().
_createColumn ( $Name, $Type, $Null, $Default, $KeyType ) : stdClass
_modify ( boolean $Explicit = false )	Modifies $this->Table() with the columns specified with $this->Column().
addIssue ( string $message, string $sql ) : Gdn_DatabaseStructure	Add an issue to the issues list.
executeQuery ( string $sql, boolean $checkThreshold = false ) : boolean	Send a query to the database and return the result.

Описание методов

Описание свойств