README

Introduction
Requirements
Installation
Documentation Publishing
- Automatic Documentation Publishing
Usage
- Nested Objects
Local Development
Contributing

Introduction

Fluently set class properties with dynamic methods.

Requirements

PHP 7.1 or higher.

Installation

Install Zerotoprod\DynamicSetter via Composer:

composer require zero-to-prod/dynamic-setter

This will add the package to your project's dependencies and create an autoloader entry for it.

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

# Publish to default location (./docs/zero-to-prod/dynamic-setter)
vendor/bin/zero-to-prod-dynamic-setter

# Publish to custom directory
vendor/bin/zero-to-prod-dynamic-setter /path/to/your/docs

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "zero-to-prod-dynamic-setter"
        ],
        "post-update-cmd": [
            "zero-to-prod-dynamic-setter"
        ]
    }
}

Usage

The DynamicSetter trait allows you to easily create class instances and dynamically set properties through method chaining. It provides a simple way to manage object instantiation and property setting with set_* methods.

To use the DynamicSetter trait, include it in your class and define the properties you want to set dynamically.

use Zerotoprod\StreamContext\DynamicSetter;

class User
{
    use DynamicSetter;

    public $name;
    public $email;
}

$user = User::new()
    ->set_name('John Doe')
    ->set_email('john.doe@example.com');

echo $user->name;  // Output: John Doe
echo $user->email; // Output: john.doe@example.com

Nested Objects

You can also use the DynamicSetter trait in classes that contain other objects, allowing you to set properties in a nested structure.

class Address
{
    use DynamicSetter;

    public $city;
    public $postalCode;
}

class Customer
{
    use DynamicSetter;

    public $name;
    public $address;
}

$customer = Customer::new()
    ->set_name('Jane Doe')
    ->set_address(
        Address::new()
            ->set_city('New York')
            ->set_postalCode('10001')
    );

echo $customer->name;                   // Output: Jane Doe
echo $customer->address->city;          // Output: New York
echo $customer->address->postalCode;    // Output: 10001

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Commit changes (git commit -m 'Add some feature').
Push to the branch (git push origin feature-branch).
Create a new Pull Request.

zero-to-prod / dynamic-setter

Maintainers

Details