Skip to content

pbraiders/stdlib

The autogenerated table of contents is here

Stdlib for PBRaiders

PBRaiders\Stdlib is a set of components that implements general purpose utility classes and functions for different scopes.

  • String and Array usefull functions.
  • Reflection trait to access protected/private methods/properties. Used in test classes.

Lint Code Base Tests

Requirements

This package requires:

  • PHP: 7.4 or 8.0

For specifics, please examine the manifest composer.json file.

You may check if your PHP and extension versions match the platform requirements using composer diagnose and composer check-platform-reqs. (This requires Composer to be available as composer.)

Installation

This package is installable and PSR-4 autoloadable via Composer as pbraiders/stdlib. For no dev, use composer install --no-dev and for dev, use composer install.

Alternatively, download a release, or clone this repository, then map the Pbraiders\Stdlib\ namespace to the package src/ directory.

Documentation

Please, read the non exhaustive documentation we wrote. More details may be found in the code and the comments ;)

Test

To run the unit tests at the command line, issue composer install and then composer run test at the package root. (This requires Composer to be available as composer.)

Contributing

Thanks you for taking the time to contribute. Please fork the repository and make changes as you'd like.

If you have any ideas, just open an issue and tell me what you think. Pull requests are also warmly welcome.

If you encounter any bugs, please open an issue.

Be sure to include a title and clear description,as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

License

PBRaiders\Stdlib is open-source and is licensed under the GNU General Public License v3.0.