Flugg\Responder\Transformers\Concerns\OverridesFractal

Complexity

Total Complexity

6

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getAvailableIncludes()	0	8	2
A	getDefaultIncludes()	0	4	1
A	callIncludeMethod()	0	6	1
A	resolveScopedIncludes()	0	11	1
A	resolveScopedParameters()	0	4	1
	getCurrentScope()	0	1	?
	allowsAllRelations()	0	1	?
	getRelations()	0	1	?
	getDefaultRelations()	0	1	?
	includeResource()	0	1	?

<?php

namespace Flugg\Responder\Transformers\Concerns;

use Illuminate\Support\Collection;
use League\Fractal\Resource\ResourceInterface;
use League\Fractal\Scope;

/**
 * A trait to be used by a transformer to override Fractal's transformer methods.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
trait OverridesFractal
{
    /**
     * Overrides Fractal's getter for available includes.
     *
     * @return array
     */
    public function getAvailableIncludes()
    {
        if ($this->allowsAllRelations()) {
            return $this->resolveScopedIncludes($this->getCurrentScope());
        }

        return $this->getRelations();
    }

    /**
     * Overrides Fractal's getter for default includes.
     *
     * @return array
     */
    public function getDefaultIncludes()
    {
        return $this->getDefaultRelations();
    }

    /**
     * Overrides Fractal's method for including a relation.
     *
     * @param  \League\Fractal\Scope $scope
     * @param  string                $identifier
     * @param  mixed                 $data
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function callIncludeMethod(Scope $scope, $identifier, $data)
    {
        $parameters = $this->resolveScopedParameters($scope, $identifier);

        return $this->includeResource($identifier, $data, $parameters);
    }

    /**
     * Resolve scoped includes for the given scope.
     *
     * @param  \League\Fractal\Scope $scope
     * @return array
     */
    protected function resolveScopedIncludes(Scope $scope): array
    {
        $level = count($scope->getParentScopes());
        $includes = $scope->getManager()->getRequestedIncludes();

        return Collection::make($includes)->map(function ($include) {
            return explode('.', $include);
        })->filter(function ($include) use ($level) {
            return count($include) > $level;
        })->pluck($level)->unique()->all();
    }

    /**
     * Resolve scoped parameters for the given scope.
     *
     * @param  \League\Fractal\Scope $scope
     * @param  string                $identifier
     * @return array
     */
    protected function resolveScopedParameters(Scope $scope, string $identifier): array
    {
        return iterator_to_array($scope->getManager()->getIncludeParams($scope->getIdentifier($identifier)));
    }

    /**
     * Get the current scope of the transformer.
     *
     * @return \League\Fractal\Scope
     */
    public abstract function getCurrentScope();

    /**
     * Indicates if all relations are allowed.
     *
     * @return bool
     */
    public abstract function allowsAllRelations(): bool;

    /**
     * Get a list of whitelisted relations.
     *
     * @return string[]
     */
    public abstract function getRelations(): array;

    /**
     * Get a list of default relations.
     *
     * @return string[]
     */
    public abstract function getDefaultRelations(): array;

    /**
     * Include a related resource.
     *
     * @param  string $identifier
     * @param  mixed  $data
     * @param  array  $parameters
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected abstract function includeResource(string $identifier, $data, array $parameters): ResourceInterface;
}