Skip to main content

Drupal: Custom module installation - hook_install() confusion

In Drupal, every module uses at least two files.
  • The .info file
  • The .module file
If you are developing a custom module, you might also need a .install file, if you want to create or alter tables in database. Most modules use just one table so it will be difficult to understand what is wrong, in case you do what I did. Drupal has its own functions for database management. In no way mysql or pgsql functions must be used in a module. Drupal functions are everything you might need. Even if you find a function you need that only exists in mysql, try to create a port using drupal functions and php. It's the Drupal way and it is something you might benefit from later. A .install file uses at least three(3) functions.
  1. hook_schema()
  2. hook_install
  3. hook_uninstall
It's absolutely certain that creating the schema array won't be something difficult. Drupal core modules are more than great examples for this. In contrast to the words above, hook_install() and hook_uninstall can be sometimes confusing. Let's take a case where you need two tables and your module is named example. The first table will be named example1 and the other example2. If you needed to create a mysql table you would possibly write:
$sql = "CREATE TABLE example1(id INT,...,...)";
mysql_query($sql) or die(mysql_error());
$sql = "CREATE TABLE example2(id INT,...,...)";
mysql_query($sql) or die(mysql_error());
I mean that since you have two tables to create, you will, most possibly, use two queries. I suppose the same goes for pgsql too. But not in Drupal. If you try to call drupal_install_schema('example1') or drupal_install_schema('example2') in hook_install all you will get(if you are lucky) is an error and it won't be very easy to discover what's really going on. The only thing sure is that no tables will be created in database. No! No need to start checking backward your changes to the .install file step by step! The solution is simple. drupal_install_schema() accepts as argument the name of the module and not the name we may want each table to have. To conclude:
CORRECTFALSE
/*
 * Implements hook_install()
 */
function example_install(){
  drupal_install_schema('example');
}
/*
 * Implements hook_install()
 */
function example_install(){
  drupal_install_schema('example1');
  drupal_install_schema('example2');
}

Comments

Popular posts from this blog

Configure drupal_http_request() on the fly

The drupal_http_request() function supports connections using a proxy. You can configure a global proxy to use for all drupal_http_request() callbacks from the settings.php file of your website/installation by filling the following lines with the proper information:For those of you preferring a UI, then HTTP proxy module is for you.But what if you only want to use a proxy in some cases; like a custom module? In that case you will need the following function(modify accordingly):Now all you have to do is Call <?php _MYMODULE_change_proxy(); ?>.Do your drupal_http_request() calls.Call <?php _MYMODULE_change_proxy(TRUE); ?> to reset your previous settings.

Drupal: Allow registrations through Invite or Referral modules only

The Invite module provides invitations from existing users to their contacts. The Referral module, in contrary, creates a special URL for each existing user, which can be found in each user's profile, and allows new user registration. Even though, these two modules seem to provide the same functionality, they don't (and they shouldn't). Invite module, provides a mechanism for a site administrator to limit new registrations to "Invitations only". Referral module doesn't provide any of this functionality. Some users have requested the Invite module and Referral module to join in one module. Until now, there isn't anything to that direction. Wouldn't it be great though if there was a solution to limit drupal registration to referral or invitation only? Copy the functions below to a refinvite.module file in your sites→all→modules→refinvite folder and enable the module. Then go to http://<your-address-here>/admin/user/settings and enable the new …

Send mass email to certain users using VBO

Views Bulk Operations uses the built-in actions to act upon nodes, users, entities etc. Among these actions is our ability to send emails to users. If you try to use this action though you will encounter a small but serious problem. You are asked for an email address to send your message. You might say "but I have selected the users I want this message to reach. Why should I input an address again?". Don't get overwhelmed. What this field expects is not an address but a token. Specially this token [user-email]. If the website is intended for you, then you might say that's not such a problem to write this token down again and again. But if the manager of the website is bound to be the client or if you just want to spend less time writing things down, you might prefer to use a custom hook_form_alter() callback to set a default value. It could be done in both theme and module environment so suit yourself. Just add the following in your module or theme.