get_table_comment

(CDBT 2.0.0)

get_table_commentテーブルのコメントを取得します

Description

string get_table_comment ( string $table_name )
指定されたテーブルのコメントを取得して文字列として返します。

このメソッドはget_table_status()のラッパーで、内部でget_table_status( $table_name, "Comment" )が呼ばれます。

Parameters

table_name
コメントを取得したいテーブル名。

Return

指定したテーブルのコメントの文字列を返します。テーブルにコメントが未定義だった場合はNULLが返ります。

History

バージョン 内容
2.0.0 CDBT v1の同名メソッドをリファクタリング

Example

<?php
global $cdbt;
$table_name = "prefix_table";
if ( $table_comment = $cdbt->get_table_comment( $table_name ) ) {
    print_r( $table_comment );
}