Casts
1 month ago
Concerns
1 month ago
Factories
1 month ago
Relations
1 month ago
BroadcastableModelEventOccurred.php
1 month ago
BroadcastsEvents.php
6 months ago
Builder.php
1 month ago
Collection.php
1 month ago
HigherOrderBuilderProxy.php
2 years ago
InvalidCastException.php
2 years ago
JsonEncodingException.php
2 years ago
MassAssignmentException.php
2 years ago
MassPrunable.php
6 months ago
MissingAttributeException.php
1 month ago
Model.php
1 month ago
ModelNotFoundException.php
1 month ago
PendingHasThroughRelationship.php
1 month ago
Prunable.php
2 years ago
QueueEntityResolver.php
2 years ago
RelationNotFoundException.php
2 years ago
Scope.php
2 years ago
SoftDeletes.php
1 month ago
SoftDeletingScope.php
1 month ago
SoftDeletingScope.php
126 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWPSCOPED\Illuminate\Database\Eloquent; |
| 4 | |
| 5 | /** @internal */ |
| 6 | class SoftDeletingScope implements Scope |
| 7 | { |
| 8 | /** |
| 9 | * All of the extensions to be added to the builder. |
| 10 | * |
| 11 | * @var string[] |
| 12 | */ |
| 13 | protected $extensions = ['Restore', 'RestoreOrCreate', 'WithTrashed', 'WithoutTrashed', 'OnlyTrashed']; |
| 14 | /** |
| 15 | * Apply the scope to a given Eloquent query builder. |
| 16 | * |
| 17 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 18 | * @param \Illuminate\Database\Eloquent\Model $model |
| 19 | * @return void |
| 20 | */ |
| 21 | public function apply(Builder $builder, Model $model) |
| 22 | { |
| 23 | $builder->whereNull($model->getQualifiedDeletedAtColumn()); |
| 24 | } |
| 25 | /** |
| 26 | * Extend the query builder with the needed functions. |
| 27 | * |
| 28 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 29 | * @return void |
| 30 | */ |
| 31 | public function extend(Builder $builder) |
| 32 | { |
| 33 | foreach ($this->extensions as $extension) { |
| 34 | $this->{"add{$extension}"}($builder); |
| 35 | } |
| 36 | $builder->onDelete(function (Builder $builder) { |
| 37 | $column = $this->getDeletedAtColumn($builder); |
| 38 | return $builder->update([$column => $builder->getModel()->freshTimestampString()]); |
| 39 | }); |
| 40 | } |
| 41 | /** |
| 42 | * Get the "deleted at" column for the builder. |
| 43 | * |
| 44 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 45 | * @return string |
| 46 | */ |
| 47 | protected function getDeletedAtColumn(Builder $builder) |
| 48 | { |
| 49 | if (\count((array) $builder->getQuery()->joins) > 0) { |
| 50 | return $builder->getModel()->getQualifiedDeletedAtColumn(); |
| 51 | } |
| 52 | return $builder->getModel()->getDeletedAtColumn(); |
| 53 | } |
| 54 | /** |
| 55 | * Add the restore extension to the builder. |
| 56 | * |
| 57 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 58 | * @return void |
| 59 | */ |
| 60 | protected function addRestore(Builder $builder) |
| 61 | { |
| 62 | $builder->macro('restore', function (Builder $builder) { |
| 63 | $builder->withTrashed(); |
| 64 | return $builder->update([$builder->getModel()->getDeletedAtColumn() => null]); |
| 65 | }); |
| 66 | } |
| 67 | /** |
| 68 | * Add the restore-or-create extension to the builder. |
| 69 | * |
| 70 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 71 | * @return void |
| 72 | */ |
| 73 | protected function addRestoreOrCreate(Builder $builder) |
| 74 | { |
| 75 | $builder->macro('restoreOrCreate', function (Builder $builder, array $attributes = [], array $values = []) { |
| 76 | $builder->withTrashed(); |
| 77 | return \IAWPSCOPED\tap($builder->firstOrCreate($attributes, $values), function ($instance) { |
| 78 | $instance->restore(); |
| 79 | }); |
| 80 | }); |
| 81 | } |
| 82 | /** |
| 83 | * Add the with-trashed extension to the builder. |
| 84 | * |
| 85 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 86 | * @return void |
| 87 | */ |
| 88 | protected function addWithTrashed(Builder $builder) |
| 89 | { |
| 90 | $builder->macro('withTrashed', function (Builder $builder, $withTrashed = \true) { |
| 91 | if (!$withTrashed) { |
| 92 | return $builder->withoutTrashed(); |
| 93 | } |
| 94 | return $builder->withoutGlobalScope($this); |
| 95 | }); |
| 96 | } |
| 97 | /** |
| 98 | * Add the without-trashed extension to the builder. |
| 99 | * |
| 100 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 101 | * @return void |
| 102 | */ |
| 103 | protected function addWithoutTrashed(Builder $builder) |
| 104 | { |
| 105 | $builder->macro('withoutTrashed', function (Builder $builder) { |
| 106 | $model = $builder->getModel(); |
| 107 | $builder->withoutGlobalScope($this)->whereNull($model->getQualifiedDeletedAtColumn()); |
| 108 | return $builder; |
| 109 | }); |
| 110 | } |
| 111 | /** |
| 112 | * Add the only-trashed extension to the builder. |
| 113 | * |
| 114 | * @param \Illuminate\Database\Eloquent\Builder $builder |
| 115 | * @return void |
| 116 | */ |
| 117 | protected function addOnlyTrashed(Builder $builder) |
| 118 | { |
| 119 | $builder->macro('onlyTrashed', function (Builder $builder) { |
| 120 | $model = $builder->getModel(); |
| 121 | $builder->withoutGlobalScope($this)->whereNotNull($model->getQualifiedDeletedAtColumn()); |
| 122 | return $builder; |
| 123 | }); |
| 124 | } |
| 125 | } |
| 126 |