Lagdo\DbAdmin\DbAdminPackage

Complexity

Total Complexity

18

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getServerDriver()	0	3	1
A	getServerOptions()	0	3	1
A	config()	0	3	1
A	getServers()	0	3	1
A	getServerAccess()	0	10	3
A	hasLoggingDatabase()	0	5	3
A	getServerName()	0	3	1
A	getHtml()	0	3	1
A	getReadyScript()	0	6	3
A	getJs()	0	3	1
A	getCss()	0	8	1
A	getScript()	0	5	1

<?php

namespace Lagdo\DbAdmin;

use Jaxon\Plugin\AbstractPackage;
use Lagdo\DbAdmin\Ajax\App\Admin;

use function in_array;
use function is_array;
use function realpath;
use function Jaxon\cl;
use function Jaxon\rq;

/**
 * Jaxon DbAdmin package
 */
class DbAdminPackage extends AbstractPackage
{
    /**
     * Get the path to the config file
     *
     * @return string|array
     */
    public static function config(): string
    {
        return realpath(__DIR__ . '/../config/dbadmin.php');
    }

    /**
     * Get the database servers
     *
     * @return array
     */
    public function getServers(): array
    {
        return $this->getOption('servers', []);
    }

    /**
     * Get the name of a given server
     *
     * @param string $server    The server name in the configuration
     *
     * @return string
     */
    public function getServerName(string $server): string
    {
        return $this->getOption("servers.$server.name", '');
    }

    /**
     * Get a given server options
     *
     * @param string $server    The server name in the configuration
     *
     * @return array
     */
    public function getServerOptions(string $server): array
    {
        return $this->getOption("servers.$server", []);
    }

    /**
     * Get the driver of a given server
     *
     * @param string $server    The server name in the configuration
     *
     * @return string
     */
    public function getServerDriver(string $server): string
    {
        return $this->getOption("servers.$server.driver", '');
    }

    /**
     * Check if the user has access to a server
     *
     * @param string $server      The database server
     *
     * return bool
     */
    public function getServerAccess(string $server): bool
    {
        // Check in server options
        $serverAccess = $this->getOption("servers.$server.access.server", null);
        if($serverAccess === true || $serverAccess === false)
        {
            return $serverAccess;
        }
        // Check in global options
        return $this->getOption('access.server', true) === true;
    }

    /**
     * @return bool
     */
    public function hasLoggingDatabase(): bool
    {
        $options = $this->getOption('logging.database');
        return is_array($options) && isset($options['driver']) &&
            in_array($options['driver'], ['pgsql', 'mysql', 'sqlite']);
    }

    /**
     * Get the HTML tags to include CSS code and files into the page
     *
     * The code must be enclosed in the appropriate HTML tags.
     *
     * @return string
     */
    public function getCss(): string
    {
        return $this->view()->render('dbadmin::codes::css.html') .
            "\n<style>\n" .
            $this->view()->render('dbadmin::codes::styles.css') .
            "\n</style>\n<!-- Spinner CSS code. -->\n<style>\n" .
            $this->view()->render('dbadmin::codes::spin.css') .
            "\n</style>\n";
    }

    /**
     * Get the HTML tags to include javascript code and files into the page
     *
     * The code must be enclosed in the appropriate HTML tags.
     *
     * @return string
     */
    public function getJs(): string
    {
        return $this->view()->render('dbadmin::codes::js.html');
    }

    /**
     * Get the javascript code to include into the page
     *
     * The code must NOT be enclosed in HTML tags.
     *
     * @return string
     */
    public function getScript(): string
    {
        return $this->view()->render('dbadmin::codes::script.js') .
            "\n\n// Spinner javascript code.\n" .
            $this->view()->render('dbadmin::codes::spin.js');
    }

    /**
     * Get the javascript code to include into the page
     *
     * The code must NOT be enclosed in HTML tags.
     *
     * @return string
     */
    public function getReadyScript(): string
    {
        $defaultServer = $this->getOption('default');
        return !$defaultServer ||
            !$this->getOption("servers.$defaultServer") ? '' :
                rq(Admin::class)->server($defaultServer);
    }

    /**
     * Get the HTML code of the package home page
     *
     * @return string
     */
    public function getHtml(): string
    {
        return cl(Admin::class)->html();
    }
}