Flugg\Responder\Transformer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getRelations()	0	8	1
A	setRelations()	0	6	1
A	allRelationsAllowed()	0	4	1
A	callIncludeMethod()	0	14	3
A	includePivot()	0	10	2

<?php

namespace Flugg\Responder;

use Illuminate\Database\Eloquent\Relations\Pivot;
use League\Fractal\Scope;
use League\Fractal\TransformerAbstract;

/**
 * An abstract base transformer. Your transformers should extend this class, and this
 * class itself extends Fractal's transformer.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
abstract class Transformer extends TransformerAbstract
{
    /**
     * A list of all available relations.
     *
     * @var array
     */
    protected $relations = ['*'];

    /**
     * Get relations set on the transformer.
     *
     * @return array
     */
    public function getRelations():array
    {
        $relations = array_unique(array_merge($this->getAvailableIncludes(), $this->relations));

        return array_filter($relations, function($relation) {
            return $relation !== '*';
        });
    }

    /**
     * Set relations on the transformer.
     *
     * @param  array|string $relations
     * @return self
     */
    public function setRelations($relations)
    {
        $this->setAvailableIncludes(array_merge($this->availableIncludes, (array) $relations));

        return $this;
    }

    /**
     * Check if the transformer has whitelisted all relations.
     *
     * @return bool
     */
    public function allRelationsAllowed():bool
    {
        return $this->relations == ['*'];
    }

    /**
     * Call method for retrieving a relation. This method overrides Fractal's own
     * [callIncludeMethod] method to load relations directly from your models.
     *
     * @param  Scope  $scope
     * @param  string $includeName
     * @param  mixed  $data
     * @return \League\Fractal\Resource\ResourceInterface|bool
     * @throws \Exception
     */
    protected function callIncludeMethod(Scope $scope, $includeName, $data)
    {
        if ($includeName === 'pivot') {
            return $this->includePivot($data->$includeName);

The expression $this->includePivot($data->{$includeName}); of type League\Fractal\Resource\ResourceInterface|boolean adds the type boolean to the return on line 76 which is incompatible with the return type of the parent method League\Fractal\TransformerAbstract::callIncludeMethod of type League\Fractal\Resource\ResourceInterface.

        }

        $params = $scope->getManager()->getIncludeParams($scope->getIdentifier($includeName));

        if (method_exists($this, $includeName)) {
            return call_user_func([$this, $includeName], $data, $params);
        } else {
            return app(Responder::class)->transform($data->$includeName)->getResource();
        }
    }

    /**
     * Include pivot table data to the response.
     *
     * @param  Pivot $pivot
     * @return \League\Fractal\Resource\ResourceInterface|bool
     */
    protected function includePivot(Pivot $pivot)
    {
        if (! method_exists($this, 'transformPivot')) {
            return false;
        }

        return app(Responder::class)->transform($pivot, function ($pivot) {
            return $this->transformPivot($pivot);

The method transformPivot() does not seem to exist on object<Flugg\Responder\Transformer>.

        })->getResource();
    }
}