fook_install()を使用して、データベーステーブルにデフォルト値を追加するにはどうすればよいですか?
-
16-10-2019 - |
質問
いくつかのテーブルの独自のスキーマを備えたカスタムモジュールを作成しています。これらのテーブルには、モジュールが動作するためにいくつかの値がそれらに事前に入力される必要があります(デフォルトの場所、選択オプションなど)。
fook_install中にこれらのテーブルにデフォルト値を挿入するためのベストプラクティスの方法は何ですか?
drupal_write_recordは利用できないため、db_queryを使用できますが、そうすることで基本的なルールを破らないようにしたいだけです。
解決
より良い方法は、内部でそれを行うことです hook_enable();フックが呼び出されたときに、モジュールはすでにインストールされており、そのデータベースのスキーマはDrupalで利用可能です。 drupal_write_record()
. 。モジュールがインストールされたときだけでなく、フックが常に呼び出されると、モジュールが有効になっているため、フックの実装は、これらのデータベースの行がまだ追加されていないかどうかを確認する必要があります(たとえば、ブール値を含むDrupal変数を使用する必要があります) 。
使用するモジュールの例として hook_enable()
同様の目的のために、確認できます forum_enable(), 、 また php_enable() (「PHPコード」入力形式を追加します)。
function php_enable() {
$format_exists = (bool) db_query_range('SELECT 1 FROM {filter_format} WHERE name = :name', 0, 1, array(':name' => 'PHP code'))->fetchField();
// Add a PHP code text format, if it does not exist. Do this only for the
// first install (or if the format has been manually deleted) as there is no
// reliable method to identify the format in an uninstall hook or in
// subsequent clean installs.
if (!$format_exists) {
$php_format = array(
'format' => 'php_code',
'name' => 'PHP code',
// 'Plain text' format is installed with a weight of 10 by default. Use a
// higher weight here to ensure that this format will not be the default
// format for anyone.
'weight' => 11,
'filters' => array(
// Enable the PHP evaluator filter.
'php_code' => array(
'weight' => 0,
'status' => 1,
),
),
);
$php_format = (object) $php_format;
filter_format_save($php_format);
drupal_set_message(t('A <a href="@php-code">PHP code</a> text format has been created.', array('@php-code' => url('admin/config/content/formats/' . $php_format->format))));
}
}
これらのフックの実装から示されているように、コードは必然的にフックが実行されるまで実行する必要があります。また、データベースに追加されたデフォルト値をユーザーから変更できない場合、それらの値を変更/削除するユーザーインターフェイスを持っていない場合、1回実行する必要があるコードである可能性があります。
他のヒント
一緒に行きます db_query
/ db_insert
(d6 / d7)fook_install()。
それは悪い習慣とは見なされていません(そして誰もあなたに使用を強制していません drupal_write_record()
).
人々がモジュールを無効にして再度に再び可能にすることは珍しくありません、そしてその場合、あなたのコードは hook_enable()
毎回発砲します。それは良くありません。