Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 11 | class SubqueryMagicScope implements Scope |
||
| 12 | { |
||
| 13 | /** |
||
| 14 | * All of the extensions to be added to the builder. |
||
| 15 | * |
||
| 16 | * @var array |
||
| 17 | */ |
||
| 18 | protected $extensions = [ |
||
| 19 | 'LeftJoinSubquery', |
||
| 20 | 'JoinSubquery', |
||
| 21 | 'RightJoinSubquery', |
||
| 22 | 'WhereInSubquery', |
||
| 23 | 'WhereNotInSubquery', |
||
| 24 | 'OrWhereInSubquery', |
||
| 25 | 'OrWhereNotInSubquery', |
||
| 26 | 'FromSubquery', |
||
| 27 | ]; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Apply the scope to a given Eloquent query builder. |
||
| 31 | * |
||
| 32 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
|
|
|||
| 33 | * @param \Illuminate\Database\Eloquent\Model $model |
||
| 34 | */ |
||
| 35 | public function apply(Builder $builder, Model $model) |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Extend the query builder with the needed functions. |
||
| 41 | * |
||
| 42 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 43 | */ |
||
| 44 | public function extend(Builder $builder) |
||
| 50 | |||
| 51 | /** |
||
| 52 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 53 | * @param array $bindings |
||
| 54 | * @param string $type |
||
| 55 | */ |
||
| 56 | private function addBindings($builder, $bindings, $type = 'where') |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Add extension to the builder. |
||
| 63 | * |
||
| 64 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 65 | */ |
||
| 66 | View Code Duplication | protected function addLeftJoinSubquery($builder) |
|
| 80 | |||
| 81 | /** |
||
| 82 | * Add extension to the builder. |
||
| 83 | * |
||
| 84 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 85 | */ |
||
| 86 | View Code Duplication | protected function addRightJoinSubquery($builder) |
|
| 100 | |||
| 101 | /** |
||
| 102 | * Add extension to the builder. |
||
| 103 | * |
||
| 104 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 105 | */ |
||
| 106 | View Code Duplication | protected function addJoinSubquery($builder) |
|
| 120 | |||
| 121 | /** |
||
| 122 | * Add extension to the builder. |
||
| 123 | * |
||
| 124 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 125 | */ |
||
| 126 | View Code Duplication | protected function addWhereInSubquery($builder) |
|
| 140 | |||
| 141 | /** |
||
| 142 | * Add extension to the builder. |
||
| 143 | * |
||
| 144 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 145 | */ |
||
| 146 | View Code Duplication | protected function addWhereNotInSubquery($builder) |
|
| 160 | |||
| 161 | /** |
||
| 162 | * Add extension to the builder. |
||
| 163 | * |
||
| 164 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 165 | */ |
||
| 166 | View Code Duplication | protected function addOrWhereInSubquery($builder) |
|
| 180 | |||
| 181 | /** |
||
| 182 | * Add extension to the builder. |
||
| 183 | * |
||
| 184 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 185 | */ |
||
| 186 | View Code Duplication | protected function addOrWhereNotInSubquery($builder) |
|
| 200 | |||
| 201 | /** |
||
| 202 | * Add extension to the builder. |
||
| 203 | * |
||
| 204 | * @param \Illuminate\Database\Eloquent\Builder|Relation $builder |
||
| 205 | */ |
||
| 206 | View Code Duplication | protected function addFromSubquery($builder) |
|
| 220 | } |
||
| 221 |