homebase2/hb-core

Core Libraries for Homebase 2 Framework

1.0.1 2024-10-29 19:30 UTC

Requires

• php: >=8.0

MIT

• Sergey Parf

• framework
• standalone
• homebase

README

tested with spartan-test, checked with psalm (level 2) && php-stan (level 6)

Using it

• composer require "homebase2/hb-core:dev-main" - recommended
• composer require homebase2/hb-core for stable version

Provided Classes & Functions

• Str - string methods
• Arr & Arr0 - Generic Array Methods
• DH aka DeepHash - Deep(aka nested) Array methods
• TODO: AH - Array of Hashes/Records (~ sql tables)
• TODO: ADH - Array of AH (~ mongo records)
• \hb\ functions - used by framework

FRAMEWORK DEVELOPMENT STUFF

TODO - move to Homebase Development Document

Install

1. composer install
2. install php-tools
3. ln -s ~/src/php-tools/bin tools

Notable tools provided

composer test run unit tests. use test-q to run quite tests (show errors only)

composer psalm check code with psalm

composer stan check code with php-stan (default level is 6)

composer lint php syntax check

composer psalm-dry AND composer psalm-fix (aka psalter review/apply suggested code changes by psalm, be careful always do dry before applying

composer cs-dry AND composer cs-fix review/apply suggested code changes by php-cs-fixer, be careful always do dry before applying

composer doc generate phpDocumentor documentation in doc folder

./check do all checks: lint, unit tests, psalm, php-stan; stops when any of them failed

./check-commit, ./check-push do ./check, add all new files to git, do git commit -v -s and git push --tags

./psysh php shell: Docs
notable commands: wtf, doc ClassName, doc ClassName::method, show ClassName::method, ls -l ClassName, ls -l --grep all \hb\Arr use help to see more

PS:
this project was bootstrapped from composer-php8-template