Filling properties from current user

[c-v-c-v]

feature

Similar to the FromRouteParameter attribute, inject the currently logged-in user.

#[Attribute(Attribute::TARGET_PROPERTY)]
class FromCurrentUser
{
    /**
     * @param  class-string|null  $userClass
     */
    public function __construct(
        public ?string $guard = null,
        public bool $replaceWhenPresentInBody = true,
        public ?string $userClass = null
    ) {}
}

#[Attribute(Attribute::TARGET_PROPERTY)]
class FromCurrentUserProperty
{
    public function __construct(
        public ?string $guard = null,
        public ?string $property = null,
        public bool $replaceWhenPresentInBody = true,
        public ?string $userClass = null
    ) {}
}

"$userClass indicates that data will only be injected for this class. Although most of the time a guard can be used instead, this is still very useful in certain situations. For example, in an API endpoint for creating user-related data, both users and admins can make requests. A user can create their own data, while an admin can create data for all users.

implement

Similar to the FillRouteParameterPropertiesDataPipe

<?php

namespace App\Common\Data\Pipes;

use App\Common\Data\Attributes\FromCurrentUser;
use App\Common\Data\Attributes\FromCurrentUserProperty;
use Illuminate\Http\Request;
use Spatie\LaravelData\DataPipes\DataPipe;
use Spatie\LaravelData\Support\Creation\CreationContext;
use Spatie\LaravelData\Support\DataClass;
use Spatie\LaravelData\Support\DataProperty;

class FillCurrentUserPropertiesDataPipe implements DataPipe
{
    public function handle(mixed $payload, DataClass $class, array $properties, CreationContext $creationContext): array
    {
        if (! $payload instanceof Request) {
            return $properties;
        }

        foreach ($class->properties as $dataProperty) {
            /** @var null|FromCurrentUser|FromCurrentUserProperty $attribute */
            $attribute = $dataProperty->attributes->first(
                fn (object $attribute) => $attribute instanceof FromCurrentUser || $attribute instanceof FromCurrentUserProperty
            );

            if ($attribute === null) {
                continue;
            }

            // if inputMappedName exists, use it first
            $name = $dataProperty->inputMappedName ?: $dataProperty->name;
            if (! $attribute->replaceWhenPresentInBody && array_key_exists($name, $properties)) {
                continue;
            }

            $user = $payload->user($attribute->guard);

            if (
                $user === null
                || ($attribute->userClass && ! ($user instanceof $attribute->userClass))) {
                continue;
            }

            $value = $this->resolveValue($dataProperty, $attribute, $user);
            if ($value === null) {
                continue;
            }
            $properties[$name] = $value;

            // keep the original property name
            if ($name !== $dataProperty->name) {
                $properties[$dataProperty->name] = $properties[$name];
            }
        }

        return $properties;
    }

    private function resolveValue(
        DataProperty $dataProperty,
        FromCurrentUser|FromCurrentUserProperty $attribute,
        mixed $user,
    ) {
        if ($attribute instanceof FromCurrentUser) {
            return $user;
        }

        if (empty($user)) {
            return null;
        }

        return data_get($user, $attribute->property ?? $dataProperty->name);
    }
}

Don't Repeat Yourself，I'm wondering if the specific implementation can be similar to Laravel's official CurrentUser attribute.
laravel/framework#52265

[rubenvanassche]

Looking good, you're always welcome to send in a tested and documented PR and I'll gladly merge it!