thinktomorrow /
chief
| Total Complexity | 43 |
| Total Lines | 257 |
| Duplicated Lines | 0 % |
| Coverage | 78.89% |
| Changes | 7 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Page 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 Page, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 35 | class Page extends Model implements ManagedModel, TranslatableContract, HasMedia, ActsAsParent, ActsAsChild, ActsAsMenuItem, MorphableContract, ViewableContract, ProvidesUrl |
||
| 36 | { |
||
| 37 | use BaseTranslatable { |
||
|
introduced
by
|
|||
| 38 | getAttribute as getTranslatableAttribute; |
||
| 39 | } |
||
| 40 | |||
| 41 | use Morphable, |
||
| 42 | AssetTrait, |
||
| 43 | Translatable, |
||
| 44 | SoftDeletes, |
||
| 45 | Publishable, |
||
| 46 | Featurable, |
||
| 47 | Archivable, |
||
| 48 | AuditTrait, |
||
| 49 | ActingAsParent, |
||
| 50 | ActingAsChild, |
||
| 51 | WithSnippets, |
||
| 52 | ResolvingRoute, |
||
| 53 | Viewable; |
||
| 54 | |||
| 55 | // Explicitly mention the translation model so on inheritance the child class uses the proper default translation model |
||
| 56 | protected $translationModel = PageTranslation::class; |
||
| 57 | protected $translationForeignKey = 'page_id'; |
||
| 58 | protected $translatedAttributes = [ |
||
| 59 | 'title', 'content', 'short', 'seo_title', 'seo_description', 'seo_keywords', 'seo_image' |
||
| 60 | ]; |
||
| 61 | |||
| 62 | public $table = "pages"; |
||
| 63 | protected $guarded = []; |
||
| 64 | protected $with = ['translations']; |
||
| 65 | |||
| 66 | protected $baseViewPath; |
||
| 67 | protected static $baseUrlSegment = '/'; |
||
| 68 | |||
| 69 | 183 | public function __construct(array $attributes = []) |
|
| 78 | 183 | } |
|
| 79 | |||
| 80 | 446 | public static function managedModelKey(): string |
|
| 81 | { |
||
| 82 | 446 | if (isset(static::$managedModelKey)) { |
|
| 83 | 446 | return static::$managedModelKey; |
|
| 84 | } |
||
| 85 | |||
| 86 | throw new \Exception('Missing required static property \'managedModelKey\' on ' . static::class. '.'); |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Parse and render any found snippets in custom |
||
| 91 | * or translatable attribute values. |
||
| 92 | * |
||
| 93 | * @param string $value |
||
| 94 | * @return mixed|null|string|string[] |
||
| 95 | */ |
||
| 96 | 158 | public function getAttribute($value) |
|
| 97 | { |
||
| 98 | 158 | $value = $this->getTranslatableAttribute($value); |
|
| 99 | |||
| 100 | 158 | if ($this->shouldParseWithSnippets($value)) { |
|
| 101 | 1 | $value = $this->parseWithSnippets($value); |
|
| 102 | } |
||
| 103 | |||
| 104 | 158 | return $value; |
|
| 105 | } |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Page specific modules. We exclude text modules since they are modules in pure |
||
| 109 | * technical terms and not so much as behavioural elements for the admin. |
||
| 110 | * |
||
| 111 | * @return \Illuminate\Database\Eloquent\Relations\HasMany |
||
| 112 | */ |
||
| 113 | 2 | public function modules() |
|
| 114 | { |
||
| 115 | 2 | return $this->hasMany(Module::class, 'page_id')->where('morph_key', '<>', 'text'); |
|
| 116 | } |
||
| 117 | |||
| 118 | 9 | public function flatReference(): FlatReference |
|
| 121 | } |
||
| 122 | |||
| 123 | 74 | public function flatReferenceLabel(): string |
|
| 124 | { |
||
| 125 | 74 | if ($this->exists) { |
|
| 126 | 57 | $status = ! $this->isPublished() ? ' [' . $this->statusAsPlainLabel().']' : null; |
|
| 127 | |||
| 128 | 57 | return $this->title ? $this->title . $status : ''; |
|
| 129 | } |
||
| 130 | |||
| 131 | 22 | return ''; |
|
| 132 | } |
||
| 133 | |||
| 134 | 4 | public function flatReferenceGroup(): string |
|
| 140 | } |
||
| 141 | |||
| 142 | public function mediaUrls($type = null): Collection |
||
| 143 | { |
||
| 144 | // TODO getallfiles should actually get all files... |
||
| 145 | // What was the creator of the assetlibrary package thinking. It sure wasn't me... I promise... |
||
| 146 | $assets = $this->getAllFiles($type, app()->getLocale())->map->getFileUrl(); |
||
| 147 | |||
| 148 | if($assets->first() == null) |
||
| 149 | { |
||
| 150 | $assets = $this->getAllFiles($type)->map->getFileUrl(); |
||
| 151 | } |
||
| 152 | |||
| 153 | return $assets; |
||
| 154 | } |
||
| 155 | |||
| 156 | public function mediaUrl($type = null): ?string |
||
| 157 | 1 | { |
|
| 158 | return $this->mediaUrls($type)->first(); |
||
| 159 | 1 | } |
|
| 160 | 1 | ||
| 161 | public static function findPublished($id) |
||
| 164 | } |
||
| 165 | 50 | ||
| 166 | 46 | public function scopeSortedByCreated($query) |
|
| 167 | { |
||
| 168 | $query->orderBy('created_at', 'DESC'); |
||
| 169 | } |
||
| 170 | 50 | ||
| 171 | /** @inheritdoc */ |
||
| 172 | 31 | public function url(string $locale = null): string |
|
| 173 | 21 | { |
|
| 174 | 21 | if (!$locale) { |
|
| 175 | $locale = app()->getLocale(); |
||
| 176 | } |
||
| 177 | |||
| 178 | 57 | try { |
|
| 179 | $slug = MemoizedUrlRecord::findByModel($this, $locale)->slug; |
||
| 180 | 57 | ||
| 181 | return $this->resolveUrl($locale, [$slug]); |
||
| 182 | 57 | } catch (UrlRecordNotFound $e) { |
|
| 183 | return ''; |
||
| 184 | } |
||
| 185 | } |
||
| 186 | 55 | ||
| 187 | public function resolveUrl(string $locale = null, $parameters = null): string |
||
| 188 | 55 | { |
|
| 189 | $routeName = config('thinktomorrow.chief.route.name'); |
||
| 190 | |||
| 191 | return $this->resolveRoute($routeName, $parameters, $locale); |
||
| 192 | } |
||
| 193 | 52 | ||
| 194 | /** @inheritdoc */ |
||
| 195 | 52 | public function previewUrl(string $locale = null): string |
|
| 196 | { |
||
| 197 | return $this->url($locale).'?preview-mode'; |
||
| 198 | } |
||
| 199 | 52 | ||
| 200 | 44 | ||
| 201 | /** @inheritdoc */ |
||
| 202 | public static function baseUrlSegment(string $locale = null): string |
||
| 203 | { |
||
| 204 | 8 | if (!isset(static::$baseUrlSegment)) { |
|
| 205 | return '/'; |
||
| 206 | 8 | } |
|
| 207 | 8 | ||
| 208 | if (!is_array(static::$baseUrlSegment)) { |
||
| 209 | return static::$baseUrlSegment; |
||
| 210 | } |
||
| 211 | |||
| 212 | // When an array, we try to locate the expected segment by locale |
||
| 213 | $key = $locale ?? app()->getlocale(); |
||
| 214 | 7 | ||
| 215 | if (isset(static::$baseUrlSegment[$key])) { |
||
| 216 | 7 | return static::$baseUrlSegment[$key]; |
|
| 217 | } |
||
| 218 | |||
| 219 | // Fall back to first entry in case no match is found |
||
| 220 | return reset(static::$baseUrlSegment); |
||
| 221 | } |
||
| 222 | |||
| 223 | public function menuLabel(): string |
||
| 226 | } |
||
| 227 | 65 | ||
| 228 | /** |
||
| 229 | * We override the publishable trait defaults because Page needs |
||
| 230 | 64 | * to be concerned with the archived state as well. |
|
| 231 | * |
||
| 232 | 64 | * TODO: IMPROVEMENT SHOULD BE TO MANAGE THE PAGE STATES IN ONE LOCATION. eg state machine |
|
| 233 | */ |
||
| 234 | public function isPublished() |
||
| 237 | 8 | } |
|
| 238 | 8 | ||
| 239 | public function isDraft() |
||
| 242 | } |
||
| 243 | 4 | ||
| 244 | public function publish() |
||
| 250 | } |
||
| 251 | |||
| 252 | public function draft() |
||
| 258 | } |
||
| 259 | |||
| 260 | public function statusAsLabel() |
||
| 261 | { |
||
| 262 | if ($this->isPublished()) { |
||
| 263 | return '<a href="'.$this->url().'" target="_blank"><em>online</em></a>'; |
||
| 264 | } |
||
| 265 | |||
| 266 | if ($this->isDraft()) { |
||
| 267 | return '<a href="'.$this->previewUrl().'" target="_blank" class="text-error"><em>offline</em></a>'; |
||
| 268 | 56 | } |
|
| 269 | |||
| 270 | 56 | if ($this->isArchived()) { |
|
| 271 | return '<span><em>gearchiveerd</em></span>'; |
||
| 272 | } |
||
| 273 | |||
| 274 | 56 | return '-'; |
|
| 275 | 54 | } |
|
| 276 | |||
| 277 | public function statusAsPlainLabel() |
||
| 292 | } |
||
| 293 | } |
||
| 294 |
Loading history...
