Completed
Pull Request — master (#179)
by
unknown
04:34
created

DynamoDbQueryBuilder::firstOrNew()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 16
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

Changes 0
Metric Value
eloc 9
dl 0
loc 16
ccs 0
cts 10
cp 0
rs 9.9666
c 0
b 0
f 0
cc 4
nc 4
nop 2
crap 20
1
<?php
2
3
namespace BaoPham\DynamoDb;
4
5
use BaoPham\DynamoDb\Concerns\HasParsers;
6
use BaoPham\DynamoDb\ConditionAnalyzer\Analyzer;
7
use BaoPham\DynamoDb\Facades\DynamoDb;
8
use BaoPham\DynamoDb\H;
9
use Closure;
10
use Illuminate\Contracts\Support\Arrayable;
11
use Illuminate\Database\Eloquent\ModelNotFoundException;
12
use Illuminate\Database\Eloquent\Scope;
13
14
class DynamoDbQueryBuilder
15
{
16
    use HasParsers;
17
18
    const MAX_LIMIT = -1;
19
    const DEFAULT_TO_ITERATOR = true;
20
21
    /**
22
     * The maximum number of records to return.
23
     *
24
     * @var int
25
     */
26
    public $limit;
27
28
    /**
29
     * @var array
30
     */
31
    public $wheres = [];
32
33
    /**
34
     * @var DynamoDbModel
35
     */
36
    protected $model;
37
38
    /**
39
     * @var \Aws\DynamoDb\DynamoDbClient
40
     */
41
    protected $client;
42
43
    /**
44
     * @var Closure
45
     */
46
    protected $decorator;
47
48
    /**
49
     * Applied global scopes.
50
     *
51
     * @var array
52
     */
53
    protected $scopes = [];
54
55
    /**
56
     * Removed global scopes.
57
     *
58
     * @var array
59
     */
60
    protected $removedScopes = [];
61
62
    /**
63
     * When not using the iterator, you can store the lastEvaluatedKey to
64
     * paginate through the results. The getAll method will take this into account
65
     * when used with $use_iterator = false.
66
     *
67
     * @var mixed
68
     */
69
    protected $lastEvaluatedKey;
70
71
    /**
72
     * Specified index name for the query.
73
     *
74
     * @var string
75
     */
76
    protected $index;
77
78 129
    public function __construct(DynamoDbModel $model)
79
    {
80 129
        $this->model = $model;
81 129
        $this->client = $model->getClient();
82 129
        $this->setupExpressions();
83 129
    }
84
85
    /**
86
     * Alias to set the "limit" value of the query.
87
     *
88
     * @param  int $value
89
     * @return DynamoDbQueryBuilder
90
     */
91 6
    public function take($value)
92
    {
93 6
        return $this->limit($value);
94
    }
95
96
    /**
97
     * Set the "limit" value of the query.
98
     *
99
     * @param  int $value
100
     * @return $this
101
     */
102 14
    public function limit($value)
103
    {
104 14
        $this->limit = $value;
105
106 14
        return $this;
107
    }
108
109
    /**
110
     * Alias to set the "offset" value of the query.
111
     *
112
     * @param  int $value
113
     * @throws NotSupportedException
114
     */
115
    public function skip($value)
116
    {
117
        return $this->offset($value);
118
    }
119
120
    /**
121
     * Set the "offset" value of the query.
122
     *
123
     * @param  int $value
124
     * @throws NotSupportedException
125
     */
126
    public function offset($value)
127
    {
128
        throw new NotSupportedException('Skip/Offset is not supported. Consider using after() instead');
129
    }
130
131
    /**
132
     * Determine the starting point (exclusively) of the query.
133
     * Unfortunately, offset of how many records to skip does not make sense for DynamoDb.
134
     * Instead, provide the last result of the previous query as the starting point for the next query.
135
     *
136
     * @param  DynamoDbModel|null $after
137
     *   Examples:
138
     *
139
     *   For query such as
140
     *       $query = $model->where('count', 10)->limit(2);
141
     *       $last = $query->all()->last();
142
     *   Take the last item of this query result as the next "offset":
143
     *       $nextPage = $query->after($last)->limit(2)->all();
144
     *
145
     *   Alternatively, pass in nothing to reset the starting point.
146
     *
147
     * @return $this
148
     */
149 4
    public function after(DynamoDbModel $after = null)
150
    {
151 4
        if (empty($after)) {
152 4
            $this->lastEvaluatedKey = null;
153
154 4
            return $this;
155
        }
156
157 4
        $afterKey = $after->getKeys();
158
159 4
        $analyzer = $this->getConditionAnalyzer();
160
161 4
        if ($index = $analyzer->index()) {
162 1
            foreach ($index->columns() as $column) {
163 1
                $afterKey[$column] = $after->getAttribute($column);
164
            }
165
        }
166
167 4
        $this->lastEvaluatedKey = DynamoDb::marshalItem($afterKey);
168
169 4
        return $this;
170
    }
171
172
    /**
173
     * Similar to after(), but instead of using the model instance, the model's keys are used.
174
     * Use $collection->lastKey() or $model->getKeys() to retrieve the value.
175
     *
176
     * @param  Array $key
177
     *   Examples:
178
     *
179
     *   For query such as
180
     *       $query = $model->where('count', 10)->limit(2);
181
     *       $items = $query->all();
182
     *   Take the last item of this query result as the next "offset":
183
     *       $nextPage = $query->afterKey($items->lastKey())->limit(2)->all();
184
     *
185
     *   Alternatively, pass in nothing to reset the starting point.
186
     *
187
     * @return $this
188
     */
189 4
    public function afterKey($key = null)
190
    {
191 4
        $this->lastEvaluatedKey = empty($key) ? null : DynamoDb::marshalItem($key);
192 4
        return $this;
193
    }
194
195
    /**
196
     * Set the index name manually
197
     *
198
     * @param string $index The index name
199
     * @return $this
200
     */
201 1
    public function withIndex($index)
202
    {
203 1
        $this->index = $index;
204 1
        return $this;
205
    }
206
207 74
    public function where($column, $operator = null, $value = null, $boolean = 'and')
208
    {
209
        // If the column is an array, we will assume it is an array of key-value pairs
210
        // and can add them each as a where clause. We will maintain the boolean we
211
        // received when the method was called and pass it into the nested where.
212 74
        if (is_array($column)) {
213
            foreach ($column as $key => $value) {
214
                return $this->where($key, '=', $value);
215
            }
216
        }
217
218
        // Here we will make some assumptions about the operator. If only 2 values are
219
        // passed to the method, we will assume that the operator is an equals sign
220
        // and keep going. Otherwise, we'll require the operator to be passed in.
221 74
        if (func_num_args() == 2) {
222 45
            list($value, $operator) = [$operator, '='];
223
        }
224
225
        // If the columns is actually a Closure instance, we will assume the developer
226
        // wants to begin a nested where statement which is wrapped in parenthesis.
227
        // We'll add that Closure to the query then return back out immediately.
228 74
        if ($column instanceof Closure) {
229 2
            return $this->whereNested($column, $boolean);
230
        }
231
232
        // If the given operator is not found in the list of valid operators we will
233
        // assume that the developer is just short-cutting the '=' operators and
234
        // we will set the operators to '=' and set the values appropriately.
235 74
        if (!ComparisonOperator::isValidOperator($operator)) {
236 4
            list($value, $operator) = [$operator, '='];
237
        }
238
239
        // If the value is a Closure, it means the developer is performing an entire
240
        // sub-select within the query and we will need to compile the sub-select
241
        // within the where clause to get the appropriate query record results.
242 74
        if ($value instanceof Closure) {
243
            throw new NotSupportedException('Closure in where clause is not supported');
244
        }
245
246 74
        $this->wheres[] = [
247 74
            'column' => $column,
248 74
            'type' => ComparisonOperator::getDynamoDbOperator($operator),
249 74
            'value' => $value,
250 74
            'boolean' => $boolean,
251
        ];
252
253 74
        return $this;
254
    }
255
256
    /**
257
     * Add a nested where statement to the query.
258
     *
259
     * @param  \Closure $callback
260
     * @param  string $boolean
261
     * @return $this
262
     */
263 2
    public function whereNested(Closure $callback, $boolean = 'and')
264
    {
265 2
        call_user_func($callback, $query = $this->forNestedWhere());
266
267 2
        return $this->addNestedWhereQuery($query, $boolean);
268
    }
269
270
    /**
271
     * Create a new query instance for nested where condition.
272
     *
273
     * @return $this
274
     */
275 2
    public function forNestedWhere()
276
    {
277 2
        return $this->newQuery();
278
    }
279
280
    /**
281
     * Add another query builder as a nested where to the query builder.
282
     *
283
     * @param  DynamoDbQueryBuilder $query
284
     * @param  string $boolean
285
     * @return $this
286
     */
287 2
    public function addNestedWhereQuery($query, $boolean = 'and')
288
    {
289 2
        if (count($query->wheres)) {
290 2
            $type = 'Nested';
291 2
            $column = null;
292 2
            $value = $query->wheres;
293 2
            $this->wheres[] = compact('column', 'type', 'value', 'boolean');
294
        }
295
296 2
        return $this;
297
    }
298
299
    /**
300
     * Add an "or where" clause to the query.
301
     *
302
     * @param  string $column
303
     * @param  string $operator
304
     * @param  mixed $value
305
     * @return $this
306
     */
307 22
    public function orWhere($column, $operator = null, $value = null)
308
    {
309 22
        return $this->where($column, $operator, $value, 'or');
310
    }
311
312
    /**
313
     * Add a "where in" clause to the query.
314
     *
315
     * @param  string $column
316
     * @param  mixed $values
317
     * @param  string $boolean
318
     * @param  bool $not
319
     * @return $this
320
     * @throws NotSupportedException
321
     */
322 2
    public function whereIn($column, $values, $boolean = 'and', $not = false)
323
    {
324 2
        if ($not) {
325
            throw new NotSupportedException('"not in" is not a valid DynamoDB comparison operator');
326
        }
327
328
        // If the value is a query builder instance, not supported
329 2
        if ($values instanceof static) {
330
            throw new NotSupportedException('Value is a query builder instance');
331
        }
332
333
        // If the value of the where in clause is actually a Closure, not supported
334 2
        if ($values instanceof Closure) {
335
            throw new NotSupportedException('Value is a Closure');
336
        }
337
338
        // Next, if the value is Arrayable we need to cast it to its raw array form
339 2
        if ($values instanceof Arrayable) {
340
            $values = $values->toArray();
341
        }
342
343 2
        return $this->where($column, ComparisonOperator::IN, $values, $boolean);
344
    }
345
346
    /**
347
     * Add an "or where in" clause to the query.
348
     *
349
     * @param  string $column
350
     * @param  mixed $values
351
     * @return $this
352
     */
353 2
    public function orWhereIn($column, $values)
354
    {
355 2
        return $this->whereIn($column, $values, 'or');
356
    }
357
358
    /**
359
     * Add a "where null" clause to the query.
360
     *
361
     * @param  string $column
362
     * @param  string $boolean
363
     * @param  bool $not
364
     * @return $this
365
     */
366 4
    public function whereNull($column, $boolean = 'and', $not = false)
367
    {
368 4
        $type = $not ? ComparisonOperator::NOT_NULL : ComparisonOperator::NULL;
369
370 4
        $this->wheres[] = compact('column', 'type', 'boolean');
371
372 4
        return $this;
373
    }
374
375
    /**
376
     * Add an "or where null" clause to the query.
377
     *
378
     * @param  string $column
379
     * @return $this
380
     */
381 2
    public function orWhereNull($column)
382
    {
383 2
        return $this->whereNull($column, 'or');
384
    }
385
386
    /**
387
     * Add an "or where not null" clause to the query.
388
     *
389
     * @param  string $column
390
     * @return $this
391
     */
392 2
    public function orWhereNotNull($column)
393
    {
394 2
        return $this->whereNotNull($column, 'or');
395
    }
396
397
    /**
398
     * Add a "where not null" clause to the query.
399
     *
400
     * @param  string $column
401
     * @param  string $boolean
402
     * @return $this
403
     */
404 2
    public function whereNotNull($column, $boolean = 'and')
405
    {
406 2
        return $this->whereNull($column, $boolean, true);
407
    }
408
409
    /**
410
     * Get a new instance of the query builder.
411
     *
412
     * @return DynamoDbQueryBuilder
413
     */
414 2
    public function newQuery()
415
    {
416 2
        return new static($this->getModel());
417
    }
418
419
    /**
420
     * Implements the Query Chunk method
421
     *
422
     * @param int $chunkSize
423
     * @param callable $callback
424
     */
425 9
    public function chunk($chunkSize, callable $callback)
426
    {
427 9
        while (true) {
428 9
            $results = $this->getAll([], $chunkSize, false);
429
430 9
            if ($results->isNotEmpty()) {
431 9
                if (call_user_func($callback, $results) === false) {
432 2
                    return false;
433
                }
434
            }
435
436 7
            if (empty($this->lastEvaluatedKey)) {
437 7
                break;
438
            }
439
        }
440
441 7
        return true;
442
    }
443
444
    /**
445
     * @param $id
446
     * @param array $columns
447
     * @return DynamoDbModel|\Illuminate\Database\Eloquent\Collection|null
448
     */
449 40
    public function find($id, array $columns = [])
450
    {
451 40
        if ($this->isMultipleIds($id)) {
452 4
            return $this->findMany($id, $columns);
453
        }
454
455 36
        $this->resetExpressions();
456
457 36
        $this->model->setId($id);
458
459 36
        $query = DynamoDb::table($this->model->getTable())
460 36
            ->setKey(DynamoDb::marshalItem($this->model->getKeys()))
461 36
            ->setConsistentRead(true);
462
463 36
        if (!empty($columns)) {
464
            $query
465 3
                ->setProjectionExpression($this->projectionExpression->parse($columns))
466 3
                ->setExpressionAttributeNames($this->expressionAttributeNames->all());
467
        }
468
469 36
        $item = $query->prepare($this->client)->getItem();
470
471 36
        $item = array_get($item->toArray(), 'Item');
472
473 36
        if (empty($item)) {
474 4
            return null;
475
        }
476
477 32
        $item = DynamoDb::unmarshalItem($item);
478
479 32
        $model = $this->model->newInstance([], true);
480
481 32
        $model->setRawAttributes($item, true);
482
483 32
        return $model;
484
    }
485
486
    /**
487
     * @param $ids
488
     * @param array $columns
489
     * @return \Illuminate\Database\Eloquent\Collection
490
     */
491 4
    public function findMany($ids, array $columns = [])
492
    {
493 4
        $collection = $this->model->newCollection();
494
495 4
        if (empty($ids)) {
496
            return $collection;
497
        }
498
499 4
        $this->resetExpressions();
500
501 4
        $table = $this->model->getTable();
502
503
        $keys = collect($ids)->map(function ($id) {
504 4
            if (!is_array($id)) {
505 2
                $id = [$this->model->getKeyName() => $id];
506
            }
507
508 4
            return DynamoDb::marshalItem($id);
509 4
        });
510
511 4
        $subQuery = DynamoDb::newQuery()
512 4
            ->setKeys($keys->toArray())
513 4
            ->setProjectionExpression($this->projectionExpression->parse($columns))
514 4
            ->setExpressionAttributeNames($this->expressionAttributeNames->all())
515 4
            ->prepare($this->client)
516 4
            ->query;
517
518 4
        $results = DynamoDb::newQuery()
519 4
            ->setRequestItems([$table => $subQuery])
520 4
            ->prepare($this->client)
521 4
            ->batchGetItem();
522
523 4
        foreach ($results['Responses'][$table] as $item) {
524 4
            $item = DynamoDb::unmarshalItem($item);
525 4
            $model = $this->model->newInstance([], true);
526 4
            $model->setRawAttributes($item, true);
527 4
            $collection->add($model);
528
        }
529
530 4
        return $collection;
531
    }
532
533
    public function firstOrNew($id, $attributes = [])
534
    {
535
        $result = $this->find($id);
536
537
        if ($this->isMultipleIds($id)) {
538
            if (count($result) == count(array_unique($id))) {
0 ignored issues
show
Bug introduced by
$result of type BaoPham\DynamoDb\DynamoDbModel is incompatible with the type Countable|array expected by parameter $var of count(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

538
            if (count(/** @scrutinizer ignore-type */ $result) == count(array_unique($id))) {
Loading history...
539
                return $result;
540
            }
541
        } elseif (!is_null($result)) {
542
            return $result;
543
        }
544
545
        $model = $this->model->newInstance($attributes);
546
        $model->setId($id);
547
548
        return $model;
549
    }
550
551
    public function firstOrCreate($id, $attributes = [])
552
    {
553
        $model = $this->firstOrNew($id, $attributes);
554
        $model->save();
555
556
        return $model;
557
    }
558
559
    public function updateOrCreate($id, $attributes = [])
560
    {
561
        $model = $this->firstOrNew($id, $attributes);
562
        $model->fill($attributes);
563
        $model->save();
564
565
        return $model;
566
    }
567
568
569 5
    public function findOrFail($id, $columns = [])
570
    {
571 5
        $result = $this->find($id, $columns);
572
573 5
        if ($this->isMultipleIds($id)) {
574 1
            if (count($result) == count(array_unique($id))) {
0 ignored issues
show
Bug introduced by
$result of type BaoPham\DynamoDb\DynamoDbModel is incompatible with the type Countable|array expected by parameter $var of count(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

574
            if (count(/** @scrutinizer ignore-type */ $result) == count(array_unique($id))) {
Loading history...
575 1
                return $result;
576
            }
577 4
        } elseif (!is_null($result)) {
578 2
            return $result;
579
        }
580
581 2
        throw (new ModelNotFoundException)->setModel(
582 2
            get_class($this->model),
583 2
            $id
584
        );
585
    }
586
587 16
    public function first($columns = [])
588
    {
589 16
        $items = $this->getAll($columns, 1);
590
591 16
        return $items->first();
592
    }
593
594 6
    public function firstOrFail($columns = [])
595
    {
596 6
        if (!is_null($model = $this->first($columns))) {
597 4
            return $model;
598
        }
599
600 2
        throw (new ModelNotFoundException)->setModel(get_class($this->model));
601
    }
602
603
    /**
604
     * Remove attributes from an existing item
605
     *
606
     * @param array ...$attributes
607
     * @return bool
608
     * @throws InvalidQuery
609
     */
610 6
    public function removeAttribute(...$attributes)
611
    {
612 6
        $keySet = !empty(array_filter($this->model->getKeys()));
613
614 6
        if (!$keySet) {
615 4
            $analyzer = $this->getConditionAnalyzer();
616
617 4
            if (!$analyzer->isExactSearch()) {
618
                throw new InvalidQuery('Need to provide the key in your query');
619
            }
620
621 4
            $id = $analyzer->identifierConditionValues();
622 4
            $this->model->setId($id);
623
        }
624
625 6
        $key = DynamoDb::marshalItem($this->model->getKeys());
626
627 6
        $this->resetExpressions();
628
629
        /** @var \Aws\Result $result */
630 6
        $result = DynamoDb::table($this->model->getTable())
631 6
            ->setKey($key)
632 6
            ->setUpdateExpression($this->updateExpression->remove($attributes))
633 6
            ->setExpressionAttributeNames($this->expressionAttributeNames->all())
634 6
            ->setReturnValues('ALL_NEW')
635 6
            ->prepare($this->client)
636 6
            ->updateItem();
637
638 6
        $success = array_get($result, '@metadata.statusCode') === 200;
639
640 6
        if ($success) {
641 6
            $this->model->setRawAttributes(DynamoDb::unmarshalItem($result->get('Attributes')));
642 6
            $this->model->syncOriginal();
643
        }
644
645 6
        return $success;
646
    }
647
648 2
    public function delete()
649
    {
650 2
        $result = DynamoDb::table($this->model->getTable())
651 2
            ->setKey(DynamoDb::marshalItem($this->model->getKeys()))
652 2
            ->prepare($this->client)
653 2
            ->deleteItem();
654
655 2
        return array_get($result->toArray(), '@metadata.statusCode') === 200;
656
    }
657
658 2
    public function deleteAsync()
659
    {
660 2
        $promise = DynamoDb::table($this->model->getTable())
661 2
            ->setKey(DynamoDb::marshalItem($this->model->getKeys()))
662 2
            ->prepare($this->client)
663 2
            ->deleteItemAsync();
664
665 2
        return $promise;
666
    }
667
668 8
    public function save()
669
    {
670 8
        $result = DynamoDb::table($this->model->getTable())
671 8
            ->setItem(DynamoDb::marshalItem($this->model->getAttributes()))
672 8
            ->prepare($this->client)
673 8
            ->putItem();
674
675 8
        return array_get($result, '@metadata.statusCode') === 200;
676
    }
677
678 6
    public function saveAsync()
679
    {
680 6
        $promise = DynamoDb::table($this->model->getTable())
681 6
            ->setItem(DynamoDb::marshalItem($this->model->getAttributes()))
682 6
            ->prepare($this->client)
683 6
            ->putItemAsync();
684
685 6
        return $promise;
686
    }
687
688 55
    public function get($columns = [])
689
    {
690 55
        return $this->all($columns);
691
    }
692
693 67
    public function all($columns = [])
694
    {
695 67
        $limit = isset($this->limit) ? $this->limit : static::MAX_LIMIT;
696 67
        return $this->getAll($columns, $limit, !isset($this->limit));
697
    }
698
699 4
    public function count()
700
    {
701 4
        $limit = isset($this->limit) ? $this->limit : static::MAX_LIMIT;
702 4
        $raw = $this->toDynamoDbQuery(['count(*)'], $limit);
703
704 4
        if ($raw->op === 'Scan') {
705 4
            $res = $this->client->scan($raw->query);
706
        } else {
707
            $res = $this->client->query($raw->query);
708
        }
709
710 4
        return $res['Count'];
711
    }
712
713 4
    public function decorate(Closure $closure)
714
    {
715 4
        $this->decorator = $closure;
716 4
        return $this;
717
    }
718
719 88
    protected function getAll(
720
        $columns = [],
721
        $limit = DynamoDbQueryBuilder::MAX_LIMIT,
722
        $useIterator = DynamoDbQueryBuilder::DEFAULT_TO_ITERATOR
723
    ) {
724 88
        $analyzer = $this->getConditionAnalyzer();
725
726 88
        if ($analyzer->isExactSearch()) {
727 7
            $item = $this->find($analyzer->identifierConditionValues(), $columns);
728
729 7
            return $this->getModel()->newCollection([$item]);
730
        }
731
732 82
        $raw = $this->toDynamoDbQuery($columns, $limit);
733
734 82
        if ($useIterator) {
735 65
            $iterator = $this->client->getIterator($raw->op, $raw->query);
736
737 65
            if (isset($raw->query['Limit'])) {
738 12
                $iterator = new \LimitIterator($iterator, 0, $raw->query['Limit']);
739
            }
740
        } else {
741 21
            if ($raw->op === 'Scan') {
742 18
                $res = $this->client->scan($raw->query);
743
            } else {
744 3
                $res = $this->client->query($raw->query);
745
            }
746
747 21
            $this->lastEvaluatedKey = array_get($res, 'LastEvaluatedKey');
748 21
            $iterator = $res['Items'];
749
        }
750
751 82
        $results = [];
752
753 82
        foreach ($iterator as $item) {
754 82
            $item = DynamoDb::unmarshalItem($item);
755 82
            $model = $this->model->newInstance([], true);
756 82
            $model->setRawAttributes($item, true);
757 82
            $results[] = $model;
758
        }
759
760 82
        return $this->getModel()->newCollection($results, $analyzer->index());
761
    }
762
763
    /**
764
     * Return the raw DynamoDb query
765
     *
766
     * @param array $columns
767
     * @param int $limit
768
     * @return RawDynamoDbQuery
769
     */
770 92
    public function toDynamoDbQuery(
771
        $columns = [],
772
        $limit = DynamoDbQueryBuilder::MAX_LIMIT
773
    ) {
774 92
        $this->applyScopes();
775
776 92
        $this->resetExpressions();
777
778 92
        $op = 'Scan';
779 92
        $queryBuilder = DynamoDb::table($this->model->getTable());
780
781 92
        if (!empty($this->wheres)) {
782 70
            $analyzer = $this->getConditionAnalyzer();
783
784 70
            if ($keyConditions = $analyzer->keyConditions()) {
785 16
                $op = 'Query';
786 16
                $queryBuilder->setKeyConditionExpression($this->keyConditionExpression->parse($keyConditions));
787
            }
788
789 70
            if ($filterConditions = $analyzer->filterConditions()) {
790 61
                $queryBuilder->setFilterExpression($this->filterExpression->parse($filterConditions));
791
            }
792
793 70
            if ($index = $analyzer->index()) {
794 8
                $queryBuilder->setIndexName($index->name);
795
            }
796
        }
797
798 92
        if ($this->index) {
799
            // If user specifies the index manually, respect that
800 1
            $queryBuilder->setIndexName($this->index);
801
        }
802
803 92
        if ($limit !== static::MAX_LIMIT) {
804 33
            $queryBuilder->setLimit($limit);
805
        }
806
807 92
        if (!empty($columns)) {
808
            // Either we try to get the count or specific columns
809 8
            if ($columns == ['count(*)']) {
810 6
                $queryBuilder->setSelect('COUNT');
811
            } else {
812 2
                $queryBuilder->setProjectionExpression($this->projectionExpression->parse($columns));
813
            }
814
        }
815
816 92
        if (!empty($this->lastEvaluatedKey)) {
817 15
            $queryBuilder->setExclusiveStartKey($this->lastEvaluatedKey);
818
        }
819
820
        $queryBuilder
821 92
            ->setExpressionAttributeNames($this->expressionAttributeNames->all())
822 92
            ->setExpressionAttributeValues($this->expressionAttributeValues->all());
823
824 92
        $raw = new RawDynamoDbQuery($op, $queryBuilder->prepare($this->client)->query);
825
826 92
        if ($this->decorator) {
827 4
            call_user_func($this->decorator, $raw);
828
        }
829
830 92
        return $raw;
831
    }
832
833
    /**
834
     * @return Analyzer
835
     */
836 97
    protected function getConditionAnalyzer()
837
    {
838 97
        return with(new Analyzer)
839 97
            ->on($this->model)
840 97
            ->withIndex($this->index)
841 97
            ->analyze($this->wheres);
842
    }
843
844 40
    protected function isMultipleIds($id)
845
    {
846 40
        $keys = collect($this->model->getKeyNames());
847
848
        // could be ['id' => 'foo'], ['id1' => 'foo', 'id2' => 'bar']
849
        $single = $keys->first(function ($name) use ($id) {
850 40
                return !isset($id[$name]);
851 40
            }) === null;
852
853 40
        if ($single) {
854 22
            return false;
855
        }
856
857
        // could be ['foo', 'bar'], [['id1' => 'foo', 'id2' => 'bar'], ...]
858 18
        return $this->model->hasCompositeKey() ? is_array(H::array_first($id)) : is_array($id);
859
    }
860
861
    /**
862
     * @return DynamoDbModel
863
     */
864 88
    public function getModel()
865
    {
866 88
        return $this->model;
867
    }
868
869
    /**
870
     * @return \Aws\DynamoDb\DynamoDbClient
871
     */
872
    public function getClient()
873
    {
874
        return $this->client;
875
    }
876
877
    /**
878
     * Register a new global scope.
879
     *
880
     * @param  string $identifier
881
     * @param  \Illuminate\Database\Eloquent\Scope|\Closure $scope
882
     * @return $this
883
     */
884 7
    public function withGlobalScope($identifier, $scope)
885
    {
886 7
        $this->scopes[$identifier] = $scope;
887
888 7
        if (method_exists($scope, 'extend')) {
889
            $scope->extend($this);
890
        }
891
892 7
        return $this;
893
    }
894
895
    /**
896
     * Remove a registered global scope.
897
     *
898
     * @param  \Illuminate\Database\Eloquent\Scope|string $scope
899
     * @return $this
900
     */
901 3
    public function withoutGlobalScope($scope)
902
    {
903 3
        if (!is_string($scope)) {
904
            $scope = get_class($scope);
905
        }
906
907 3
        unset($this->scopes[$scope]);
908
909 3
        $this->removedScopes[] = $scope;
910
911 3
        return $this;
912
    }
913
914
    /**
915
     * Remove all or passed registered global scopes.
916
     *
917
     * @param  array|null $scopes
918
     * @return $this
919
     */
920 5
    public function withoutGlobalScopes(array $scopes = null)
921
    {
922 5
        if (is_array($scopes)) {
923
            foreach ($scopes as $scope) {
924
                $this->withoutGlobalScope($scope);
925
            }
926
        } else {
927 5
            $this->scopes = [];
928
        }
929
930 5
        return $this;
931
    }
932
933
    /**
934
     * Get an array of global scopes that were removed from the query.
935
     *
936
     * @return array
937
     */
938
    public function removedScopes()
939
    {
940
        return $this->removedScopes;
941
    }
942
943
    /**
944
     * Apply the scopes to the Eloquent builder instance and return it.
945
     *
946
     * @return DynamoDbQueryBuilder
947
     */
948 92
    public function applyScopes()
949
    {
950 92
        if (!$this->scopes) {
951 91
            return $this;
952
        }
953
954 3
        $builder = $this;
955
956 3
        foreach ($builder->scopes as $identifier => $scope) {
957 3
            if (!isset($builder->scopes[$identifier])) {
958
                continue;
959
            }
960
961
            $builder->callScope(function (DynamoDbQueryBuilder $builder) use ($scope) {
962
                // If the scope is a Closure we will just go ahead and call the scope with the
963
                // builder instance. The "callScope" method will properly group the clauses
964
                // that are added to this query so "where" clauses maintain proper logic.
965 3
                if ($scope instanceof Closure) {
966 3
                    $scope($builder);
967
                }
968
969
                // If the scope is a scope object, we will call the apply method on this scope
970
                // passing in the builder and the model instance. After we run all of these
971
                // scopes we will return back the builder instance to the outside caller.
972 3
                if ($scope instanceof Scope) {
973
                    throw new NotSupportedException('Scope object is not yet supported');
974
                }
975 3
            });
976
977 3
            $builder->withoutGlobalScope($identifier);
978
        }
979
980 3
        return $builder;
981
    }
982
983
    /**
984
     * Apply the given scope on the current builder instance.
985
     *
986
     * @param  callable $scope
987
     * @param  array $parameters
988
     * @return mixed
989
     */
990 7
    protected function callScope(callable $scope, $parameters = [])
991
    {
992 7
        array_unshift($parameters, $this);
993
994
        // $query = $this->getQuery();
995
996
        // // We will keep track of how many wheres are on the query before running the
997
        // // scope so that we can properly group the added scope constraints in the
998
        // // query as their own isolated nested where statement and avoid issues.
999
        // $originalWhereCount = is_null($query->wheres)
1000
        //             ? 0 : count($query->wheres);
1001
1002 7
        $result = $scope(...array_values($parameters)) ?: $this;
1003
1004
        // if (count((array) $query->wheres) > $originalWhereCount) {
1005
        //     $this->addNewWheresWithinGroup($query, $originalWhereCount);
1006
        // }
1007
1008 7
        return $result;
1009
    }
1010
1011
    /**
1012
     * Dynamically handle calls into the query instance.
1013
     *
1014
     * @param  string $method
1015
     * @param  array $parameters
1016
     * @return mixed
1017
     */
1018 7
    public function __call($method, $parameters)
1019
    {
1020 7
        if (method_exists($this->model, $scope = 'scope' . ucfirst($method))) {
1021 5
            return $this->callScope([$this->model, $scope], $parameters);
1022
        }
1023
1024 2
        return $this;
1025
    }
1026
}
1027