aedart/athenaeum-support

Aware-of Helpers for Laravel components and other utilities

8.15.0 2024-11-21 08:34 UTC

Requires

• php: ^8.2
• aedart/athenaeum-contracts: ^8.15
• aedart/athenaeum-utils: ^8.15
• illuminate/config: ^v11.33.2
• illuminate/support: ^v11.33.2

Requires (Dev)

• predis/predis: ^2.2.2
• symfony/console: ^v7.1.8
• twig/twig: ^3.15.0

Suggests

• twig/twig: Required for using aware-of generator

BSD-3-Clause

• Alin Eugen Deac

• helpers
• utils
• properties
• Athenaeum
• Aware Of

README

Offers complementary components and helpers to Laravel's Support package.

Laravel Aware-of Helpers

Traits that offer Getters and Setters helpers for some of Laravel's core packages.

These components allow you to manually set and retrieve a Laravel component, e.g. a configuration Repository. Additionally, when no component instance has been specified, it will automatically default to whatever Laravel has bound in the Service Container.

You can think of these helpers as supplements, or alternatives to Laravel's native Facades.

use \Aedart\Support\Helpers\Config\ConfigTrait;

class MyApiService
{
    use ConfigTrait;    

    public function __construct()
    {
        $config = $this->getConfig();

        $url = $config->get('services.trucks-api.url');
    
        // ... remaining not shown ...
    }
}

Aware-of Properties

In addition to the Laravel Aware-of Helpers, this package comes with an abundance of "aware-of xyz" helpers. These are generated traits that offer getters and setter methods for various types properties. They are mostly useful when creating DTOs.

use \Aedart\Support\Properties\Strings\NameTrait;
use \Aedart\Support\Properties\Integers\AgeTrait;

class Person
{
    use NameTrait;
    use AgeTrait;
}  

Documentation

Please read the official documentation for additional information.

Repository

The mono repository is located at github.com/aedart/athenaeum

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package