You are here

Home » API reference » Devel 6

README.txt in Devel 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 5 README.txt
  4. 7 README.txt
README.txt
==========

A module containing helper functions for Drupal developers and
inquisitive admins. This module can print a log of
all database queries for each page request at the bottom of each page. The
summary includes how many times each query was executed on a page, and how long each query
 took.
 
 It also
 - a block for running custom PHP on a page
 - a block for quickly accessing devel pages
 - a block for masquerading as other users (useful for testing)
 - reports memory usage at bottom of page
 - more
 
 This module is safe to use on a production site. Just be sure to only grant
 'access development information' permission to developers.

Also a dpr() function is provided, which pretty prints arrays and strings. Useful during
development. Many other nice functions like dpm(), dvm().

AJAX developers in particular ought to install FirePHP Core from http://www.firephp.org/ and put it in the devel directory. Your path to fb.php should looks like devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore. Then you can log php variables to the firebug console. Is quite useful. 

Included in this package is also: 
- devel_node_access module which prints out the node_access records for a given node. Also offers hook_node_access_explain for all node access modules to implement. Handy.
- devel_generate.module which bulk creates nodes, users, comment, terms for development

Some nifty drush integration ships with devel and devel_generate. See drush help for details.

COMPATIBILITY NOTES
==================
- Modules that use AHAH may have incompatibility with the query log and other footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE in order to avoid issues.
-  Modules that use AJAX should idenify their response as Content-type: text/javascript. The easiest way to do that is run your reply through drupal_json().


DRUSH UNIT TEST
==================
See develDrushTest.php for an example of unit testing of the Drush integration.
This uses Drush's own test framework, based on PHPUnit. To run the tests, use
phpunit --bootstrap=/path/to/drush/tests/drush_testcase.inc. Note that we must name a file
under /tests there.

AUTHOR/MAINTAINER
======================
Moshe Weitzman <weitzman at tejasa DOT com> http://cyrve.com
Hans Salvisberg <drupal at salvisberg DOT com>

File

README.txt
View source 
  1. README.txt

  2. ==========

  3. 

  4. A module containing helper functions for Drupal developers and

  5. inquisitive admins. This module can print a log of

  6. all database queries for each page request at the bottom of each page. The

  7. summary includes how many times each query was executed on a page, and how long each query

  8.  took.

  9.  

  10.  It also

  11.  - a block for running custom PHP on a page

  12.  - a block for quickly accessing devel pages

  13.  - a block for masquerading as other users (useful for testing)

  14.  - reports memory usage at bottom of page

  15.  - more

  16.  

  17.  This module is safe to use on a production site. Just be sure to only grant

  18.  'access development information' permission to developers.

  19. 

  20. Also a dpr() function is provided, which pretty prints arrays and strings. Useful during

  21. development. Many other nice functions like dpm(), dvm().

  22. 

  23. AJAX developers in particular ought to install FirePHP Core from http://www.firephp.org/ and put it in the devel directory. Your path to fb.php should looks like devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore. Then you can log php variables to the firebug console. Is quite useful. 

  24. 

  25. Included in this package is also: 

  26. - devel_node_access module which prints out the node_access records for a given node. Also offers hook_node_access_explain for all node access modules to implement. Handy.

  27. - devel_generate.module which bulk creates nodes, users, comment, terms for development

  28. 

  29. Some nifty drush integration ships with devel and devel_generate. See drush help for details.

  30. 

  31. COMPATIBILITY NOTES

  32. ==================

  33. - Modules that use AHAH may have incompatibility with the query log and other footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE in order to avoid issues.

  34. -  Modules that use AJAX should idenify their response as Content-type: text/javascript. The easiest way to do that is run your reply through drupal_json().

  35. 

  36. 

  37. DRUSH UNIT TEST

  38. ==================

  39. See develDrushTest.php for an example of unit testing of the Drush integration.

  40. This uses Drush's own test framework, based on PHPUnit. To run the tests, use

  41. phpunit --bootstrap=/path/to/drush/tests/drush_testcase.inc. Note that we must name a file

  42. under /tests there.

  43. 

  44. AUTHOR/MAINTAINER

  45. ======================

  46. Moshe Weitzman  http://cyrve.com

  47. Hans Salvisberg