Clean code

chamilo · Dec 19, 2019 · 5313e71 · 5313e71
1 parent d794586
commit 5313e71
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 39 deletions.
diff --git a/ecs.yaml b/ecs.yaml
@@ -2,7 +2,11 @@ services:
     SlevomatCodingStandard\Sniffs\Variables\UnusedVariableSniff:
         ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach: 'true'
 
+    PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer:
+        remove_inheritdoc: true
+
 parameters:
     sets:
         - 'clean-code'
         - 'symfony'
+        - 'symfony-risky'
diff --git a/src/Command/Common/CommonCommand.php b/src/Command/Common/CommonCommand.php
@@ -124,9 +124,6 @@ public function setExtraDatabaseSettings(array $databaseSettings)
         $this->extraDatabaseSettings = $databaseSettings;
     }
 
-    /**
-     * @return mixed
-     */
     public function getExtraDatabaseSettings()
     {
         return $this->extraDatabaseSettings;
@@ -179,7 +176,7 @@ public function getCourseSysPath(): ?string
      */
     public function getInstallationFolder()
     {
-        $chashFolder = dirname(dirname(dirname(__FILE__)));
+        $chashFolder = dirname(dirname(__DIR__));
 
         return $chashFolder.'/Resources/Database/';
     }
@@ -428,8 +425,6 @@ public function getAvailableVersionInfo($version)
 
     /**
      * Gets the min version available to migrate with this command.
-     *
-     * @return mixed
      */
     public function getMinVersionSupportedByInstall()
     {

diff --git a/src/Command/Common/DatabaseCommand.php b/src/Command/Common/DatabaseCommand.php
@@ -14,9 +14,6 @@
  */
 class DatabaseCommand extends CommonCommand
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getConnection()
     {
         try {

diff --git a/src/Command/Files/DeleteCoursesCommand.php b/src/Command/Files/DeleteCoursesCommand.php
@@ -89,7 +89,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
             // Check the courses that match the search criteria
             if (!empty($courseId)) {
-                $courseId = intval($courseId);
+                $courseId = (int) $courseId;
                 $sql = "SELECT id, code, category_code, creation_date
                         FROM course
                         WHERE id = $courseId ";

diff --git a/src/Command/Installation/StatusCommand.php b/src/Command/Installation/StatusCommand.php
@@ -27,9 +27,6 @@ protected function configure(): void
         ;
     }
 
-    /**
-     * @return int
-     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         parent::execute($input, $output);

diff --git a/src/Command/Installation/UpgradeCommand.php b/src/Command/Installation/UpgradeCommand.php
@@ -502,8 +502,6 @@ public function saveDatabaseList($path, $databaseSection, $version, $type)
      * @param string          $section
      * @param string          $version
      * @param string          $type
-     *
-     * @return mixed
      */
     public function getDatabasesPerSection($output, $courseList, $path, $section, $version, $type)
     {

diff --git a/src/Command/Installation/UpgradeDatabaseCommand.php b/src/Command/Installation/UpgradeDatabaseCommand.php
@@ -414,8 +414,6 @@ public function saveDatabaseList($path, $databaseSection, $version, $type)
      * @param string          $section
      * @param string          $version
      * @param string          $type
-     *
-     * @return mixed
      */
     public function getDatabasesPerSection($output, $courseList, $path, $section, $version, $type)
     {
@@ -492,8 +490,6 @@ public function getSQLContents($file, $section, $output)
      *
      * @param OutputInterface $output
      * @param string          $dryRun
-     *
-     * @return int
      */
     public function createCourseTables($output, $dryRun): int
     {
@@ -534,12 +530,7 @@ protected function configure(): void
         ;
     }
 
-    /**
-     * Executes a command via CLI.
-     *
-     * @return int|void|null
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         // sudo php /var/www/html/chash/chash.php chash:chamilo_upgrade 1.11.x --linux-user=jmontoya --linux-group=jmontoya
 

diff --git a/src/Command/Translation/AddSubLanguageCommand.php b/src/Command/Translation/AddSubLanguageCommand.php
@@ -34,9 +34,6 @@ protected function configure(): void
             );
     }
 
-    /**
-     * @return int
-     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         parent::execute($input, $output);

diff --git a/src/Command/Translation/TermsPackageCommand.php b/src/Command/Translation/TermsPackageCommand.php
@@ -97,7 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('The directory '.$destination.' does not seem to exist. The destination directory must exist in order for this script to write the results in a safe place');
             exit;
         }
-        if (!is_writeable($destination)) {
+        if (!is_writable($destination)) {
             $output->writeln('The destination directory must be writeable. '.$destination.' seems not to be writeable now.');
             exit;
         }
@@ -127,7 +127,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }*/
         if (is_dir($destination.$language)) {
-            if (!is_writeable($destination.$language)) {
+            if (!is_writable($destination.$language)) {
                 $output->writeln('Destination directory '.$destination.$language.' already exists but is not writeable. Please make sure whoever launches this script has privileges to write in there.');
                 exit;
             }
@@ -137,7 +137,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             exit;
         }
         if (is_dir($destination.$origLang)) {
-            if (!is_writeable($destination.$origLang)) {
+            if (!is_writable($destination.$origLang)) {
                 $output->writeln('Destination directory '.$destination.$origLang.' already exists but is not writeable. Please make sure whoever launches this script has privileges to write in there.');
                 exit;
             }

diff --git a/src/DoctrineExtensions/DBAL/Types/UTCDateTimeType.php b/src/DoctrineExtensions/DBAL/Types/UTCDateTimeType.php
@@ -15,16 +15,13 @@ class UTCDateTimeType extends DateTimeType
 {
     private static $utc = null;
 
-    /**
-     * {@inheritdoc}
-     */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
         if (null === $value) {
             return null;
         }
 
-        if (is_null(self::$utc)) {
+        if (null === self::$utc) {
             self::$utc = new \DateTimeZone('UTC');
         }
 
@@ -33,16 +30,13 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         return $value->format($platform->getDateTimeFormatString());
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         if (null === $value) {
             return null;
         }
 
-        if (is_null(self::$utc)) {
+        if (null === self::$utc) {
             self::$utc = new \DateTimeZone('UTC');
         }
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,9 +14,6 @@ @@
      */
     class DatabaseCommand extends CommonCommand
     {
-        /**
-         * {@inheritdoc}
-         */
         public function getConnection()
         {
             try {
@@ Expand Down @@