Enable strict coding style with complete type hints and phpdoc

Author: mnapoli

.phpcs.xml.dist

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg name="basepath" value="."/>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <rule ref="HardMode"/>
+</ruleset>

composer.json

@@ -20,6 +20,7 @@
         "symfony/property-info": "^4.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0"
+        "phpunit/phpunit": "^8.0",
+        "mnapoli/hard-mode": "^0.1.1"
     }
 }

src/Dynamap.php

@@ -18,7 +18,7 @@ public function __construct(DynamoDbClient $dynamoDb, array $mapping)
         $this->mappingObj = new Mapping($mapping);
     }
 
-    public static function fromOptions(array $options, array $mapping)
+    public static function fromOptions(array $options, array $mapping): self
     {
         $options['version'] = $options['version'] ?? 'latest';
 
@@ -36,8 +36,11 @@ public function getAll(string $table): array
 
     /**
      * Get item by primary key.
+     *
+     * @param int|string|array $key
+     * @throws \Exception
      */
-    public function get(string $table, $key)
+    public function get(string $table, $key): object
     {
         $tableMapping = $this->mappingObj->getTableMapping($table);
 
@@ -81,6 +84,16 @@ public function save(object $object): void
         ]);
     }
 
+    /**
+     * Update only specific fields for an item.
+     *
+     * Warning: if the item has been loaded as a PHP object, the PHP object will not be updated.
+     * If you want it to be updated you will need to reload it from database.
+     *
+     * @param int|string|array $itemKey
+     * @param array $values Key-value map
+     * @throws \Exception
+     */
     public function partialUpdate(string $table, $itemKey, array $values): void
     {
         $tableMapping = $this->mappingObj->getTableMapping($table);
@@ -120,7 +133,7 @@ private function map(array $item, string $table): object
         $object = $class->newInstanceWithoutConstructor();
 
         foreach ($item as $fieldName => $fieldData) {
-            if (!$tableMapping->hasFieldOrKey($fieldName)) {
+            if (! $tableMapping->hasFieldOrKey($fieldName)) {
                 continue;
             }
             $fieldMapping = $tableMapping->getFieldMapping($fieldName);
@@ -133,6 +146,10 @@ private function map(array $item, string $table): object
         return $object;
     }
 
+    /**
+     * @param int|string|array $key
+     * @throws \Exception
+     */
     private function buildKeyQuery($key, TableMapping $tableMapping): array
     {
         $keyQuery = [];

src/FieldMapping.php

@@ -36,17 +36,23 @@ public function name(): string
         return $this->name;
     }
 
+    /**
+     * @return mixed
+     */
     public function readFieldValue(array $item, string $fieldName)
     {
         $rawDynamoDbValue = $item[$fieldName][$this->dynamoDbType()];
 
         return $this->castValueFromDynamoDbFormat($rawDynamoDbValue);
     }
 
+    /**
+     * @param mixed $fieldValue
+     */
     public function dynamoDbQueryValue($fieldValue): array
     {
         return [
-            $this->dynamoDbType() => $this->castValueForDynamoDbFormat($fieldValue)
+            $this->dynamoDbType() => $this->castValueForDynamoDbFormat($fieldValue),
         ];
     }
 
@@ -55,6 +61,10 @@ public function dynamoDbType(): string
         return $this->dynamoDbType;
     }
 
+    /**
+     * @param mixed $value
+     * @return mixed
+     */
     private function castValueForDynamoDbFormat($value)
     {
         switch ($this->dynamoDbType()) {
@@ -70,6 +80,10 @@ private function castValueForDynamoDbFormat($value)
         }
     }
 
+    /**
+     * @param mixed $value
+     * @return mixed
+     */
     private function castValueFromDynamoDbFormat($value)
     {
         switch ($this->dynamoDbType()) {

src/Mapping.php

@@ -13,8 +13,8 @@ class Mapping
 
     public function __construct(array $mappingConfig)
     {
-        $phpDocExtractor = new PhpDocExtractor();
-        $reflectionExtractor = new ReflectionExtractor();
+        $phpDocExtractor = new PhpDocExtractor;
+        $reflectionExtractor = new ReflectionExtractor;
         $listExtractors = [$reflectionExtractor];
         $typeExtractors = [$phpDocExtractor, $reflectionExtractor];
         $descriptionExtractors = [$phpDocExtractor];