laravel api collection property name does not exist on this collection instance

Question

when i use api resource collection in postman with type GET it returns Property [name] does not exist on this collection instance i dont know why although i wrote everything correct please help

i make a collection folder and it returns info

note : when i return $instructors = User::where('type',3)->get(); it returns informations

here is my code

my route api.php

Route::resource('instructors',InstructorController::class);

my collection file

public function toArray($request)
{
    // return parent::toArray($request);

    return [
        'name' => $this->name,
        'email' => $this->email,
        'area_id' => $this->area_id,
        'whatsapp' => $this->whatsapp,
        'phone' => $this->phone,
        'description' => $this->description,
    ];
}

my controller

 public function index()
{

    $instructors = User::where('type',3)->get();
    $collection = new InstructorCollection($instructors);
    return response()->json(['data'=>$collection,'error']);
}

my table

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->bigIncrements('id');
        $table->string('name', 250);
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->string('password');
        $table->bigInteger('area_id')->unsigned()->nullable();
        $table->foreign('area_id')->references('id')->on('areas')->onDelete('set null');
        $table->string('whatsapp')->nullable();
        $table->string('phone')->nullable();
        $table->string('facebook')->nullable();
        $table->tinyInteger('type');
        $table->text('description')->nullable();
        $table->integer('views')->default('0');
        $table->rememberToken();
        $table->timestamps();
        $table->softDeletes();
    });
}

What if there is no type 3 instructor... and $instructors variable is null? — nikistag, Jun 18 '22 at 16:56
no when i return $instructors = User::where('type',3)->get(); it returns information — user19180330, Jun 18 '22 at 17:11

score 2 · Answer 1 · answered Jun 18 '22 at 17:15

You're using a UserResourceCollection (that has access to a $this->collection method) and trying to access the entity properties, instead of using the normal UserResource::collection method, which maps and fills multiple UserResource for you, returning an array of resources.

Create a normal resource called UserResource and call UserResource::collection($instructors) from your controller method.

More information in: https://laravel.com/docs/9.x/eloquent-resources#resource-collections

score 0 · Answer 2 · edited May 18 '23 at 20:28

Extend Illuminate\Http\Resources\Json\JsonResource class, and your problem will be resolved. If you extend ResourceCollection class, code like the following.

public function toArray($request)
{
    return [
        'data' => $this->collection->map(function ($item) {
            return [
                'name' => $item->name,
                'email' => $item->email,
                'area_id' => $item->area_id,
                'whatsapp' => $item->whatsapp,
                'phone' => $item->phone,
                'description' => $item->description,
            ];
        }),
    ];
}

laravel api collection property name does not exist on this collection instance

2 Answers2