lane4hub/classversion

ClassVersion enables loading classes with the same name from specific subdirectories associated with respective version labels

1.0.0 2025-01-31 17:07 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpstan/phpstan: ^2.0.4
• phpunit/phpunit: ^9.6.22
• squizlabs/php_codesniffer: ^3.11.2

MIT

• Rolf Beab

• version
• loader
• Domain Driven Design
• classversion
• version class loader
• jardis
• lane4 digital
• lane4hub

README

ClassVersion enables loading classes with the same name from specific subdirectories associated with respective version labels.

Description for example code

This code implements a dynamic loading system for classes, allowing different versions of a class to be loaded from corresponding subdirectories. The main functionality is provided by the ClassVersion and ClassVersionConfig classes. Here is a step-by-step explanation:

1. Class Version Configuration:
   • The $classVersions variable defines a mapping of subdirectories (subDirectory) to available version labels (version1, version2).
2. Configuration Initialization:
   • A ClassVersionConfig object is created and initialized with the version configuration $classVersions.
3. ClassVersion Instance:
   • An instance of ClassVersion is created, working with the previously defined configuration.
4. Loading Classes:
   • ClassVersion enables loading classes in different versions:

• $classVersion(YourClass::class): Loads the default version of the class YourClass.
• $classVersion(YourClass::class, 'version1'): Loads version version1 of the class YourClass.
• $classVersion(YourClass::class, 'version2'): Loads version version2 of the class YourClass.

Code Benefits

This approach allows different versions of a class to be dynamically loaded without directly referencing the implementations in the code. This is particularly useful in projects that require versioning, such as API versions or experimental implementations of classes.

Example Code

use Jardis\Version\ClassVersion;
use Jardis\Version\config\ClassVersionConfig;

$classVersions = ['subDirectory' => ['version1', 'version2']];
$classVersionConfig = new ClassVersionConfig($classVersions);
$classVersion = new ClassVersion($classVersionConfig);

$class = $classVersion(YourClass::class)
$class1 = $classVersion(YourClass::class, 'version1')
$class2 = $classVersion(YourClass::class, 'version2')

Quickstart Composer

composer require lane4hub/classversion
make install

Quickstart GitHub

git clone https://github.com/lane4hub/classversion.git
cd classversion

GitHub Repository Contents

• Source Files:
  • src
  • tests
• Support:
  • Docker Compose
  • .env
  • pre-commit-hook.sh
  • Makefile: Simply run make in the terminal.
• Documentation:
  • README.md

The structure of the Dockerfile for building the PHP image is more comprehensive than necessary for this tool, as the resulting PHP image is used in various Lane4 tools.

We also ensure that our images are as small as possible and that no unnecessary files remain on your system during repeated builds.

Jardis Framework

This tool is part of the development of our Domain-Driven Design framework Jardis (Just a reliable domain integration system).

Jardis consists of a collection of highly professional PHP software packages and concepts based on DDD, explicitly developed for the efficient and sustainable solution of complex business applications.

Our development is based on defined standards such as DDD and PSR, aiming to deliver the highest possible quality for functional and non-functional requirements.

For technical quality assurance, we use PhpStan Level 8, PhpCS, and generate full test coverage with PhpUnit.

Our software packages meet the following quality attributes:

• Analyzability
• Adaptability
• Extensibility
• Modularity
• Maintainability
• Testability
• Scalability
• High performance