spatie / laravel-resource-links

src/HasLinks.php

<?php

namespace Spatie\ResourceLinks;

/** @mixin \Illuminate\Http\Resources\Json\JsonResource */
trait HasLinks
{
    /** @var bool */
    private $withCollectionLinks = false;

    /**
     * @param string|\Closure|null|array $controller
     * @param null $parameters

Are you sure the doc-type for parameter $parameters is correct as it would always require null to be passed?

     *
     * @return \Spatie\ResourceLinks\LinkResource
     */
    public function links($controller = null, $parameters = null): LinkResource
    {
        $resource = LinkResource::create($this->resource, LinkResourceType::ITEM)->link($controller, $parameters);

        if (property_exists($this, 'withCollectionLinks') && $this->withCollectionLinks) {
            $resource->withCollectionLinks();
        }

        return $resource;
    }

    /**
     * @param string|\Closure|null|array $controller
     * @param null $parameters

Are you sure the doc-type for parameter $parameters is correct as it would always require null to be passed?

     *
     * @return \Spatie\ResourceLinks\LinkResource
     */
    public static function collectionLinks($controller = null, $parameters = null): LinkResource
    {
        return LinkResource::create(null, LinkResourceType::COLLECTION)->link($controller, $parameters);
    }

    public function withCollectionLinks()
    {
        $this->withCollectionLinks = true;

        return $this;
    }
}