Merge pull request #1041 from oat-sa/feature/ADF-1440/psr-12-apply

chore: apply PSR-12
oat-sa · May 30, 2023 · ad97fb8 · ad97fb8
2 parents 984ae70 + 700d6e0
commit ad97fb8
Show file tree

Hide file tree

Showing 453 changed files with 4,530 additions and 2,815 deletions.
diff --git a/common/cache/class.Exception.php b/common/cache/class.Exception.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -14,8 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);              2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2009-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 

diff --git a/common/cache/class.FileCache.php b/common/cache/class.FileCache.php
@@ -15,9 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
- *               2010-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2010-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 

diff --git a/common/cache/class.KeyValueCache.php b/common/cache/class.KeyValueCache.php
@@ -15,9 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
- *               2010-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2010-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 
@@ -33,18 +36,21 @@
  */
 class common_cache_KeyValueCache extends ConfigurableService implements common_cache_Cache
 {
-    const OPTION_PERSISTENCE = 'persistence';
-    
-    
+    public const OPTION_PERSISTENCE = 'persistence';
+
+
     /**
      * @var common_persistence_KeyValuePersistence
      */
     private $persistence;
-    
+
     protected function getPersistence()
     {
         if (is_null($this->persistence)) {
-            $this->persistence = $this->getServiceLocator()->get('generis/persistences')->getPersistenceById($this->getOption(self::OPTION_PERSISTENCE));
+            $this->persistence = $this
+                ->getServiceLocator()
+                ->get('generis/persistences')
+                ->getPersistenceById($this->getOption(self::OPTION_PERSISTENCE));
         }
         return $this->persistence;
     }

diff --git a/common/cache/class.NoCache.php b/common/cache/class.NoCache.php
@@ -27,7 +27,6 @@
  */
 class common_cache_NoCache extends ConfigurableService implements common_cache_Cache
 {
-
     public function has($key)
     {
         return false;
@@ -47,7 +46,7 @@ public function remove($serial)
     {
         return true;
     }
-    
+
     public function get($serial)
     {
         throw new common_cache_NotFoundException();

diff --git a/common/cache/class.NotFoundException.php b/common/cache/class.NotFoundException.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -14,8 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);              2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2009-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 

diff --git a/common/cache/class.PartitionedCachable.php b/common/cache/class.PartitionedCachable.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -14,9 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
-*               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+*               2009-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 
@@ -65,12 +69,12 @@ public function getSerial()
     {
         $returnValue = (string) '';
 
-        
+
         if (empty($this->serial)) {
             $this->serial = $this->buildSerial();
         }
         $returnValue = $this->serial;
-        
+
 
         return (string) $returnValue;
     }
@@ -84,7 +88,7 @@ public function getSerial()
      */
     public function __construct()
     {
-        
+
         if (!is_null($this->getCache())) {
             $this->getCache()->put($this);
         }
@@ -101,7 +105,7 @@ public function __sleep()
     {
         $returnValue = [];
 
-        
+
         $this->serializedProperties = [];
         $reflection = new ReflectionClass($this);
         foreach ($reflection->getProperties() as $property) {
@@ -122,7 +126,10 @@ public function __sleep()
                         }
                     }
                     if ($containsNonSerializable && $containsSerializable) {
-                        throw new common_exception_Error('Serializable ' . $this->getSerial() . ' mixed serializable and non serializable values in property ' . $propertyName);
+                        throw new common_exception_Error(
+                            'Serializable ' . $this->getSerial()
+                                . ' mixed serializable and non serializable values in property ' . $propertyName
+                        );
                     }
                 } else {
                     if (is_object($value) && $value instanceof self) {
@@ -137,7 +144,7 @@ public function __sleep()
                 }
             }
         }
-        
+
 
         return (array) $returnValue;
     }
@@ -151,7 +158,7 @@ public function __sleep()
      */
     public function __wakeup()
     {
-        
+
         foreach ($this->serializedProperties as $key => $value) {
             if (is_array($value)) {
                 $restored = [];
@@ -172,16 +179,19 @@ public function __wakeup()
      * @access public
      * @author Jerome Bogaerts, <[email protected]>
      * @return mixed
+     *
+     * phpcs:disable PSR2.Methods.MethodDeclaration
      */
     public function _remove()
     {
-        
+
         //usefull only when persistance is enabled
         if (!is_null($this->getCache())) {
             //clean session
             $this->getCache()->remove($this->getSerial());
         }
     }
+    // phpcs:enable PSR2.Methods.MethodDeclaration
 
     /**
      * Short description of method getSuccessors
@@ -194,7 +204,7 @@ public function getSuccessors()
     {
         $returnValue = [];
 
-        
+
         $reflection = new ReflectionClass($this);
         foreach ($reflection->getProperties() as $property) {
             if (!$property->isStatic() && !$property->isPrivate()) {
@@ -203,15 +213,15 @@ public function getSuccessors()
                 if (is_array($value)) {
                     foreach ($value as $key => $subvalue) {
                         if (is_object($subvalue) && $subvalue instanceof self) {
-                                $returnValue[] = $subvalue;
+                            $returnValue[] = $subvalue;
                         }
                     }
                 } elseif (is_object($value) && $value instanceof self) {
-                        $returnValue[] = $value;
+                    $returnValue[] = $value;
                 }
             }
         }
-        
+
 
         return (array) $returnValue;
     }
@@ -228,7 +238,7 @@ public function getPredecessors($classFilter = null)
     {
         $returnValue = [];
 
-        
+
         foreach ($this->getCache()->getAll() as $serial => $instance) {
             if (
                 ($classFilter == null || $instance instanceof $classFilter)
@@ -238,7 +248,7 @@ public function getPredecessors($classFilter = null)
                 break;
             }
         }
-        
+
 
         return (array) $returnValue;
     }
@@ -262,4 +272,4 @@ abstract protected function buildSerial();
      * @return common_cache_Cache
      */
     abstract public function getCache();
-} /* end of abstract class common_cache_PartitionedCachable */
+}
diff --git a/common/cache/class.PsrWrapperCache.php b/common/cache/class.PsrWrapperCache.php
@@ -29,7 +29,6 @@
  */
 class common_cache_PsrWrapperCache extends ConfigurableService implements common_cache_Cache
 {
-
     /**
      * puts "something" into the cache,
      *      * If this is an object and implements Serializable,
@@ -112,7 +111,7 @@ public function purge()
         return $this->getPsrSimpleCache()->clear();
     }
 
-    protected function getPsrSimpleCache() : CacheInterface
+    protected function getPsrSimpleCache(): CacheInterface
     {
         return $this->getServiceLocator()->get(SimpleCache::SERVICE_ID);
     }

diff --git a/common/cache/class.SingletonCache.php b/common/cache/class.SingletonCache.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -112,4 +113,4 @@ public static function getCached($function)
     private function __construct()
     {
     }
-} /* end of abstract class common_cache_SingletonCache */
+}
diff --git a/common/cache/interface.Cache.php b/common/cache/interface.Cache.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -14,9 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
- *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2009-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *               2013-2014 (update and modification) Open Assessment Technologies SA;
  */
 
@@ -29,7 +33,7 @@ interface common_cache_Cache
     /**
      * Service manager id.
      */
-    const SERVICE_ID = 'generis/cache';
+    public const SERVICE_ID = 'generis/cache';
 
     // --- OPERATIONS ---
 

diff --git a/common/class.AjaxResponse.php b/common/class.AjaxResponse.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -14,9 +15,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
- *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
- *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
+ * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
+ *                         (under the project TAO & TAO2);
+ *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
+ *                         (under the project TAO-TRANSFER);
+ *               2009-2012 (update and modification) Public Research Centre Henri Tudor
+ *                         (under the project TAO-SUSTAIN & TAO-DEV);
  *
  */
 
@@ -51,12 +55,12 @@ class common_AjaxResponse
     public function __construct(array $options = [])
     {
 
-        
-        $success    = isset($options['success'])    ? $options['success']    : true;
-        $type       = isset($options['type'])       ? $options['type']       : 'json';
-        $data       = isset($options['data'])       ? $options['data']       : null;
-        $message    = isset($options['message'])    ? $options['message']    : '';
-        
+
+        $success    = isset($options['success']) ? $options['success'] : true;
+        $type       = isset($options['type']) ? $options['type'] : 'json';
+        $data       = isset($options['data']) ? $options['data'] : null;
+        $message    = isset($options['message']) ? $options['message'] : '';
+
         //position the header of the response
         $context = Context::getInstance();
         $context->getResponse()->setContentHeader('application/json');
@@ -67,7 +71,7 @@ public function __construct(array $options = [])
             , 'message'         => $message
             , 'data'            => $data
         ];
-        
+
         //write the response
         echo json_encode($response);
     }