Debian Codegraph @

vendor/ramsey/collection/README.md

raw
1 <h1 align="center">ramsey/collection</h1>
2
3 <p align="center">
4 <strong>A PHP library for representing and manipulating collections.</strong>
5 </p>
6
7 <p align="center">
8 <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>
9 <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>
10 <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>
11 <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>
12 <a href="https://github.com/ramsey/collection/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/actions/workflow/status/ramsey/collection/continuous-integration.yml?branch=main&logo=github&style=flat-square" alt="Build Status"></a>
13 <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>
14 </p>
15
16 ## About
17
18 ramsey/collection is a PHP library for representing and manipulating collections.
19
20 Much inspiration for this library came from the [Java Collections Framework][java].
21
22 This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
23 By participating in this project and its community, you are expected to
24 uphold this code.
25
26 ## Installation
27
28 Install this package as a dependency using [Composer](https://getcomposer.org).
29
30 ``` bash
31 composer require ramsey/collection
32 ```
33
34 ## Usage
35
36 Examples of how to use this library may be found in the
37 [Wiki pages](https://github.com/ramsey/collection/wiki/Examples).
38
39 ## Contributing
40
41 Contributions are welcome! To contribute, please familiarize yourself with
42 [CONTRIBUTING.md](CONTRIBUTING.md).
43
44 ## Coordinated Disclosure
45
46 Keeping user information safe and secure is a top priority, and we welcome the
47 contribution of external security researchers. If you believe you've found a
48 security issue in software that is maintained in this repository, please read
49 [SECURITY.md][] for instructions on submitting a vulnerability report.
50
51 ## Copyright and License
52
53 The ramsey/collection library is copyright © [Ben Ramsey](https://benramsey.com)
54 and licensed for use under the terms of the
55 MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
56
57
58 [java]: http://docs.oracle.com/javase/8/docs/technotes/guides/collections/index.html
59 [security.md]: https://github.com/ramsey/collection/blob/main/SECURITY.md