README

This is a library project providing building blocks for building your own PHP application.

📚 Documentation

Visit elephox.dev for the documentation.

🎯 Goals

Take a look at the Notion page for the goals of this project: Notion

✨ Contributing

Contributions in all forms are welcome. Make sure to read elephox.dev/contributing for the details.

🏷️ Get the Badge

Using Elephox in your project? Add a badge to your README:

Replace the value of the style parameter for different styles (flat, flat-square, plastic, for-the-badge).

[![Elephox Framework](https://img.shields.io/badge/framework-Elephox-blue?style=flat&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8%2BCjxzdmcKICAgd2lkdGg9IjcxLjAxNTk2MW1tIgogICBoZWlnaHQ9IjgxLjI4Njg5Nm1tIgogICB2aWV3Qm94PSIwIDAgMjUxLjYwOTQ2IDI4OC4wMDAwMSIKICAgdmVyc2lvbj0iMS4xIgogICBpZD0ic3ZnMyIKICAgc29kaXBvZGk6ZG9jbmFtZT0ibGV0dGVyLnN2ZyIKICAgaW5rc2NhcGU6dmVyc2lvbj0iMS4xLjIgKGI4ZTI1YmU4MzMsIDIwMjItMDItMDUpIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB4bWxuczpzdmc9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8ZGVmcwogICAgIGlkPSJkZWZzNyI%2BCiAgICA8bGluZWFyR3JhZGllbnQKICAgICAgIGlua3NjYXBlOmNvbGxlY3Q9ImFsd2F5cyIKICAgICAgIGlkPSJuZW9uIj4KICAgICAgPHN0b3AKICAgICAgICAgc3R5bGU9InN0b3AtY29sb3I6IzNjZTdmNTtzdG9wLW9wYWNpdHk6MSIKICAgICAgICAgb2Zmc2V0PSIwIgogICAgICAgICBpZD0ic3RvcDgyNCIgLz4KICAgICAgPHN0b3AKICAgICAgICAgc3R5bGU9InN0b3AtY29sb3I6I2RjMjg3NztzdG9wLW9wYWNpdHk6MSIKICAgICAgICAgb2Zmc2V0PSIxIgogICAgICAgICBpZD0ic3RvcDgyNiIgLz4KICAgIDwvbGluZWFyR3JhZGllbnQ%2BCiAgICA8bGluZWFyR3JhZGllbnQKICAgICAgIGlua3NjYXBlOmNvbGxlY3Q9ImFsd2F5cyIKICAgICAgIHhsaW5rOmhyZWY9IiNuZW9uIgogICAgICAgaWQ9ImxpbmVhckdyYWRpZW50ODMwIgogICAgICAgeDE9IjI3Ny4yMzUwOCIKICAgICAgIHkxPSI3MC42MjE1MjkiCiAgICAgICB4Mj0iMjIyLjcxNzk2IgogICAgICAgeTI9IjM2MS4yNTY3NyIKICAgICAgIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIgogICAgICAgZ3JhZGllbnRUcmFuc2Zvcm09InRyYW5zbGF0ZSgtNDYuMzIxNzA2LC03Mi4yOTE1NDgpIiAvPgogIDwvZGVmcz4KICA8c29kaXBvZGk6bmFtZWR2aWV3CiAgICAgaWQ9Im5hbWVkdmlldzUiCiAgICAgcGFnZWNvbG9yPSIjZmZmZmZmIgogICAgIGJvcmRlcmNvbG9yPSIjNjY2NjY2IgogICAgIGJvcmRlcm9wYWNpdHk9IjEuMCIKICAgICBpbmtzY2FwZTpwYWdlc2hhZG93PSIyIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwLjAiCiAgICAgaW5rc2NhcGU6cGFnZWNoZWNrZXJib2FyZD0iMCIKICAgICBpbmtzY2FwZTpkb2N1bWVudC11bml0cz0ibW0iCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGlua3NjYXBlOnpvb209IjEuNDE0MjEzNiIKICAgICBpbmtzY2FwZTpjeD0iNTEzLjM1OTUxIgogICAgIGlua3NjYXBlOmN5PSIxNDcuNzg1MzEiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSIyNTYwIgogICAgIGlua3NjYXBlOndpbmRvdy1oZWlnaHQ9IjEwMDkiCiAgICAgaW5rc2NhcGU6d2luZG93LXg9Ii04IgogICAgIGlua3NjYXBlOndpbmRvdy15PSItOCIKICAgICBpbmtzY2FwZTp3aW5kb3ctbWF4aW1pemVkPSIxIgogICAgIGlua3NjYXBlOmN1cnJlbnQtbGF5ZXI9InN2ZzMiPgogICAgPGlua3NjYXBlOmdyaWQKICAgICAgIHR5cGU9Inh5Z3JpZCIKICAgICAgIGlkPSJncmlkMjYxMyIKICAgICAgIG9yaWdpbng9Ii00Ni4zMjMwMjgiCiAgICAgICBvcmlnaW55PSItNzIuMjkxNTQzIiAvPgogIDwvc29kaXBvZGk6bmFtZWR2aWV3PgogIDxwYXRoCiAgICAgaWQ9IlBhdGgiCiAgICAgZmlsbD0ibm9uZSIKICAgICBzdHJva2U9IiMwMDAwMDAiCiAgICAgc3Ryb2tlLXdpZHRoPSIxIgogICAgIGQ9Ik0gMjAwLjgxOTc0LDI4OCBIIC0yLjY0MTM2MTdlLTQgTCA1MC44MTk3MzUsMCBIIDI1MS42MDk3NCBsIC0xMS4yLDYyLjQxMDAwMiBoIC0xMjguOCBsIC05LjIsNTMuOTk5OTk4IGggMTA2LjQxIGwgLTExLjIxLDYyLjM5IEggOTEuMjA5NzM0IGwgLTgsNDYuNzkgSCAyMTEuOTk5NzQgWiIKICAgICBzdHlsZT0iZmlsbDp1cmwoI2xpbmVhckdyYWRpZW50ODMwKTtmaWxsLW9wYWNpdHk6MTtmaWxsLXJ1bGU6bm9uemVybztzdHJva2U6bm9uZSIKICAgICBpbmtzY2FwZTpleHBvcnQtZmlsZW5hbWU9IkM6XFVzZXJzXHJpYlxEb3dubG9hZHNcRWxlcGhveFxsb2dvLWJhbm5lci5wbmciCiAgICAgaW5rc2NhcGU6ZXhwb3J0LXhkcGk9Ijk2IgogICAgIGlua3NjYXBlOmV4cG9ydC15ZHBpPSI5NiIKICAgICBzb2RpcG9kaTpub2RldHlwZXM9ImNjY2NjY2NjY2NjY2MiIC8%2BCjwvc3ZnPgo%3D)](https://elephox.dev)

<a href="https://elephox.dev"><img alt="Elephox Framework" src="https://img.shields.io/badge/framework-Elephox-blue?style=flat&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8%2BCjxzdmcKICAgd2lkdGg9IjcxLjAxNTk2MW1tIgogICBoZWlnaHQ9IjgxLjI4Njg5Nm1tIgogICB2aWV3Qm94PSIwIDAgMjUxLjYwOTQ2IDI4OC4wMDAwMSIKICAgdmVyc2lvbj0iMS4xIgogICBpZD0ic3ZnMyIKICAgc29kaXBvZGk6ZG9jbmFtZT0ibGV0dGVyLnN2ZyIKICAgaW5rc2NhcGU6dmVyc2lvbj0iMS4xLjIgKGI4ZTI1YmU4MzMsIDIwMjItMDItMDUpIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB4bWxuczpzdmc9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8ZGVmcwogICAgIGlkPSJkZWZzNyI%2BCiAgICA8bGluZWFyR3JhZGllbnQKICAgICAgIGlua3NjYXBlOmNvbGxlY3Q9ImFsd2F5cyIKICAgICAgIGlkPSJuZW9uIj4KICAgICAgPHN0b3AKICAgICAgICAgc3R5bGU9InN0b3AtY29sb3I6IzNjZTdmNTtzdG9wLW9wYWNpdHk6MSIKICAgICAgICAgb2Zmc2V0PSIwIgogICAgICAgICBpZD0ic3RvcDgyNCIgLz4KICAgICAgPHN0b3AKICAgICAgICAgc3R5bGU9InN0b3AtY29sb3I6I2RjMjg3NztzdG9wLW9wYWNpdHk6MSIKICAgICAgICAgb2Zmc2V0PSIxIgogICAgICAgICBpZD0ic3RvcDgyNiIgLz4KICAgIDwvbGluZWFyR3JhZGllbnQ%2BCiAgICA8bGluZWFyR3JhZGllbnQKICAgICAgIGlua3NjYXBlOmNvbGxlY3Q9ImFsd2F5cyIKICAgICAgIHhsaW5rOmhyZWY9IiNuZW9uIgogICAgICAgaWQ9ImxpbmVhckdyYWRpZW50ODMwIgogICAgICAgeDE9IjI3Ny4yMzUwOCIKICAgICAgIHkxPSI3MC42MjE1MjkiCiAgICAgICB4Mj0iMjIyLjcxNzk2IgogICAgICAgeTI9IjM2MS4yNTY3NyIKICAgICAgIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIgogICAgICAgZ3JhZGllbnRUcmFuc2Zvcm09InRyYW5zbGF0ZSgtNDYuMzIxNzA2LC03Mi4yOTE1NDgpIiAvPgogIDwvZGVmcz4KICA8c29kaXBvZGk6bmFtZWR2aWV3CiAgICAgaWQ9Im5hbWVkdmlldzUiCiAgICAgcGFnZWNvbG9yPSIjZmZmZmZmIgogICAgIGJvcmRlcmNvbG9yPSIjNjY2NjY2IgogICAgIGJvcmRlcm9wYWNpdHk9IjEuMCIKICAgICBpbmtzY2FwZTpwYWdlc2hhZG93PSIyIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwLjAiCiAgICAgaW5rc2NhcGU6cGFnZWNoZWNrZXJib2FyZD0iMCIKICAgICBpbmtzY2FwZTpkb2N1bWVudC11bml0cz0ibW0iCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGlua3NjYXBlOnpvb209IjEuNDE0MjEzNiIKICAgICBpbmtzY2FwZTpjeD0iNTEzLjM1OTUxIgogICAgIGlua3NjYXBlOmN5PSIxNDcuNzg1MzEiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSIyNTYwIgogICAgIGlua3NjYXBlOndpbmRvdy1oZWlnaHQ9IjEwMDkiCiAgICAgaW5rc2NhcGU6d2luZG93LXg9Ii04IgogICAgIGlua3NjYXBlOndpbmRvdy15PSItOCIKICAgICBpbmtzY2FwZTp3aW5kb3ctbWF4aW1pemVkPSIxIgogICAgIGlua3NjYXBlOmN1cnJlbnQtbGF5ZXI9InN2ZzMiPgogICAgPGlua3NjYXBlOmdyaWQKICAgICAgIHR5cGU9Inh5Z3JpZCIKICAgICAgIGlkPSJncmlkMjYxMyIKICAgICAgIG9yaWdpbng9Ii00Ni4zMjMwMjgiCiAgICAgICBvcmlnaW55PSItNzIuMjkxNTQzIiAvPgogIDwvc29kaXBvZGk6bmFtZWR2aWV3PgogIDxwYXRoCiAgICAgaWQ9IlBhdGgiCiAgICAgZmlsbD0ibm9uZSIKICAgICBzdHJva2U9IiMwMDAwMDAiCiAgICAgc3Ryb2tlLXdpZHRoPSIxIgogICAgIGQ9Ik0gMjAwLjgxOTc0LDI4OCBIIC0yLjY0MTM2MTdlLTQgTCA1MC44MTk3MzUsMCBIIDI1MS42MDk3NCBsIC0xMS4yLDYyLjQxMDAwMiBoIC0xMjguOCBsIC05LjIsNTMuOTk5OTk4IGggMTA2LjQxIGwgLTExLjIxLDYyLjM5IEggOTEuMjA5NzM0IGwgLTgsNDYuNzkgSCAyMTEuOTk5NzQgWiIKICAgICBzdHlsZT0iZmlsbDp1cmwoI2xpbmVhckdyYWRpZW50ODMwKTtmaWxsLW9wYWNpdHk6MTtmaWxsLXJ1bGU6bm9uemVybztzdHJva2U6bm9uZSIKICAgICBpbmtzY2FwZTpleHBvcnQtZmlsZW5hbWU9IkM6XFVzZXJzXHJpYlxEb3dubG9hZHNcRWxlcGhveFxsb2dvLWJhbm5lci5wbmciCiAgICAgaW5rc2NhcGU6ZXhwb3J0LXhkcGk9Ijk2IgogICAgIGlua3NjYXBlOmV4cG9ydC15ZHBpPSI5NiIKICAgICBzb2RpcG9kaTpub2RldHlwZXM9ImNjY2NjY2NjY2NjY2MiIC8%2BCjwvc3ZnPgo%3D"></a>

📋 Source code annotations

✅ To Do

modules/Collection/src/ArrayList.php
- replace generic enumerable function with array-specific functions where possible
modules/Collection/src/ArrayMap.php
- replace generic enumerable function with array-specific functions where possible
modules/Collection/src/ArraySet.php
- replace generic enumerable function with array-specific functions where possible
modules/Collection/src/IsKeyedEnumerable.php
- rewrite more functions to use iterators
modules/Collection/src/Iterator/OrderedIterator.php
- cache keys
modules/Logging/test/AnsiColorSinkTest.php
- write tests for background and options
modules/Web/src/Routing/InvalidRequestController.php
- change message to be more general and/or create more specific exceptions

⚠️ Fixes

modules/Collection/src/IsArrayEnumerable.php
- this seems to be worse than the generic implementation in IsEnumerable (according to phpbench). This can be improved.
modules/Collection/src/IsEnumerable.php
- de-duplicate code from IsEnumerable and IsKeyedEnumerable where possible (move iterator creation to trait and return self with created iterator)

🤔 Maybe

modules/Collection/src/Iterator/ReverseIterator.php
- only reverse key order if key is numeric

🚧 Related issues

vimeo/psalm
- #7795

elephox / framework

Maintainers

Details