tidy

Author: kitar

src/Kitar/Dynamodb/Connection.php

@@ -36,29 +36,39 @@ public function table($table, $as = null)
         return $query->from($table, $as);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getDriverName()
+    {
+        return 'dynamodb';
+    }
+
     /**
      * Get the DynamoDB Client object.
      * @return \Aws\Dynamodb\DynamoDbClient
      */
-    public function getDynamodbClient()
+    public function getClient()
     {
         return $this->client;
     }
 
     /**
-     * @inheritdoc
+     * Set the DynamoDB client.
+     * @param DynamoDbClient $client
+     * @return void
      */
-    public function getDriverName()
+    public function setClient(DynamoDbClient $client)
     {
-        return 'dynamodb';
+        $this->client = $client;
     }
 
     /**
      * Create a new MongoDB client.
      * @param array $config
      * @return \Aws\Dynamodb\DynamoDbClient
      */
-    public function createClient(array $config)
+    protected function createClient(array $config)
     {
         $sdk = new AwsSdk([
             'region' => $config['region'] ?? 'us-east-1',
@@ -72,16 +82,6 @@ public function createClient(array $config)
         return $sdk->createDynamoDb();
     }
 
-    /**
-     * Set the DynamoDB client.
-     * @param DynamoDbClient $client
-     * @return void
-     */
-    public function setClient(DynamoDbClient $client)
-    {
-        $this->client = $client;
-    }
-
     /**
      * @inheritdoc
      */

src/Kitar/Dynamodb/Query/Builder.php

@@ -35,14 +35,15 @@ class Builder extends BaseBuilder
 
     /**
      * The key/values to update.
+     * @var array
      */
     public $updates = [
         'set' => [],
         'remove' => []
     ];
 
     /**
-     * LastEvaluatedKey attribute.
+     * LastEvaluatedKey option.
      * @var array|null
      */
     public $exclusive_start_key;
@@ -60,10 +61,7 @@ class Builder extends BaseBuilder
     public $dry_run = false;
 
     /**
-     * ** experimental **
-     * If set, all response items will be converted to
-     * this class using (new $model_class)->newFromBuilder($item).
-     *
+     * The model class name used to transform the DynamoDB responses.
      * @var string|null
      */
     public $model_class;
@@ -72,40 +70,47 @@ class Builder extends BaseBuilder
      * The ExpressionAttributes object.
      * @var Kitar\Dynamodb\Query\ExpressionAttributes
      */
-    public $expression_attributes;
+    protected $expression_attributes;
 
     /**
      * Available where methods which will pass to dedicated queries.
      * @var array
      */
-    public $available_wheres;
+    protected $available_wheres;
 
     /**
      * The attribute name to place compiled wheres.
      * @var string
      */
-    public $where_as;
+    protected $where_as;
 
     /**
      * Dedicated query for building FilterExpression.
      * @var Kitar\Dynamodb\Query\Builder
      */
-    public $filter_query;
+    protected $filter_query;
 
     /**
      * Dedicated query for building ConditionExpression.
      * @var Kitar\Dynamodb\Query\Builder
      */
-    public $condition_query;
+    protected $condition_query;
 
     /**
      * Dedicated query for building KeyConditionExpression.
      * @var Kitar\Dynamodb\Query\Builder
      */
-    public $key_condition_query;
+    protected $key_condition_query;
 
     /**
-     * @inheritdoc
+     * Create a new query builder instance.
+     *
+     * @param Kitar\Dynamodb\Connection $connection
+     * @param Kitar\Dynamodb\Query\Grammar $grammar
+     * @param Kitar\Dynamodb\Query\Processor $processor
+     * @param Kitar\Dynamodb\Query\ExpressionAttributes|null $expression_attributes
+     * @param bool $is_nested_query
+     * @return void
      */
     public function __construct(Connection $connection, Grammar $grammar, Processor $processor, $expression_attributes = null, $is_nested_query = false)
     {
@@ -124,6 +129,7 @@ public function __construct(Connection $connection, Grammar $grammar, Processor
 
     /**
      * Set the index name.
+     *
      * @param string $index
      * @return $this
      */
@@ -136,6 +142,7 @@ public function index(string $index)
 
     /**
      * Set the key.
+     *
      * @param array $key
      * @return $this
      */
@@ -148,7 +155,6 @@ public function key(array $key)
 
     /**
      * Set the ExclusiveStartKey option.
-     * Unlike other methods, this $key should be marshaled　beforehand.
      *
      * @param array $key
      * @return $this
@@ -162,6 +168,7 @@ public function exclusiveStartKey($key)
 
     /**
      * Set the ConsistentRead option.
+     *
      * @param bool $active
      * @return $this
      */
@@ -173,7 +180,8 @@ public function consistentRead($active = true)
     }
 
     /**
-     * Set the dry run option. It'll return compiled params instead of calling DynamoDB.
+     * Set the dry run option.
+     *
      * @param bool $active
      * @return $this
      */
@@ -185,11 +193,11 @@ public function dryRun($active = true)
     }
 
     /**
-     * ** experimental **
-     * If set, all response items will be converted to
-     * this class using (new $model_class)->newFromBuilder($item).
+     * If set, response items will be converted to the model instance by using:
+     * (new $model_class)->newFromBuilder($item).
      *
-     * @var string|null
+     * @var string
+     * @return $this
      */
     public function usingModel($class_name)
     {
@@ -200,20 +208,32 @@ public function usingModel($class_name)
 
     /**
      * Set key name of wheres. eg. FilterExpression
+     *
      * @param string $condition_key_name
      * @return $this
      */
-    public function whereAs($condition_key_name)
+    protected function whereAs($condition_key_name)
     {
         $this->where_as = $condition_key_name;
 
         return $this;
     }
 
+    /**
+     * Get the where_as attribute.
+     *
+     * @return string
+     */
+    public function getWhereAs()
+    {
+        return $this->where_as;
+    }
+
     /**
      * Get item.
+     *
      * @param array|null $key
-     * @return Illuminate\Support\Collection|null
+     * @return array|null
      */
     public function getItem($key = null)
     {
@@ -226,6 +246,7 @@ public function getItem($key = null)
 
     /**
      * Put item.
+     *
      * @param array $item
      * @return \Aws\Result
      */
@@ -238,22 +259,22 @@ public function putItem($item)
 
     /**
      * Delete item.
-     * @param array $key|null;
-     * @return \Aws\Result;
+     *
+     * @param array $key;
+     * @return \Aws\Result
      */
     public function deleteItem($key)
     {
-        if ($key) {
-            $this->key($key);
-        }
+        $this->key($key);
 
         return $this->process('deleteItem', null);
     }
 
     /**
      * Update item.
-     * @param mixed $item
-     * @return void
+     *
+     * @param array $item
+     * @return \Aws\Result
      */
     public function updateItem($item)
     {
@@ -276,7 +297,8 @@ public function updateItem($item)
 
     /**
      * Query.
-     * @return Illuminate\Support\Collection
+     *
+     * @return Illuminate\Support\Collection|array
      */
     public function query()
     {
@@ -285,19 +307,22 @@ public function query()
 
     /**
      * Scan.
-     * @return Illuminate\Support\Collection
+     *
+     * @return Illuminate\Support\Collection|array
      */
     public function scan()
     {
         return $this->process('scan', 'processMultipleItems');
     }
 
     /**
-     * Make individual Builder instance for condition types. (Filter, Condition and KeyCondition)
+     * Make individual Builder instance for condition types.
+     *
      * @return void
      */
-    public function initializeDedicatedQueries()
+    protected function initializeDedicatedQueries()
     {
+        // Set builder instances.
         $this->filter_query = $this->newQuery()->whereAs('FilterExpression');
         $this->condition_query = $this->newQuery()->whereAs('ConditionExpression');
         $this->key_condition_query = $this->newQuery()->whereAs('KeyConditionExpression');
@@ -319,6 +344,7 @@ public function initializeDedicatedQueries()
 
     /**
      * Perform where methods within dedicated queries.
+     *
      * @param string $method
      * @param array $parameters
      * @return $this
@@ -431,6 +457,7 @@ public function newQuery()
 
     /**
      * Execute DynamoDB call and returns processed result.
+     *
      * @param string $query_method
      * @param array $params
      * @param string $processor_method