Common PHP project library
Go to file
flash 73051dc71e Bump LICENCE year. 2024-02-06 23:52:46 +00:00
bench Imported into new repository. 2022-09-13 15:13:11 +02:00
docs Imported into new repository. 2022-09-13 15:13:11 +02:00
src Added database result iterator. 2024-02-06 21:39:36 +00:00
tests Removed AString and IString and turned WString into a utility class like XString for multibyte strings. 2024-01-04 02:07:43 +00:00
tools Allow including Index through Composer. 2023-07-21 18:04:29 +00:00
.gitattributes Imported into new repository. 2022-09-13 15:13:11 +02:00
.gitignore Allow including Index through Composer. 2023-07-21 18:04:29 +00:00
LICENCE Bump LICENCE year. 2024-02-06 23:52:46 +00:00
README.md Bump minimum PHP requirement. 2023-08-28 13:58:51 +00:00
TODO.md Updated TODO list. 2023-11-09 13:55:30 +00:00
VERSION Added database result iterator. 2024-02-06 21:39:36 +00:00
composer.json Translate to Simplified English. 2023-07-21 18:09:19 +00:00
composer.lock Added database result iterator. 2024-02-06 21:39:36 +00:00
index.php Allow including Index through Composer. 2023-07-21 18:04:29 +00:00
phpdoc.xml Imported into new repository. 2022-09-13 15:13:11 +02:00
phpstan.neon Imported into new repository. 2022-09-13 15:13:11 +02:00
phpunit.xml Allow including Index through Composer. 2023-07-21 18:04:29 +00:00

README.md

Index

Index is a common library for my PHP projects.

It provides a number of components that I would otherwise copy between projects (and thus become out-of-sync) as well as a number of quality of life things on top of standard PHP stdlib functionality such as abstractions of arrays and strings as objects inspired by .NET's standard library.

Requirements and Dependencies

Index currently targets PHP 8.2 with the mbstring extension installed.

Index\Data\MariaDB

Requires the mysqli extension. mysqlnd is recommended as the underlying driver, but libmysql should work without a hitch. This driver also works for MySQL as the dependencies would suggest, but you should consider using MariaDB instead of possible.

Index\Data\SQLite

Requires the sqlite3 extension.

Versioning

Index versioning will mostly follow the Semantic Versioning specification v2.0.0, counting dropped support for a minor PHP version (e.g. 7.1 -> 7.2 or 7.4 -> 8.0) as a reason to increment the major version. Previous major versions may be supported for a time with backports depending on what projects of mine still target older versions of PHP.

The version is stored in the root of the repository in a file called VERSION and can be read out within Index using Index\Environment::getIndexVersion().

Contribution

By submitting code for inclusion in the main Index source tree you agree to transfer ownership of the code to the project owner. The contributor will still be attributed for the contributed code, unless they ask for this attribution to be removed. This is to avoid intellectual property rights traps and drama that could lead to blackmail situations. If you do not agree with these terms, you are free to fork off.

Licencing

Index is available under the BSD 3-Clause Clear License, a full version of which is enclosed in the LICENCE file.