mayflower/php-codebrowser

A code browser that augments the code with information from various QA tools.

4.0.1 2024-03-19 22:19 UTC

Requires

• php: ^8.0
• ext-dom: *
• monolog/monolog: ~1.7||~2.0||~3.0
• phpunit/php-file-iterator: ~2.0||^3.0
• symfony/console: ~3.4||~4.0||~5.0||~6.0

Requires (Dev)

• humbug/box: ^3.13
• mayflower/mo4-coding-standard: ^9.0
• phploc/phploc: *
• phpmd/phpmd: 1.5.*||~2.6
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.0
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^9.5
• sebastian/phpcpd: *

BSD-3-Clause

• Robin Gloster
• Christian Albrecht

README

Structure

|--> bin/           PHP_CodeBrowser scripts
|--> src/           Source files for PHP_CodeBrowser
|   |--> Plugins/   Plugins for different error handling/types
|
|--> templates/     Template files for PHP_CodeBrowser
|   |--> css/       Used CSS by templates, Color definition for errors
|   |--> img/       Used images for PHP_CodeBrowser
|   |--> js/        Used javascript for PHP_CodeBrowser
|
|--> tests/         PHPUnit test suite
|
|--> package.xml    PEAR package information file
|
|--> LICENCE        Licence information
|--> README         Structure and install information
|--> CHANGELOG      Update information

Installation

Git Checkout

$ git clone git://github.com/Mayflower/PHP_CodeBrowser.git

Installation via Composer

Add this line to the require section in composer.json:

"mayflower/php-codebrowser": "~1.1"

Or to install it globally

composer global require "mayflower/php-codebrowser=~1.1"

Get PHAR

see Releases

Usage

Shell Usage

Try ./bin/phpcb.php -h for usage information.

Integration in Jenkins, CruiseControl and Hudson

...
<!-- phpcb should be called after xml file generation -->
<target name="build" depends="...,phpcb" />
...
<target name="phpcb">
    <exec executable="phpcb">
        <arg line="--log path/to/log/dir
                   --output path/to/output/dir/
                   --source path/to/source/dir/" />
    </exec>
</target>
...

View the Results

Webbrowser

Open /path/to/defined/output/index.html.

CruiseControl

config.xml

<publishers>
  <artifactspublisher dir="path/to/output" dest="artifacts/${project.name}" subdirectory="PhpCbIdentifier" />
  ...
</publishers>

main.jsp

<cruisecontrol:tab name="PHP_CodeBrowser" label="PHP_CodeBrowser">
  <cruisecontrol:artifactsLink>
     <iframe src="<%=request.getContextPath() %>/<%= artifacts_url %>/PhpCbIdentifier/index.html" class="tab-content">
     </iframe>
  </cruisecontrol:artifactsLink>
</cruisecontrol:tab>

Jenkins/Hudson

Have a look at the standard template for Jenkins jobs for PHP projects to see how PHP_CodeBrowser can be used together with Jenkins.

Contact Information

If you have any questions you may get in contact with: Elger Thiele or Thorsten Rinne