vistart /
yii2-models
Complex classes like EntityTrait 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 EntityTrait, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | trait EntityTrait |
||
| 26 | { |
||
| 27 | use GUIDTrait, |
||
| 28 | IDTrait, |
||
| 29 | IPTrait, |
||
| 30 | TimestampTrait; |
||
| 31 | |||
| 32 | private $entityLocalRules = []; |
||
| 33 | private $entityLocalBehaviors = []; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var string cache key and tag prefix. the prefix is usually set to full |
||
| 37 | * qualified class name. |
||
| 38 | */ |
||
| 39 | public $cachePrefix = ''; |
||
| 40 | public static $eventNewRecordCreated = 'newRecordCreated'; |
||
| 41 | public static $cacheKeyEntityRules = 'entity_rules'; |
||
| 42 | public static $cacheTagEntityRules = 'tag_entity_rules'; |
||
| 43 | public static $cacheKeyEntityBehaviors = 'entity_behaviors'; |
||
| 44 | public static $cacheTagEntityBehaviors = 'tag_entity_behaviors'; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @var string cache component id. |
||
| 48 | */ |
||
| 49 | public $cacheId = 'cache'; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * @var boolean Determines to skip initialization. |
||
| 53 | */ |
||
| 54 | public $skipInit = false; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @var string the name of query class or sub-class. |
||
| 58 | */ |
||
| 59 | public $queryClass; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * @return \static New self without any initializations. |
||
| 63 | */ |
||
| 64 | 51 | public static function buildNoInitModel() |
|
| 68 | |||
| 69 | /** |
||
| 70 | * Populate and return the entity rules. |
||
| 71 | * You should call this function in your extended class and merge the result |
||
| 72 | * with your rules, instead of overriding it, unless you know the |
||
| 73 | * consequences. |
||
| 74 | * @return type |
||
| 75 | */ |
||
| 76 | 49 | public function rules() |
|
| 77 | { |
||
| 78 | 49 | return $this->getEntityRules(); |
|
| 79 | } |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Populate and return the entity behaviors. |
||
| 83 | * You should call this function in your extended class and merge the result |
||
| 84 | * with your behaviors, instead of overriding it, unless you know the |
||
| 85 | * consequences. |
||
| 86 | * @return type |
||
| 87 | */ |
||
| 88 | 51 | public function behaviors() |
|
| 89 | { |
||
| 90 | 51 | return $this->getEntityBehaviors(); |
|
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Get cache component. If cache component is not configured, Yii::$app->cache |
||
| 95 | * will be given. |
||
| 96 | * @return \yii\caching\Cache cache component. |
||
| 97 | */ |
||
| 98 | 51 | protected function getCache() |
|
| 99 | { |
||
| 100 | 51 | $cacheId = $this->cacheId; |
|
| 101 | 51 | return empty($cacheId) ? Yii::$app->cache : Yii::$app->$cacheId; |
|
| 102 | } |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Get entity rules cache key. |
||
| 106 | * @return string cache key. |
||
| 107 | */ |
||
| 108 | 49 | public function getEntityRulesCacheKey() |
|
| 112 | |||
| 113 | /** |
||
| 114 | * Get entity rules cache tag. |
||
| 115 | * @return string cache tag. |
||
| 116 | */ |
||
| 117 | 15 | public function getEntityRulesCacheTag() |
|
| 121 | |||
| 122 | /** |
||
| 123 | * Get entity rules. |
||
| 124 | * @return array rules. |
||
| 125 | */ |
||
| 126 | 49 | public function getEntityRules() |
|
| 127 | { |
||
| 128 | 49 | $cache = $this->getCache(); |
|
| 129 | 49 | if ($cache) { |
|
| 130 | 49 | $this->entityLocalRules = $cache->get($this->getEntityRulesCacheKey()); |
|
| 131 | 49 | } |
|
| 132 | 49 | if (empty($this->entityLocalRules) || !is_array($this->entityLocalRules)) { |
|
| 133 | 15 | $rules = array_merge($this->getGuidRules(), $this->getIdRules(), $this->getCreatedAtRules(), $this->getUpdatedAtRules(), $this->getIpRules()); |
|
| 134 | 15 | $this->setEntityRules($rules); |
|
| 135 | 15 | } |
|
| 136 | 49 | return $this->entityLocalRules; |
|
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Set entity rules. |
||
| 141 | * @param array $rules |
||
| 142 | */ |
||
| 143 | 15 | protected function setEntityRules($rules = []) |
|
| 144 | { |
||
| 145 | 15 | $this->entityLocalRules = $rules; |
|
| 146 | 15 | $cache = $this->getCache(); |
|
| 147 | 15 | if ($cache) { |
|
| 148 | 15 | $tagDependency = new \yii\caching\TagDependency( |
|
| 149 | 15 | ['tags' => [$this->getEntityRulesCacheTag()]] |
|
| 150 | 15 | ); |
|
| 151 | 15 | $cache->set($this->getEntityRulesCacheKey(), $rules, 0, $tagDependency); |
|
| 152 | 15 | } |
|
| 153 | 15 | } |
|
| 154 | |||
| 155 | /** |
||
| 156 | * Get entity behaviors cache key. |
||
| 157 | * @return string cache key. |
||
| 158 | */ |
||
| 159 | 51 | public function getEntityBehaviorsCacheKey() |
|
| 163 | |||
| 164 | /** |
||
| 165 | * Get entity behaviors cache tag. |
||
| 166 | * @return string cache tag. |
||
| 167 | */ |
||
| 168 | 15 | public function getEntityBehaviorsCacheTag() |
|
| 172 | |||
| 173 | /** |
||
| 174 | * Get the entity behaviors. |
||
| 175 | * @return array |
||
| 176 | */ |
||
| 177 | 51 | public function getEntityBehaviors() |
|
| 178 | { |
||
| 179 | 51 | $cache = $this->getCache(); |
|
| 180 | 51 | if ($cache) { |
|
| 181 | 51 | $this->entityLocalBehaviors = $cache->get($this->getEntityBehaviorsCacheKey()); |
|
| 182 | 51 | } |
|
| 183 | 51 | if (empty($this->entityLocalBehaviors) || !is_array($this->entityLocalBehaviors)) { |
|
| 184 | 15 | $this->setEntityBehaviors($this->getTimestampBehaviors()); |
|
| 185 | 15 | } |
|
| 186 | 51 | return $this->entityLocalBehaviors; |
|
| 187 | } |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Set the entity behaviors. |
||
| 191 | * @param array $behaviors |
||
| 192 | */ |
||
| 193 | 15 | protected function setEntityBehaviors($behaviors) |
|
| 194 | { |
||
| 195 | 15 | $this->entityLocalBehaviors = $behaviors; |
|
| 196 | 15 | $cache = $this->getCache(); |
|
| 197 | 15 | if ($cache) { |
|
| 198 | 15 | $tagDependencyConfig = ['tags' => [$this->getEntityBehaviorsCacheTag()]]; |
|
| 199 | 15 | $tagDependency = new \yii\caching\TagDependency($tagDependencyConfig); |
|
| 200 | 15 | $cache->set($this->getEntityBehaviorsCacheKey(), $behaviors, 0, $tagDependency); |
|
| 201 | 15 | } |
|
| 202 | 15 | } |
|
| 203 | |||
| 204 | /** |
||
| 205 | * Reset cache key. |
||
| 206 | * @param string $cacheKey |
||
| 207 | * @param mixed $value |
||
| 208 | * @return boolean whether the value is successfully stored into cache. if |
||
| 209 | * cache component was not configured, then return false directly. |
||
| 210 | */ |
||
| 211 | 1 | public function resetCacheKey($cacheKey, $value = false) |
|
| 212 | 1 | { |
|
| 213 | $cache = $this->getCache(); |
||
| 214 | if ($cache) { |
||
| 215 | return $this->getCache()->set($cacheKey, $value); |
||
| 216 | } |
||
| 217 | return false; |
||
| 218 | } |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Attach events associated with entity model. |
||
| 222 | */ |
||
| 223 | 51 | protected function initEntityEvents() |
|
| 224 | { |
||
| 225 | 51 | $this->on(static::EVENT_INIT, [$this, 'onInitCache']); |
|
| 226 | 51 | $this->attachInitGuidEvent(static::$eventNewRecordCreated); |
|
| 227 | 51 | $this->attachInitIdEvent(static::$eventNewRecordCreated); |
|
| 228 | 51 | $this->attachInitIpEvent(static::$eventNewRecordCreated); |
|
| 229 | 51 | if ($this->isNewRecord) { |
|
| 230 | 51 | $this->trigger(static::$eventNewRecordCreated); |
|
| 231 | 51 | } |
|
| 232 | 51 | $this->on(static::EVENT_AFTER_FIND, [$this, 'onRemoveExpired']); |
|
| 233 | 51 | } |
|
| 234 | |||
| 235 | /** |
||
| 236 | * Initialize the cache prefix. |
||
| 237 | * @param \yii\base\Event $event |
||
| 238 | */ |
||
| 239 | 51 | public function onInitCache($event) |
|
| 240 | { |
||
| 241 | 51 | $sender = $event->sender; |
|
| 242 | 51 | $data = $event->data; |
|
| 243 | 51 | if (isset($data['prefix'])) { |
|
| 244 | $sender->cachePrefix = $data['prefix']; |
||
| 245 | } else { |
||
| 246 | 51 | $sender->cachePrefix = $sender::className(); |
|
| 247 | } |
||
| 248 | 51 | } |
|
| 249 | |||
| 250 | /** |
||
| 251 | * Record warnings. |
||
| 252 | */ |
||
| 253 | protected function recordWarnings() |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Get guid or id. if neither disabled, return null. |
||
| 262 | * @return string |
||
| 263 | */ |
||
| 264 | 8 | public function __toString() |
|
| 274 | |||
| 275 | /** |
||
| 276 | * @inheritdoc |
||
| 277 | * ------------- |
||
| 278 | * if enable `$idAttribute` and $row[$idAttribute] set, the `idPreassigned` |
||
| 279 | * will be assigned to true. |
||
| 280 | */ |
||
| 281 | 39 | public static function instantiate($row) |
|
| 291 | |||
| 292 | /** |
||
| 293 | * unset entity attributes. |
||
| 294 | * @return array result. |
||
| 295 | */ |
||
| 296 | public function unsetSelfFields() |
||
| 300 | |||
| 301 | /** |
||
| 302 | * unset fields of array. |
||
| 303 | * @param array $array |
||
| 304 | * @param array $fields |
||
| 305 | * @return array |
||
| 306 | */ |
||
| 307 | public static function unsetFields($array, $fields = null) |
||
| 319 | |||
| 320 | /** |
||
| 321 | * Get enabled fields. |
||
| 322 | * @return string[] |
||
| 323 | */ |
||
| 324 | 13 | public function enabledFields() |
|
| 333 | } |
||
| 334 |
Loading history...
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.