|
1 | 1 | # alof-lib |
2 | | -[](https://packagist.org/packages/vectorial1024/alof-lib) |
3 | | - |
4 | | -[](https://packagist.org/packages/vectorial1024/alof-lib) |
5 | | -[](https://packagist.org/packages/vectorial1024/alof-lib) |
6 | | -[](https://packagist.org/packages/vectorial1024/alof-lib) |
| 2 | +[![Packagist License][packagist-license-image]][packagist-url] |
| 3 | +[![Packagist Version][packagist-version-image]][packagist-url] |
| 4 | +[![Packagist Downloads][packagist-downloads-image]][packagist-stats-url] |
| 5 | +[![PHP Dependency Version][php-version-image]][packagist-url] |
| 6 | +[![GitHub Actions Workflow Status][php-build-status-image]][github-actions-url] |
| 7 | +[![GitHub Repo Stars][github-stars-image]][github-repo-url] |
7 | 8 | [](https://alof-lib.readthedocs.io/en/latest/?badge=latest) |
8 | 9 |
|
9 | 10 | (This is a WIP project!) |
10 | 11 |
|
11 | 12 | PHP array-like object functions library ("alof-lib"). Type-hinted functions for array-like objects, just like [those for native arrays](https://www.php.net/manual/en/ref.array.php). Think of this library as a polyfill of those useful functions for array-like objects, so that you may write clean code with array-like objects. |
12 | 13 |
|
13 | | -An array-like object ("ALO") is defined to be `implements ArrayAccess` and `implements Traversable`. Examples of array-like objects include: |
| 14 | +An array-like object ("ALO") is defined to be `implements ArrayAccess` and `implements Traversable`. Examples include: |
14 | 15 | - [ArrayObject](https://www.php.net/manual/en/class.arrayobject.php) (since PHP 5) |
15 | 16 | - [ArrayIterator](https://www.php.net/manual/en/class.arrayiterator.php) (since PHP 5) |
16 | 17 | - [SplObjectStorage](https://www.php.net/manual/en/class.splobjectstorage.php) (since PHP 5.1) |
@@ -65,3 +66,15 @@ assert($keys === [$objKey]); // passes |
65 | 66 |
|
66 | 67 | ## Relationship with `transmutation` |
67 | 68 | This library does the dirty work and ensures the correctness of ALO functions, while `transmutation` provides an easy-to-use API for ALO processing. |
| 69 | + |
| 70 | +[packagist-url]: https://packagist.org/packages/vectorial1024/alof-lib |
| 71 | +[packagist-stats-url]: https://packagist.org/packages/vectorial1024/alof-lib/stats |
| 72 | +[github-repo-url]: https://github.com/Vectorial1024/alof-lib |
| 73 | +[github-actions-url]: https://github.com/Vectorial1024/alof-lib/actions/workflows/php.yml |
| 74 | + |
| 75 | +[packagist-license-image]: https://img.shields.io/packagist/l/vectorial1024/alof-lib?style=plastic |
| 76 | +[packagist-version-image]: https://img.shields.io/packagist/v/vectorial1024/alof-lib?style=plastic |
| 77 | +[packagist-downloads-image]: https://img.shields.io/packagist/dm/vectorial1024/alof-lib?style=plastic |
| 78 | +[php-version-image]: https://img.shields.io/packagist/dependency-v/vectorial1024/alof-lib/php?style=plastic&label=PHP |
| 79 | +[php-build-status-image]: https://img.shields.io/github/actions/workflow/status/Vectorial1024/alof-lib/php.yml?style=plastic |
| 80 | +[github-stars-image]: https://img.shields.io/github/stars/vectorial1024/alof-lib |
0 commit comments