MiW\DemoDoctrine\Utility\Utils

Complexity

Total Complexity

12

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	updateSchema()	0	15	2
B	loadEnv()	0	37	7
A	loadUserData()	0	26	3

<?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 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 end with a full stop

Parameter comment must start with a capital letter

     */

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';

File is being conditionally included; use "include_once" instead

Concat operator must not be surrounded by spaces

        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

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

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

Variable "e_manager" is not in valid camel caps format

            $sch_tool = new SchemaTool($e_manager);

The type MiW\DemoDoctrine\Utility\SchemaTool was not found. Maybe you did not declare it correctly or list all dependencies?

Variable "sch_tool" is not in valid camel caps format

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

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; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end updateSchema()

    /**
     * Load user data fixtures
     *
     * @param string $username user name

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param string $email user email

Expected 4 spaces after parameter name; 1 found

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param string $password user password

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param bool $isWriter isAdmin

Expected 3 spaces after parameter type; 1 found

Expected "boolean" but found "bool" for parameter type

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     *
     * @return int user_id

Expected "integer" but found "int" for function return type

     */
    public static function loadUserData(
        string $username,
        string $email,
        string $password,
        bool $isWriter = false

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

    ): int {

Opening brace should be on a new line

        assert($username !== '');
        $user = new User(

The type MiW\DemoDoctrine\Utility\User was not found. Maybe you did not declare it correctly or list all dependencies?

The value of a comparison must not be assigned to a variable

            username: $username,
            email: $email,
            password: $password,
            role: $isWriter ? Role::WRITER : Role::READER

The type MiW\DemoDoctrine\Utility\Role was not found. Maybe you did not declare it correctly or list all dependencies?

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

        );
        try {
            $e_manager = DoctrineConnector::getEntityManager();

Variable "e_manager" is not in valid camel caps format

            $e_manager?->persist($user);

Variable "e_manager" is not in valid camel caps format

            $e_manager?->flush();

Variable "e_manager" 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);

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

Using exit here is not recommended.

        }

        return $user->getId();
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end loadUserData()

}

Expected //end class

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