codingpaws/expose

This package is abandoned and no longer maintained. No replacement package was suggested.

Transforms your classes to API entities

Maintainers

Details

gitlab.com/codingpaws/expose

Source

Issues

Installs: 1 121

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Forks: 0

v1.1 2022-08-29 17:47 UTC

Requires

Requires (Dev)

MIT 3b05e9f22bb3566b0cc8383c8c709fb7bb327303

  • Kev <kevslashnull.woop@gmail.com>

This package is auto-updated.

Last update: 2024-12-29 06:58:33 UTC

README

Expose is a framework to transform your classes (e.g. Laravel entities) to API entities.

Example

Install: composer require codingpaws/expose

use CodingPaws\Expose\HasEntity;
use CodingPaws\Expose\Entity;

// Dog.php
class Dog implements HasEntity {
  public function __construct(public string $name, public string $breed)
  {
  }
}

// DogEntity.class
class DogEntity extends Entity {
  public function __invoke(): void
  {
    $this->expose('name');
    $this->expose('breed');
    $this->expose('cute', true);
  }
}

// In your controller
$result = Entity::transform(new Dog('Lacey', 'Border Collie'));

// Generates an array like
$result = [
  'name' => 'Lacey',
  'breed' => 'Border Collie',
  'cute' => true,
];