GeneaLabs /
laravel-model-caching
| Total Complexity | 51 |
| Total Lines | 287 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like CacheKey often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CacheKey, and based on these observations, apply Extract Interface, too.
| 1 | <?php namespace GeneaLabs\LaravelModelCaching; |
||
| 8 | class CacheKey |
||
| 9 | { |
||
| 10 | use CachePrefixing; |
||
|
1 ignored issue
–
show
|
|||
| 11 | |||
| 12 | protected $eagerLoad; |
||
| 13 | protected $model; |
||
| 14 | protected $query; |
||
| 15 | protected $currentBinding = 0; |
||
| 16 | |||
| 17 | public function __construct( |
||
| 25 | } |
||
| 26 | |||
| 27 | public function make( |
||
| 28 | array $columns = ["*"], |
||
| 29 | $idColumn = null, |
||
| 30 | string $keyDifferentiator = "" |
||
| 31 | ) : string { |
||
| 32 | $key = $this->getCachePrefix(); |
||
| 33 | $key .= $this->getTableSlug(); |
||
| 34 | $key .= $this->getModelSlug(); |
||
| 35 | $key .= $this->getIdColumn($idColumn ?: ""); |
||
| 36 | $key .= $this->getQueryColumns($columns); |
||
| 37 | $key .= $this->getWhereClauses(); |
||
| 38 | $key .= $this->getWithModels(); |
||
| 39 | $key .= $this->getOrderByClauses(); |
||
| 40 | $key .= $this->getOffsetClause(); |
||
| 41 | $key .= $this->getLimitClause(); |
||
| 42 | $key .= $keyDifferentiator; |
||
| 43 | |||
| 44 | return $key; |
||
| 45 | } |
||
| 46 | |||
| 47 | protected function getIdColumn(string $idColumn) : string |
||
| 48 | { |
||
| 49 | return $idColumn ? "_{$idColumn}" : ""; |
||
| 50 | } |
||
| 51 | |||
| 52 | protected function getLimitClause() : string |
||
| 53 | { |
||
| 54 | if (! $this->query->limit) { |
||
| 55 | return ""; |
||
| 56 | } |
||
| 57 | |||
| 58 | return "-limit_{$this->query->limit}"; |
||
| 59 | } |
||
| 60 | |||
| 61 | protected function getTableSlug() : string |
||
| 62 | { |
||
| 63 | return str_slug($this->model->getTable()) |
||
| 64 | . ":"; |
||
| 65 | } |
||
| 66 | |||
| 67 | protected function getModelSlug() : string |
||
| 68 | { |
||
| 69 | return str_slug(get_class($this->model)); |
||
| 70 | } |
||
| 71 | |||
| 72 | protected function getOffsetClause() : string |
||
| 73 | { |
||
| 74 | if (! $this->query->offset) { |
||
| 75 | return ""; |
||
| 76 | } |
||
| 77 | |||
| 78 | return "-offset_{$this->query->offset}"; |
||
| 79 | } |
||
| 80 | |||
| 81 | protected function getOrderByClauses() : string |
||
| 82 | { |
||
| 83 | $orders = collect($this->query->orders); |
||
| 84 | |||
| 85 | return $orders |
||
| 86 | ->reduce(function ($carry, $order) { |
||
| 87 | if (($order["type"] ?? "") === "Raw") { |
||
| 88 | return $carry . "_orderByRaw_" . str_slug($order["sql"]); |
||
| 89 | } |
||
| 90 | |||
| 91 | return $carry . "_orderBy_" . $order["column"] . "_" . $order["direction"]; |
||
| 92 | }) |
||
| 93 | ?: ""; |
||
| 94 | } |
||
| 95 | |||
| 96 | protected function getQueryColumns(array $columns) : string |
||
| 97 | { |
||
| 98 | if ($columns === ["*"] || $columns === []) { |
||
| 99 | return ""; |
||
| 100 | } |
||
| 101 | |||
| 102 | return "_" . implode("_", $columns); |
||
| 103 | } |
||
| 104 | |||
| 105 | protected function getTypeClause($where) : string |
||
| 106 | { |
||
| 107 | $type = in_array($where["type"], ["InRaw", "In", "NotIn", "Null", "NotNull", "between", "NotInSub", "InSub", "JsonContains"]) |
||
| 108 | ? strtolower($where["type"]) |
||
| 109 | : strtolower($where["operator"]); |
||
| 110 | |||
| 111 | return str_replace(" ", "_", $type); |
||
| 112 | } |
||
| 113 | |||
| 114 | protected function getValuesClause(array $where = null) : string |
||
| 115 | { |
||
| 116 | if (in_array($where["type"], ["NotNull", "Null"])) { |
||
| 117 | return ""; |
||
| 118 | } |
||
| 119 | |||
| 120 | $values = $this->getValuesFromWhere($where); |
||
| 121 | $values = $this->getValuesFromBindings($where, $values); |
||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | return "_" . $values; |
||
| 126 | } |
||
| 127 | |||
| 128 | protected function getValuesFromWhere(array $where) : string |
||
| 129 | { |
||
| 130 | if (array_get($where, "query")) { |
||
| 131 | $prefix = $this->getCachePrefix(); |
||
| 132 | $subKey = (new self($this->eagerLoad, $this->model, $where["query"])) |
||
| 133 | ->make(); |
||
| 134 | $subKey = str_replace($prefix, "", $subKey); |
||
| 135 | $subKey = str_replace($this->getModelSlug(), "", $subKey); |
||
| 136 | $classParts = explode("\\", get_class($this->model)); |
||
| 137 | $subKey = strtolower(array_pop($classParts)) . $subKey; |
||
| 138 | |||
| 139 | return $subKey; |
||
| 140 | } |
||
| 141 | |||
| 142 | if (is_array(array_get($where, "values"))) { |
||
| 143 | return implode("_", $where["values"]); |
||
| 144 | } |
||
| 145 | |||
| 146 | return array_get($where, "value", ""); |
||
| 147 | } |
||
| 148 | |||
| 149 | protected function getValuesFromBindings(array $where, string $values) : string |
||
| 150 | { |
||
| 151 | if (! $values && ($this->query->bindings["where"][$this->currentBinding] ?? false)) { |
||
| 152 | $values = $this->query->bindings["where"][$this->currentBinding]; |
||
| 153 | $this->currentBinding++; |
||
| 154 | |||
| 155 | if ($where["type"] === "between") { |
||
| 156 | $values .= "_" . $this->query->bindings["where"][$this->currentBinding]; |
||
| 157 | $this->currentBinding++; |
||
| 158 | } |
||
| 159 | } |
||
| 160 | |||
| 161 | return $values ?: ""; |
||
| 162 | } |
||
| 163 | |||
| 164 | protected function getWhereClauses(array $wheres = []) : string |
||
| 177 | }); |
||
| 178 | } |
||
| 179 | |||
| 180 | protected function getNestedClauses(array $where) : string |
||
| 181 | { |
||
| 182 | if (! in_array($where["type"], ["Exists", "Nested", "NotExists"])) { |
||
| 183 | return ""; |
||
| 184 | } |
||
| 185 | |||
| 186 | return "-" . strtolower($where["type"]) . $this->getWhereClauses($where["query"]->wheres); |
||
| 187 | } |
||
| 188 | |||
| 189 | protected function getColumnClauses(array $where) : string |
||
| 190 | { |
||
| 191 | if ($where["type"] !== "Column") { |
||
| 192 | return ""; |
||
| 193 | } |
||
| 194 | |||
| 195 | return "-{$where["boolean"]}_{$where["first"]}_{$where["operator"]}_{$where["second"]}"; |
||
| 196 | } |
||
| 197 | |||
| 198 | protected function getInClauses(array $where) : string |
||
| 199 | { |
||
| 200 | if (! in_array($where["type"], ["In"])) { |
||
| 201 | return ""; |
||
| 202 | } |
||
| 203 | |||
| 204 | $this->currentBinding++; |
||
| 205 | $values = $this->recursiveImplode($where["values"], "_"); |
||
| 206 | |||
| 207 | return "-{$where["column"]}_in{$values}"; |
||
| 208 | } |
||
| 209 | |||
| 210 | protected function getNotInClauses(array $where) : string |
||
| 211 | { |
||
| 212 | if (! in_array($where["type"], ["NotIn"])) { |
||
| 213 | return ""; |
||
| 214 | } |
||
| 215 | |||
| 216 | $this->currentBinding++; |
||
| 217 | $values = $this->recursiveImplode($where["values"], "_"); |
||
| 218 | |||
| 219 | return "-{$where["column"]}_not_in{$values}"; |
||
| 220 | } |
||
| 221 | |||
| 222 | protected function recursiveImplode(array $items, string $glue = ",") : string |
||
| 223 | { |
||
| 224 | $result = ""; |
||
| 225 | |||
| 226 | foreach ($items as $value) { |
||
| 227 | if (is_array($value)) { |
||
| 228 | $result .= $this->recursiveImplode($value, $glue); |
||
| 229 | |||
| 230 | continue; |
||
| 231 | } |
||
| 232 | |||
| 233 | $result .= $glue . $value; |
||
| 234 | } |
||
| 235 | |||
| 236 | return $result; |
||
| 237 | } |
||
| 238 | |||
| 239 | protected function getRawClauses(array $where) : string |
||
| 240 | { |
||
| 241 | if ($where["type"] !== "raw") { |
||
| 242 | return ""; |
||
| 243 | } |
||
| 244 | |||
| 245 | $queryParts = explode("?", $where["sql"]); |
||
| 246 | $clause = "_{$where["boolean"]}"; |
||
| 247 | |||
| 248 | while (count($queryParts) > 1) { |
||
| 249 | $clause .= "_" . array_shift($queryParts); |
||
| 250 | $clause .= $this->query->bindings["where"][$this->currentBinding]; |
||
| 251 | $this->currentBinding++; |
||
| 252 | } |
||
| 253 | |||
| 254 | $lastPart = array_shift($queryParts); |
||
| 255 | |||
| 256 | if ($lastPart) { |
||
| 257 | $clause .= "_" . $lastPart; |
||
| 258 | } |
||
| 259 | |||
| 260 | return "-" . str_replace(" ", "_", $clause); |
||
| 261 | } |
||
| 262 | |||
| 263 | protected function getOtherClauses(array $where) : string |
||
| 273 | } |
||
| 274 | |||
| 275 | protected function getWheres(array $wheres) : Collection |
||
| 276 | { |
||
| 277 | $wheres = collect($wheres); |
||
| 278 | |||
| 279 | if ($wheres->isEmpty()) { |
||
| 280 | $wheres = collect($this->query->wheres); |
||
| 281 | } |
||
| 282 | |||
| 283 | return $wheres; |
||
| 284 | } |
||
| 285 | |||
| 286 | protected function getWithModels() : string |
||
| 287 | { |
||
| 295 | } |
||
| 296 | } |
||
| 297 |
Loading history...