SectionView::display_year() - Code Metrics - Inspection of "Ignore dot in URL, so e.g. index.php not matched." - mysociety/theyworkforyou - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Branch — master (3ce7e2)

by Nick
created 2018-06-21 14:13 UTC
SectionView::display_year() A

↳ Parent: SectionView
Complexity

Conditions	2
Paths	2
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	7
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	10
rs	9.4285
<?php
# For displaying any debate calendar, day, debate, speech page or related.

namespace MySociety\TheyWorkForYou\SectionView;

class SectionView {
    protected $major;
    protected $class;
    protected $list;
    private $major_data;
    private $page_base;
    protected $index_template = '';

    public function __construct() {
        global $hansardmajors;
function myFunction($a, $b) {
    // Do something
}
        $this->major_data = $hansardmajors[$this->major];
        $this->page_base = str_replace('year', '', $this->major_data['page_year']);
        if (!$this->list) {
            $this->class = "\\" . $this->class;
            $this->list = new $this->class();
        }
    }

    public function display() {
        if ($year = get_http_var('y')) {
            $data = $this->display_year($year);
            $data['year'] = $year;
            $data['template'] = 'section/year';
            $data = $this->addCommonData($data);
        } elseif (($date = get_http_var('d')) && ($column = get_http_var('c'))) {
            $data = $this->display_column($date, $column);
            $data = $this->addCommonData($data);
        } elseif ($date = get_http_var('d')) {
            $data = $this->display_day($date);
            if ( !isset($data['template']) ) {
                $data['template'] = 'section/day';
            }
            $data = $this->addCommonData($data);
        } elseif (get_http_var('id')) {
            $data = $this->display_section_or_speech();
        } else {
            $data = $this->display_front();
            if ( !isset($data['template']) ) {
                $data['template'] = 'section/recent';
            }
            $data['search_sections'] = $this->getSearchSections();
            $data = $this->addCommonData($data);
        }

        return $data;
    }

    protected function addCommonData($data) {
        global $DATA, $this_page;
function myFunction($a, $b) {
    // Do something
}

        $common = new \MySociety\TheyWorkForYou\Common;
        $data['urls'] = $this->getURLs($data);
        $data['popular_searches'] = $common->getPopularSearches();
        $data['recess_major'] = $this->getRecessMajor($data);

        $nextprev = $DATA->page_metadata($this_page, 'nextprev');
        if ( isset($nextprev['next']['url']) ) {
            $data['next'] = $nextprev['next'];
        }
        if ( isset($nextprev['prev']['url']) ) {
            $data['prev'] = $nextprev['prev'];
        }

        $parent_page = $DATA->page_metadata($this_page, 'parent');
        $data['title'] = $DATA->page_metadata($this_page, 'title');
        if (!isset($data['title']) && $parent_page != '') {
            $data['title'] = $DATA->page_metadata($parent_page, 'title');
        }
        if ( $parent_page ) {
            $data['parent_title'] = $DATA->page_metadata($parent_page, 'title');
        }

        $data['section'] = $this->pageToSection();

        return $data;
    }

    protected function getURLs($data) {
        global $DATA, $this_page;
function myFunction($a, $b) {
    // Do something
}

        $urls = array();

        $urls = array_merge($urls, $this->getViewUrls());

        if ( isset($data['info']['page']) ) {
            $day = new \MySociety\TheyWorkForYou\Url($data['info']['page']);
            $urls['day'] = $day;
        }

        return $urls;
    }

    protected function getViewUrls() {
        $urls = array();
        $day = new \MySociety\TheyWorkForYou\Url('debates');
        $urls['debatesday'] = $day;
        $urls['day'] = $day;
        $day = new \MySociety\TheyWorkForYou\Url('whall');
        $urls['whallday'] = $day;
        $day = new \MySociety\TheyWorkForYou\Url('lordsdebates');
        $urls['lordsday'] = $day;
        return $urls;
    }

    protected function getSearchSections() {
        return array();
    }

    protected function getRecessMajor($data) {
    protected function getRecessMajor(/** @scrutinizer ignore-unused */ $data) {
        global $hansardmajors;
function myFunction($a, $b) {
    // Do something
}

        $recess_major = 1; # For all of UK Parliament
        if ($hansardmajors[$this->major]['location'] == 'NI') {
            $recess_major = 5;
        } elseif ($hansardmajors[$this->major]['location'] == 'Scotland') {
            $recess_major = 4; # For all of Scotland
        } elseif ($this->major == 101) {
            $recess_major = 101; # Lords slightly different
        }

        return $recess_major;
    }

    protected function display_year($year) {
        global $this_page, $PAGE, $DATA;
function myFunction($a, $b) {
    // Do something
}
        $this_page = $this->page_base . 'year';
        if (is_numeric($year)) {
            $DATA->set_page_metadata($this_page, 'title', $year);
        }

        $args = array ( 'year' => $year );
        $data = $this->list->display('calendar', $args, 'none');
        return $data;
    }

    protected function display_column($date, $column) {
        global $this_page;
function myFunction($a, $b) {
    // Do something
}
        $this_page = $this->page_base;
        $args = array( 'date' => $date, 'column' => $column );
        $content = $this->list->display('column', $args, 'none');

        $data = array();
        $data['column'] = $column;
        $URL = new \MySociety\TheyWorkForYou\Url($this->list->listpage);
        $URL->insert(array('d' => $date));
        $data['debate_day_link'] = $URL->generate();
        $data['debate_day_human'] = format_date($date, LONGDATEFORMAT);

        $data['rows'] = $content;
        $data['info'] = array('major' => $this->major, 'date' => $date);

        list($country, $location, $assembly) = $this->getCountryDetails();
        $data['col_country'] = $country;
        $data['location'] = $location;
        $data['current_assembly'] = $assembly;

        $data['template'] = 'section/column';
        return $data;
    }

    protected function display_day($date) {
        global $this_page;
function myFunction($a, $b) {
    // Do something
}
        $this_page = $this->page_base . 'day';
        $args = array ( 'date' => get_http_var('d') );
        $data = $this->list->display('date', $args, 'none');
        list($year, $month, $day) = explode('-', $date);
        $args = array( 'year' => $year, 'month' => $month, 'day' => $day);
        $calendar = $this->list->display('calendar', $args, 'none');
        if ( isset($calendar['years']) ) {
            $data['calendar'] = $calendar['years'];
        }
        return $data;
    }

    protected function display_section_or_speech($args = array()) {
        global $DATA, $this_page, $THEUSER;
function myFunction($a, $b) {
    // Do something
}

        # += as we *don't* want to override any already supplied argument
        $args += array (
            'gid' => get_http_var('id'),
            's' => get_http_var('s'), // Search terms to be highlighted.
            'member_id' => get_http_var('m'), // Member's speeches to be highlighted.
        );

        if (preg_match('/speaker:(\d+)/', get_http_var('s'), $mmm)) {
            $args['person_id'] = $mmm[1];
        }

        try {
            $data = $this->list->display('gid', $args, 'none');
        } catch (\RedirectException $e) {
            $URL = new \MySociety\TheyWorkForYou\Url($this->major_data['page_all']);
            if ($this->major == 6) {
                # Magically (as in I can't remember quite why), pbc_clause will
                # contain the new URL without any change...
                $URL->remove( array('id') );
            } else {
                $URL->insert( array('id'=>$e->getMessage()) );
            }
            # put the search term back in so highlighting works.
            # NB: as we don't see the # part of the URL we lose this :(
            if ( $args['s'] !== '' ) {
                $URL->insert( array('s'=>$args['s']) );
            }
            redirect($URL->generate('none'));
        }

        $data['individual_item'] = ($this->list->commentspage == $this_page);

        if ($data['individual_item']) {
            $COMMENTLIST = new \COMMENTLIST;
            $args['user_id'] = get_http_var('u');
            $args['epobject_id'] = $this->list->epobject_id();
            $data['comments']['object'] = $COMMENTLIST;
            $data['comments']['args'] = $args;
            $data['comments']['commentdata'] = array(
                'epobject_id' => $this->list->epobject_id(),
                'gid' => get_http_var('id'), # wrans is LIST->gid?
                'return_page' => $this_page
            );
        }

        if (!isset($data['info'])) {
            header("HTTP/1.0 404 Not Found");
            $data['template'] = 'error';
            return $data;
        }

        # Okay, let's set up highlighting and glossarisation

        list($bodies, $speeches) = $this->highlightSpeeches($data);

        list($data, $first_speech, $subsection_title) = $this->annotateSpeeches($data, $bodies, $speeches);


        list($country, $location, $assembly) = $this->getCountryDetails();
        $data['location'] = $location;
        $data['current_assembly'] = $assembly;

        $data = $this->setTitleAndAlertText($data, $subsection_title);

        $data['debate_time_human'] = format_time($first_speech['htime'], 'g:i a');
        $data['debate_day_human'] = format_date($first_speech['hdate'], 'jS F Y');

        $URL = new \MySociety\TheyWorkForYou\Url($this->list->listpage);
        $URL->insert(array('d' => $first_speech['hdate']));
        $URL->remove(array('id'));
        $data['debate_day_link'] = $URL->generate();

        $data['nextprev'] = $DATA->page_metadata($this_page, 'nextprev');

        return $data;
    }

    private function setTitleAndAlertText($data, $subsection_title) {
        if ($subsection_title) {
            $data['heading'] = $subsection_title;
        } else {
            $data['heading'] = $data['section_title'];
        }

        if ($subsection_title) {
            $data['intro'] = "$data[section_title]";
        } else {
            $data['intro'] = "";
        }

        if (array_key_exists('text_heading', $data['info'])) {
            // avoid having Clause 1 etc as the alert text search string on PBC pages as it's
            // almost certainly not what the person wants
            if ( $this->major == 6 ) {
                $data['email_alert_text'] = $data['section_title'];
            } else {
                $data['email_alert_text'] = $data['info']['text_heading'];
            }
        } else {
            // The user has requested only part of a debate, so find a suitable title
            if ($subsection_title) {
                $data['intro'] = "Part of $data[section_title]";
            } else {
                $data['intro'] = "Part of the debate";
            }
            foreach ($data['rows'] as $row) {
                if ($row['htype'] == 10 || $row['htype'] == 11) {
                    $data['email_alert_text'] = $row['body'];
                    $data['full_debate_url'] = $row['listurl'];
                    break;
                }
            }
        }
        // strip a couple of common characters that result in encode junk in the
        // search string
        $data['email_alert_text'] = preg_replace('/(?:[:()\[\]]|&#\d+;)/', '', $data['email_alert_text']);

        return $data;
    }

    private function highlightSpeeches($data) {
        $SEARCHENGINE = null;
        if (isset($data['info']['searchstring']) && $data['info']['searchstring'] != '') {
            $SEARCHENGINE = new \SEARCHENGINE($data['info']['searchstring']);
        }

        // Before we print the body text we need to insert glossary links
        // and highlight search string words.

        $speeches = 0;
        $bodies = array();
        foreach ($data['rows'] as $row) {
            $htype = $row['htype'];
            if ($htype == 12 || $htype == 13) {
                $speeches++;
            }
            $body = $row['body'];
            $body = preg_replace('#<phrase class="honfriend" id="uk.org.publicwhip/member/(\d+)" name="([^"]*?)">(.*?\s*\((.*?)\))</phrase>#', '<a href="/mp/?m=$1" title="Our page on $2 - \'$3\'">$4</a>', $body);
            $body = preg_replace('#<phrase class="honfriend" name="([^"]*?)" person_id="uk.org.publicwhip/person/(\d+)">(.*?\s*\((.*?)\))</phrase>#', '<a href="/mp/?p=$2" title="Our page on $1 - \'$3\'">$4</a>', $body);
            $body = preg_replace_callback('#<phrase class="offrep" id="(.*?)/(\d+)-(\d+)-(\d+)\.(.*?)">(.*?)</phrase>#', function($matches) {
                return '<a href="/search/?pop=1&s=date:' . $matches[2] . $matches[3] . $matches[4] . '+column:' . $matches[5] . '+section:' . $matches[1] .'">' . str_replace("Official Report", "Hansard", $matches[6]) . '</a>';
            }, $body);
            #$body = preg_replace('#<phrase class="offrep" id="((.*?)/(\d+)-(\d+)-(\d+)\.(.*?))">(.*?)</phrase>#e', "\"<a href='/search/?pop=1&amp;s=date:$3$4$5+column:$6+section:$2&amp;match=$1'>\" . str_replace('Official Report', 'Hansard', '$7') . '</a>'", $body);

            $bodies[] = $body;
        }

        if ($SEARCHENGINE) {
            // We have some search terms to highlight.
            twfy_debug_timestamp('Before highlight');
            $bodies = $SEARCHENGINE->highlight($bodies);
            twfy_debug_timestamp('After highlight');
        }
        // Do all this unless the glossary is turned off in the URL
        if (get_http_var('ug') != 1) {
            // And glossary phrases
            twfy_debug_timestamp('Before glossarise');

            $args['sort'] = "regexp_replace";

            $GLOSSARY = new \GLOSSARY($args);
            $bodies = $GLOSSARY->glossarise($bodies, 1);

            twfy_debug_timestamp('After glossarise');
        }

        return array($bodies, $speeches);
    }

    private function annotateSpeeches($data, $bodies, $speeches) {
        global $THEUSER;
function myFunction($a, $b) {
    // Do something
}
        $first_speech = null;
        $data['section_title'] = '';
        $subsection_title = '';
        for ($i=0; $i<count($data['rows']); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $row = $data['rows'][$i];
            $htype = $row['htype'];
            // HPOS should be defined below if it's needed; otherwise default to 0
            $heading_hpos = 0;
            if ($htype == 10) {
                $data['section_title'] = $row['body'];
                $heading_hpos = $row['hpos'];
            } elseif ($htype == 11) {
                $subsection_title = $row['body'];
                $heading_hpos = $row['hpos'];
            } elseif ($htype == 12) {
                # Splitting out highlighting results back into individual bits
                $data['rows'][$i]['body'] = $bodies[$i];
            }
            if ($htype == 12 || $htype == 13) {
                if (!$first_speech) {
                    $first_speech = $data['rows'][$i];
                }

                # Voting links
                $data['rows'][$i]['voting_data'] = '';
                if (isset($row['votes'])) {
                    $data['rows'][$i]['voting_data'] = $this->generate_votes( $row['votes'], $row['epobject_id'], $row['gid'] );
                    $data['rows'][$i]['voting_data'] = $this->generate_votes( $row['votes'], $row['epobject_id'], $row['gid'] );
                }

                # Annotation link
                if ($this->is_debate_section_page()) {
                    $data['rows'][$i]['commentteaser'] = $this->generate_commentteaser($row);
                }

                if (isset($row['mentions'])) {
                    $data['rows'][$i]['mentions'] = $this->get_question_mentions_html($row['mentions']);
                }

                if ($this->major == 1) {
                    $data['rows'][$i]['video'] = $this->get_video_html($row, $heading_hpos, $speeches);
                    $data['rows'][$i]['video'] = $this->get_video_html($row, $heading_hpos, $speeches);
                }

                if (array_key_exists('name', $data['rows'][$i]['speaker'])) {
                    $data['rows'][$i]['socialteaser'] = sprintf(
                        '%s on %s, at TheyWorkForYou',
                        ucfirst($data['rows'][$i]['speaker']['name']),
                        $data['section_title']
                    );
                } else {
                    $data['rows'][$i]['socialteaser'] = sprintf(
                        '%s on TheyWorkForYou',
                        $data['section_title']
                    );
                }

                $data['rows'][$i]['socialurl'] = sprintf(
                    'https://www.theyworkforyou.com%s',
                    $row['commentsurl']
                );
            }
        }

        return array($data, $first_speech, $subsection_title);
    }

    private function getCountryDetails() {
        $details = array(
            1 => array (
                'country' => 'UK',
                'assembly' => 'uk-commons',
                'location' => '&ndash; in the House of Commons'
            ),
            2 => array (
                'country' => 'UK',
                'assembly' => 'uk-commons',
                'location' => '&ndash; in Westminster Hall'
            ),
            3 => array (
                'country' => 'UK',
                'assembly' => 'uk-commons',
                'location' => 'written question &ndash; answered'
            ),
            4 => array (
                'country' => 'UK',
                'assembly' => 'uk-commons',
                'location' => 'written statement &ndash; made'
            ),
            5 => array (
                'country' => 'NORTHERN IRELAND',
                'assembly' => 'ni',
                'location' => '&ndash; in the Northern Ireland Assembly'
            ),
            6 => array (
                'country' => 'UK',
                'assembly' => 'uk-commons',
                'location' => '&ndash; in a Public Bill Committee'
            ),
            7 => array (
                'country' => 'SCOTLAND',
                'assembly' => 'scotland',
                'location' => '&ndash; in the Scottish Parliament'
            ),
            8 => array (
                'country' => 'SCOTLAND',
                'assembly' => 'scotland',
                'location' => '&ndash; Scottish Parliament written question &ndash; answered'
            ),
            101 => array (
                'country' => 'UK',
                'assembly' => 'uk-lords',
                'location' => '&ndash; in the House of Lords'
            )
        );

        $detail = $details[$this->major];
        return array($detail['country'], $detail['location'], $detail['assembly']);
    }

    protected function display_front() {
        global $DATA, $this_page;
function myFunction($a, $b) {
    // Do something
}
        $this_page = $this->page_base . 'front';
        $data = array();
        if ( $this->index_template ) {
            $data['template'] = $this->index_template;
        }

        $class = new $this->class;
        $content = array();
        $content['data'] = $this->front_content();
        $content['data'] = $this->front_content();

        $content['calendar'] = $class->display('calendar', array('months' => 1), 'none');

        if ( $rssurl = $DATA->page_metadata($this_page, 'rss') ) {
            $content['rssurl'] = $rssurl;
        }

        $data['content'] = $content;
        return $this->addCommonData($data);

    }

    public function is_debate_section_page() {
        global $this_page;
function myFunction($a, $b) {
    // Do something
}
        return ($this->major_data['type'] == 'debate' && $this->major_data['page_all'] == $this_page);
    }

    //$totalcomments, $comment, $commenturl

    function generate_commentteaser ($row) {

        // Returns HTML for the one fragment of comment and link for the sidebar.
        // $totalcomments is the number of comments this item has on it.
        // $comment is an array like:
        /* $comment = array (

            'comment_id' => 23,
            'user_id'    => 34,
            'body'        => 'Blah blah...',
            'posted'    => '2004-02-24 23:45:30',
            'username'    => 'phil'
            )
        */
        // $url is the URL of the item's page, which contains comments.

        if ($row['totalcomments'] == 0) {
            return;
        }

        //Add existing annotations
        $comment = $row['comment'];

        // If the comment is longer than the speech body, we want to trim it
        // to be the same length so they fit next to each other.
        // But the comment typeface is smaller, so we scale things slightly too...
        $targetsize = round(strlen($row['body']) * 0.6);

        $linktext = '';
        if ($targetsize > strlen($comment['body'])) {
            // This comment will fit in its entirety.
            $commentbody = $comment['body'];

            if ($row['totalcomments'] > 1) {
                $morecount = $row['totalcomments'] - 1;
                $plural = $morecount == 1 ? 'annotation' : 'annotations';
                $linktext = "Read $morecount more $plural";
            }

        } else {
            // This comment needs trimming.
            $commentbody = trim_characters($comment['body'], 0, $targetsize, 1000);
            if ($row['totalcomments'] > 1) {
                $morecount = $row['totalcomments'] - 1;
                $plural = $morecount == 1 ? 'annotation' : 'annotations';
                $linktext = "Continue reading (and $morecount more $plural)";
            } else {
                $linktext = 'Continue reading';
            }
        }

        return array(
            'body' => prepare_comment_for_display($commentbody),
            'username' => _htmlentities($comment['username']),
            'linktext' => $linktext,
            'commentsurl' => $row['commentsurl'],
            'comment_id' => $comment['comment_id'],
        );
    }

    protected function get_question_mentions_html($row_data) {
    protected function get_question_mentions_html(/** @scrutinizer ignore-unused */ $row_data) {
        throw new \Exception('get_question_mentions_html called from class with no implementation');
    }

    private function pageToSection() {
        $sections = array(
            1 => 'debates',
            2 => 'whall',
            3 => 'wrans',
            4 => 'wms',
            5 => 'ni',
            6 => 'standing',
            7 => 'sp',
            8 => 'spwrans',
            101 => 'lords'
        );

        return $sections[$this->major];
    }

}

Branch — master (3ce7e2)

SectionView::display_year() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

mysociety / theyworkforyou

Branch — master (3ce7e2)

SectionView::display_year() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like
