VGirol / JsonApi

src/Resources/IsRelationship.php

<?php

namespace VGirol\JsonApi\Resources;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use VGirol\JsonApiConstant\Members;

trait IsRelationship
{
    /**
     * Transform the resource into an array used as relationship.
     *
     * @param Request $request
     * @param Model   $model            Parent model instance
     * @param string  $relationshipName
     *
     * @return array
     */
    public function asRelationship($request, $model, string $relationshipName): array
    {
        $data = [(self::$wrap ?? Members::DATA) => $this->toArray($request)];

It seems like toArray() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->setRelationshipMeta($request, $model);
        $this->setRelationshipLinks($request, $model, $relationshipName);

        return array_merge_recursive($data, $this->additional);
    }

    /**
     * Could be overloaded
     *
     * @param Request $request
     * @param Model   $model   Parent model instance
     *
     * @return void
     */
    protected function setRelationshipMeta($request, $model)

The parameter $model is not used and could be removed.

The parameter $request is not used and could be removed.

    {
        // $this->addRelationshipMeta('key', 'value');
    }

    /**
     * Could be overloaded
     *
     * @param Request $request
     * @param Model   $model            Parent model instance
     * @param string  $relationshipName
     *
     * @return void
     */
    protected function setRelationshipLinks($request, $model, string $relationshipName)

The parameter $request is not used and could be removed.

    {
        $this->addRelationshipLink(Members::LINK_SELF, $this->getRelationshipSelfLink($model, $relationshipName));

It seems like getRelationshipSelfLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like addRelationshipLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->addRelationshipLink(Members::LINK_RELATED, $this->getRelationshipRelatedLink($model, $relationshipName));

It seems like getRelationshipRelatedLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}