README

Component\Core\DebugPrint is a simple-to-use PHP component that provides the Debug Print Method implementation pattern as an interface and a trait.

Table of Contents (ToC)

Introduction
Features
Requirements
Usage
Installation
Testing
Contributing
Credits
License

Introduction

This component is inspired by the method java.lang.Object.toString of the Java programming language.

Component\Core\DebugPrint consists of two artifacts:

The interface FlorianWolters\Component\Core\DebugPrintInterface: Indicates that an implementing class provides a Debug Print Method for objects.
The trait FlorianWolters\Component\Core\DebugPrintTrait: Provides a default Debug Print Method implementation for objects.

Features

Offers a default hash code value implementation for objects via the method toString of the trait FlorianWolters\Component\Core\DebugPrintTrait. Refer to the section Usage below for an example.
Allows to create a custom hash code value implementation by implementing the interface FlorianWolters\Component\Core\DebugPrintInterface, more precisely implementing the public method toString of that interface. Refer to the section Usage below for an example.
Artifacts tested with both static and dynamic test procedures:
- Dynamic component tests (unit and integration tests) implemented with PHPUnit.
- Static code analysis performed using the following tools:
  - PHP_CodeSniffer: Style Checker
  - PHP Mess Detector (PHPMD): Code Analyzer
  - PHP Depend: Code Metrics
  - phpcpd: Copy/Paste Detector (CPD)
  - phpdcd: Dead Code Detector (DCD)
  - SensioLabs Security Checker: Security Checker
- Continuous Integration (CI) using the following web services:
Provides a Packagist package which can be installed using the dependency manager Composer. Click here for the package on Packagist.
Provides a complete Application Programming Interface (API) documentation generated with the documentation generator Sami. Click here for the API documentation.
Follows the following "standards" from the PHP Framework Interoperability Group (FIG). PSR stands for PHP Standards Recommendation:
- PSR-0: Autoloading Standards
  
  Aims to provide a standard file, class and namespace convention to allow plug-and-play code.
- PSR-1: Basic Coding Standard
  
  Aims to ensure a high level of technical interoperability between shared PHP code.
- PSR-2: Coding Style Guide
  
  Provides a Coding Style Guide for projects looking to standardize their code.
- PSR-4: Autoloader
  
  A more modern take on autoloading reflecting advances in the ecosystem.
Follows the Semantic Versioning (SemVer) specification version 2.0.0.

Requirements

Production

PHP >= 5.4
Composer

Development

Installation

Component\Core\DebugPrint should be installed using the dependency manager Composer.

Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.

The Composer installer can be downloaded with php.

php -r "readfile('https://getcomposer.org/installer');" | php

This will just check a few PHP settings and then download composer.phar to your working directory. This file is the Composer binary. It is a PHAR (PHP archive), which is an archive format for PHP which can be run on the command line, amongst other things.

To resolve and download dependencies, run the install command:

php composer.phar install

If you are creating a component that relies on Component\Core\DebugPrint, please make sure that you add Component\Core\DebugPrint to your component's composer.json file:

{
    "require": {
        "florianwolters/component-core-debugprint": "0.3.*"
    }
}

Usage

The best documentation for \Component\Core\DebugPrint are the unit tests, which are shipped in the package.

The most important usage rule:

Always implement the interface DebugPrintInterface if using the trait DebugPrintTrait, since that allows Type Hinting.

The class DebugPrintExample can be run via the command php resources/php/DebugPrintExample.php from the root of the project.

Default Debug Print Method

The class DebugPrintDefaultImpl uses the default implementation of the trait DebugPrintTrait.

Custom Debug Print Method

The class DebugPrintCustomImpl implements a custom implementation, which fulfills the design contract for a Value Object.

Testing

phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://gnu.org/licenses/lgpl.txt.

florianwolters / component-core-debugprint

Maintainers

Details