phpbb-extensions /
ad-management
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:
Complex classes like admin_controller 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 admin_controller, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class admin_controller |
||
| 17 | { |
||
| 18 | const MAX_NAME_LENGTH = 255; |
||
| 19 | const DATE_FORMAT = 'Y-m-d'; |
||
| 20 | |||
| 21 | /** @var \phpbb\template\template */ |
||
| 22 | protected $template; |
||
| 23 | |||
| 24 | /** @var \phpbb\user */ |
||
| 25 | protected $user; |
||
| 26 | |||
| 27 | /** @var \phpbb\request\request */ |
||
| 28 | protected $request; |
||
| 29 | |||
| 30 | /** @var \phpbb\admanagement\ad\manager */ |
||
| 31 | protected $manager; |
||
| 32 | |||
| 33 | /** @var \phpbb\admanagement\location\manager */ |
||
| 34 | protected $location_manager; |
||
| 35 | |||
| 36 | /** @var \phpbb\log\log */ |
||
| 37 | protected $log; |
||
| 38 | |||
| 39 | /** @var string php_ext */ |
||
| 40 | protected $php_ext; |
||
| 41 | |||
| 42 | /** @var string ext_path */ |
||
| 43 | protected $ext_path; |
||
| 44 | |||
| 45 | /** @var string Custom form action */ |
||
| 46 | protected $u_action; |
||
| 47 | |||
| 48 | /** @var array Form validation errors */ |
||
| 49 | protected $errors = array(); |
||
| 50 | |||
| 51 | /** |
||
| 52 | * Constructor |
||
| 53 | * |
||
| 54 | * @param \phpbb\template\template $template Template object |
||
| 55 | * @param \phpbb\user $user User object |
||
| 56 | * @param \phpbb\request\request $request Request object |
||
| 57 | * @param \phpbb\admanagement\ad\manager $manager Advertisement manager object |
||
| 58 | * @param \phpbb\admanagement\location\manager $location_manager Template location manager object |
||
| 59 | * @param \phpbb\log\log $log The phpBB log system |
||
| 60 | * @param string $php_ext PHP extension |
||
| 61 | * @param string $ext_path Path to this extension |
||
| 62 | */ |
||
| 63 | 29 | public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, \phpbb\admanagement\ad\manager $manager, \phpbb\admanagement\location\manager $location_manager, \phpbb\log\log $log, $php_ext, $ext_path) |
|
| 74 | |||
| 75 | /** |
||
| 76 | * Process user request |
||
| 77 | * |
||
| 78 | * @return void |
||
| 79 | */ |
||
| 80 | 6 | public function main() |
|
| 94 | |||
| 95 | /** |
||
| 96 | * Set page url |
||
| 97 | * |
||
| 98 | * @param string $u_action Custom form action |
||
| 99 | * @return void |
||
| 100 | */ |
||
| 101 | 23 | public function set_page_url($u_action) |
|
| 105 | |||
| 106 | /** |
||
| 107 | * Get ACP page title for Ads module |
||
| 108 | * |
||
| 109 | * @return string Language string for Ads ACP module |
||
| 110 | */ |
||
| 111 | 1 | public function get_page_title() |
|
| 115 | |||
| 116 | /** |
||
| 117 | * Add an advertisement |
||
| 118 | * |
||
| 119 | * @return void |
||
| 120 | */ |
||
| 121 | 6 | public function action_add() |
|
| 162 | |||
| 163 | /** |
||
| 164 | * Edit an advertisement |
||
| 165 | * |
||
| 166 | * @return void |
||
| 167 | */ |
||
| 168 | 8 | public function action_edit() |
|
| 225 | |||
| 226 | /** |
||
| 227 | * Enable an advertisement |
||
| 228 | * |
||
| 229 | * @return void |
||
| 230 | */ |
||
| 231 | 3 | public function action_enable() |
|
| 235 | |||
| 236 | /** |
||
| 237 | * Disable an advertisement |
||
| 238 | * |
||
| 239 | * @return void |
||
| 240 | */ |
||
| 241 | 3 | public function action_disable() |
|
| 245 | |||
| 246 | /** |
||
| 247 | * Delete an advertisement |
||
| 248 | * |
||
| 249 | * @return void |
||
| 250 | */ |
||
| 251 | 3 | public function action_delete() |
|
| 291 | |||
| 292 | /** |
||
| 293 | * Display the ads |
||
| 294 | * |
||
| 295 | * @return void |
||
| 296 | */ |
||
| 297 | 1 | public function list_ads() |
|
| 298 | { |
||
| 299 | 1 | foreach ($this->manager->get_all_ads() as $row) |
|
| 300 | { |
||
| 301 | 1 | $ad_enabled = (int) $row['ad_enabled']; |
|
| 302 | |||
| 303 | 1 | $this->template->assign_block_vars('ads', array( |
|
| 304 | 1 | 'NAME' => $row['ad_name'], |
|
| 305 | 1 | 'S_ENABLED' => $ad_enabled, |
|
| 306 | 1 | 'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'], |
|
| 307 | 1 | 'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'], |
|
| 308 | 1 | 'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'], |
|
| 309 | 1 | )); |
|
| 310 | 1 | } |
|
| 311 | |||
| 312 | // Set output vars for display in the template |
||
| 313 | 1 | $this->template->assign_vars(array( |
|
| 314 | 1 | 'S_ADS' => true, |
|
| 315 | 1 | 'U_ACTION_ADD' => $this->u_action . '&action=add', |
|
| 316 | 1 | )); |
|
| 317 | 1 | } |
|
| 318 | |||
| 319 | /** |
||
| 320 | * Enable/disable an advertisement |
||
| 321 | * |
||
| 322 | * @param bool $enable Enable or disable the advertisement? |
||
| 323 | * @return void |
||
| 324 | */ |
||
| 325 | 4 | protected function ad_enable($enable) |
|
| 326 | { |
||
| 327 | 4 | $ad_id = $this->request->variable('id', 0); |
|
| 328 | |||
| 329 | 4 | $success = $this->manager->update_ad($ad_id, array( |
|
| 330 | 4 | 'ad_enabled' => (int) $enable, |
|
| 331 | 4 | )); |
|
| 332 | |||
| 333 | // If AJAX was used, show user a result message |
||
| 334 | 4 | if ($this->request->is_ajax()) |
|
| 335 | 4 | { |
|
| 336 | $json_response = new \phpbb\json_response; |
||
| 337 | $json_response->send(array( |
||
| 338 | 'text' => $this->user->lang($enable ? 'ENABLED' : 'DISABLED'), |
||
| 339 | 'title' => $this->user->lang('AD_ENABLE_TITLE', (int) $enable), |
||
| 340 | )); |
||
| 341 | } |
||
| 342 | |||
| 343 | // Otherwise, show traditional infobox |
||
| 344 | if ($success) |
||
| 345 | 4 | { |
|
| 346 | 2 | $this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS'); |
|
| 347 | } |
||
| 348 | else |
||
| 349 | { |
||
| 350 | 2 | $this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED'); |
|
| 351 | } |
||
| 352 | } |
||
| 353 | |||
| 354 | /** |
||
| 355 | * Get admin form data. |
||
| 356 | * |
||
| 357 | * @return array Form data |
||
| 358 | */ |
||
| 359 | 11 | protected function get_form_data() |
|
| 360 | { |
||
| 361 | return array( |
||
| 362 | 11 | 'ad_name' => $this->request->variable('ad_name', '', true), |
|
| 363 | 11 | 'ad_note' => $this->request->variable('ad_note', '', true), |
|
| 364 | 11 | 'ad_code' => $this->request->variable('ad_code', '', true), |
|
| 365 | 11 | 'ad_enabled' => $this->request->variable('ad_enabled', 0), |
|
| 366 | 11 | 'ad_locations' => $this->request->variable('ad_locations', array('')), |
|
| 367 | 11 | 'ad_end_date' => (int) $this->user->get_timestamp_from_format(self::DATE_FORMAT, $this->request->variable('ad_end_date', '')), |
|
| 368 | 11 | ); |
|
| 369 | } |
||
| 370 | |||
| 371 | /** |
||
| 372 | * Validate form data. |
||
| 373 | * |
||
| 374 | * @param array $data The form data. |
||
| 375 | * @param string $form_name The form name. |
||
| 376 | * @return void |
||
| 377 | */ |
||
| 378 | 11 | protected function validate($data, $form_name) |
|
| 379 | { |
||
| 380 | 11 | if (!check_form_key($form_name)) |
|
| 381 | 11 | { |
|
| 382 | 2 | $this->errors[] = $this->user->lang('FORM_INVALID'); |
|
| 383 | 2 | } |
|
| 384 | |||
| 385 | 11 | if ($data['ad_name'] === '') |
|
| 386 | 11 | { |
|
| 387 | 2 | $this->errors[] = $this->user->lang('AD_NAME_REQUIRED'); |
|
| 388 | 2 | } |
|
| 389 | 11 | if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name']) |
|
| 390 | 11 | { |
|
| 391 | 2 | $this->errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH); |
|
| 392 | 2 | } |
|
| 393 | 11 | if ($data['ad_end_date'] != 0 && $data['ad_end_date'] < time()) |
|
| 394 | 11 | { |
|
| 395 | $this->errors[] = $this->user->lang('AD_END_DATE_INVALID'); |
||
| 396 | } |
||
| 397 | 11 | } |
|
| 398 | |||
| 399 | /** |
||
| 400 | * Assign form data to the template. |
||
| 401 | * |
||
| 402 | * @param array $data The form data. |
||
| 403 | * @return void |
||
| 404 | */ |
||
| 405 | 9 | protected function assign_form_data($data) |
|
| 406 | { |
||
| 407 | 9 | $this->template->assign_vars(array( |
|
| 408 | 9 | 'S_ERROR' => (bool) count($this->errors), |
|
| 409 | 9 | 'ERROR_MSG' => count($this->errors) ? implode('<br />', $this->errors) : '', |
|
| 410 | |||
| 411 | 9 | 'AD_NAME' => $data['ad_name'], |
|
| 412 | 9 | 'AD_NOTE' => $data['ad_note'], |
|
| 413 | 9 | 'AD_CODE' => $data['ad_code'], |
|
| 414 | 9 | 'AD_ENABLED' => $data['ad_enabled'], |
|
| 415 | 9 | 'AD_END_DATE' => $data['ad_end_date'] ? $this->user->format_date($data['ad_end_date'], self::DATE_FORMAT) : '', |
|
| 416 | 9 | )); |
|
| 417 | 9 | } |
|
| 418 | |||
| 419 | /** |
||
| 420 | * Assign template locations data to the template. |
||
| 421 | * |
||
| 422 | * @param mixed $data The form data or nothing. |
||
| 423 | * @return void |
||
| 424 | */ |
||
| 425 | 10 | protected function assign_locations($data = false) |
|
| 426 | { |
||
| 427 | 10 | foreach ($this->location_manager->get_all_locations() as $location_id => $location_data) |
|
| 428 | { |
||
| 429 | 10 | $this->template->assign_block_vars('ad_locations', array( |
|
| 430 | 10 | 'LOCATION_ID' => $location_id, |
|
| 431 | 10 | 'LOCATION_DESC' => $location_data['desc'], |
|
| 432 | 10 | 'LOCATION_NAME' => $location_data['name'], |
|
| 433 | 10 | 'S_SELECTED' => $data ? in_array($location_id, $data['ad_locations']) : false, |
|
| 434 | 10 | )); |
|
| 435 | 10 | } |
|
| 436 | 10 | } |
|
| 437 | |||
| 438 | /** |
||
| 439 | * Prepare advertisement preview |
||
| 440 | * |
||
| 441 | * @param string $code Ad code to preview |
||
| 442 | * @return void |
||
| 443 | */ |
||
| 444 | 2 | protected function ad_preview($code) |
|
| 445 | { |
||
| 446 | 2 | $this->template->assign_var('PREVIEW', htmlspecialchars_decode($code)); |
|
| 447 | 2 | } |
|
| 448 | |||
| 449 | /** |
||
| 450 | * Print success message. |
||
| 451 | * |
||
| 452 | * It takes arguments in the form of a language key, followed by language substitution values. |
||
| 453 | */ |
||
| 454 | 5 | protected function success() |
|
| 458 | |||
| 459 | /** |
||
| 460 | * Print error message. |
||
| 461 | * |
||
| 462 | * It takes arguments in the form of a language key, followed by language substitution values. |
||
| 463 | */ |
||
| 464 | 5 | protected function error() |
|
| 465 | { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Log action |
||
| 471 | * |
||
| 472 | * @param string $action Performed action in uppercase |
||
| 473 | * @param string $ad_name Advertisement name |
||
| 474 | * @return void |
||
| 475 | */ |
||
| 476 | 3 | protected function log($action, $ad_name) |
|
| 480 | } |
||
| 481 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.