Compare commits
No commits in common. "c4479b49905c37d33dc45b1a34ce3509b61f93dc" and "fc54a7161bcc56f2bb533dfd1cabeea0636b55b2" have entirely different histories.
c4479b4990
...
fc54a7161b
|
@ -24,15 +24,11 @@ namespace PhpCsFixer;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configuration for PHP-CS-Fixer.
|
* Configuration for PHP-CS-Fixer.
|
||||||
*
|
|
||||||
* @see https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/config.rst
|
* @see https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/config.rst
|
||||||
*
|
*
|
||||||
* @return ConfigInterface
|
* @return ConfigInterface
|
||||||
*/
|
*/
|
||||||
$config = new Config();
|
return (new Config())
|
||||||
$finder = new Finder();
|
|
||||||
|
|
||||||
return $config
|
|
||||||
->setRiskyAllowed(true)
|
->setRiskyAllowed(true)
|
||||||
->setRules(['@PSR12' => true])
|
->setRules(['@PSR12' => true])
|
||||||
->setFinder($finder->in([__DIR__ . '/src']));
|
->setFinder((new Finder())->in(__DIR__));
|
||||||
|
|
27
README.md
27
README.md
|
@ -1,25 +1,10 @@
|
||||||
# PHP Basics
|
# PHP Basics
|
||||||
|
|
||||||
***A collection of generic classes and useful traits for PHP projects.***
|
This is a collection of generic [classes](https://www.php.net/manual/en/language.oop5.php) and useful [traits](https://www.php.net/manual/en/language.oop5.traits.php) for your PHP projects.
|
||||||
|
|
||||||
The package currently contains classes for [type-sensitive data structures](src/DataStructures/), [error and exception handlers](src/ErrorHandlers/), multiple [traits implementing standard interfaces](src/InterfaceTraits/), and more generic [traits for common use cases](src/Traits/). They share the same design principles like property and method naming schema, highest [Psalm](https://psalm.dev/) and [PHPStan](https://phpstan.org/) coding standards and full [PSR-12](https://www.php-fig.org/psr/psr-12/) compliance to make sure they can be combined and easily re-used in other projects.
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
The intended and recommended way of re-using this package is via [Composer](https://getcomposer.org/). The following command will get you the latest version:
|
|
||||||
|
|
||||||
composer require opencultureconsulting/basics
|
|
||||||
|
|
||||||
All available versions as well as further information about requirements and dependencies can be found on [Packagist](https://packagist.org/packages/opencultureconsulting/basics).
|
|
||||||
|
|
||||||
## Full Documentation
|
|
||||||
|
|
||||||
The full documentation is available on [GitHub Pages](https://opencultureconsulting.github.io/php-basics/) or alternatively in [doc/](doc/).
|
|
||||||
|
|
||||||
## Quality Gates
|
|
||||||
|
|
||||||
[![PHPCS](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpcs.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpcs.yml)
|
|
||||||
[![PHPMD](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml)
|
|
||||||
|
|
||||||
[![PHPStan](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml)
|
[![PHPStan](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml)
|
||||||
[![Psalm](https://github.com/opencultureconsulting/php-basics/actions/workflows/psalm.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/psalm.yml)
|
[![PHPMD](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The most convenient way to use the PHP Basics classes and traits in your own project is `composer require opencultureconsulting/basics`
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "opencultureconsulting/basics",
|
"name": "opencultureconsulting/basics",
|
||||||
"description": "A collection of generic classes and useful traits for PHP projects.",
|
"description": "This is a collection of generic Classes and useful Traits for PHP projects.",
|
||||||
"type": "library",
|
"type": "library",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"ArrayAccess",
|
"ArrayAccess",
|
||||||
|
|
|
@ -3,7 +3,5 @@
|
||||||
<description>Open Culture Consulting strictly follows PSR standards.</description>
|
<description>Open Culture Consulting strictly follows PSR standards.</description>
|
||||||
<file>./src</file>
|
<file>./src</file>
|
||||||
<arg name="extensions" value="php"/>
|
<arg name="extensions" value="php"/>
|
||||||
<rule ref="PSR1"/>
|
|
||||||
<rule ref="PSR2"/>
|
|
||||||
<rule ref="PSR12"/>
|
<rule ref="PSR12"/>
|
||||||
</ruleset>
|
</ruleset>
|
||||||
|
|
Loading…
Reference in New Issue