Add many typings from PHPDoc (#6)

* Add many typings from PHPDoc

* Apply suggestions from code review

Co-authored-by: Bob van de Vijver <[email protected]>

---------

Co-authored-by: Bob van de Vijver <[email protected]>

Author: tobias-93

BobvEntityHistoryBundle.php

@@ -5,8 +5,6 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
- * Class BobVEntityHistoryBundle
- *
  * @author BobV
  */
 class BobvEntityHistoryBundle extends Bundle

Configuration/HistoryConfiguration.php

@@ -5,8 +5,6 @@
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
 /**
- * Class HistoryConfiguration
- *
  * Based on the work of
  *  SimpleThings\EntityAudit
  *  Benjamin Eberlei <[email protected]>
@@ -16,7 +14,6 @@
  */
 class HistoryConfiguration
 {
-
   // Configuration variables
   protected $classes;
   protected $prefix;
@@ -26,70 +23,37 @@ class HistoryConfiguration
   protected $deletedAtField;
   protected $deletedByField;
   protected $deletedByMethod;
-
-  /**
-   * @var array
-   */
-  private $changes = array();
+  private array $changes = [];
 
   public function __construct(private readonly AuthorizationCheckerInterface $authorizationChecker) {
   }
 
-  /**
-   * @return mixed
-   */
-  public function getClasses() {
+  public function getClasses(): mixed {
     return $this->classes;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getPrefix() {
+  public function getPrefix(): mixed {
     return $this->prefix;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getRevisionFieldName() {
+  public function getRevisionFieldName(): mixed {
     return $this->revisionFieldName;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getRevisionTypeFieldName() {
+  public function getRevisionTypeFieldName(): mixed {
     return $this->revisionTypeFieldName;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getSuffix() {
+  public function getSuffix(): mixed {
     return $this->suffix;
   }
 
-  /**
-   * @param $class
-   *
-   * @return string
-   */
-  public function getTableName($class) {
+  public function getTableName($class): string {
     return $this->prefix . $class . $this->suffix;
   }
 
-  /**
-   * @param $prefix
-   * @param $suffix
-   * @param $revFieldName
-   * @param $revTypeFieldName
-   * @param $classes
-   * @param $deletedAtField
-   * @param $deletedByField
-   * @param $deletedByMethod
-   */
-  public function injectVars($prefix, $suffix, $revFieldName, $revTypeFieldName, $classes, $deletedAtField, $deletedByField, $deletedByMethod) {
+  public function injectVars($prefix, $suffix, $revFieldName, $revTypeFieldName, $classes, $deletedAtField, $deletedByField, $deletedByMethod): void
+  {
     $this->prefix                = $prefix;
     $this->suffix                = $suffix;
     $this->revisionFieldName     = $revFieldName;
@@ -100,33 +64,19 @@ public function injectVars($prefix, $suffix, $revFieldName, $revTypeFieldName, $
     $this->deletedByMethod       = $deletedByMethod;
   }
 
-  /**
-   * @param $entityName
-   *
-   * @return mixed
-   */
-  public function isLogged($entityName) {
+  public function isLogged($entityName): bool {
     return array_key_exists($entityName, $this->classes);
   }
 
-  /**
-   * @return mixed
-   */
-  public function getDeletedAtField() {
+  public function getDeletedAtField(): mixed {
     return $this->deletedAtField;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getDeletedByField() {
+  public function getDeletedByField(): mixed {
     return $this->deletedByField;
   }
 
-  /**
-   * @return mixed
-   */
-  public function getDeletedByValue() {
+  public function getDeletedByValue(): mixed {
     $method = $this->deletedByMethod;
     try {
       return $this->authorizationChecker->$method();
@@ -135,13 +85,7 @@ public function getDeletedByValue() {
     }
   }
 
-  /**
-   * @param $className
-   * @param $id
-   *
-   * @return bool
-   */
-  public function isReverted($className, $id) {
+  public function isReverted($className, $id): bool {
     if (isset($this->changes[$className]) && in_array($id, $this->changes[$className])) {
       unset($this->changes[$className][$id]);
       return true;
@@ -150,15 +94,10 @@ public function isReverted($className, $id) {
     return false;
   }
 
-  /**
-   * @param $className
-   * @param $id
-   */
-  public function setReverted($className, $id) {
+  public function setReverted($className, $id): void {
     if (!isset($this->changes[$className])) {
       $this->changes[$className] = [];
     }
     $this->changes[$className][] = $id;
   }
-
 }

DependencyInjection/BobvEntityHistoryExtension.php

@@ -8,8 +8,6 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
- * Class BobVEntityHistoryExtension
- *
  * Based on the work of
  *  SimpleThings\EntityAudit
  *  Benjamin Eberlei <[email protected]>
@@ -19,7 +17,7 @@
  */
 class BobvEntityHistoryExtension extends Extension
 {
-  public function load(array $configs, ContainerBuilder $container) {
+  public function load(array $configs, ContainerBuilder $container): void {
     $config = $this->processConfiguration(new Configuration(), $configs);
 
     $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));

DependencyInjection/Configuration.php

@@ -6,8 +6,6 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
- * Class Configuration
- *
  * Based on the work of
  *  SimpleThings\EntityAudit
  *  Benjamin Eberlei <[email protected]>

EventSubscriber/CreateSchemaSubscriber.php

@@ -9,8 +9,6 @@
 use Doctrine\ORM\Tools\ToolEvents;
 
 /**
- * Class CreateSchemaSubscriber
- *
  * Based on the work of
  *  SimpleThings\EntityAudit
  *  Benjamin Eberlei <[email protected]>
@@ -20,47 +18,31 @@
  */
 class CreateSchemaSubscriber implements EventSubscriber
 {
-
-  /**
-   * @var HistoryConfiguration
-   */
-  private $config;
-
-  /**
-   * @param HistoryConfiguration $configuration
-   */
-  public function __construct(HistoryConfiguration $configuration)
+  public function __construct(private readonly HistoryConfiguration $configuration)
   {
-    $this->config = $configuration;
   }
 
-  /**
-   * @return array
-   */
-  public function getSubscribedEvents()
+  public function getSubscribedEvents(): array
   {
-    return array(
+    return [
         ToolEvents::postGenerateSchemaTable
-    );
+    ];
   }
 
-  /**
-   * @param GenerateSchemaTableEventArgs $eventArgs
-   */
-  public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)
+  public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs): void
   {
     $cm = $eventArgs->getClassMetadata();
 
     // Check if the entity is logged
-    if ($this->config->isLogged($cm->getName())) {
+    if ($this->configuration->isLogged($cm->getName())) {
 
       // Get needed vars
       $schema      = $eventArgs->getSchema();
       $entityTable = $eventArgs->getClassTable();
 
       // Create table
       $revisionTable = $schema->createTable(
-          $this->config->getTableName($entityTable->getName())
+          $this->configuration->getTableName($entityTable->getName())
       );
 
       // Get id column (if any)