Plasma\Drivers\MySQL\DriverFactory

Complexity

Total Complexity

10

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Test Coverage

Coverage

95.83%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getAuthPlugins()	0	2	1
A	setFilesystem()	0	2	1
A	getFilesystem()	0	2	1
A	addAuthPlugin()	0	10	3
A	__construct()	0	13	3
A	createDriver()	0	2	1

<?php
/**
 * Plasma Driver MySQL component
 * Copyright 2018-2019 PlasmaPHP, All Rights Reserved
 *
 * Website: https://github.com/PlasmaPHP
 * License: https://github.com/PlasmaPHP/driver-mysql/blob/master/LICENSE
*/

namespace Plasma\Drivers\MySQL;

/**
 * The Driver Factory is responsible for creating the driver correctly.
 */
class DriverFactory implements \Plasma\DriverFactoryInterface {
    /**
     * @var \React\EventLoop\LoopInterface
     */
    protected $loop;
    
    /**
     * @var array
     */
    protected $options;
    
    /**
     * @var \Plasma\Drivers\MySQL\AuthPlugins\AuthPluginInterface[]
     */
    protected static $authPlugins = array(
        \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_SECURE_CONNECTION => \Plasma\Drivers\MySQL\AuthPlugins\AuthSecureConnection::class,
        'mysql_native_password' => \Plasma\Drivers\MySQL\AuthPlugins\AuthSecureConnection::class
    );
    
    /**
     * @var \React\Filesystem\FilesystemInterface|null
     */
    protected static $filesystem;
    
    /**
     * Constructor.
     *
     * The driver supports the following options:
     * ```
     * array(
     *     'connector' => ConnectorInstance, (a custom connector instance, which MUST return a `Connection` instance from the `react/socket` package)
     *     'characters.set' => string, (the character set to use, defaults to utf8mb4)
     *     'characters.collate' => string, (the collate to use, defaults to the charset default)
     *     'compression.enable' => bool, (whether compression should be used if available, defaults to true)
     *     'localInFile.enable' => bool, (whether local in file requests are enabled, defaults to false, see issue #16)
     *     'tls.context' => array, (socket TLS context options)
     *     'tls.force' => bool, (whether non-localhost connections are forced to use TLS, defaults to true)
     *     'tls.forceLocal' => bool, (whether localhost connections are forced to use TLS, defaults to false)
     * )
     * ```
     *
     * @param \React\EventLoop\LoopInterface  $loop
     * @param array                           $options
     */
    function __construct(\React\EventLoop\LoopInterface $loop, array $options) {
        if(!\function_exists('stream_socket_enable_crypto')) {
            throw new \LogicException('Encryption is not supported on your platform');
        }
        
        try {
            \Plasma\Types\TypeExtensionsManager::registerManager('driver-mysql', null);
        } catch (\Plasma\Exception $e) {
            /* One already exists, continue regardless */
        }
        
        $this->loop = $loop;
        $this->options = $options;
    }
    
    /**
     * Creates a new driver instance.
     * @return \Plasma\DriverInterface
     */
    function createDriver(): \Plasma\DriverInterface {
        return (new \Plasma\Drivers\MySQL\Driver($this->loop, $this->options));
    }
    
    /**
     * Adds an auth plugin. `$condition` is either an int (for server capabilities), or a string (for auth plugin name).
     * @param string|int  $condition
     * @param string      $classname  A class implementing `AuthPluginInterface`.
     * @return void
     * @throws \InvalidArgumentException
     */
    static function addAuthPlugin($condition, string $classname): void {
        if(isset(static::$authPlugins[$condition])) {
            throw new \InvalidArgumentException('Auth plugin for specified condition already exists');
        }
        
        if(!\in_array(\Plasma\Drivers\MySQL\AuthPlugins\AuthPluginInterface::class, \class_implements($classname, true))) {
            throw new \InvalidArgumentException('Specified auth plugin does not implement interface');
        }
        
        static::$authPlugins[$condition] = $classname;
    }
    
    /**
     * Get the registered auth plugins.
     * @return \Plasma\Drivers\MySQL\AuthPlugins\AuthPluginInterface[]
     */
    static function getAuthPlugins(): array {
        return static::$authPlugins;
    }
    
    /**
     * Set the React Filesystem to use.
     * @param \React\Filesystem\FilesystemInterface|null  $filesystem
     * @return void
     */
    static function setFilesystem(?\React\Filesystem\FilesystemInterface $filesystem): void {
        static::$filesystem = $filesystem;
    }
    
    /**
     * Get the React Filesystem, or null. The filesystem must be set by the user, in order to not get `null`.
     * @return \React\Filesystem\FilesystemInterface|null
     */
    static function getFilesystem(): ?\React\Filesystem\FilesystemInterface {
        return static::$filesystem;
    }
}