bristol-su / control

src/Export/ExportManager.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export;

use BristolSU\ControlDB\Export\Handler\Airtable\AirtableHandler;

The type BristolSU\ControlDB\Export\Handler\Airtable\AirtableHandler was not found. Maybe you did not declare it correctly or list all dependencies?

use BristolSU\ControlDB\Export\Handler\DumpHandler;
use BristolSU\ControlDB\Export\Handler\Handler;
use BristolSU\ControlDB\Export\Handler\SaveCsvHandler;
use Closure;
use Illuminate\Contracts\Container\Container;
use Illuminate\Support\Str;
use InvalidArgumentException;

class ExportManager

Missing doc comment for class ExportManager

{

    /**
     * The container instance.
     *
     * @var Container
     */
    protected $container;

    /**
     * The registered custom driver creators.
     *
     * @var array
     */
    protected $customCreators = [];
    
    protected $formatters = [];

    /**
     * Create a new Export manager instance.
     *
     * @param  Container  $container

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return void

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function __construct(Container $container)
    {
        $this->container = $container;
    }

    /**
     * Get a export driver instance.
     *
     * @param  string|null  $driver

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function driver($driver = null)
    {
        return $this->resolve($driver ?? $this->getDefaultDriver());
    }

    /**
     * Resolve the given export instance by name.
     *
     * @param  string  $name

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return Handler

Tag @return cannot be grouped with parameter tags in a doc comment

     *
     * @throws \InvalidArgumentException
     */
    protected function resolve($name)
    {
        $config = $this->configurationFor($name);

        if (is_null($config)) {

The condition is_null($config) is always false.

            throw new InvalidArgumentException("Exporter [{$name}] is not defined.");
        }
        if (isset($this->customCreators[$config['driver']])) {
            return $this->callCustomCreator($config);
        }

        $driverMethod = 'create'.Str::studly($config['driver']).'Driver';

        if (method_exists($this, $driverMethod)) {
            return $this->{$driverMethod}($config);
        }

        throw new InvalidArgumentException("Driver [{$config['driver']}] is not supported.");
    }

    /**
     * Call a custom driver creator.
     *
     * @param  array  $config

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function callCustomCreator(array $config)
    {
        return $this->customCreators[$config['driver']]($this->container, $config);
    }
    
    /**
     * Get the export connection configuration.
     *
     * @param  string  $name

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return array

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function configurationFor($name)
    {
        $config = $this->container['config']["control.export.{$name}"];
        if(is_null($config)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return null;
        }
        if(!isset($config['formatters'])) {

Expected "if (...) {\n"; found "if(...) {\n"

            $config['formatters'] = [];
        }
        foreach($this->formatters() as $formatter => $formatterConfig) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $config['formatters'][$formatter] = $formatterConfig;
        }
        
        return $config;
    }

    /**
     * Get the default export driver name.
     *
     * @return string
     */
    public function getDefaultDriver()
    {
        return $this->container['config']['control.export.default'];
    }

    /**
     * Register a custom driver creator Closure.
     *
     * @param  string  $driver

Missing parameter comment

Expected 3 spaces after parameter type; 2 found

     * @param  \Closure  $callback

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function extend($driver, Closure $callback)
    {
        $this->customCreators[$driver] = $callback->bindTo($this, $this);

        return $this;
    }

    public function withFormatter(string $formatter, array $config = [])

Missing doc comment for function withFormatter()

    {
        $this->formatters[$formatter] = $config;
        
        return $this;
    }
    
    /**
     * Dynamically call the default driver instance.
     *
     * @param  string  $method

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  array  $parameters

Missing parameter comment

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function __call($method, $parameters)
    {
        return $this->driver()->$method(...$parameters);
    }

    public function createDumpDriver(array $config)

Missing doc comment for function createDumpDriver()

    {
        return new DumpHandler($config);
    }

    public function createSaveCsvDriver(array $config)

Missing doc comment for function createSaveCsvDriver()

    {
        return new SaveCsvHandler($config);
    }

    protected function formatters()

Missing doc comment for function formatters()

    {
        return $this->formatters;
    }

}