You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

84 lines
4.2 KiB

3 years ago
  1. <h1 align="center">ramsey/collection</h1>
  2. <p align="center">
  3. <strong>A PHP library for representing and manipulating collections.</strong>
  4. </p>
  5. <p align="center">
  6. <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>
  7. <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>
  8. <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>
  9. <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>
  10. <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>
  11. <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>
  12. <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>
  13. <a href="https://packagist.org/packages/ramsey/collection/stats"><img src="https://img.shields.io/packagist/dt/ramsey/collection.svg?style=flat-square&colorB=darkmagenta" alt="Package downloads on Packagist"></a>
  14. <a href="https://phpc.chat/channel/ramsey"><img src="https://img.shields.io/badge/phpc.chat-%23ramsey-darkslateblue?style=flat-square" alt="Chat with the maintainers"></a>
  15. </p>
  16. ## About
  17. ramsey/collection is a PHP 7.2+ library for representing and manipulating collections.
  18. Much inspiration for this library came from the [Java Collections Framework][java].
  19. This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
  20. By participating in this project and its community, you are expected to
  21. uphold this code.
  22. ## Installation
  23. Install this package as a dependency using [Composer](https://getcomposer.org).
  24. ``` bash
  25. composer require ramsey/collection
  26. ```
  27. ## Usage
  28. Examples of how to use this framework can be found in the
  29. [Wiki pages](https://github.com/ramsey/collection/wiki/Examples).
  30. ## Contributing
  31. Contributions are welcome! Before contributing to this project, familiarize
  32. yourself with [CONTRIBUTING.md](CONTRIBUTING.md).
  33. To develop this project, you will need [PHP](https://www.php.net) 7.2 or greater
  34. and [Composer](https://getcomposer.org).
  35. After cloning this repository locally, execute the following commands:
  36. ``` bash
  37. cd /path/to/repository
  38. composer install
  39. ```
  40. Now, you are ready to develop!
  41. ## Coordinated Disclosure
  42. Keeping user information safe and secure is a top priority, and we welcome the
  43. contribution of external security researchers. If you believe you've found a
  44. security issue in software that is maintained in this repository, please read
  45. [SECURITY.md][] for instructions on submitting a vulnerability report.
  46. ## ramsey/collection for Enterprise
  47. Available as part of the Tidelift Subscription.
  48. The maintainers of ramsey/collection and thousands of other packages are working
  49. with Tidelift to deliver commercial support and maintenance for the open source
  50. packages you use to build your applications. Save time, reduce risk, and improve
  51. code health, while paying the maintainers of the exact packages you use.
  52. [Learn more.](https://tidelift.com/subscription/pkg/packagist-ramsey-collection?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
  53. ## Copyright and License
  54. The ramsey/collection library is copyright © [Ben Ramsey](https://benramsey.com)
  55. and licensed for use under the terms of the
  56. MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
  57. [java]: http://docs.oracle.com/javase/8/docs/technotes/guides/collections/index.html
  58. [security.md]: https://github.com/ramsey/collection/blob/master/SECURITY.md