README

An Efficient Dependency Injector and Encapsulator

Capsule is a library that uses a Container to manage dependencies and objects in an organized and centralized way, thus facilitating encapsulation.

🔖 Contents

An Efficient Dependency Injector and Encapsulator

📋 Requirements

Requires PHP 8.1+ (at least 8.1.14 recommended to avoid potential bugs).

Requires Composer v2+ to manage PHP dependencies.

⚡️ Installation

Install Capsule using Composer:

By adding the sikessem/capsule dependency to your composer.json file:

{
    "require" : {
        "sikessem/capsule": "^0.5"
    }
}

Or by including the dependency:

composer require sikessem/capsule --no-dev

🧑‍💻 Usage

Define your custom components using Capsule's interfaces and traits:

<?php

namespace Sikessem\Capsule\Sample;

use Sikessem\Capsule\Core\IsEncapsulated;

interface CustomInterface extends IsEncapsulated
{
    public function getName(): string;

    public function setName(string $name): void;
}

<?php

namespace Sikessem\Capsule\Sample;

final class CustomClass implements CustomInterface
{
    use CustomTrait;

    public function __construct(string $name = 'World')
    {
        $this->setName($name);
    }
}

<?php

namespace Sikessem\Capsule\Sample;

use Sikessem\Capsule\Core\HasEncapsulator;

trait CustomTrait
{
    use HasEncapsulator;

    protected string $name;

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }
}

You can use your components as below:

<?php

use Sikessem\Capsule\Sample\CustomClass;

$capsule = new CustomClass('Sikessem');

isset($capsule->name); // Returns true

echo $capsule->name; // Prints "Sikessem"

unset($capsule->name); // Does nothing

isset($capsule->name); // Returns true

$capsule->value = 'value'; // Throws an exception

$capsule->name = 'value'; // Set name to "value"

echo $capsule->name; // Prints "value"

$capsule->on('hello', function (?string $name = null) {
    return 'Hello '.($name ?? 'Sikessem').'!';
});

echo $capsule->hello(); //Prints "Hello Sikessem!"

👏 Contribution

The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.

👷 Code of Conduct

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

👥 Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.

🔒️ Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

💬 Discussions

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

🔐 Security Reports

If you discover a security vulnerability within any of Sikessem's projects, please email SIGUI Kessé Emmanuel at contact@sigui.ci. All security vulnerabilities will be promptly addressed.

📄 License

The Sikessem Skeleton is open-sourced software licensed under the MIT License - see the LICENSE file for details.

_{Made with ❤︎ by @siguici.}

sikessem / core

Maintainers

Details