nystudio107 / craft-connect

src/variables/ConnectVariable.php

<?php
/**
 * Connect plugin for Craft CMS 3.x
 *
 * Allows you to connect to external databases and perform db queries
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\connect\variables;

use nystudio107\connect\Connect;
use nystudio107\connect\db\Query;
use nystudio107\connect\models\Settings;

use Craft;

use yii\db\Connection;
use yii\db\Exception;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Connect

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ConnectVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Open a new database connection
     *
     * @param string $configName

Missing parameter comment

     *
     * @return null|Connection
     */
    public function open(string $configName)
    {
        $connection = null;
        $config = $this->getDbConfig($configName);
        if (!empty($config)) {
            // Create a connection to the db
            $connection = new Connection($config);
            try {
                $connection->open();
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return $connection;
    }

    /**
     * Returns a new generic query.
     *
     * @param null|Connection $connection

Missing parameter comment

     *
     * @return Query
     */
    public function query($connection = null): Query
    {
        return new Query([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'db' => $connection,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    // Protected Methods
    // =========================================================================

    /**
     * Return a database config with the key $configName from the Settings
     *
     * @param string $configName

Missing parameter comment

     *
     * @return array
     */
    protected function getDbConfig(string $configName): array
    {
        $config = [];
        /* @var Settings $settings */
        $settings = Connect::$plugin->getSettings();
        if ($settings !== null && !empty($settings->connections[$configName])) {
            $dbConnection = $settings->connections[$configName];
            $config = [
                'dsn' => "{$dbConnection['driver']}:"
                    ."host={$dbConnection['server']};"
                    ."dbname={$dbConnection['database']};"
                    ."port={$dbConnection['port']};",
                'username' => $dbConnection['user'],
                'password' => $dbConnection['password'],
                'tablePrefix' => $dbConnection['tablePrefix'],
            ];
        }

        return $config;
    }
}