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 namespace Anomaly\Streams\Platform\Addon\Module; |
||
| 12 | */ |
||
| 13 | class ModuleRepository implements ModuleRepositoryInterface |
||
| 14 | { |
||
| 15 | |||
| 16 | /** |
||
| 17 | * The module model. |
||
| 18 | * |
||
| 19 | * @var |
||
| 20 | */ |
||
| 21 | protected $model; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Create a new ModuleRepository instance. |
||
| 25 | * |
||
| 26 | * @param ModuleModel $model |
||
| 27 | */ |
||
| 28 | public function __construct(ModuleModel $model) |
||
| 29 | { |
||
| 30 | $this->model = $model; |
||
| 31 | } |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Return all modules in the database. |
||
| 35 | * |
||
| 36 | * @return mixed |
||
| 37 | */ |
||
| 38 | public function all() |
||
| 39 | { |
||
| 40 | return $this->model->all(); |
||
| 41 | } |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Create a module record. |
||
| 45 | * |
||
| 46 | * @param Module $module |
||
| 47 | * @return bool |
||
| 48 | */ |
||
| 49 | public function create(Module $module) |
||
| 50 | { |
||
| 51 | $instance = $this->model->newInstance(); |
||
| 52 | |||
| 53 | $instance->namespace = $module->getNamespace(); |
||
| 54 | $instance->installed = false; |
||
| 55 | $instance->enabled = false; |
||
| 56 | |||
| 57 | return $instance->save(); |
||
| 58 | } |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Delete a module record. |
||
| 62 | * |
||
| 63 | * @param Module $module |
||
| 64 | * @return ModuleModel |
||
| 65 | */ |
||
| 66 | public function delete(Module $module) |
||
| 67 | { |
||
| 68 | $module = $this->model->findByNamespace($module->getNamespace()); |
||
| 69 | |||
| 70 | if ($module) { |
||
| 71 | $module->delete(); |
||
| 72 | } |
||
| 73 | |||
| 74 | return $module; |
||
| 75 | } |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Mark a module as installed. |
||
| 79 | * |
||
| 80 | * @param Module $module |
||
| 81 | * @return bool |
||
| 82 | */ |
||
| 83 | public function install(Module $module) |
||
| 84 | { |
||
| 85 | if (!$module = $this->model->findByNamespaceOrNew($module->getNamespace())) { |
||
| 86 | return false; |
||
| 87 | } |
||
| 88 | |||
| 89 | $module->installed = true; |
||
| 90 | $module->enabled = true; |
||
| 91 | |||
| 92 | return $module->save(); |
||
| 93 | } |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Mark a module as uninstalled. |
||
| 97 | * |
||
| 98 | * @param Module $module |
||
| 99 | * @return bool |
||
| 100 | */ |
||
| 101 | public function uninstall(Module $module) |
||
| 102 | { |
||
| 103 | if (!$module = $this->model->findByNamespace($module->getNamespace())) { |
||
| 104 | return false; |
||
| 105 | } |
||
| 106 | |||
| 107 | $module->installed = false; |
||
| 108 | $module->enabled = false; |
||
| 109 | |||
| 110 | return $module->save(); |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Mark a module as disabled. |
||
| 115 | * |
||
| 116 | * @param Module $module |
||
| 117 | * @return bool |
||
| 118 | */ |
||
| 119 | public function disable(Module $module) |
||
| 120 | { |
||
| 121 | $module = $this->model->findByNamespace($module->getNamespace()); |
||
| 122 | |||
| 123 | $module->enabled = false; |
||
| 124 | |||
| 125 | return $module->save(); |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Mark a module as enabled. |
||
| 130 | * |
||
| 131 | * @param Module $module |
||
| 132 | * @return bool |
||
| 133 | */ |
||
| 134 | public function enabled(Module $module) |
||
| 135 | { |
||
| 136 | $module = $this->model->findByNamespace($module->getNamespace()); |
||
| 137 | |||
| 138 | $module->enabled = true; |
||
| 139 | |||
| 140 | return $module->save(); |
||
| 141 | } |
||
| 142 | |||
| 178 |