mysociety /
theyworkforyou
| Total Complexity | 203 |
| Total Lines | 840 |
| Duplicated Lines | 0 % |
| Changes | 8 | ||
| Bugs | 0 | Features | 1 |
Complex classes like Standard 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 Standard, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class Standard extends \MySociety\TheyWorkForYou\AlertView { |
||
| 12 | public $data; |
||
| 13 | |||
| 14 | public function __construct($THEUSER = null) { |
||
| 17 | } |
||
| 18 | |||
| 19 | /** |
||
| 20 | * This file handles all actions on user alerts. |
||
| 21 | * |
||
| 22 | * It splits alerts into two types and they get different screens: |
||
| 23 | * * keyword alerts - a person wants an alert when a word or phrase is said |
||
| 24 | * * representative alerts - a person wants an alert when a representative speaks or votes |
||
| 25 | * |
||
| 26 | * There are several form variables that control what is displayed or what action is taken: |
||
| 27 | * * action - this is used for things happening to alerts - creation/editing, deletion, suspension etc |
||
| 28 | * * step - this determines which step of creating a keyword alert to display |
||
| 29 | * * this_step - stores which step is currently being processed, also used for prev step button |
||
| 30 | * * mp_step - show the representative alert screen |
||
| 31 | * * results - stores the results of an action, used to display appropriate message |
||
| 32 | * |
||
| 33 | * The steps in the keyword alert creation/editing process are: |
||
| 34 | * * define - Initial options where you can add a keyword, any exclusions plus select which chambers it applies to |
||
| 35 | * * add_vector_related - an optional related terms step which suggests extra terms if we find any in the database |
||
| 36 | * * review - a confirmation step |
||
| 37 | * |
||
| 38 | * If the user is happy then they will click Confirm which will submit the form with action set to Confirm and the alert |
||
| 39 | * will be created or updated. |
||
| 40 | * |
||
| 41 | * If mp_step is one of the parameters set then the form to add a representative alert is displayed. This only has a creation |
||
| 42 | * and a confirm step. As part of this the mp_search param will be submitted which will trigger checking detecting |
||
| 43 | * which MP the user is trying to add. This will try the following steps: |
||
| 44 | * * try to match the search text against a name |
||
| 45 | * * check if the text contains a postcode and if so use that to look up the constituencies |
||
| 46 | * * if there's not a postcode then try to match against a constituency name |
||
| 47 | * |
||
| 48 | * If there is more than one match then these are stored in the constituencies varaible and a choice is |
||
| 49 | * presented to the user. |
||
| 50 | * |
||
| 51 | * The representive alert creation flow will also be entered if an alertsearch or pid parameter is submitted. This |
||
| 52 | * is used for handling "create an alert when $rep speaks" links from elsewhere in the site (e.g. an MP page) |
||
| 53 | * |
||
| 54 | * Other actions such as suspend use a form with only an action value and the alert token if required. |
||
| 55 | */ |
||
| 56 | public function display() { |
||
| 57 | global $this_page; |
||
| 58 | $this_page = "alert"; |
||
| 59 | |||
| 60 | $this->processAction(); |
||
| 61 | $this->getBasicData(); |
||
| 62 | $this->checkInput(); |
||
| 63 | $this->searchForConstituenciesAndMembers(); |
||
| 64 | |||
| 65 | if ($this->data['step'] || $this->data['addword']) { |
||
| 66 | $this->processStep(); |
||
| 67 | } elseif (!$this->data['results'] == 'changes-abandoned' && !sizeof($this->data['errors']) && $this->data['submitted'] && ($this->data['keyword'] || $this->data['pid'])) { |
||
| 68 | $this->addAlert(); |
||
| 69 | } |
||
| 70 | |||
| 71 | $this->formatSearchTerms(); |
||
| 72 | $this->checkForCommonMistakes(); |
||
| 73 | $this->formatSearchMemberData(); |
||
| 74 | |||
| 75 | // Determine if we should fetch alert counts |
||
| 76 | // We skip counts when in form workflows (step, mp_step, disambiguation) |
||
| 77 | $in_active_workflow = $this->data['step'] // Alert creation wizard steps |
||
| 78 | || $this->data['mp_step'] // MP alert creation |
||
| 79 | || $this->data['alertsearch']; // Search disambiguation (but not if showing results) |
||
| 80 | |||
| 81 | $this->data['showing_main_alert_list'] = !$in_active_workflow; |
||
| 82 | |||
| 83 | $this->setUserData(); |
||
| 84 | |||
| 85 | return $this->data; |
||
| 86 | } |
||
| 87 | |||
| 88 | # This only happens if we have an alert and want to do something to it. |
||
| 89 | private function processAction() { |
||
| 148 | } |
||
| 149 | |||
| 150 | # Process a screen in the alert creation wizard |
||
| 151 | private function processStep() { |
||
| 192 | } |
||
| 193 | } |
||
| 194 | } |
||
| 195 | |||
| 196 | |||
| 197 | /* |
||
| 198 | * set up the data we will be using in processing later steps |
||
| 199 | */ |
||
| 200 | private function getBasicData() { |
||
| 201 | global $this_page; |
||
| 202 | |||
| 203 | if ($this->user->loggedin()) { |
||
| 204 | $this->data['email'] = $this->user->email(); |
||
| 205 | $this->data['email_verified'] = true; |
||
| 206 | } elseif ($this->data['alert']) { |
||
| 207 | $this->data['email'] = $this->data['alert']['email']; |
||
| 208 | $this->data['email_verified'] = true; |
||
| 209 | } else { |
||
| 210 | $this->data["email"] = trim(get_http_var("email")); |
||
| 211 | $this->data['email_verified'] = false; |
||
| 212 | } |
||
| 213 | |||
| 214 | $this->data['token'] = get_http_var('t'); |
||
| 215 | $this->data['step'] = trim(get_http_var("step")); |
||
| 216 | $this->data['mp_step'] = trim(get_http_var("mp_step")); |
||
| 217 | $this->data['addword'] = trim(get_http_var("addword")); |
||
| 218 | $this->data['this_step'] = trim(get_http_var("this_step")); |
||
| 219 | $this->data['shown_related'] = get_http_var('shown_related'); |
||
| 220 | $this->data['match_all'] = get_http_var('match_all') == 'on'; |
||
| 221 | $this->data['keyword'] = trim(get_http_var("keyword")); |
||
| 222 | $this->data['search_section'] = ''; |
||
| 223 | $this->data['alertsearch'] = trim(get_http_var("alertsearch")); |
||
| 224 | $this->data['mp_search'] = trim(get_http_var("mp_search")); |
||
| 225 | $this->data['pid'] = trim(get_http_var("pid")); |
||
| 226 | $this->data['pc'] = get_http_var('pc'); |
||
| 227 | $this->data['submitted'] = get_http_var('submitted') || $this->data['pid'] || $this->data['keyword'] || $this->data['step']; |
||
| 228 | $this->data['ignore_speaker_votes'] = get_http_var('ignore_speaker_votes'); |
||
| 229 | |||
| 230 | if ($this->data['addword'] || $this->data['step']) { |
||
| 231 | $alert = $this->alert->check_token($this->data['token']); |
||
| 232 | |||
| 233 | $criteria = ''; |
||
| 234 | $alert_ignore_speaker_votes = 0; |
||
| 235 | if ($alert) { |
||
| 236 | $criteria = $alert['criteria']; |
||
| 237 | $alert_ignore_speaker_votes = $alert['ignore_speaker_votes']; |
||
| 238 | } |
||
| 239 | |||
| 240 | $ignore_speaker_votes = get_http_var('ignore_speaker_votes', $alert_ignore_speaker_votes); |
||
| 241 | $this->data['ignore_speaker_votes'] = ($ignore_speaker_votes == 'on' || $ignore_speaker_votes == 1); |
||
| 242 | |||
| 243 | $this->data['alert'] = $alert; |
||
| 244 | |||
| 245 | $this->data['alert_parts'] = \MySociety\TheyWorkForYou\Utility\Alert::prettifyCriteria($criteria, $alert_ignore_speaker_votes, true); |
||
| 246 | |||
| 247 | $existing_rep = ''; |
||
| 248 | if (isset($this->data['alert_parts']['spokenby'])) { |
||
| 249 | $existing_rep = $this->data['alert_parts']['spokenby'][0]; |
||
| 250 | } |
||
| 251 | |||
| 252 | $existing_section = ''; |
||
| 253 | if (count($this->data['alert_parts']['sections'])) { |
||
| 254 | $existing_section = $this->data['alert_parts']['sections'][0]; |
||
| 255 | } |
||
| 256 | |||
| 257 | # only want to load this the first time, otherwise we want to default to the form |
||
| 258 | # value |
||
| 259 | if (!$this->data['this_step'] && $this->data['alert_parts']['match_all']) { |
||
| 260 | $this->data['match_all'] = false; |
||
| 261 | } |
||
| 262 | |||
| 263 | $words = get_http_var('words', $this->data['alert_parts']['words'], true); |
||
| 264 | |||
| 265 | $this->data['words'] = []; |
||
| 266 | $this->data['keywords'] = []; |
||
| 267 | foreach ($words as $word) { |
||
| 268 | if (trim($word) != '') { |
||
| 269 | $this->data['keywords'][] = $word; |
||
| 270 | $this->data['words'][] = $this->wrap_phrase_in_quotes($word); |
||
| 271 | } |
||
| 272 | } |
||
| 273 | |||
| 274 | $add_all_related = get_http_var('add_all_related'); |
||
| 275 | $this->data['add_all_related'] = $add_all_related; |
||
| 276 | $this->data['skip_keyword_terms'] = []; |
||
| 277 | |||
| 278 | $selected_related_terms = get_http_var('selected_related_terms', [], true); |
||
| 279 | $this->data['selected_related_terms'] = $selected_related_terms; |
||
| 280 | |||
| 281 | if ($this->data['step'] !== 'define') { |
||
| 282 | if ($add_all_related) { |
||
| 283 | $this->data['selected_related_terms'] = []; |
||
| 284 | $related_terms = get_http_var('related_terms', [], true); |
||
| 285 | foreach ($related_terms as $term) { |
||
| 286 | $this->data['skip_keyword_terms'][] = $term; |
||
| 287 | $this->data['keywords'][] = $term; |
||
| 288 | $this->data['words'][] = $this->wrap_phrase_in_quotes($term); |
||
| 289 | } |
||
| 290 | } else { |
||
| 291 | $this->data['skip_keyword_terms'] = $selected_related_terms; |
||
| 292 | foreach ($selected_related_terms as $term) { |
||
| 293 | $this->data['keywords'][] = $term; |
||
| 294 | $this->data['words'][] = $this->wrap_phrase_in_quotes($term); |
||
| 295 | } |
||
| 296 | } |
||
| 297 | } |
||
| 298 | $this->data['exclusions'] = trim(get_http_var("exclusions", implode(' ', $this->data['alert_parts']['exclusions']))); |
||
| 299 | $this->data['representative'] = trim(get_http_var("representative", $existing_rep)); |
||
| 300 | |||
| 301 | $this->data['search_section'] = trim(get_http_var("search_section", $existing_section)); |
||
| 302 | |||
| 303 | $separator = ' OR '; |
||
| 304 | if ($this->data['match_all']) { |
||
| 305 | $separator = ' '; |
||
| 306 | } |
||
| 307 | $this->data['keyword'] = implode($separator, $this->data['words']); |
||
| 308 | if ($this->data['exclusions']) { |
||
| 309 | $this->data['keyword'] = '(' . $this->data['keyword'] . ') -' . implode(' -', explode(' ', $this->data["exclusions"])); |
||
| 310 | } |
||
| 311 | |||
| 312 | $this->data['results'] = ''; |
||
| 313 | |||
| 314 | $this->getSearchSections(); |
||
| 315 | } elseif ($this->data['mp_step'] == 'mp_alert') { |
||
| 316 | $alert = $this->alert->check_token($this->data['token']); |
||
| 317 | if ($alert) { |
||
| 318 | $ignore_speaker_votes = get_http_var('ignore_speaker_votes', $alert['ignore_speaker_votes']); |
||
| 319 | $this->data['ignore_speaker_votes'] = ($ignore_speaker_votes == 'on' || $ignore_speaker_votes == 1); |
||
| 320 | |||
| 321 | $existing_rep = ''; |
||
| 322 | if (isset($alert['criteria'])) { |
||
| 323 | $alert_parts = \MySociety\TheyWorkForYou\Utility\Alert::prettifyCriteria($alert['criteria'], $alert['ignore_speaker_votes'], true); |
||
| 324 | $existing_rep = $alert_parts['spokenby'][0]; |
||
| 325 | $this->data['pid'] = $alert_parts['pid']; |
||
| 326 | } |
||
| 327 | $this->data['keyword'] = get_http_var('mp_search', $existing_rep); |
||
| 328 | } else { |
||
| 329 | $this->data['ignore_speaker_votes'] = get_http_var('ignore_speaker_votes'); |
||
| 330 | } |
||
| 331 | } |
||
| 332 | |||
| 333 | $this->data['sign'] = get_http_var('sign'); |
||
| 334 | $this->data['site'] = get_http_var('site'); |
||
| 335 | $this->data['message'] = ''; |
||
| 336 | |||
| 337 | $ACTIONURL = new \MySociety\TheyWorkForYou\Url($this_page); |
||
| 338 | $ACTIONURL->reset(); |
||
| 339 | $this->data['actionurl'] = $ACTIONURL->generate(); |
||
| 340 | |||
| 341 | } |
||
| 342 | |||
| 343 | private function wrap_phrase_in_quotes($phrase) { |
||
| 344 | if (strpos($phrase, ' ') > 0) { |
||
| 345 | $phrase = '"' . trim($phrase, '"') . '"'; |
||
| 346 | } |
||
| 347 | |||
| 348 | return $phrase; |
||
| 349 | } |
||
| 350 | |||
| 351 | /* |
||
| 352 | * Check if the current alert has returned any results recently |
||
| 353 | */ |
||
| 354 | private function getRecentResults($text) { |
||
| 390 | ]; |
||
| 391 | } |
||
| 392 | |||
| 393 | private function getSearchSections() { |
||
| 394 | $this->data['sections'] = []; |
||
| 395 | if ($this->data['search_section']) { |
||
| 396 | foreach (explode(' ', $this->data['search_section']) as $section) { |
||
| 397 | $this->data['sections'][] = \MySociety\TheyWorkForYou\Utility\Alert::sectionToTitle($section); |
||
| 398 | } |
||
| 399 | } |
||
| 400 | } |
||
| 401 | |||
| 402 | private function updateAlert($token) { |
||
| 405 | } |
||
| 406 | |||
| 407 | private function checkInput() { |
||
| 408 | global $SEARCHENGINE; |
||
| 409 | |||
| 410 | $errors = []; |
||
| 411 | |||
| 412 | # these are the initial screens and so cannot have any errors as we've not submitted |
||
| 413 | if (!$this->data['submitted'] || $this->data['step'] == 'define' || $this->data['mp_step'] == 'mp_alert') { |
||
| 414 | $this->data['errors'] = $errors; |
||
| 415 | return; |
||
| 416 | } |
||
| 417 | |||
| 418 | // Check each of the things the user has input. |
||
| 419 | // If there is a problem with any of them, set an entry in the $errors array. |
||
| 420 | // This will then be used to (a) indicate there were errors and (b) display |
||
| 421 | // error messages when we show the form again. |
||
| 422 | |||
| 423 | // Check email address is valid and unique. |
||
| 424 | if (!$this->data['email']) { |
||
| 425 | $errors["email"] = gettext("Please enter your email address"); |
||
| 426 | } elseif (!validate_email($this->data["email"])) { |
||
| 427 | // validate_email() is in includes/utilities.php |
||
| 428 | $errors["email"] = gettext("Please enter a valid email address"); |
||
| 429 | } |
||
| 430 | |||
| 431 | if ($this->data['pid'] && !ctype_digit($this->data['pid'])) { |
||
| 432 | $errors['pid'] = 'Invalid person ID passed'; |
||
| 433 | } |
||
| 434 | |||
| 435 | $text = $this->data['alertsearch']; |
||
| 436 | if ($this->data['mp_search']) { |
||
| 437 | $text = $this->data['mp_search']; |
||
| 438 | } |
||
| 439 | if (!$text) { |
||
| 440 | $text = $this->data['keyword']; |
||
| 441 | } |
||
| 442 | |||
| 443 | if ($this->data['submitted'] && !$this->data['pid'] && !$text) { |
||
| 444 | $errors['alertsearch'] = gettext('Please enter what you want to be alerted about'); |
||
| 445 | } |
||
| 446 | |||
| 447 | if (strpos($text, '..')) { |
||
| 448 | $errors['alertsearch'] = gettext('You probably don’t want a date range as part of your criteria, as you won’t be alerted to anything new!'); |
||
| 449 | } |
||
| 450 | |||
| 451 | $se = new \SEARCHENGINE($text); |
||
| 452 | if (!$se->valid) { |
||
| 453 | $errors['alertsearch'] = sprintf(gettext('That search appears to be invalid - %s - please check and try again.'), $se->error); |
||
| 454 | } |
||
| 455 | |||
| 456 | if (strlen($text) > 255) { |
||
| 457 | $errors['alertsearch'] = gettext('That search is too long for our database; please split it up into multiple smaller alerts.'); |
||
| 458 | } |
||
| 459 | |||
| 460 | $this->data['errors'] = $errors; |
||
| 461 | } |
||
| 462 | |||
| 463 | |||
| 464 | private function searchForConstituenciesAndMembers() { |
||
| 591 | } |
||
| 592 | } |
||
| 593 | |||
| 594 | private function addAlert() { |
||
| 651 | } |
||
| 652 | |||
| 653 | |||
| 654 | private function formatSearchTerms() { |
||
| 655 | if ($this->data['alertsearch']) { |
||
| 656 | $this->data['alertsearch_pretty'] = \MySociety\TheyWorkForYou\Utility\Alert::prettifyCriteria($this->data['alertsearch']); |
||
| 657 | $this->data['search_text'] = $this->data['alertsearch']; |
||
| 658 | } elseif ($this->data['mp_search']) { |
||
| 659 | $this->data['search_text'] = $this->data['mp_search']; |
||
| 660 | } else { |
||
| 661 | $this->data['search_text'] = $this->data['keyword']; |
||
| 662 | } |
||
| 663 | } |
||
| 664 | |||
| 665 | private function checkForCommonMistakes() { |
||
| 666 | $mistakes = []; |
||
| 667 | if (strstr($this->data['alertsearch'], ',') > -1) { |
||
| 668 | $mistakes['multiple'] = 1; |
||
| 669 | } |
||
| 670 | |||
| 671 | if ( |
||
| 672 | preg_match('#([A-Z]{1,2}\d+[A-Z]? ?\d[A-Z]{2})#i', $this->data['alertsearch'], $m) && |
||
| 673 | strlen($this->data['alertsearch']) > strlen($m[1]) && |
||
| 674 | validate_postcode($m[1]) |
||
| 675 | ) { |
||
| 676 | $this->data['postcode'] = $m[1]; |
||
| 677 | $mistakes['postcode_and'] = 1; |
||
| 678 | } |
||
| 679 | |||
| 680 | $this->data['mistakes'] = $mistakes; |
||
| 681 | } |
||
| 682 | |||
| 683 | private function formatSearchMemberData() { |
||
| 684 | if (isset($this->data['postcode'])) { |
||
| 685 | try { |
||
| 686 | $postcode = $this->data['postcode']; |
||
| 687 | |||
| 688 | $MEMBER = new \MySociety\TheyWorkForYou\Member(['postcode' => $postcode]); |
||
| 689 | // move the postcode to the front just to be tidy |
||
| 690 | $tidy_alertsearch = $postcode . " " . trim(str_replace("$postcode", "", $this->data['alertsearch'])); |
||
| 691 | $alertsearch_display = str_replace("$postcode ", "", $tidy_alertsearch); |
||
| 692 | |||
| 693 | $this->data['member_alertsearch'] = str_replace("$postcode", "speaker:" . $MEMBER->person_id, $tidy_alertsearch); |
||
| 694 | $this->data['member_displaysearch'] = $alertsearch_display; |
||
| 695 | $this->data['member'] = $MEMBER; |
||
| 696 | |||
| 697 | if (isset($this->data['mistakes']['postcode_and'])) { |
||
| 698 | $constituencies = \MySociety\TheyWorkForYou\Utility\Postcode::postcodeToConstituencies($postcode); |
||
| 699 | if (isset($constituencies['SPC'])) { |
||
| 700 | $MEMBER = new \MySociety\TheyWorkForYou\Member(['constituency' => $constituencies['SPC'], 'house' => HOUSE_TYPE_SCOTLAND]); |
||
| 701 | $this->data['scottish_alertsearch'] = str_replace("$postcode", "speaker:" . $MEMBER->person_id, $tidy_alertsearch); |
||
| 702 | $this->data['scottish_member'] = $MEMBER; |
||
| 703 | } elseif (isset($constituencies['WAC'])) { |
||
| 704 | $MEMBER = new \MySociety\TheyWorkForYou\Member(['constituency' => $constituencies['WAC'], 'house' => HOUSE_TYPE_WALES]); |
||
| 705 | $this->data['welsh_alertsearch'] = str_replace("$postcode", "speaker:" . $MEMBER->person_id, $tidy_alertsearch); |
||
| 706 | $this->data['welsh_member'] = $MEMBER; |
||
| 707 | } |
||
| 708 | } |
||
| 709 | } catch (\MySociety\TheyWorkForYou\MemberException $e) { |
||
| 710 | $this->data['member_error'] = 1; |
||
| 711 | } |
||
| 712 | } |
||
| 713 | |||
| 714 | if ($this->data['pid']) { |
||
| 715 | $MEMBER = new \MySociety\TheyWorkForYou\Member(['person_id' => $this->data['pid']]); |
||
| 716 | $this->data['pid_member'] = $MEMBER; |
||
| 717 | } |
||
| 718 | |||
| 719 | if ($this->data['keyword']) { |
||
| 720 | $this->data['display_keyword'] = \MySociety\TheyWorkForYou\Utility\Alert::prettifyCriteria($this->data['keyword']); |
||
| 721 | } |
||
| 722 | } |
||
| 723 | |||
| 724 | /* |
||
| 725 | * This makes sure that the $this->data makes sense once all the other steps have been completed |
||
| 726 | */ |
||
| 727 | private function setUserData() { |
||
| 851 | } |
||
| 852 | } |
||
| 853 | } |
||
| 854 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.