FJavierGil / baseDoctrine

src/Utility/DoctrineConnector.php

<?php

Class found in ".php" file; use ".inc" extension instead

There must be no blank lines before the file comment

The PHP open tag does not have a corresponding PHP close tag

Filename "DoctrineConnector.php" doesn't match the expected filename "doctrineconnector.php"

/**
 * src/Utility/DoctrineConnector.php

Doc comment short description must start with a capital letter

 *
 * @license https://opensource.org/licenses/MIT MIT License

The tag in position 1 should be the @package tag

 * @link    https://miw.etsisi.upm.es/ ETS de Ingeniería de Sistemas Informáticos

The tag in position 2 should be the @subpackage tag

 */

PHP version not specified

Missing @package tag in file comment

Missing @subpackage tag in file comment

Missing @author tag in file comment

Missing @category tag in file comment

namespace MiW\DemoDoctrine\Utility;

use Doctrine\DBAL\{ Connection, DriverManager };
use Doctrine\ORM\{ EntityManager, EntityManagerInterface, ORMSetup };
use Doctrine\ORM\Proxy\ProxyFactory;
use Exception;
// use Symfony\Component\Cache\Adapter\PhpFilesAdapter;

Inline comments must start with a capital letter

Inline comments must end in full-stops, exclamation marks, or question marks

use Throwable;

/**
 * Class DoctrineConnector
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class DoctrineConnector
{

Opening brace should be on the same line as the declaration for class DoctrineConnector

    private static EntityManager|null $instance = null;

Expected 1 blank line(s) before first member var; 0 found

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

Private member variable "instance" must contain a leading underscore

Missing member variable doc comment

Private member variable "instance" must be prefixed with an underscore

    /**
     * Generate the Entity Manager
     *
     * @return EntityManagerInterface
     */
    public static function getEntityManager(): EntityManagerInterface

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        if (self::$instance instanceof EntityManager) {
            return self::$instance;
        }

        if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

            !isset(

Each line in a multi-line IF statement must begin with a boolean operator

Expected 1 space(s) after NOT operator; 0 found

                $_ENV['DATABASE_NAME'],

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

Each line in a multi-line IF statement must begin with a boolean operator

                $_ENV['DATABASE_USER'],

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

Each line in a multi-line IF statement must begin with a boolean operator

                $_ENV['DATABASE_PASSWD'],

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

Each line in a multi-line IF statement must begin with a boolean operator

                $_ENV['ENTITY_DIR'],

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

Each line in a multi-line IF statement must begin with a boolean operator

                $_ENV['SERVER_VERSION'],

Each line in a multi-line IF statement must begin with a boolean operator

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

            )

Each line in a multi-line IF statement must begin with a boolean operator

        ) {
            fwrite(STDERR, 'Faltan variables de entorno por definir' . PHP_EOL);

Concat operator must not be surrounded by spaces

            exit(1);

Using exit here is not recommended.

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Doctrine\ORM\EntityManagerInterface. Consider adding a return statement or allowing null as return value.

        }

        // Cargar configuración de la conexión.
        $dbParams = [

Short array syntax is not allowed

            'host'          => $_ENV['DATABASE_HOST'] ?? '127.0.0.1',

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

Operation must be bracketed

            'port'          => $_ENV['DATABASE_PORT'] ?? 3306,

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

Operation must be bracketed

            'dbname'        => $_ENV['DATABASE_NAME'],

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

            'user'          => $_ENV['DATABASE_USER'],

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

            'password'      => $_ENV['DATABASE_PASSWD'],

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

            'driver'        => $_ENV['DATABASE_DRIVER'] ?? 'pdo_mysql',

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

Operation must be bracketed

            'serverVersion' => $_ENV['SERVER_VERSION'],

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

            'charset'       => $_ENV['DATABASE_CHARSET'] ?? 'UTF8',

This array key does not seem to be aligned correctly; expected 21 spaces, but found 12.

Operation must be bracketed

        ];

The closing parenthesis does not seem to be aligned correctly; expected 20 space(s), but found 8.

        $entityDir = dirname(__DIR__, 2) . '/' . $_ENV['ENTITY_DIR'];

Concat operator must not be surrounded by spaces

        // $queryCache = new PhpFilesAdapter('doctrine_queries');
        // $metadataCache = new PhpFilesAdapter('doctrine_metadata');
        // $resultsCache = new PhpFilesAdapter('doctrine_results');
        $config = ORMSetup::createAttributeMetadataConfiguration(
            paths: [ $entityDir ],            // paths to mapped entities

Comments may not appear after statements

Inline comments must end in full-stops, exclamation marks, or question marks

Short array syntax is not allowed

Inline comments must start with a capital letter

            isDevMode: true,                  // developper mode

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

Comments may not appear after statements

Inline comments must start with a capital letter

Inline comments must end in full-stops, exclamation marks, or question marks

            proxyDir: (string) ini_get('sys_temp_dir') // Proxy dir

Comments may not appear after statements

Inline comments must end in full-stops, exclamation marks, or question marks

A cast statement should not be followed as per the coding-style.

        );
        // $config->setQueryCache($queryCache);
        // $config->setMetadataCache($metadataCache);
        // $config->setResultCache($resultsCache);
        $config->setAutoGenerateProxyClasses(ProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS_OR_CHANGED);

        // configuring the database connection

Inline comments must start with a capital letter

Inline comments must end in full-stops, exclamation marks, or question marks

        /** @var Connection $connection */

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $connection = DriverManager::getConnection($dbParams, $config);

        try {
            self::$instance = new EntityManager($connection, $config);
        } catch (Throwable $e) {
            $msg = sprintf('ERROR (%d): %s', $e->getCode(), $e->getMessage());
            fwrite(STDERR, $msg . PHP_EOL);

Concat operator must not be surrounded by spaces

            exit(1);

Using exit here is not recommended.

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Doctrine\ORM\EntityManagerInterface. Consider adding a return statement or allowing null as return value.

        }

        return self::$instance;

The expression return self::instance returns the type null which is incompatible with the type-hinted return Doctrine\ORM\EntityManagerInterface.

    }

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

Expected //end getEntityManager()

    protected function __construct()

Missing doc comment for function __construct()

    {

Opening brace should be on the same line as the declaration

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    protected function __clone()

Missing doc comment for function __clone()

    {

Opening brace should be on the same line as the declaration

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __clone()

    /**

Missing short description in doc comment

     * @throws Exception

Comment missing for @throws tag in function comment

     */

Missing @return tag in function comment

    public function __wakeup()
    {

Opening brace should be on the same line as the declaration

        throw new Exception('Cannot unserialize a Singleton.');
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __wakeup()

}

Expected //end class

As per coding style, files should not end with a newline character.