joeycumines/phelp

PHelP contains useful tools that PHP doesn't - Helpers for PHP 5.6+

dev-master 2018-12-15 05:04 UTC

Requires

• php: >=5.6
• symfony/polyfill-iconv: ^1.6
• symfony/polyfill-mbstring: ^1.6
• symfony/polyfill-php70: ^1.6
• symfony/polyfill-php71: ^1.6

Apache-2.0

• Joey Cumines

README

PHelP contains useful tools that PHP doesn't - Helpers for PHP 5.6+

Written by Joseph Cumines - but I would welcome contributions or even just code reviews.

Rulebook

1. Helper libraries with no external dependencies that are not of a similar standard AND very likely to be maintained
2. Make logical groupings of functionality, and make an effort to follow best practices
3. Always tested, cover all documented or important cases, at minimum
4. Functional style preferred, immutable objects favoured
5. Minimal or no coupling as far as practical (between libraries, etc), without sacrificing the "DRY" principle
6. Don't change method signatures without a very good reason, or very low risk (backwards-compatible changes are ok)
7. Code must be written to be used in production, and must at least have a good chance to pass a professional code review
8. As a general rule, all aggregate classes that provide more than one functionality must always use final classes implementing both a singleton style getInstance method, have no other public static methods, and provide a public default constructor for Dependency Injection
9. Unless specifically designed to be stateful, everything must be stateless
10. Clearly document all functionality, it is desirable to be able to know what something does at a glance
11. Names like classes and namespaces should be named as if they were all in lowercase words, then conjoined, so JsonObject not JSONObject, for as an example.

Release Plan

This will be maintained, and at this stage I will be regularly adding functionality - though it starts from almost nothing. I will be re-writing some features that I wrote before, some I have wanted before, and probably just doing what I want. Eventually I plan to setup either subtrees, or some way to better package the dependencies, however until then, I will just be keeping everything in one place.

Package Overview

This package uses Psr-4 namespaces. The src folder is autoload and mapped to JoeyCumines/Phelp. The tests folder is autoload-dev and mapped to Tests/JoeyCumines/Phelp.

The following headings are based on the namespaces nested within those two.

Algorithms

Solutions, grouped by functionality rather than project or category for a better code structure. While similar, the purpose of this namespace differs to JoeyCumines/Phelp/Utilities, with a focus on solutions including (but not limited to) implementations of computer-sciencey things like sorting algorithms, primitive type helpers, and general functions that extend core PHP functionality, similar to PHP's array_* methods.

Utilities

Anything that leans towards solving a specific problem instead of providing a more general solution. A good example of this would be testing utilities, which fill a very specific niche.

Helpers

"Helper" classes implement and document a thin layer between implementations in JoeyCumines/Phelp/Algorithms. Helpers are provided as a less-specific catch-all way to import your dependencies, and offer the benefit of being able to mock out their methods.

Interfaces

All interfaces, provided to be used as dependencies (in place of a concrete class), are here.

Adaptors

Concrete implementations of interfaces, that's it.

Contributing

Do what you want, I love talking about the best way to solve problems. If you think that a certain way is better, or even just want to have a crack at adding something, go for your life, I am happy to review PR's even if it's just something relevant you wrote that you want feedback for. I am not at all possessive about this project, and I am happy to incorporate any new code under the same license, if it's something I can agree on.