Component\Util\Reflection

Component\Util\Reflection is a simple-to-use PHP component that provides operations for the [PHP Reflection Application Programming Interface (API)][53]., _(*1)

, _(*2)

, _(*3)

, _(*4)

Table of Contents (ToC)

Introduction
Features
Requirements
Usage
Installation
Testing
Contributing
Credits
License

Introduction

Component\Util\Reflection consists of one artifact:, _(*5)

The static class [ReflectionUtils][54]: Provides methods which simplify the usage of the [PHP Reflection Application Programming Interface (API)][53].

Features

Artifacts tested with both static and dynamic test procedures:
- Dynamic component tests (unit and integration tests) implemented with [PHPUnit][41].
- Static code analysis performed using the following tools:
  - [PHP_CodeSniffer][40]: Style Checker
  - [PHP Mess Detector (PHPMD)][44]: Code Analyzer
  - [PHP Depend][45]: Code Metrics
  - [phpcpd][42]: Copy/Paste Detector (CPD)
  - [phpdcd][43]: Dead Code Detector (DCD)
  - [SensioLabs Security Checker][47]: 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][51] for the package on Packagist.
Provides a complete Application Programming Interface (API) documentation generated with the documentation generator [Sami][46]. Click [here][52] for the API documentation.
Follows the following "standards" from the PHP Framework Interoperability Group (FIG). PSR stands for PHP Standards Recommendation:, _(*6)
- PSR-0: Autoloading Standards, _(*7)
  
  Aims to provide a standard file, class and namespace convention to allow plug-and-play code., _(*8)
- PSR-1: Basic Coding Standard, _(*9)
  
  Aims to ensure a high level of technical interoperability between shared PHP code., _(*10)
- PSR-2: Coding Style Guide, _(*11)
  
  Provides a Coding Style Guide for projects looking to standardize their code., _(*12)
- PSR-4: Autoloader, _(*13)
  
  A more modern take on autoloading reflecting advances in the ecosystem., _(*14)
Follows the Semantic Versioning (SemVer) specification version 2.0.0.

Requirements

Production

PHP >= 5.4
Composer

Development

[PHPUnit][41]
[phpcpd][42]
[phpdcd][43]
[PHP_CodeSniffer][40]
[PHP Mess Detector (PHPMD)][44]
[Sami][46]
[SensioLabs Security Checker][47]
[php-coveralls][48]

Installation

Component\Util\Singleton should be installed using the dependency manager Composer., _(*15)

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., _(*16)

The Composer installer can be downloaded with php., _(*17)

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 , which is an archive format for PHP which can be run on the command line, amongst other things., _(*18)

To resolve and download dependencies, run the install command:, _(*19)

php composer.phar install

If you are creating a component that relies on Component\Util\Singleton, please make sure that you add Component\Util\Singleton to your component's composer.json file:, _(*20)

{
    "require": {
        "florianwolters/component-Util-Reflection": "0.3.*"
    }
}

Usage

The best documentation for Component\Util\Singleton are the unit tests, which are shipped in the package., _(*21)

Additional documentation can be found in the [official Wiki][55] of the project., _(*22)

Testing

phpunit

Contributing

Please see CONTRIBUTING for details., _(*23)

Credits

Florian Wolters
[All Contributors][50]

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., _(*24)

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., _(*25)

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., _(*26)