sebastian-meyer
/
php-basics
mirror of https://github.com/opencultureconsulting/php-basics.git
2
0
Fork 0
Code Issues

Update documentation

This commit is contained in:
Sebastian Meyer 2024-02-09 22:57:20 +01:00
parent 0ae6064c1e
commit c4479b4990
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,10 +1,25 @@
# PHP Basics
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.
***A collection of generic classes and useful traits for PHP projects.***
[![PHPStan](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml)
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)
## Usage
The most convenient way to use the PHP Basics classes and traits in your own project is `composer require opencultureconsulting/basics`
[![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)

2
composer.json
View File

@ -1,6 +1,6 @@
{
"name": "opencultureconsulting/basics",
"description": "This is a collection of generic Classes and useful Traits for PHP projects.",
"description": "A collection of generic classes and useful traits for PHP projects.",
"type": "library",
"keywords": [
"ArrayAccess",