README.txt 2.38 KB
Newer Older
1 2
README.txt
==========
3

4 5 6 7
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.
8

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

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

20 21
Enabling the Devel Kint module gives you a dpr() function, which pretty prints variables.
Useful during development. Also see similar helpers like dpm(), dvm().
22

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

30
Included in this package is also:
moshe weitzman's avatar
moshe weitzman committed
31 32

- 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.
33
- devel_generate.module which bulk creates nodes, users, comment, terms for development.
34

35
Some nifty Drush integration ships with devel and devel_generate. See `drush help` for details.
moshe weitzman's avatar
moshe weitzman committed
36

37 38 39 40
DEVEL GENERATE EXTENSIONS
=========================
Devel Images Provider [http://drupal.org/project/devel_image_provider] allows to configure external providers for images.

41 42 43 44
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
45
run-tests-drush.sh. You may pass in any arguments that are valid for `phpunit`.
46

47 48
AUTHOR/MAINTAINER
======================
49 50 51
- Moshe Weitzman <weitzman at tejasa DOT com> http://www.acquia.com
- Hans Salvisberg <drupal at salvisberg DOT com>
- Pedro Cambra <https://drupal.org/user/122101/contact> http://www.ymbra.com/