ric_README.html
Same filename in other branches
=============================================================================
Krumo
version 0.1a
=============================================================================
You probably got this package from...
http://www.sourceforge.net/projects/krumo/
If there is no licence agreement with this package please download
a version from the location above. You must read and accept that
licence to use this software. The file is titled simply LICENSE.
OVERVIEW
------------------------------------------------------------------------------
To put it simply, Krumo is a replacement for print_r() and var_dump(). By
definition Krumo is a debugging tool (PHP4/PHP5), which displays structured
information about any PHP variable.
A lot of developers use print_r() and var_dump() in the means of debugging
tools. Although they were intended to present human readble information about a
variable, we can all agree that in general they are not. Krumo is an
alternative: it does the same job, but it presents the information beautified
using CSS and DHTML.
EXAMPLES
------------------------------------------------------------------------------
Here's a basic example, which will return a report on the array variable passed
as argument to it:
krumo(array('a1'=> 'A1', 3, 'red'));
You can dump simultaneously more then one variable - here's another example:
krumo($_SERVER, $_REQUEST);
You probably saw from the examples above that some of the nodes are expandable,
so if you want to inspect the nested information, click on them and they will
expand; if you do not need that information shown simply click again on it to
collapse it. Here's an example to test this:
$x1->x2->x3->x4->x5->x6->x7->x8->x9 = 'X10';
krumo($x1);
The krumo() is the only standalone function from the package, and this is
because basic dumps about variables (like print_r() or var_dump()) are the most
common tasks such functionality is used for. The rest of the functionality can
be called using static calls to the Krumo class. Here are several more examples:
// print a debug backgrace
krumo::backtrace();
// print all the included(or required) files
krumo::includes();
// print all the included functions
krumo::functions();
// print all the declared classes
krumo::classes();
// print all the defined constants
krumo::defines();
... and so on, etc.
A full PHPDocumenter API documentation exists both in this package and at the
project's website.
INSTALL
------------------------------------------------------------------------------
Read the INSTALL file.
DOCUMENTATION
------------------------------------------------------------------------------
As I said, a full PHPDocumenter API documentation can be found both in this
package and at the project's website.
SKINS
------------------------------------------------------------------------------
There are several skins pre-installed with this package, but if you wish you can
create skins of your own. The skins are simply CSS files that are prepended to
the result that Krumo prints. If you want to use images in your CSS (for
background, list-style, etc), you have to put "%URL%" in front of the image URL
in order hook it up to the skin folder and make the image web-accessible.
Here's an example:
ul.krumo-first {background: url(%url%bg.gif);}
TODO
------------------------------------------------------------------------------
You can find the list of stuff that is going to be added to this project in the
TODO file from this very package.
CONTRIBUTION
-----------------------------------------------------------------------------
If you download and use and possibly even extend this tool, please let us know.
Any feedback, even bad, is always welcome and your suggestions are going to be
considered for our next release. Please use our SourceForge page for that:
http://www.sourceforge.net/projects/krumo/
Documentation generated on Sat, 16 Jun 2007 09:50:08 +0300 by phpDocumentor 1.3.0RC4
File
-
krumo/
docs/ ric_README.html
View source
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title></title>
<link rel="stylesheet" href="media/stylesheet.css" />
</head>
<body>
<div align="center"><h1>README</h1></div>
<pre>
=============================================================================
Krumo
version 0.1a
=============================================================================
You probably got this package from...
http://www.sourceforge.net/projects/krumo/
If there is no licence agreement with this package please download
a version from the location above. You must read and accept that
licence to use this software. The file is titled simply LICENSE.
OVERVIEW
------------------------------------------------------------------------------
To put it simply, Krumo is a replacement for print_r() and var_dump(). By
definition Krumo is a debugging tool (PHP4/PHP5), which displays structured
information about any PHP variable.
A lot of developers use print_r() and var_dump() in the means of debugging
tools. Although they were intended to present human readble information about a
variable, we can all agree that in general they are not. Krumo is an
alternative: it does the same job, but it presents the information beautified
using CSS and DHTML.
EXAMPLES
------------------------------------------------------------------------------
Here's a basic example, which will return a report on the array variable passed
as argument to it:
krumo(array('a1'=> 'A1', 3, 'red'));
You can dump simultaneously more then one variable - here's another example:
krumo($_SERVER, $_REQUEST);
You probably saw from the examples above that some of the nodes are expandable,
so if you want to inspect the nested information, click on them and they will
expand; if you do not need that information shown simply click again on it to
collapse it. Here's an example to test this:
$x1->x2->x3->x4->x5->x6->x7->x8->x9 = 'X10';
krumo($x1);
The krumo() is the only standalone function from the package, and this is
because basic dumps about variables (like print_r() or var_dump()) are the most
common tasks such functionality is used for. The rest of the functionality can
be called using static calls to the Krumo class. Here are several more examples:
// print a debug backgrace
krumo::backtrace();
// print all the included(or required) files
krumo::includes();
// print all the included functions
krumo::functions();
// print all the declared classes
krumo::classes();
// print all the defined constants
krumo::defines();
... and so on, etc.
A full PHPDocumenter API documentation exists both in this package and at the
project's website.
INSTALL
------------------------------------------------------------------------------
Read the INSTALL file.
DOCUMENTATION
------------------------------------------------------------------------------
As I said, a full PHPDocumenter API documentation can be found both in this
package and at the project's website.
SKINS
------------------------------------------------------------------------------
There are several skins pre-installed with this package, but if you wish you can
create skins of your own. The skins are simply CSS files that are prepended to
the result that Krumo prints. If you want to use images in your CSS (for
background, list-style, etc), you have to put "%URL%" in front of the image URL
in order hook it up to the skin folder and make the image web-accessible.
Here's an example:
ul.krumo-first {background: url(%url%bg.gif);}
TODO
------------------------------------------------------------------------------
You can find the list of stuff that is going to be added to this project in the
TODO file from this very package.
CONTRIBUTION
-----------------------------------------------------------------------------
If you download and use and possibly even extend this tool, please let us know.
Any feedback, even bad, is always welcome and your suggestions are going to be
considered for our next release. Please use our SourceForge page for that:
http://www.sourceforge.net/projects/krumo/
</pre>
<p class="notes" id="credit">
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>
</p>
</body>
</html>