web-dev-qa-db-ja.com

hook_install（）を使用してデータベーステーブルにデフォルト値を追加するにはどうすればよいですか？

いくつかのテーブルの独自のスキーマを持つカスタムモジュールを作成しています。モジュールが機能するためには、これらのテーブルにいくつかの値が事前に入力されている必要があります（デフォルトの場所、オプションの選択など）。

Hook_install中にこれらのテーブルにデフォルト値を挿入するためのベストプラクティスの方法は何ですか？

Drupal_write_recordが利用できないため、db_queryを使用できますが、そうすることで基本的なルールに違反しないことを確認したいだけです。

databaseinstalling
9
oranges13

より良い方法は、内部で行うことです 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回実行するだけで十分な場合もあります。

7
kiamlaluno

私は、hook_install（）でdb_query/db_insert（D6/D7）を使用します。

これは悪い習慣とは見なされていません（そして、drupal_write_record()を使用するように強制されている人はいません）。

モジュールを無効にしてから再度有効にするのは珍しいことではありません。その場合、hook_enable()のコードは毎回実行されます。ニースではありません。

4
Bojan Zivanovic