Defining a Resource

namespace App\Resource;

use apivalk\apivalk\Documentation\OpenAPI\Object\TagObject;
use apivalk\apivalk\Documentation\Property\FloatProperty;
use apivalk\apivalk\Documentation\Property\StringProperty;
use apivalk\apivalk\Resource\AbstractResource;

class AnimalResource extends AbstractResource
{
    public function getName(): string
    {
        return 'animal';
    }

    public function excludeFromMode(string $mode): array
    {
        if ($mode === self::MODE_LIST) {
            return ['weight'];
        }

        return [];
    }

    protected function init(): void
    {
        $this->addProperty(new StringProperty('animal_uuid', 'Unique identifier of the animal'));
        $this->addProperty(new StringProperty('name', 'Animal name'));
        $this->addProperty(new StringProperty('type', 'Animal type'));
        $this->addProperty((new FloatProperty('weight', 'Weight in kg'))->setIsRequired(false));
    }
}

public function getPluralName(): string
{
    return 'children';
}

public function availableFilters(): array
{
    return [
        EnumFilter::equals(new EnumProperty('status', 'Status', ['active', 'archived'])),
        StringFilter::contains(new StringProperty('name', 'Name contains')),
    ];
}

public function availableSortings(): array
{
    return [
        Sort::asc('name'),
        Sort::desc('created_at'),
    ];
}

public function tags(): array
{
    return [new TagObject('Animals', 'Animal management')];
}

$resource = AnimalResource::byRequest($request);   // from request body only
$resource = AnimalResource::byArray($row);         // from a database row

$resource = AnimalResource::byRequest($request);
$resource->animal_uuid = $request->path()->animal_uuid;

$resource->toArray(AbstractResource::MODE_LIST);   // respects excludeFromMode()

$resource->name = 'Leo';
echo $resource->name;