withinboredom/record

A simple Record base class

v0.1.0 2022-09-01 20:49 UTC

MIT

• Robert Landers

README

This aims to be a bare-bones library for creating immutable records in PHP.

Example:

use Withinboredom\Record;

class Person extends Record {
    public function __construct(public readonly string $firstName, public readonly string $lastName) {
        // validate here
    }
    
    public function __toString() : string{
        return $this->firstName . ' ' . $this->lastName;
    }
}

$person = new Person('John', 'Doe');
$friend = $person->with(firstName: 'Jane');
echo "$person is friends with $friend";
// output: John Doe is friends with Jane Doe

Reason for existing

Immutable objects are a great way to prevent some classes of bugs and with PHP 8.1 we can finally make them a reality. This library provides a very simple (no bells and whistles) way to copy an object while changing one or two parameters using newer php syntax. The only thing missing is IDE support... :)

Installation

composer require withinboredom/record

Running tests

Tests deps have been intentially left out of the composer.json file.

Add in the following to run the tests:

{
  "require-dev": {
    "pestphp/pest": "^1.22"
  }
}

Then run the tests with:

./vendor/bin/pest