florianwolters / component-util-reflection
Provides operations for the PHP Reflection API as a PHP component.
Installs: 171 960
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 1
Requires
- php: >=5.4
- florianwolters/component-core-stringutils: 0.3.*
Requires (Dev)
- phpdocumentor/phpdocumentor: 2.0.*
- phpmd/phpmd: 1.*
- phpunit/phpunit: 4.0.*
- sebastian/phpcpd: 2.0.*@dev
- sebastian/phpdcd: 1.0.*
- squizlabs/php_codesniffer: 2.0.*@dev
This package is not auto-updated.
Last update: 2024-10-26 15:23:56 UTC
README
Component\Util\Reflection is a simple-to-use PHP component that provides operations for the PHP Reflection Application Programming Interface (API).
Table of Contents (ToC)
Introduction
Component\Util\Reflection consists of one artifact:
- The static class
ReflectionUtils
: Provides methods which simplify the usage of the PHP Reflection Application Programming Interface (API).
Features
- 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
Development
- PHPUnit
- phpcpd
- phpdcd
- PHP_CodeSniffer
- PHP Mess Detector (PHPMD)
- Sami
- SensioLabs Security Checker
- php-coveralls
Installation
Component\Util\Singleton 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\Util\Singleton,
please make sure that you add Component\Util\Singleton to your component's
composer.json
file:
{ "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.
Additional documentation can be found in the [official Wiki][55] of the project.
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.