nazar-pc /
CleverStyle-Framework
Complex classes like Profile 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 Profile, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 27 | trait Profile { |
||
| 28 | /** |
||
| 29 | * Copy of columns list of users table for internal needs without Cache usage |
||
| 30 | * @var array |
||
| 31 | */ |
||
| 32 | protected $users_columns = []; |
||
| 33 | /** |
||
| 34 | * Local cache of users data |
||
| 35 | * @var array |
||
| 36 | */ |
||
| 37 | protected $data = []; |
||
| 38 | /** |
||
| 39 | * Whether to use memory cache (locally, inside object, may require a lot of memory if working with many users together) |
||
| 40 | * @var bool |
||
| 41 | */ |
||
| 42 | protected $memory_cache = true; |
||
| 43 | 10 | protected function initialize_data () { |
|
| 51 | /** |
||
| 52 | * Get data item of specified user |
||
| 53 | * |
||
| 54 | * @param string|string[] $item |
||
| 55 | * @param false|int $user If not specified - current user assumed |
||
| 56 | * |
||
| 57 | * @return false|int|mixed[]|string|Properties If <i>$item</i> is integer - cs\User\Properties object will be returned |
||
| 58 | */ |
||
| 59 | 8 | function get ($item, $user = false) { |
|
| 65 | /** |
||
| 66 | * Get data item of specified user |
||
| 67 | * |
||
| 68 | * @param string|string[] $item |
||
| 69 | * @param false|int $user If not specified - current user assumed |
||
| 70 | * |
||
| 71 | * @return false|int|string|mixed[] |
||
| 72 | */ |
||
| 73 | 8 | protected function get_internal ($item, $user = false) { |
|
| 74 | 8 | $user = (int)$user ?: $this->id; |
|
| 75 | 8 | if (isset($this->data[$user])) { |
|
| 76 | 6 | $data = $this->data[$user]; |
|
| 77 | } else { |
||
| 78 | 8 | $data = $this->cache->get( |
|
| 79 | $user, |
||
| 80 | function () use ($user) { |
||
| 81 | 8 | return $this->db()->qf( |
|
| 82 | "SELECT * |
||
| 83 | FROM `[prefix]users` |
||
| 84 | 8 | WHERE `id` = $user |
|
| 85 | 8 | LIMIT 1" |
|
| 86 | 8 | ) ?: false; |
|
| 87 | 8 | } |
|
| 88 | ); |
||
| 89 | 8 | if (!$data) { |
|
| 90 | 4 | return false; |
|
| 91 | 8 | } elseif ($this->memory_cache || $user = User::GUEST_ID) { |
|
| 92 | 8 | $this->data[$user] = $data; |
|
| 93 | } |
||
| 94 | } |
||
| 95 | /** |
||
| 96 | * If get an array of values |
||
| 97 | */ |
||
| 98 | 8 | if (is_array($item)) { |
|
| 99 | 6 | $result = []; |
|
| 100 | /** |
||
| 101 | * Trying to get value from the local cache, or make up an array of missing values |
||
| 102 | */ |
||
| 103 | 6 | foreach ($item as $i) { |
|
| 104 | 6 | if (in_array($i, $this->users_columns)) { |
|
| 105 | 6 | $result[$i] = $data[$i]; |
|
| 106 | } |
||
| 107 | } |
||
| 108 | 6 | return $result; |
|
| 109 | } |
||
| 110 | 8 | return in_array($item, $this->users_columns) ? $data[$item] : false; |
|
| 111 | } |
||
| 112 | /** |
||
| 113 | * Set data item of specified user |
||
| 114 | * |
||
| 115 | * @param array|string $item Item-value array may be specified for setting several items at once |
||
| 116 | * @param int|null|string $value |
||
| 117 | * @param false|int $user If not specified - current user assumed |
||
| 118 | * |
||
| 119 | * @return bool |
||
| 120 | */ |
||
| 121 | 4 | function set ($item, $value = null, $user = false) { |
|
| 122 | 4 | $user = (int)$user ?: $this->id; |
|
| 123 | 4 | $data_set = []; |
|
| 124 | 4 | if (!$this->set_internal($item, $value, $user, $data_set)) { |
|
| 125 | return false; |
||
| 126 | } |
||
| 127 | 4 | if (!$data_set) { |
|
| 128 | return true; |
||
| 129 | } |
||
| 130 | 4 | $update = []; |
|
| 131 | 4 | foreach (array_keys($data_set) as $column) { |
|
| 132 | 4 | $update[] = "`$column` = '%s'"; |
|
| 133 | } |
||
| 134 | 4 | $update = implode(', ', $update); |
|
| 135 | 4 | $result = $this->db_prime()->q( |
|
| 136 | "UPDATE `[prefix]users` |
||
| 137 | 4 | SET $update |
|
| 138 | 4 | WHERE `id` = '$user'", |
|
| 139 | 4 | xap($data_set, false) |
|
| 140 | ); |
||
| 141 | 4 | if ($result) { |
|
| 142 | 4 | unset($this->data[$user], $this->cache->$user); |
|
| 143 | } |
||
| 144 | 4 | return (bool)$result; |
|
| 145 | } |
||
| 146 | /** |
||
| 147 | * Set data item of specified user |
||
| 148 | * |
||
| 149 | * @param array|string $item Item-value array may be specified for setting several items at once |
||
| 150 | * @param int|null|string $value |
||
| 151 | * @param int $user If not specified - current user assumed |
||
| 152 | * @param array $data_set |
||
| 153 | * |
||
| 154 | * @return bool |
||
| 155 | */ |
||
| 156 | 4 | protected function set_internal ($item, $value, $user, &$data_set) { |
|
| 157 | 4 | if (is_array($item)) { |
|
| 158 | $result = true; |
||
| 159 | foreach ($item as $i => $v) { |
||
| 160 | $result = $result && $this->set_internal($i, $v, $user, $data_set); |
||
| 161 | } |
||
| 162 | return $result; |
||
| 163 | } |
||
| 164 | 4 | if (!$this->set_internal_allowed($user, $item, $value)) { |
|
| 165 | return false; |
||
| 166 | } |
||
| 167 | 4 | $old_value = $this->get($item, $user); |
|
| 168 | 4 | if ($value == $old_value) { |
|
| 169 | return true; |
||
| 170 | } |
||
| 171 | 4 | if ($item == 'language') { |
|
| 172 | $value = $value ? Language::instance()->get('clanguage', $value) : ''; |
||
| 173 | 4 | } elseif ($item == 'timezone') { |
|
| 174 | $value = in_array($value, get_timezones_list(), true) ? $value : ''; |
||
| 175 | 4 | } elseif ($item == 'avatar') { |
|
| 176 | if ( |
||
| 177 | strpos($value, 'http://') !== 0 && |
||
| 178 | strpos($value, 'https://') !== 0 |
||
| 179 | ) { |
||
| 180 | $value = ''; |
||
| 181 | } else { |
||
| 182 | $Event = Event::instance(); |
||
| 183 | $Event->fire( |
||
| 184 | 'System/upload_files/del_tag', |
||
| 185 | [ |
||
| 186 | 'url' => $old_value, |
||
| 187 | 'tag' => "users/$user/avatar" |
||
| 188 | ] |
||
| 189 | ); |
||
| 190 | $Event->fire( |
||
| 191 | 'System/upload_files/add_tag', |
||
| 192 | [ |
||
| 193 | 'url' => $value, |
||
| 194 | 'tag' => "users/$user/avatar" |
||
| 195 | ] |
||
| 196 | ); |
||
| 197 | } |
||
| 198 | } |
||
| 199 | /** |
||
| 200 | * @var string $item |
||
| 201 | */ |
||
| 202 | 4 | $data_set[$item] = $value; |
|
| 203 | 4 | if (in_array($item, ['login', 'email'], true)) { |
|
| 204 | $old_value = $this->get($item.'_hash', $user); |
||
| 205 | $data_set[$item.'_hash'] = hash('sha224', $value); |
||
| 206 | unset($this->cache->$old_value); |
||
| 207 | 4 | } elseif ($item == 'password_hash' || ($item == 'status' && $value == 0)) { |
|
| 208 | 4 | Session::instance()->del_all($user); |
|
| 209 | } |
||
| 210 | 4 | return true; |
|
| 211 | } |
||
| 212 | /** |
||
| 213 | * Check whether setting specified item to specified value for specified user is allowed |
||
| 214 | * |
||
| 215 | * @param int $user |
||
| 216 | * @param string $item |
||
| 217 | * @param string $value |
||
| 218 | * |
||
| 219 | * @return bool |
||
| 220 | */ |
||
| 221 | 4 | protected function set_internal_allowed ($user, $item, $value) { |
|
| 222 | if ( |
||
| 223 | 4 | $user == User::GUEST_ID || |
|
| 224 | 4 | $item == 'id' || |
|
| 225 | 4 | !in_array($item, $this->users_columns, true) |
|
| 226 | ) { |
||
| 227 | return false; |
||
| 228 | } |
||
| 229 | 4 | if (in_array($item, ['login', 'email'], true)) { |
|
| 230 | $value = mb_strtolower($value); |
||
| 231 | if ( |
||
| 232 | $item == 'email' && |
||
| 233 | !filter_var($value, FILTER_VALIDATE_EMAIL) |
||
| 234 | ) { |
||
| 235 | return false; |
||
| 236 | } |
||
| 237 | if ($value == $this->get($item, $user)) { |
||
| 238 | return true; |
||
| 239 | } |
||
| 240 | return !$this->get_id(hash('sha224', $value)); |
||
| 241 | } |
||
| 242 | 4 | return true; |
|
| 243 | } |
||
| 244 | /** |
||
| 245 | * Get user id by login or email hash (sha224) (hash from lowercase string) |
||
| 246 | * |
||
| 247 | * @param string $login_hash Login or email hash |
||
| 248 | * |
||
| 249 | * @return false|int User id if found and not guest, otherwise - boolean <i>false</i> |
||
| 250 | */ |
||
| 251 | 6 | function get_id ($login_hash) { |
|
| 272 | /** |
||
| 273 | * Get user avatar, if no one present - uses Gravatar |
||
| 274 | * |
||
| 275 | * @param int|null $size Avatar size, if not specified or resizing is not possible - original image is used |
||
| 276 | * @param false|int $user If not specified - current user assumed |
||
| 277 | * |
||
| 278 | * @return string |
||
| 279 | */ |
||
| 280 | 2 | function avatar ($size = null, $user = false) { |
|
| 294 | /** |
||
| 295 | * Get user name or login or email, depending on existing information |
||
| 296 | * |
||
| 297 | * @param false|int $user If not specified - current user assumed |
||
| 298 | * |
||
| 299 | * @return string |
||
| 300 | */ |
||
| 301 | 2 | function username ($user = false) { |
|
| 315 | /** |
||
| 316 | * Disable memory cache |
||
| 317 | * |
||
| 318 | * Memory cache stores users data inside User class in order to get data faster next time. |
||
| 319 | * But in case of working with large amount of users this cache can be too large. Disabling will cause some performance drop, but save a lot of RAM. |
||
| 320 | */ |
||
| 321 | 4 | function disable_memory_cache () { |
|
| 322 | 4 | $this->memory_cache = false; |
|
| 323 | 4 | $this->data = []; |
|
| 324 | 4 | } |
|
| 325 | /** |
||
| 326 | * Returns array of users columns, available for getting of data |
||
| 327 | * |
||
| 328 | * @return array |
||
| 329 | */ |
||
| 330 | function get_users_columns () { |
||
| 333 | } |
||
| 334 |
