FJavierGil / baseDoctrine

src/Utility/Utils.php

<?php

There must be no blank lines before the file comment

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

Filename "Utils.php" doesn't match the expected filename "utils.php"

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

/**
 * src/Utility/Utils.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\ORM\{ EntityManager, Tools\SchemaTool };
use Dotenv\Dotenv;
use Throwable;

/**
 * Class Utils
 */

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

class Utils
{

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

    /**
     * Load the environment/configuration variables
     * defined in .env file + (.env.docker || .env.local)
     *
     * @param string $dir   project root directory

Expected 1 spaces after parameter name; 3 found

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     */

Missing @return tag in function comment

    public static function loadEnv(string $dir): void

Expected 2 blank lines before function; 0 found

    {

Opening brace should be on the same line as the declaration

        require_once $dir . '/vendor/autoload.php';

Concat operator must not be surrounded by spaces

File is being conditionally included; use "include_once" instead

        if (!class_exists(Dotenv::class)) {

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

            fwrite(STDERR, 'ERROR: No se ha cargado la clase Dotenv' . PHP_EOL);

Concat operator must not be surrounded by spaces

            exit(1);

Using exit here is not recommended.

        }

        try {
            // Load environment variables from .env file

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

            if (file_exists($dir . '/.env')) {

Concat operator must not be surrounded by spaces

                $dotenv = Dotenv::createMutable($dir, '.env');
                $dotenv->load();
            } else {
                fwrite(STDERR, 'ERROR: no existe el fichero .env' . PHP_EOL);

Concat operator must not be surrounded by spaces

                exit(1);

Using exit here is not recommended.

            }

            // Overload (if they exist) with .env.docker or .env.local

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

            if (isset($_SERVER['DOCKER']) && file_exists($dir . '/.env.docker')) {

Concat operator must not be surrounded by spaces

                $dotenv = Dotenv::createMutable($dir, '.env.docker');
                $dotenv->load();
            } elseif (file_exists($dir . '/.env.local')) {

Usage of ELSEIF not allowed; use ELSE IF instead

Concat operator must not be surrounded by spaces

                $dotenv = Dotenv::createMutable($dir, '.env.local');
                $dotenv->load();
            }

            // Requiring Variables to be set

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

            $dotenv->required([ 'DATABASE_NAME', 'DATABASE_USER', 'DATABASE_PASSWD', 'SERVER_VERSION' ]);

Short array syntax is not allowed

            $dotenv->required([ 'ENTITY_DIR' ]);

Short array syntax is not allowed

        } catch (Throwable $e) {
            fwrite(
                STDERR,
                'EXCEPCIÓN: ' . $e->getCode() . ' - ' . $e->getMessage()

Concat operator must not be surrounded by spaces

            );
            exit(1);

Using exit here is not recommended.

        }

End comment for long condition not found; expected "//end try"

    }

Expected 1 blank line before closing function brace; 0 found

Expected //end loadEnv()

Expected 2 blank lines after function; 1 found

    /**
     * Drop & Update database schema
     *
     * @return void
     */
    public static function updateSchema(): void
    {

Opening brace should be on the same line as the declaration

        try {
            /** @var EntityManager $e_manager */

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

            $e_manager = DoctrineConnector::getEntityManager();

Variable "e_manager" is not in valid camel caps format

            $e_manager->clear();

Variable "e_manager" is not in valid camel caps format

            $metadata = $e_manager->getMetadataFactory()->getAllMetadata();

Variable "e_manager" is not in valid camel caps format

            $sch_tool = new SchemaTool($e_manager);

Variable "sch_tool" is not in valid camel caps format

Variable "e_manager" is not in valid camel caps format

            $sch_tool->dropDatabase();

Variable "sch_tool" is not in valid camel caps format

            $sch_tool->updateSchema($metadata);

Variable "sch_tool" is not in valid camel caps format

        } catch (Throwable $e) {
            fwrite(
                STDERR,
                'EXCEPCIÓN: ' . $e->getCode() . ' - ' . $e->getMessage()

Concat operator must not be surrounded by spaces

            );
            exit(1);

Using exit here is not recommended.

        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end updateSchema()

}

Expected //end class

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