get_table_comment

　 get_table_comment( [string $table_name] )

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

パラメータ

$table_name

文字列としてテーブルコメントを取得したいテーブル名 table_name を指定します。
table_name の指定がない場合は、CDBT管理コンソールで現在選択されているテーブルが指定されます。

返り値

array( bool, string )
テーブルコメントの文字列を含む配列を返します。第1要素に処理結果を示す Boolean 値が入ります。テーブルコメントが正常に取得された場合は TRUE 、テーブルコメントが未定義だったりテーブルが存在しなかった場合は FALSE が入ります。第2要素には、正常処理時にはテーブルコメントの文字列が返り、それ以外の時は処理ステータスのメッセージ文字列が入ります。

変更履歴

バージョン 内容
1.0.0 –

使用例

<?php
global $cdbt;
$table_name = "prefix_tablename";
$result = $cdbt->get_table_comment($table_name);
if ($result[0]) {
    echo "This table is {$result[1]}.";
}