Come faccio ad aggiungere valori predefiniti a una tabella di database usando hook_install ()?


9

Sto creando un modulo personalizzato con il suo schema di alcune tabelle. Queste tabelle devono contenere alcuni valori precompilati affinché il modulo funzioni (posizioni predefinite, opzioni di selezione, ecc.).

Qual è il modo migliore per inserire valori predefiniti in queste tabelle durante hook_install?

Poiché drupal_write_record non è disponibile, posso usare db_query, ma voglio solo assicurarmi di non infrangere alcuna regola cardinale.

Risposte:


7

Il modo migliore è farlo all'interno di hook_enable () ; al momento del richiamo dell'hook, il modulo è già installato e lo schema del suo database è disponibile per Drupal e per drupal_write_record(). Dato che l'hook viene invocato tutte le volte che un modulo è abilitato, e non solo quando il modulo è installato, l'implementazione dell'hook dovrebbe verificare se non ha già aggiunto quelle righe del database (ad esempio, dovrebbe usare una variabile Drupal contenente un valore booleano) .

Come esempio di modulo che utilizza hook_enable()per uno scopo simile, puoi controllare forum_enable () o php_enable () (che aggiunge il formato di input "Codice 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))));
  }
}

Come mostrato da queste implementazioni di hook, potrebbe essere necessario eseguire il codice ogni volta che viene eseguito l'hook; potrebbe anche essere che il codice debba essere eseguito una sola volta, poiché nel caso in cui i valori predefiniti aggiunti al database non possano essere modificati dall'utente, che non ha un'interfaccia utente per alterare / eliminare tali valori.


Se lo facessi in hook_enable (), ciò significa che i valori predefiniti sarebbero ripristinati ogni volta che il modulo è abilitato e disabilitato. Penso che sia abbastanza comune, al contrario di completamente disinstallare e reinstallare (a quel punto si prevede che il database venga ripristinato).
arance13

1
Questo è il motivo per cui ho scritto: "L'implementazione hook deve verificare se non ha già aggiunto quelle righe del database". Ciò significa che dovrebbe verificare se i valori sono già nella tabella del database o utilizzare una variabile Drupal per verificare se ha già svolto tale attività. Il controllo della tabella del database verrebbe eseguito se tali valori devono necessariamente essere presenti nel database; ad esempio, questo è il caso se i valori sono richiesti dal modulo e gli utenti non sono autorizzati a rimuovere i valori predefiniti.
kiamlaluno

Grazie per il chiarimento. C'è qualche differenza nella memorizzazione di questi valori nella mia tabella personalizzata rispetto al solo utilizzo di variabile_set per memorizzarli in una variabile persistente? È solo una matrice di valori per caselle di selezione personalizzate.
arance13

Tutti i valori impostati utilizzando variable_set(), che non vengono eliminati con variable_del(), vengono caricati in memoria quando Bootstrap Drupal e salvati in una variabile globale; questo significa che sono in memoria qualunque sia il modulo che sta usando quei valori o no. Utilizzando una tabella di database personalizzata, puoi essere sicuro che quei valori vengano caricati solo quando il modulo ne ha davvero bisogno. Non utilizzare variable_set()se la variabile Drupal contiene un array a cui si continua ad aggiungere un nuovo indice di array in qualsiasi momento, ad esempio.
kiamlaluno

Guardando il codice (D7). Vedo solo 2 righe di codice tra l'invocazione di hook_install e hook_enable: un aggiornamento a una variabile locale e una chiamata al watchdog. Quindi, durante un'installazione reale, non c'è alcuna differenza tra questi 2 hook su ciò che è disponibile e registrato e cosa no. L'unica differenza è se si tratta della prima installazione o della riattivazione del modulo.
fietserwin,

4

Andrei con db_query/ db_insert(D6 / D7) in hook_install ().

Non è considerata una cattiva pratica (e nessuno ti costringe mai ad usare drupal_write_record()).

Non è raro che le persone disabilitino e riattivano i moduli, e in quel caso il tuo codice hook_enable()entrerebbe in funzione ogni volta. che non è carino.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.