Skip to content

Commit 592200a

Browse files
justmoonjustmoon
committed
Initial import, forked from version 0.2.1a
0 parents  commit 592200a

21 files changed

+2883
-0
lines changed

‎INSTALL

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
------------------------------------------------------------------------------
2+
3+
SETUP: How to install Krumo ?
4+
5+
------------------------------------------------------------------------------
6+
7+
In order to use Krumo you have to put it on your (development) server, and
8+
include it in your script. You can put it somewhere in the INCLUDE_PATH, or
9+
specify the full path to the "class.krumo.php" file.
10+
11+
You have to modify the "krumo.ini" file too. It is the configuration file for
12+
Krumo. The first option is choosing a skin:
13+
14+
[skin]
15+
selected = "orange"
16+
17+
The value for this setting has to be the name of one of the sub-folders from the
18+
"Krumo/skins/" folder. If the value provided for the skin results in not finding
19+
the skin, the `default` skin will be used instead.
20+
21+
The second option is used to set the correct web path to the folder where Krumo
22+
is installed. This is used in order to make the images from Krumo's CSS skins
23+
web-accessible.
24+
25+
[css]
26+
url = "http://www.example.com/Krumo/"
27+
28+
So far those two are the only configuration options.
29+
30+
All the CSS files ("skin.css") from the "Krumo/skins/" sub-folders must have the
31+
proper permissions in order to be readable from Krumo. Same applies for
32+
"krumo.ini" and "krumo.js" files.

‎LICENSE

+504
Large diffs are not rendered by default.

‎README

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
=============================================================================
2+
3+
Krumo
4+
version 0.2.1a
5+
6+
=============================================================================
7+
8+
You probably got this package from...
9+
http://www.sourceforge.net/projects/krumo/
10+
11+
If there is no licence agreement with this package please download
12+
a version from the location above. You must read and accept that
13+
licence to use this software. The file is titled simply LICENSE.
14+
15+
OVERVIEW
16+
------------------------------------------------------------------------------
17+
To put it simply, Krumo is a replacement for print_r() and var_dump(). By
18+
definition Krumo is a debugging tool (for PHP5), which displays structured
19+
information about any PHP variable.
20+
21+
A lot of developers use print_r() and var_dump() in the means of debugging
22+
tools. Although they were intended to present human readble information about a
23+
variable, we can all agree that in general they are not. Krumo is an
24+
alternative: it does the same job, but it presents the information beautified
25+
using CSS and DHTML.
26+
27+
EXAMPLES
28+
------------------------------------------------------------------------------
29+
Here's a basic example, which will return a report on the array variable passed
30+
as argument to it:
31+
32+
krumo(array('a1'=> 'A1', 3, 'red'));
33+
34+
You can dump simultaneously more then one variable - here's another example:
35+
36+
krumo($_SERVER, $_REQUEST);
37+
38+
You probably saw from the examples above that some of the nodes are expandable,
39+
so if you want to inspect the nested information, click on them and they will
40+
expand; if you do not need that information shown simply click again on it to
41+
collapse it. Here's an example to test this:
42+
43+
$x1->x2->x3->x4->x5->x6->x7->x8->x9 = 'X10';
44+
krumo($x1);
45+
46+
The krumo() is the only standalone function from the package, and this is
47+
because basic dumps about variables (like print_r() or var_dump()) are the most
48+
common tasks such functionality is used for. The rest of the functionality can
49+
be called using static calls to the Krumo class. Here are several more examples:
50+
51+
// print a debug backgrace
52+
krumo::backtrace();
53+
54+
// print all the included(or required) files
55+
krumo::includes();
56+
57+
// print all the included functions
58+
krumo::functions();
59+
60+
// print all the declared classes
61+
krumo::classes();
62+
63+
// print all the defined constants
64+
krumo::defines();
65+
66+
... and so on, etc.
67+
68+
A full PHPDocumenter API documentation exists both in this package and at the
69+
project's website.
70+
71+
INSTALL
72+
------------------------------------------------------------------------------
73+
Read the INSTALL file.
74+
75+
DOCUMENTATION
76+
------------------------------------------------------------------------------
77+
As I said, a full PHPDocumenter API documentation can be found both in this
78+
package and at the project's website.
79+
80+
SKINS
81+
------------------------------------------------------------------------------
82+
There are several skins pre-installed with this package, but if you wish you can
83+
create skins of your own. The skins are simply CSS files that are prepended to
84+
the result that Krumo prints. If you want to use images in your CSS (for
85+
background, list-style, etc), you have to put "%URL%" in front of the image URL
86+
in order hook it up to the skin folder and make the image web-accessible.
87+
88+
Here's an example:
89+
90+
ul.krumo-first {background: url(%url%bg.gif);}
91+
92+
TODO
93+
------------------------------------------------------------------------------
94+
You can find the list of stuff that is going to be added to this project in the
95+
TODO file from this very package.
96+
97+
CONTRIBUTION
98+
-----------------------------------------------------------------------------
99+
If you download and use and possibly even extend this tool, please let us know.
100+
Any feedback, even bad, is always welcome and your suggestions are going to be
101+
considered for our next release. Please use our SourceForge page for that:
102+
103+
http://www.sourceforge.net/projects/krumo/

‎TODO

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
******************************************************************************
2+
3+
Krumo: TODO
4+
5+
******************************************************************************
6+
7+
BUGS
8+
----------------
9+
- watch the SourceForge.net Bug Tracker
10+
11+
Features: PHP
12+
----------------
13+
- Try to detect anonymous (lambda) functions
14+
- Try to detect whether an array is indexed or associated
15+
- Add var_export support for arrays and objects
16+
- Add JSON support for arrays and objects
17+
18+
Features: GUI
19+
----------------
20+
- Nicer and friendlier skin(s)
21+
- Add top-level links for collapsing and expanding the whole tree
22+
- Add object & array -level links for collapsing and expanding all the
23+
nested nodes
24+
- Print all parent classes for the rendered objects

‎VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.2.1a

0 commit comments

Comments
 (0)