PHPXRef 0.7 : Drupal 6 (yi-drupal) : /sites/all/modules/devel/krumo/docs/ric

[Summary view] [Print] [Text view]
   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos  -->
   6              <title></title>
   7              <link rel="stylesheet" href="media/stylesheet.css" />
   8                                              </head>
   9          <body>
  10                          
<div align="center"><h1>README</h1></div>
  11  <pre>
  12  =============================================================================
  13  
  14                                 Krumo
  15                              version 0.1a
  16  
  17  =============================================================================
  18  
  19  You probably got this package from...
  20  http://www.sourceforge.net/projects/krumo/
  21  
  22  If there is no licence agreement with this package please download
  23  a version from the location above. You must read and accept that
  24  licence to use this software. The file is titled simply LICENSE.
  25  
  26  OVERVIEW
  27  ------------------------------------------------------------------------------
  28  To put it simply, Krumo is a replacement for print_r() and var_dump(). By 
  29  definition Krumo is a debugging tool (PHP4/PHP5), which displays structured 
  30  information about any PHP variable.
  31  
  32  A lot of developers use print_r() and var_dump() in the means of debugging 
  33  tools. Although they were intended to present human readble information about a 
  34  variable, we can all agree that in general they are not. Krumo is an 
  35  alternative: it does the same job, but it presents the information beautified 
  36  using CSS and DHTML. 
  37  
  38  EXAMPLES
  39  ------------------------------------------------------------------------------
  40  Here's a basic example, which will return a report on the array variable passed 
  41  as argument to it:
  42  
  43   krumo(array('a1'=&gt; 'A1', 3, 'red'));
  44  
  45  You can dump simultaneously more then one variable - here's another example:
  46  
  47   krumo($_SERVER, $_REQUEST);
  48  
  49  You probably saw from the examples above that some of the nodes are expandable, 
  50  so if you want to inspect the nested information, click on them and they will 
  51  expand; if you do not need that information shown simply click again on it to 
  52  collapse it. Here's an example to test this:
  53  
  54   $x1-&gt;x2-&gt;x3-&gt;x4-&gt;x5-&gt;x6-&gt;x7-&gt;x8-&gt;x9 = 'X10';
  55   krumo($x1);
  56  
  57  The krumo() is the only standalone function from the package, and this is 
  58  because basic dumps about variables (like print_r() or var_dump()) are the most 
  59  common tasks such functionality is used for. The rest of the functionality can 
  60  be called using static calls to the Krumo class. Here are several more examples:
  61  
  62   // print a debug backgrace

  63   krumo::backtrace();
  64  
  65   // print all the included(or required) files

  66   krumo::includes();
  67   
  68   // print all the included functions

  69   krumo::functions();
  70   
  71   // print all the declared classes

  72   krumo::classes();
  73   
  74   // print all the defined constants

  75   krumo::defines();
  76  
  77   ... and so on, etc.
  78  
  79  A full PHPDocumenter API documentation exists both in this package and at the 
  80  project's website.
  81  
  82  INSTALL
  83  ------------------------------------------------------------------------------
  84  Read the INSTALL file.
  85  
  86  DOCUMENTATION
  87  ------------------------------------------------------------------------------
  88  As I said, a full PHPDocumenter API documentation can be found both in this
  89  package and at the project's website.
  90  
  91  SKINS
  92  ------------------------------------------------------------------------------
  93  There are several skins pre-installed with this package, but if you wish you can 
  94  create skins of your own. The skins are simply CSS files that are prepended to 
  95  the result that Krumo prints. If you want to use images in your CSS (for 
  96  background, list-style, etc), you have to put &quot;%URL%&quot; in front of the image URL 
  97  in order hook it up to the skin folder and make the image web-accessible.
  98  
  99  Here's an example:
 100  
 101   ul.krumo-first {background: url(%url%bg.gif);}
 102  
 103  TODO
 104  ------------------------------------------------------------------------------
 105  You can find the list of stuff that is going to be added to this project in the 
 106  TODO file from this very package.
 107  
 108  CONTRIBUTION
 109  -----------------------------------------------------------------------------
 110  If you download and use and possibly even extend this tool, please let us know. 
 111  Any feedback, even bad, is always welcome and your suggestions are going to be 
 112  considered for our next release. Please use our SourceForge page for that:
 113   
 114   http://www.sourceforge.net/projects/krumo/
 115  
 116  </pre>
 117      <p class="notes" id="credit">
 118          Documentation generated on Sat, 16 Jun 2007 09:50:08 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 119      </p>
 120      </body>
 121  </html>
PHP Cross Reference of Drupal 6 (yi-drupal)

/sites/all/modules/devel/krumo/docs/ -> ric_README.html (source)
