83 lines
3.8 KiB
Markdown
83 lines
3.8 KiB
Markdown
|
<h1 align="center">ramsey/collection</h1>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<strong>A PHP library for representing and manipulating collections.</strong>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://github.com/ramsey/collection"><img src="http://img.shields.io/badge/source-ramsey/collection-blue.svg?style=flat-square" alt="Source Code"></a>
|
||
|
|
<a href="https://packagist.org/packages/ramsey/collection"><img src="https://img.shields.io/packagist/v/ramsey/collection.svg?style=flat-square&label=release" alt="Download Package"></a>
|
||
|
|
<a href="https://php.net"><img src="https://img.shields.io/packagist/php-v/ramsey/collection.svg?style=flat-square&colorB=%238892BF" alt="PHP Programming Language"></a>
|
||
|
|
<a href="https://github.com/ramsey/collection/blob/master/LICENSE"><img src="https://img.shields.io/packagist/l/ramsey/collection.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a>
|
||
|
|
<a href="https://github.com/ramsey/collection/actions?query=workflow%3ACI"><img src="https://img.shields.io/github/workflow/status/ramsey/collection/CI?label=CI&logo=github&style=flat-square" alt="Build Status"></a>
|
||
|
|
<a href="https://codecov.io/gh/ramsey/collection"><img src="https://img.shields.io/codecov/c/gh/ramsey/collection?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
|
||
|
|
<a href="https://shepherd.dev/github/ramsey/collection"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fcollection%2Fcoverage" alt="Psalm Type Coverage"></a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
ramsey/collection is a PHP library for representing and manipulating collections.
|
||
|
|
|
||
|
|
Much inspiration for this library came from the [Java Collections Framework][java].
|
||
|
|
|
||
|
|
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
|
||
|
|
By participating in this project and its community, you are expected to
|
||
|
|
uphold this code.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Install this package as a dependency using [Composer](https://getcomposer.org).
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
composer require ramsey/collection
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Examples of how to use this framework can be found in the
|
||
|
|
[Wiki pages](https://github.com/ramsey/collection/wiki/Examples).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! Before contributing to this project, familiarize
|
||
|
|
yourself with [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
|
|
|
||
|
|
To develop this project, you will need [PHP](https://www.php.net) 7.3 or greater
|
||
|
|
and [Composer](https://getcomposer.org).
|
||
|
|
|
||
|
|
After cloning this repository locally, execute the following commands:
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
cd /path/to/repository
|
||
|
|
composer install
|
||
|
|
```
|
||
|
|
|
||
|
|
Now, you are ready to develop!
|
||
|
|
|
||
|
|
## Coordinated Disclosure
|
||
|
|
|
||
|
|
Keeping user information safe and secure is a top priority, and we welcome the
|
||
|
|
contribution of external security researchers. If you believe you've found a
|
||
|
|
security issue in software that is maintained in this repository, please read
|
||
|
|
[SECURITY.md][] for instructions on submitting a vulnerability report.
|
||
|
|
|
||
|
|
## ramsey/collection for Enterprise
|
||
|
|
|
||
|
|
Available as part of the Tidelift Subscription.
|
||
|
|
|
||
|
|
The maintainers of ramsey/collection and thousands of other packages are working
|
||
|
|
with Tidelift to deliver commercial support and maintenance for the open source
|
||
|
|
packages you use to build your applications. Save time, reduce risk, and improve
|
||
|
|
code health, while paying the maintainers of the exact packages you use.
|
||
|
|
[Learn more.](https://tidelift.com/subscription/pkg/packagist-ramsey-collection?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
|
||
|
|
|
||
|
|
## Copyright and License
|
||
|
|
|
||
|
|
The ramsey/collection library is copyright © [Ben Ramsey](https://benramsey.com)
|
||
|
|
and licensed for use under the terms of the
|
||
|
|
MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
|
||
|
|
|
||
|
|
|
||
|
|
[java]: http://docs.oracle.com/javase/8/docs/technotes/guides/collections/index.html
|
||
|
|
[security.md]: https://github.com/ramsey/collection/blob/master/SECURITY.md
|