Code driven development: using Features effectively in Drupal 6 and 7
18 likes7,188 views
This document discusses using code-driven development with features in Drupal 6 and 7. Key points include: - Storing configuration and content in code via features allows for version control and easier deployment to production. - A "controller feature" can be used to manage other features and site-wide configuration through hook updates and installation tasks. - Features follow code conventions like logical namespaces to organize functionality. - In Drupal 7, installation profiles are like modules and use similar hooks to manage updates and configuration.
![feature_news.info
core = "6.x"
dependencies[] = "context"
dependencies[] = "features"
dependencies[] = "imagecache"
dependencies[] = "imagefield"
description = "Publish news."
features[content][] = "news-field_news_image"
features[context][] = "feature_news_list"
features[ctools][] = "context:context:3"
features[ctools][] = "strongarm:strongarm:1"
features[imagecache][] = "news-badge"
features[imagecache][] = "news-m"
features[imagecache][] = "news-s"
features[node][] = "news"
...
name = "Feature News"
package = "Features"
project = "feature_news"
version = "6.x-1.0-dev"](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-11-320.jpg)
![project.make
core = "6.x"
; Contrib
projects[features][version] = "1.0"
projects[features][subdir] = "contrib"
projects[views][version] = "2.11"
projects[views][subdir] = "contrib"
projects[inline][version] = "1.0"
projects[inline][subdir] = "contrib"
...](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-17-320.jpg)
![hook_update_N()
/**
* Enabling Rules module
*/
function feature_controller_update_6001() {
$return = array();
$modules = array('rules');
drupal_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enabling Rules module');
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-24-320.jpg)
![hook_update_N()
/**
* Removing contributor role
*/
function feature_controller_update_6002() {
$return = array();
$role_name = 'contributor';
$result = db_query("SELECT rid FROM {role} WHERE name='%s'", $role_name);
while ($role = db_fetch_object($result)) {
$rid = $role->rid;
$return[] = update_sql("DELETE FROM {role} WHERE rid = '$rid'");
$return[] = update_sql("DELETE FROM {users_roles} WHERE rid = '$rid'");
}
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-27-320.jpg)
![hook_update_N()
/**
* Adding Nuvole OpenID to admin account
*/
function feature_controller_update_6003() {
$return = array();
$uid = 1;
$claimed_id = 'http://admin.myopenid.com/';
$return[] = update_sql("DELETE FROM {authmap} WHERE authname = '$claimed_id'");
$return[] = update_sql("INSERT INTO {authmap}(uid, authname, module)
VALUES($uid, '$claimed_id', 'openid')");
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-30-320.jpg)
![project.make
...
projects[inline][type] = "module"
projects[inline][download][type] = "cvs"
projects[inline][download][module] = "contributions/modules/inline"
projects[inline][download][revision] = "HEAD:2010-03-06"
projects[inline][subdir] = "contrib"
...
;
; Patches
;
projects[inline][patch][] = "http://drupal.org/files/issues/inline.patch"](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-31-320.jpg)
![hook_install()
/**
* Implementation of hook_install()
*/
function feature_controller_install() {
$return = array();
$modules = array('rules');
drupal_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enable Rules module.');
$uid = 1;
$claimed_id = 'http://nuvole.myopenid.com/';
$return[] = update_sql("INSERT INTO {authmap}(uid, authname, module)
VALUES($uid, '$claimed_id', 'openid')");
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-36-320.jpg)
![hook_update_N()
/**
* Enabling News feature
*/
function feature_controller_update_6004() {
$return = array();
$modules = array('feature_news');
features_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enabling News');
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-39-320.jpg)
![/**
* Implementation of hook_install()
*/
function feature_controller_install() {
$return = array();
$modules = array('rules');
drupal_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enable Rules module.');
$uid = 1;
$claimed_id = 'http://nuvole.myopenid.com/';
$return[] = update_sql("INSERT INTO {authmap}(uid, authname, module)
VALUES($uid, '$claimed_id', 'openid')");
$modules = array('feature_news');
features_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enabling News');
return $return;
}
feature_controller.install](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-40-320.jpg)
![project.info
name = Project
description = Project Description.
core = 7.x
dependencies[] = "context"
dependencies[] = "features"
dependencies[] = "feature_controller"
...
files[] = project.profile](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-50-320.jpg)
![project.install
/**
* Enabling Rules module
*/
function project_update_6001() {
$return = array();
$modules = array('rules');
drupal_install_modules($modules);
$return[] = array('success' => TRUE, 'query' => 'Enabling Rules module');
return $return;
}
/**
* Removing contributor role
*/
function project_update_6002() {
$return = array();
$role_name = 'contributor';
$result = db_query("SELECT rid FROM {role} WHERE name='%s'", $role_name);
while ($role = db_fetch_object($result)) {
$rid = $role->rid;
$return[] = update_sql("DELETE FROM {role} WHERE rid = '$rid'");
$return[] = update_sql("DELETE FROM {users_roles} WHERE rid = '$rid'");
}
return $return;
}](https://image.slidesharecdn.com/drupaldevdayscdd-110206080718-phpapp02/85/Code-driven-development-using-Features-effectively-in-Drupal-6-and-7-51-320.jpg)
Code driven development: using Features effectively in Drupal 6 and 7
- 1. Code-driven Development: Using Features Effectively in D6 and D7 Antonio De Marco Andrea Pescetti [email protected] [email protected]
- 2. Code Settings Content Filesystem Database
- 3. Code Content Settings Filesystem Database
- 4. How can multiple developers work together on the same project?
- 7. Major drawbacks • Not ideal for a distributed team • Makes it difficult to push settings to production • Content and settings are mixed in one db dump • Easy to lose control
- 8. Put everything in code
- 9. Major benefits • Code can be versioned • Conflicts can be solved • Content and settings are separated • Easy to push changes to production
- 10. Features: storing configuration in code
- 11. feature_news.info core = "6.x" dependencies[] = "context" dependencies[] = "features" dependencies[] = "imagecache" dependencies[] = "imagefield" description = "Publish news." features[content][] = "news-field_news_image" features[context][] = "feature_news_list" features[ctools][] = "context:context:3" features[ctools][] = "strongarm:strongarm:1" features[imagecache][] = "news-badge" features[imagecache][] = "news-m" features[imagecache][] = "news-s" features[node][] = "news" ... name = "Feature News" package = "Features" project = "feature_news" version = "6.x-1.0-dev"
- 12. From DB to code and vice versa $ # Dump your changes into code. $ drush features-update feature_name $ # Restore your changes into the db. $ drush features-revert feature_name
- 13. Want to add a component to a feature? 1. add it to the .info file 2. $ drush features-update feature_name
- 14. Want to remove a component from a feature? 1. remove it from the .info file 2. $ drush features-update feature_name
- 17. project.make core = "6.x" ; Contrib projects[features][version] = "1.0" projects[features][subdir] = "contrib" projects[views][version] = "2.11" projects[views][subdir] = "contrib" projects[inline][version] = "1.0" projects[inline][subdir] = "contrib" ...
- 18. project.profile /** * Implementation of hook_profile_details(). */ function project_profile_details() { return array( 'name' => 'Project', 'description' => 'Project Description’, ); } /** * Implementation of hook_profile_modules(). */ function project_profile_modules() { $modules = array( 'cck', 'views', 'features', 'feature_controller', ...
- 19. Use the controller feature to keep track of development Enable/disable other features, store sitewide configuration, share changes, etc...
- 21. Controller Feature Workflow Developer A Time Developer B Time Start: both Developers run installation, Controller Feature is enabled.
- 22. Controller Feature Workflow Developer A Time Developer B Time Developer A enables Rules module, Developer B does other work on the project.
- 23. Features are modules. Modules can be updated via hook_update_N()
- 24. hook_update_N() /** * Enabling Rules module */ function feature_controller_update_6001() { $return = array(); $modules = array('rules'); drupal_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enabling Rules module'); return $return; } feature_controller.install
- 25. Controller Feature Workflow 6001 Developer A Time Developer B Time DevA$ svn ci -m “Enable Rules module.” Developer A commits his changes.
- 26. Controller Feature Workflow 6001 Developer A Time Developer B Time DevB$ svn up && dr updatedb -y && dr cc all Developer B updates his local copy and wants to remove a user role.
- 27. hook_update_N() /** * Removing contributor role */ function feature_controller_update_6002() { $return = array(); $role_name = 'contributor'; $result = db_query("SELECT rid FROM {role} WHERE name='%s'", $role_name); while ($role = db_fetch_object($result)) { $rid = $role->rid; $return[] = update_sql("DELETE FROM {role} WHERE rid = '$rid'"); $return[] = update_sql("DELETE FROM {users_roles} WHERE rid = '$rid'"); } return $return; } feature_controller.install
- 28. Controller Feature Workflow 6001 Developer A Time Developer B 6002 Time DevB$ svn ci -m “Removed contributor role.” Developer B commits his changes.
- 29. Controller Feature Workflow 6001 Developer A Time Developer B 6002 Time Click. Click. Click. DevB$ patch -p0 < inline.patch Click. Click. Click. Developer B adds an OpenID account for admin and patches the Inline module.
- 30. hook_update_N() /** * Adding Nuvole OpenID to admin account */ function feature_controller_update_6003() { $return = array(); $uid = 1; $claimed_id = 'http://admin.myopenid.com/'; $return[] = update_sql("DELETE FROM {authmap} WHERE authname = '$claimed_id'"); $return[] = update_sql("INSERT INTO {authmap}(uid, authname, module) VALUES($uid, '$claimed_id', 'openid')"); return $return; } feature_controller.install
- 31. project.make ... projects[inline][type] = "module" projects[inline][download][type] = "cvs" projects[inline][download][module] = "contributions/modules/inline" projects[inline][download][revision] = "HEAD:2010-03-06" projects[inline][subdir] = "contrib" ... ; ; Patches ; projects[inline][patch][] = "http://drupal.org/files/issues/inline.patch"
- 32. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time DevB$ svn ci -m “Add OpenID for admin. Patching Inline” Developer B commits his changes.
- 33. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time Developer C Time DevC$ svn co http://svn.nuvole.org/project Developer C joins.
- 34. hook_update_N() is not enough. Structural updates go in hook_install() too
- 35. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time Developer C Time feature_controller_install()
- 36. hook_install() /** * Implementation of hook_install() */ function feature_controller_install() { $return = array(); $modules = array('rules'); drupal_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enable Rules module.'); $uid = 1; $claimed_id = 'http://nuvole.myopenid.com/'; $return[] = update_sql("INSERT INTO {authmap}(uid, authname, module) VALUES($uid, '$claimed_id', 'openid')"); return $return; } feature_controller.install
- 37. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time Developer C Time Click. Click. Click. Developer C installs the project.
- 38. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time Developer C Time Click. Click. Click. Developer C creates and enables a new feature.
- 39. hook_update_N() /** * Enabling News feature */ function feature_controller_update_6004() { $return = array(); $modules = array('feature_news'); features_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enabling News'); return $return; } feature_controller.install
- 40. /** * Implementation of hook_install() */ function feature_controller_install() { $return = array(); $modules = array('rules'); drupal_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enable Rules module.'); $uid = 1; $claimed_id = 'http://nuvole.myopenid.com/'; $return[] = update_sql("INSERT INTO {authmap}(uid, authname, module) VALUES($uid, '$claimed_id', 'openid')"); $modules = array('feature_news'); features_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enabling News'); return $return; } feature_controller.install
- 41. Controller Feature Workflow 6001 Developer A Time Developer B 6002 6003 Time Developer C 6004 Time DevC$ svn ci -m “News Feature.” Developer C commits his changes.
- 42. Code conventions for a better world.
- 44. Feature namespace # Feature News (feature_news) Views feature_news_blocks feature_news_list feature_news_node feature_news_taxonomy Contexts feature_news_front feature_news_list Openlayers Presets feature_news_small_map feature_news_big_map
- 45. Content type namespace # News (news) CCK Fields field_news_pictures field_news_links Imagecache Presets news-s news-m news-l news-portrait
- 46. Features Boundaries Package functionalities in a logical way
- 47. Features Inheritance Re-use and extend features
- 48. Drupal 7
- 49. Installation profiles are like modules project.info project.install project.profile
- 50. project.info name = Project description = Project Description. core = 7.x dependencies[] = "context" dependencies[] = "features" dependencies[] = "feature_controller" ... files[] = project.profile
- 51. project.install /** * Enabling Rules module */ function project_update_6001() { $return = array(); $modules = array('rules'); drupal_install_modules($modules); $return[] = array('success' => TRUE, 'query' => 'Enabling Rules module'); return $return; } /** * Removing contributor role */ function project_update_6002() { $return = array(); $role_name = 'contributor'; $result = db_query("SELECT rid FROM {role} WHERE name='%s'", $role_name); while ($role = db_fetch_object($result)) { $rid = $role->rid; $return[] = update_sql("DELETE FROM {role} WHERE rid = '$rid'"); $return[] = update_sql("DELETE FROM {users_roles} WHERE rid = '$rid'"); } return $return; }
- 52. project.profile /** * Implementation of hook_install_tasks() */ function project_install_tasks($install_state) { ... } /** * Implementation of hook_form_FORM_ID_alter() */ function project_form_install_configure_form_alter(&$form, $form_state) { ... }
- 54. See also: Installation Profiles As A Development Tool by Florian Loretan http://bxl2011.drupaldays.org/node/280
- 55. Thank You. http://nuvole.org @nuvoleweb