README.txt

README.txt for Devel module
---------------------------

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Included Modules and Features
 * Recommended Modules
 * Installation
 * Compatibility Notes
 * Maintainers

INTRODUCTION
------------

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.

 - For a full description of the module visit:
   https://www.drupal.org/project/devel

 - To submit bug reports and feature suggestions, or to track changes visit:
   https://www.drupal.org/project/issues/devel

It also offers
 - 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
 - A mail-system class which redirects outbound email to files
 - 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. You may use the
devel-download drush command to download the library. If downloading by hand,
your path to fb.php should look 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.


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


INCLUDED MODULES AND FEATURES
-----------------------------

Included in this package is also:

 - Devel Node Access module - 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 - Bulk creates nodes, users, comment, terms for
   development.

Some nifty drush integration ships with Devel and Devel Generate. See drush help
for details.

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.


RECOMMENDED MODULE
------------------

Devel Generate Extensions - Devel Images Provider allows to configure external
providers for images.

 - http://drupal.org/project/devel_image_provider


INSTALLATION
------------

 - Install the Devel module as you would normally install a contributed Drupal
   module. Visit https://www.drupal.org/node/895232 for further information.


COMPATIBILITY NOTES
-------------------

- Modules that use AHAH may have incompatibility with the query log and other
  footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run
  into any issues.


AUTHOR/MAINTAINER
-----------------

 - Moshe Weitzman (moshe weitzman) - https://www.drupal.org/u/moshe-weitzman
 - Hans Salvisberg (salvis) - https://www.drupal.org/u/salvis

File

./README.txt

View source 
  1. README.txt for Devel module

  2. ---------------------------

  3. 

  4. CONTENTS OF THIS FILE

  5. ---------------------

  6. 

  7.  * Introduction

  8.  * Requirements

  9.  * Included Modules and Features

  10.  * Recommended Modules

  11.  * Installation

  12.  * Compatibility Notes

  13.  * Maintainers

  14. 

  15. INTRODUCTION

  16. ------------

  17. 

  18. A module containing helper functions for Drupal developers and inquisitive

  19. admins. This module can print a log of all database queries for each page

  20. request at the bottom of each page. The summary includes how many times each

  21. query was executed on a page, and how long each query took.

  22. 

  23.  - For a full description of the module visit:

  24.    https://www.drupal.org/project/devel

  25. 

  26.  - To submit bug reports and feature suggestions, or to track changes visit:

  27.    https://www.drupal.org/project/issues/devel

  28. 

  29. It also offers

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

  31.  - a block for quickly accessing devel pages

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

  33.  - reports memory usage at bottom of page

  34.  - A mail-system class which redirects outbound email to files

  35.  - more

  36. 

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

  38. 'access development information' permission to developers.

  39. 

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

  41. Useful during development. Many other nice functions like dpm(), dvm().

  42. 

  43. AJAX developers in particular ought to install FirePHP Core from

  44. http://www.firephp.org/ and put it in the devel directory. You may use the

  45. devel-download drush command to download the library. If downloading by hand,

  46. your path to fb.php should look like

  47. devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn checkout

  48. http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.

  49. Then you can log php variables to the Firebug console. Is quite useful.

  50. 

  51. 

  52. REQUIREMENTS

  53. ------------

  54. 

  55. This module requires no modules outside of Drupal core.

  56. 

  57. 

  58. INCLUDED MODULES AND FEATURES

  59. -----------------------------

  60. 

  61. Included in this package is also:

  62. 

  63.  - Devel Node Access module - Prints out the node_access records for a given

  64.    node. Also offers hook_node_access_explain for all node access modules to

  65.    implement. Handy.

  66.  - Devel Generate module - Bulk creates nodes, users, comment, terms for

  67.    development.

  68. 

  69. Some nifty drush integration ships with Devel and Devel Generate. See drush help

  70. for details.

  71. 

  72. DRUSH UNIT TEST - See develDrushTest.php for an example of unit testing of the

  73. Drush integration. This uses Drush's own test framework, based on PHPUnit. To

  74. run the tests, use

  75. phpunit --bootstrap=/path/to/drush/tests/drush_testcase.inc. Note that we must

  76. name a file under /tests there.

  77. 

  78. 

  79. RECOMMENDED MODULE

  80. ------------------

  81. 

  82. Devel Generate Extensions - Devel Images Provider allows to configure external

  83. providers for images.

  84. 

  85.  - http://drupal.org/project/devel_image_provider

  86. 

  87. 

  88. INSTALLATION

  89. ------------

  90. 

  91.  - Install the Devel module as you would normally install a contributed Drupal

  92.    module. Visit https://www.drupal.org/node/895232 for further information.

  93. 

  94. 

  95. COMPATIBILITY NOTES

  96. -------------------

  97. 

  98. - Modules that use AHAH may have incompatibility with the query log and other

  99.   footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run

  100.   into any issues.

  101. 

  102. 

  103. AUTHOR/MAINTAINER

  104. -----------------

  105. 

  106.  - Moshe Weitzman (moshe weitzman) - https://www.drupal.org/u/moshe-weitzman

  107.  - Hans Salvisberg (salvis) - https://www.drupal.org/u/salvis