|
1 | | - PHP_CodeBrowser |
| 1 | +# PHP_CodeBrowser # |
2 | 2 |
|
3 | | - |
4 | | - 1. Structure |
5 | | - 2. Installation |
6 | | - 3. Usage |
7 | | - 4. View the results |
8 | | - 5. Contact information |
9 | | - |
10 | | - |
11 | | -1. Structure |
12 | | ------------------------------------------------------------------------- |
| 3 | +## Structure ## |
13 | 4 |
|
14 | 5 | |--> bin/ PHP_CodeBrowser scripts |
15 | 6 | |--> src/ Source files for PHP_CodeBrowser |
|
28 | 19 | |--> README Structure and install information |
29 | 20 | |--> CHANGELOG Update information |
30 | 21 |
|
| 22 | +## Installation ## |
31 | 23 |
|
32 | | -2. Installation |
33 | | ------------------------------------------------------------------------- |
| 24 | +### Git Checkout ### |
34 | 25 |
|
35 | | - a) Svn checkout |
36 | | - =============== |
37 | | - |
38 | | - svn co svn://phpunit.de/phpunit/phpcb/trunk PHP_CodeBrowser |
39 | | - |
40 | | - b) Installation by PEAR |
41 | | - ==================== |
42 | | - |
43 | | - pear config-set preferred_state alpha |
44 | | - pear channel-discover pear.phpunit.de |
45 | | - pear install --alldeps phpunit/PHP_CodeBrowser |
46 | | - |
| 26 | + $ git clone git://github.com/mayflowergmbh/PHP_CodeBrowser.git |
47 | 27 |
|
48 | | -3. Usage |
49 | | ------------------------------------------------------------------------- |
| 28 | +### Installation with PEAR Installer ### |
| 29 | + |
| 30 | + $ pear config-set preferred_state alpha |
| 31 | + $ pear channel-discover pear.phpunit.de |
| 32 | + $ pear install --alldeps phpunit/PHP_CodeBrowser |
| 33 | + |
| 34 | +## Usage ## |
| 35 | + |
| 36 | +### Shell Usage ### |
50 | 37 |
|
51 | | - a) Shell usage |
52 | | - ============== |
53 | | - |
54 | 38 | Usage: phpcb(.php|.bat) --log <dir> --output <dir> [--source <dir>] |
55 | 39 |
|
56 | 40 | --log Path to xml log files, e.g. generated by phpunit |
57 | 41 | --output Path to output directory (must differ from source directory) |
58 | 42 | --source (opt) Path to project source |
59 | 43 |
|
60 | | - In case of optional --source parameter definition its target directory will be |
61 | | - parsed. Errors from log files will be merged into parsed file list from target |
62 | | - directory, if match in path definition exists. |
63 | | - Else only files from error logs will be parsed. |
| 44 | +In case the optional `--source` parameter is used the given target directory will be parsed. Errors from log files will be merged into the parsed file list from the target directory. |
| 45 | + |
| 46 | +Otherwise only files from error logs will be parsed. |
64 | 47 |
|
65 | | - b) Integration in cruisecontrol |
66 | | - =============================== |
| 48 | +### Integration in CruiseControl ### |
67 | 49 |
|
68 | 50 | ... |
69 | | - <target name="build" depends="...,phpcb" /> (phpcb should be called after xml file generation) |
| 51 | + <!-- phpcb should be called after xml file generation --> |
| 52 | + <target name="build" depends="...,phpcb" /> |
70 | 53 | ... |
71 | 54 | <target name="phpcb"> |
72 | 55 | <exec executable="phpcb"> |
|
76 | 59 | </exec> |
77 | 60 | </target> |
78 | 61 | ... |
79 | | - |
80 | 62 |
|
81 | | -4. View the results |
82 | | ------------------------------------------------------------------------- |
| 63 | +## View the Results ## |
83 | 64 |
|
84 | | - a) Webbrowser |
85 | | - ============= |
| 65 | +### Webbrowser ### |
86 | 66 |
|
87 | | - Call the /path/to/defined/output/index.html |
| 67 | +Open `/path/to/defined/output/index.html`. |
88 | 68 |
|
89 | | - b) Cruisecontrol |
90 | | - ================ |
91 | | - |
92 | | - b.1) config.xml |
93 | | - --------------- |
| 69 | +### CruiseControl ### |
| 70 | + |
| 71 | +#### config.xml #### |
| 72 | + |
94 | 73 | <publishers> |
95 | 74 | <artifactspublisher dir="path/to/output" dest="artifacts/${project.name}" subdirectory="PhpCbIdentifier" /> |
96 | 75 | ... |
97 | 76 | </publishers> |
98 | 77 |
|
99 | | - b.2) path/to/cruisecontrol/webapps/cruisecontrol/main.jsp |
100 | | - ------------- |
| 78 | +#### main.jsp #### |
| 79 | + |
101 | 80 | <cruisecontrol:tab name="PHP_CodeBrowser" label="PHP_CodeBrowser"> |
102 | 81 | <cruisecontrol:artifactsLink> |
103 | 82 | <iframe src="<%=request.getContextPath() %>/<%= artifacts_url %>/PhpCbIdentifier/index.html" class="tab-content"> |
104 | 83 | </iframe> |
105 | 84 | </cruisecontrol:artifactsLink> |
106 | 85 | </cruisecontrol:tab> |
107 | | - |
108 | 86 |
|
109 | | -5. Contact information |
110 | | ------------------------------------------------------------------------- |
| 87 | +## Contact Information ## |
111 | 88 |
|
112 | | - If you have any questions you may get in contact with: |
113 | | - |
114 | | - |
115 | | - |
| 89 | +If you have any questions you may get in contact with: Elger Thiele < [email protected]> |
0 commit comments