AlgoWeb\PODataLaravel\Providers\MetadataControllerProvider

Complexity

Total Complexity

12

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Test Coverage

Coverage

79.17%

Importance

Changes	4
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	6	1
B	boot()	0	51	10
A	getCandidateControllers()	0	3	1

<?php

declare(strict_types=1);

namespace AlgoWeb\PODataLaravel\Providers;

use AlgoWeb\PODataLaravel\Controllers\MetadataControllerContainer;
use AlgoWeb\PODataLaravel\Controllers\MetadataControllerTrait;
use AlgoWeb\PODataLaravel\Models\ClassReflectionHelper;
use Cruxinator\ClassFinder\ClassFinder;
use Illuminate\Routing\Controller;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Cache;
use POData\Common\InvalidOperationException;

class MetadataControllerProvider extends MetadataBaseProvider
{
    /*
     * Optional crud verbs - these need to be deduplicated for empty mappings
     */
    /** @var string[] */
    protected $optionalVerbs = ['bulkCreate', 'bulkUpdate'];

    /**
     * Bootstrap the application services.  Post-boot.
     *
     * @throws InvalidOperationException
     * @throws \Exception
     * @return void
     */
    public function boot()
    {
        $isCaching = true === $this->getIsCaching();
        $hasCache  = null;

        if ($isCaching) {
            $hasCache = Cache::has('metadataControllers');
            if ($hasCache) {
                $meta = Cache::get('metadataControllers');
                App::instance('metadataControllers', $meta);
                return;
            }
        }

        /** @var MetadataControllerContainer $meta */
        $meta = App::make('metadataControllers');

        $ends = $this->getCandidateControllers();
        // now process each class that uses the metadata controller trait and stick results in $metamix
        $metamix = [];
        foreach ($ends as $end) {
            $map = $end->getMappings();
            // verify uniqueness - must be exactly one mapping for model-verb combo - different verb mappings for
            // a model can glom onto different controllers
            foreach ($map as $key => $lock) {
                if (!array_key_exists($key, $metamix)) {
                    // if we haven't yet got a mapping for this model, grab it holus-bolus
                    $metamix[$key] = $lock;
                    continue;
                }
                // if we do, make sure we aren't re-adding mappings for any of the CRUD verbs
                foreach ($lock as $barrel => $roll) {
                    $isOptional = in_array($barrel, $this->optionalVerbs);
                    $alreadyKey = array_key_exists($barrel, $metamix[$key]);
                    if ($isOptional) {
                        // if we've picked up a default mapping for an optional verb, then we can overwrite it
                        $alreadyKey = null === $metamix[$key][$barrel] ? false : $alreadyKey;
                    }
                    if ($alreadyKey) {
                        $msg = 'Mapping already defined for model ' . $key . ' and CRUD verb ' . $barrel;
                        throw new InvalidOperationException($msg);
                    }
                    $metamix[$key][$barrel] = $roll;
                }
            }
        }

        $meta->setMetadata($metamix);

        $key = 'metadataControllers';
        $this->handlePostBoot($isCaching, $hasCache, $key, $meta);
    }

    /**
     * Register the application services.  Boot-time only.
     *
     * @return void
     */
    public function register()
    {
        $this->app->/* @scrutinizer ignore-call */singleton(
            'metadataControllers',
            function () {
                return new MetadataControllerContainer();
            }
        );
    }

    /**
     * @return mixed
     * @throws \Exception
     */
    protected function getCandidateControllers()
    {
        return ClassReflectionHelper::getCandidateControllers();
    }
}