grottopress/setter

Set private object attributes directly, without calling setter methods.

v1.0.0 2023-05-31 20:32 UTC

Requires

• php: >=7.0

Requires (Dev)

• codeception/codeception: ^4.1
• codeception/module-asserts: ^1.3

MIT

• GrottoPress.com
• N Atta Kusi Adusei

• setter
• 00P

README

Description

Setter allows you to set private object attributes directly, without calling setter methods.

For example, instead of calling $myObject->setMyAttr($newValue), you can just do $myObject->myAttr = $newValue. Under the hood, Setter sets your attribute by calling a private setMyAttr() method that you define in your class.

This way, you get the benefit of syntactic sugar, while maintaining encapsulation.

Installation

Install via composer:

composer require grottopress/setter

Usage

Import trait into your class, and use thus:

<?php
declare (strict_types = 1);

namespace Vendor;

use GrottoPress\Setter\SetterTrait;

class MyClass {
    /**
     * Import trait
     */
    use SetterTrait;

    private $changeMe;
    private $leaveMeAlone;

    /**
     * Define your private setter method
     * Method name should be of the format "set{$attrName}"
     */
    private function setChangeMe($newValue)
    {
        $this->changeMe = $newValue;
    }

    // ...
}

// Instantiate
$object = new Vendor\MyClass();

// Try to set attributes
$object->changeMe = 'New Me!'; // => Works!
$object->leaveMeAlone = 'xyz'; // => Error: 'setLeaveMeAlone()' not defined

Development

Run tests with composer run test.

Contributing

1. Fork it
2. Switch to the master branch: git checkout master
3. Create your feature branch: git checkout -b my-new-feature
4. Make your changes, updating changelog and documentation as appropriate.
5. Commit your changes: git commit
6. Push to the branch: git push origin my-new-feature
7. Submit a new Pull Request against the GrottoPress:master branch.