• Главная
• PMA
• libraries
• Table

PHP Класс PMA\libraries\Table

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

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

Свойство	Тип	Описание
$engine		engine (innodb, myisam, bdb, ...)
$errors		errors occurred
$messages		messages
$type		type (view, base table, system view)
$uiprefs		UI preferences

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

Свойство	Тип	Описание
$_db_name		database name
$_dbi	DatabaseInterface
$_name		table name

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

Метод	Описание
__construct ( string $table_name, string $db_name, DatabaseInterface $dbi = null )	Constructor
__toString ( ) : string	returns table name
checkIfMinRecordsExist ( integer $min_records ) : boolean	Checks if the number of records in a table is at least equal to $min_records
countRecords ( boolean $force_exact = false ) : mixed	Counts and returns (or displays) the number of records in a table
duplicateInfo ( string $work, string $pma_table, array $get_fields, array $where_fields, array $new_fields ) : integer | boolean	Inserts existing entries in a PMA_* table by reading a value from an old entry
generateAlter ( string $oldcol, string $newcol, string $type, string $length, string $attribute, string $collation, boolean | string $null, string $default_type, string $default_value, string $extra, string $comment, string $virtuality, string $expression, string $move_to ) : string	Generates column specification for ALTER syntax
generateFieldSpec ( string $name, string $type, string $length = '', string $attribute = '', string $collation = '', boolean | string $null = false, string $default_type = 'USER_DEFINED', string $default_value = '', string $extra = '', string $comment = '', string $virtuality = '', string $expression = '', string $move_to = '' ) : string	generates column specification for ALTER or CREATE TABLE syntax
getColumnGenerationExpression ( string $column = null ) : array | boolean	Returns the generation expression for virtual columns
getColumns ( boolean $backquoted = true, boolean $fullName = true ) : array	Get all columns
getColumnsMeta ( ) : mixed	Get meta info for fields in table
getColumnsWithIndex ( integer $types ) : array	Get columns with indexes
getDbName ( boolean $backquoted = false ) : string	returns database name for this table
getFullName ( boolean $backquoted = false ) : string	returns full name for table, including database name
getIndex ( string $index ) : Index	Get index with index name
getIndexedColumns ( boolean $backquoted = true, boolean $fullName = true ) : array	Get all indexed columns
getLastError ( ) : string	return the last error
getLastMessage ( ) : string	return the last message
getName ( boolean $backquoted = false ) : string	returns table name
getNameAndTypeOfTheColumns ( ) : array	Function to get the name and type of the columns of a table
getNonGeneratedColumns ( boolean $backquoted = true ) : array	Get non-generated columns in table
getRealRowCountTable ( ) : number	Returns the real row count for a table
getReservedColumnNames ( ) : array	Get all column names which are MySQL reserved words
getSqlQueryForIndexCreateOrEdit ( Index $index, &$error ) : string	Function to get the sql query for index creation or edit
getStatusInfo ( string $info = null, boolean $force_read = false, boolean $disable_error = false ) : mixed	Returns full table status info, or specific if $info provided this info is collected from information_schema
getUiProp ( string $property ) : mixed	Get a property from UI preferences.
getUniqueColumns ( boolean $backquoted = true, boolean $fullName = true ) : array	Get all unique columns
isEngine ( $engine ) : boolean	Checks the storage engine used to create table
isMerge ( ) : boolean	Checks if this is a merge table
isUpdatableView ( ) : boolean	Returns whether the table is actually an updatable view
isValidName ( string $table_name, boolean $is_backquoted = false ) : boolean	checks if given name is a valid table name, currently if not empty, trailing spaces, '.', '/' and '\'
isView ( ) : boolean	returns whether the table is actually a view
moveCopy ( string $source_db, string $source_table, string $target_db, string $target_table, string $what, boolean $move, string $mode ) : boolean	Copies or renames table
removeUiProp ( string $property ) : true | Message	Remove a property from UI preferences.
rename ( string $new_name, string $new_db = null ) : boolean	renames table
setUiProp ( string $property, mixed $value, string $table_create_time = null ) : boolean | Message	Set a property from UI preferences.
showCreate ( ) : mixed	Returns the CREATE statement for this table
updateDisplayField ( string $disp, string $display_field, array $cfgRelation ) : boolean	Function to handle update for display field
updateForeignKeys ( array $destination_foreign_db, array $multi_edit_columns_name, array $destination_foreign_table, array $destination_foreign_column, array $options_array, string $table, array $existrel_foreign ) : array	Function to handle foreign key updates
updateInternalRelations ( array $multi_edit_columns_name, array $destination_db, array $destination_table, array $destination_column, array $cfgRelation, array | null $existrel ) : boolean	Function to get update query for updating internal relations

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

Метод	Описание
getUiPrefsFromDb ( ) : array	Return UI preferences for this table from phpMyAdmin database.
loadUiPrefs ( ) : void	Loads the UI preferences for this table.
saveUiPrefsToDb ( ) : true | Message	Save this table's UI preferences into phpMyAdmin database.

Приватные методы

Метод	Описание
_formatColumns ( array $indexed, boolean $backquoted, boolean $fullName ) : array	Formats lists of columns
_getSQLToCreateForeignKey ( string $table, array $field, string $foreignDb, string $foreignTable, array $foreignField, string $name = null, string $onDelete = null, string $onUpdate = null ) : string	Returns the SQL query for foreign key constraint creation

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

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