MySociety\TheyWorkForYou\GlossaryView\AddTermView

Complexity

Total Complexity

23

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	has_stop_words()	0	5	2
A	check_term_is_useful()	0	12	5
A	add_glossary_entry()	0	26	5
B	display()	0	37	6
A	check_glossary_entry()	0	18	2
A	get_appearance_count()	0	5	1
A	add_example_urls()	0	24	2

<?php

# For adding glossary terms

namespace MySociety\TheyWorkForYou\GlossaryView;

class AddTermView extends BaseView {
    public $glossary;

    public function display(): array {
        global $THEUSER;
        if (!$this->has_edit_access()) {
            return ['error' => _("You don't have permission to manage the glossary")];
        }

        $data = [
            'template_name' => 'addterm_start',
        ];
        $term = filter_user_input(get_http_var('g'), 'strict');
        // glossary matches should always be quoted.
        // Just to be sure, we'll strip away any quotes and add them again.
        if (preg_match("/^(\"|\')/", $term)) {
            $term = preg_replace("/\"|\'/", "", $term);
        }
        $data['title'] = $term;

        $this->glossary = new \GLOSSARY(['s' => $term]);
        $data['glossary'] = $this->glossary;

        if (get_http_var('submitterm') != '') {
            $data = $this->add_glossary_entry($data);
        } elseif (get_http_var('previewterm') != '') {
            $data['contributing_user'] = $THEUSER->firstname . " " . $THEUSER->lastname;
            $data['definition_raw'] = get_http_var('definition');
            $data['definition'] = $this->format_body($data['definition_raw']);
            $data['template_name'] = 'addterm_preview';
        } elseif (get_http_var('g') != '') {
            $data = $this->check_glossary_entry($data);
        } else {
            $data = $this->add_example_urls($data);
        }

        $URL = new \MySociety\TheyWorkForYou\Url('glossary_addterm');
        $data['form_url'] = $URL->generate();

        return $data;
    }

    protected function has_stop_words(): bool {
        if (in_array($this->glossary->query, $this->glossary->stopwords)) {
            return true;
        }
        return false;
    }

    protected function check_term_is_useful(array $data): array {
        if ($this->has_stop_words()) {
            $data['error'] = 'Sorry, that phrase appears too many times to be a useful as a link within the parliamentary record.';
        } elseif (isset($data['appearances']) && !$data['appearances']) {
            $data['error'] = "Unfortunately <strong>" . $data['title'] . "</strong>, doesn't seem to appear in hansard at all...</p>";
        } elseif ($this->glossary->num_search_matches > 0) {
            $data['template_name'] = 'addterm_matches';
            $data['error'] = 'Existing matches';
            $data['count'] = $this->glossary->num_search_matches;
        }

        return $data;
    }

    protected function get_appearance_count(string $term): int {
        global $SEARCHENGINE;
        $SEARCHENGINE = new \SEARCHENGINE($term);
        $count = $SEARCHENGINE->run_count(0, 10000);
        return $count;

The expression return $count could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    protected function check_glossary_entry(array $data): array {
        $data['template_name'] = 'addterm_appearances';
        $data['appearances'] = $this->get_appearance_count($data['title']);
        $data['definition_raw'] = '';
        $data = $this->check_term_is_useful($data);

        if (!isset($data['error'])) {
            $data['definition_raw'] = '';
            $list = new \HANSARDLIST();
            $examples = $list->display('search', [
                'num' => 5,
                's' => $data['title'],
                'view_override' => 'glossary_search',
            ], 'none');
            $data['examples'] = $examples['rows'];
        }

        return $data;
    }

    protected function add_glossary_entry(array $data): array {
        $data['submitted'] = 1;
        $data['template_name'] = 'addterm_examples';
        $data['body'] = get_http_var('definition');
        $data = $this->check_term_is_useful($data);

        $success = false;
        if (!isset($data['error'])) {
            $entry = [
                'title' => $data['title'],
                'body'  => $data['body'],
            ];
            $success = $this->glossary->create($entry);
        }

        if (is_int($success)) {
            $data['template_name'] = 'addterm_success';
        } elseif (is_array($success)) {
            $data = array_merge($data, $success);
        } else {
            if (!isset($data['error'])) {
                $data['error'] = "Sorry, there was an error and we were unable to add your Glossary item.";
            }
        }

        return $data;
    }

    protected function add_example_urls(array $data): array {
        $URL = new \MySociety\TheyWorkForYou\Url('glossary');

        $examples = [
            'technical' => [
                'name' => 'Early Day Motion', 'id' => 90,
            ],
            'organisation' => [
                'name' => 'Devon County Council', 'id' => 12,
            ],
            'document' => [
                'name' => 'Hutton Report', 'id' => 7,
            ],
        ];

        $example_urls = [];
        foreach ($examples as $name => $example) {
            $URL->insert(["gl" => $example['id']]);
            $example['url'] = $URL->generate();
            $example_urls[$name] = $example;
        }

        $data['example_urls'] = $example_urls;
        return $data;
    }

}