add php cs fixer

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: "Code Linting"
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  php-cs-fixer:
+    name: 'PHP-CS-Fixer'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: php-cs-fixer:3.49
+
+      - uses: actions/cache@v3
+        with:
+          path: '.php-cs-fixer.cache'
+          key: ${{ github.repository }}-8.2-phpcsfixer-${{ github.ref_name }}
+          restore-keys: |
+            ${{ github.repository }}-8.2-phpcsfixer-master
+            ${{ github.repository }}-8.2-phpcsfixer-
+
+      - name: Run PHP-CS-Fixer
+        run: 'php-cs-fixer fix --dry-run --show-progress=none --diff'

.gitignore

@@ -4,3 +4,4 @@ tests/DoctrineTest/doctrine_tests/*
 /tests/tmp
 /tests/foo.sq3
 /vendor/
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,56 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->ignoreVCSIgnored(true)
+    ->in(__DIR__.'/lib')
+    ->in(__DIR__.'/tests')
+    ->append([__FILE__])
+    // Exclude generated files (single files)
+    ->notPath('should-be-ignored.php')
+;
+
+$config = new PhpCsFixer\Config();
+$config->setRules([
+    '@PhpCsFixer' => true,
+    '@Symfony' => true,
+    '@PHP70Migration' => true,
+    '@PHP70Migration:risky' => true,
+    '@PHP71Migration' => true,
+    '@PHP74Migration' => true,
+    '@PHP74Migration:risky' => true,
+    'heredoc_indentation' => false,
+    'declare_strict_types' => false,
+    'void_return' => false,
+    'array_syntax' => [
+        'syntax' => 'short',
+    ],
+    'method_argument_space' => [
+        'on_multiline' => 'ensure_fully_multiline',
+    ],
+    'general_phpdoc_annotation_remove' => [
+        'annotations' => ['version', 'license', 'since'],
+    ],
+    'phpdoc_no_package' => true,
+    'phpdoc_separation' => [
+        'groups' => [
+            [
+                'author',
+            ],
+            [
+                'deprecated',
+                'see',
+            ],
+            [
+                'param',
+                'return',
+                'throws',
+            ],
+        ],
+    ],
+])
+    ->setRiskyAllowed(true)
+    ->setCacheFile('.php-cs-fixer.cache')
+    ->setFinder($finder)
+;
+
+return $config;

composer.json

@@ -39,5 +39,9 @@
         "branch-alias": {
             "dev-master": "1.4-dev"
         }
+    },
+    "scripts": {
+        "cs-fix-diff": "php-cs-fixer fix --dry-run --diff",
+        "cs-fix": "php-cs-fixer fix"
     }
 }

lib/Doctrine/Access.php

@@ -20,23 +20,19 @@
  */
 
 /**
- * Provides array access and property overload interface for Doctrine subclasses
+ * Provides array access and property overload interface for Doctrine subclasses.
+ *
+ * @see        www.doctrine-project.org
  *
- * @package     Doctrine
- * @subpackage  Access
- * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @link        www.doctrine-project.org
- * @since       1.0
- * @version     $Revision: 7490 $
  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  */
 abstract class Doctrine_Access extends Doctrine_Locator_Injectable implements ArrayAccess
 {
     /**
-     * Set an entire aray to the data
+     * Set an entire aray to the data.
      *
-     * @param   array $array An array of key => value pairs
-     * @return  Doctrine_Access
+     * @param  array           $array An array of key => value pairs
+     * @return Doctrine_Access
      */
     public function setArray(array $array)
     {
@@ -48,48 +44,42 @@ public function setArray(array $array)
     }
 
     /**
-     * Set key and value to data
+     * Set key and value to data.
      *
      * @see     set, offsetSet
-     * @param   $name
-     * @param   $value
-     * @return  void
      */
     public function __set($name, $value)
     {
         $this->set($name, $value);
     }
 
     /**
-     * Get key from data
+     * Get key from data.
      *
      * @see     get, offsetGet
-     * @param   mixed $name
-     * @return  mixed
      */
     public function __get($name)
     {
         return $this->get($name);
     }
 
     /**
-     * Check if key exists in data
+     * Check if key exists in data.
      *
-     * @param   string $name
-     * @return  boolean whether or not this object contains $name
+     * @param  string $name
+     * @return bool   whether or not this object contains $name
      */
     public function __isset($name)
     {
         return $this->contains($name);
     }
 
     /**
-     * Remove key from data
+     * Remove key from data.
      *
-     * @param   string $name
-     * @return  void
+     * @param string $name
      */
-    #[\ReturnTypeWillChange]
+    #[ReturnTypeWillChange]
     public function __unset($name)
     {
         return $this->remove($name);
@@ -98,16 +88,13 @@ public function __unset($name)
     /**
      * @return bool
      */
-    #[\ReturnTypeWillChange]
+    #[ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return $this->contains($offset);
     }
 
-    /**
-     * @return  mixed
-     */
-    #[\ReturnTypeWillChange]
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         // array notation with no index was causing 'undefined variable: $offset' notices in php7,
@@ -116,84 +103,76 @@ public function offsetGet($offset)
         if (!isset($offset)) {
             return $this->get(null);
         }
+
         return $this->get($offset);
     }
 
-    /**
-     * @return  void
-     */
-    #[\ReturnTypeWillChange]
+    #[ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
-        if ( ! isset($offset)) {
+        if (!isset($offset)) {
             $this->add($value);
         } else {
             $this->set($offset, $value);
         }
     }
 
-    /**
-     * @return void
-     */
-    #[\ReturnTypeWillChange]
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->remove($offset);
     }
 
     /**
-     * Remove the element with the specified offset
+     * Remove the element with the specified offset.
      *
-     * @param mixed $offset The offset to remove
-     * @return bool True if removed otherwise false
+     * @param  mixed $offset The offset to remove
+     * @return bool  True if removed otherwise false
      */
     public function remove($offset)
     {
-        throw new Doctrine_Exception('Remove is not supported for ' . get_class($this));
+        throw new Doctrine_Exception('Remove is not supported for '.get_class($this));
     }
 
     /**
-     * Return the element with the specified offset
+     * Return the element with the specified offset.
      *
-     * @param mixed $offset     The offset to return
-     * @return mixed
+     * @param mixed $offset The offset to return
      */
     public function get($offset)
     {
-        throw new Doctrine_Exception('Get is not supported for ' . get_class($this));
+        throw new Doctrine_Exception('Get is not supported for '.get_class($this));
     }
 
     /**
-     * Set the offset to the value
+     * Set the offset to the value.
      *
      * @param mixed $offset The offset to set
-     * @param mixed $value The value to set the offset to
-     *
+     * @param mixed $value  The value to set the offset to
      */
     public function set($offset, $value)
     {
-        throw new Doctrine_Exception('Set is not supported for ' . get_class($this));
+        throw new Doctrine_Exception('Set is not supported for '.get_class($this));
     }
 
     /**
-     * Check if the specified offset exists
+     * Check if the specified offset exists.
      *
-     * @param mixed $offset The offset to check
-     * @return boolean True if exists otherwise false
+     * @param  mixed $offset The offset to check
+     * @return bool  True if exists otherwise false
      */
     public function contains($offset)
     {
-        throw new Doctrine_Exception('Contains is not supported for ' . get_class($this));
+        throw new Doctrine_Exception('Contains is not supported for '.get_class($this));
     }
 
     /**
-     * Add the value
+     * Add the value.
      *
      * @param mixed $value The value to add
-     * @return void
      */
     public function add($value)
     {
-        throw new Doctrine_Exception('Add is not supported for ' . get_class($this));
+        throw new Doctrine_Exception('Add is not supported for '.get_class($this));
     }
 }

lib/Doctrine/Adapter/Exception.php

@@ -20,15 +20,12 @@
  */
 
 /**
- * Doctrine_Adapter exception class
+ * Doctrine_Adapter exception class.
+ *
+ * @see        www.doctrine-project.org
  *
- * @package     Doctrine
- * @subpackage  Adapter
- * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @link        www.doctrine-project.org
- * @since       1.0
- * @version     $Revision$
  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  */
 class Doctrine_Adapter_Exception extends Doctrine_Exception
-{ }
+{
+}

lib/Doctrine/Adapter/Interface.php

@@ -20,28 +20,35 @@
  */
 
 /**
- * This adapter interface should be implemented by all custom adapters
+ * This adapter interface should be implemented by all custom adapters.
  *
  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
- * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @package     Doctrine
- * @subpackage  Adapter
- * @link        www.doctrine-project.org
- * @since       1.0
- * @version     $Revision: 7490 $
+ *
+ * @see        www.doctrine-project.org
  */
 interface Doctrine_Adapter_Interface
 {
     public function prepare($prepareString);
+
     public function query($queryString);
+
     public function quote($input);
+
     public function exec($statement);
+
     public function lastInsertId();
+
     public function beginTransaction();
+
     public function commit();
+
     public function rollBack();
+
     public function errorCode();
+
     public function errorInfo();
+
     public function setAttribute($attribute, $value);
+
     public function getAttribute($attribute);
-}
+}