README.txt 2.09 KB
Newer Older
1 2
README.txt
==========
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 8
summary includes how many times each query was executed on a page, and how long
each query took.
9

moshe weitzman's avatar
moshe weitzman committed
10
 It also offers
11
 - a block for running custom PHP on a page
12 13 14
 - a block for quickly accessing devel pages
 - a block for masquerading as other users (useful for testing)
 - reports memory usage at bottom of page
15
 - A mail-system class which redirects outbound email to files
moshe weitzman's avatar
moshe weitzman committed
16
 - more
17

18 19
 This module is safe to use on a production site. Just be sure to only grant
 'access development information' permission to developers.
20

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

24
AJAX developers in particular ought to install FirePHP Core from
25
http://www.firephp.org/ and put it in the devel directory.
moshe weitzman's avatar
moshe weitzman committed
26
This happens automatically when you enable via drush. You may also
27 28
use a drush command to download the library. If downloading by hand,
your path to fb.php should look like devel/FirePHPCore/lib/FirePHPCore/fb.php.
moshe weitzman's avatar
moshe weitzman committed
29
You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.
30
Then you can log php variables to the Firebug console. Is quite useful.
31

32
Included in this package is also:
moshe weitzman's avatar
moshe weitzman committed
33 34 35

- 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
36

moshe weitzman's avatar
moshe weitzman committed
37 38
Some nifty drush integration ships with devel and devel_generate. See drush help for details.

39 40
COMPATIBILITY NOTES
==================
41
- Modules that use AHAH may have incompatibility with the query log and other
moshe weitzman's avatar
moshe weitzman committed
42 43
  footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run into
  any issues.
44 45 46

AUTHOR/MAINTAINER
======================
moshe weitzman's avatar
moshe weitzman committed
47 48
-moshe weitzman <weitzman at tejasa DOT com>
http://cyrve.com
salvis's avatar
salvis committed
49
Hans Salvisberg <drupal at salvisberg DOT com>