mysociety / theyworkforyou

classes/People.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
         $this->db = new \ParlDB();
     }
 
+    /**
+     * @param User $user
+     */
     protected function getRegionalReps($user) {
         return $user->getRegionalReps($this->reg_cons_type, $this->house);
     }

Spacing +12 added lines, -12 removed lines

@@ -7,7 +7,7 @@ 
 
 namespace MySociety\TheyWorkForYou;
 
-include_once( dirname(__FILE__) . '/../www/includes/easyparliament/people.php' );
+include_once(dirname(__FILE__) . '/../www/includes/easyparliament/people.php');
 
 /**
  * People
@@ -38,7 +38,7 @@ 
         $data = $this->display($this->type, $args, 'none');
 
         $user = new User();
-        if ( $reps = $this->getRegionalReps($user) ) {
+        if ($reps = $this->getRegionalReps($user)) {
             $data['reps'] = $reps;
         }
 
@@ -70,7 +70,7 @@ 
             $args['all'] = true;
         }
 
-        if ( $this->type == 'peers' ) {
+        if ($this->type == 'peers') {
             $args['order'] = 'name';
         }
 
@@ -136,8 +136,8 @@ 
 
     private function addImagesToData($data) {
         $new_data = array();
-        foreach ( $data as $pid => $details ) {
-            list($image, ) = Utility\Member::findMemberImage($pid, true, $this->subs_missing_image);
+        foreach ($data as $pid => $details) {
+            list($image,) = Utility\Member::findMemberImage($pid, true, $this->subs_missing_image);
             $details['image'] = $image;
             $new_data[$pid] = $details;
         }
@@ -154,21 +154,21 @@ 
 
         $urls['plain'] = $URL->generate();
 
-        $URL->insert(array( 'o' => 'n'));
+        $URL->insert(array('o' => 'n'));
         $urls['by_name'] = $URL->generate();
 
-        $URL->insert(array( 'o' => 'l'));
+        $URL->insert(array('o' => 'l'));
         $urls['by_last'] = $URL->generate();
 
-        $URL->insert(array( 'o' => 'f'));
+        $URL->insert(array('o' => 'f'));
         $urls['by_first'] = $URL->generate();
 
-        $URL->insert(array( 'o' => 'p'));
+        $URL->insert(array('o' => 'p'));
         $urls['by_party'] = $URL->generate();
 
-        $URL->insert(array( 'f' => 'csv'));
-        $URL->remove(array( 'o'));
-        if ( $date = get_http_var('date') ) {
+        $URL->insert(array('f' => 'csv'));
+        $URL->remove(array('o'));
+        if ($date = get_http_var('date')) {
             $URL->insert(array('date' => $date));
         }
         $urls['by_csv'] = $URL->generate();

classes/Renderer/Header.php

Doc Comments +3 added lines

@@ -110,6 +110,9 @@
         }
     }
 
+    /**
+     * @param string $linktype
+     */
     private function generate_next_prev_link($nextprev, $linktype) {
         $link = null;
         if (isset($nextprev[$linktype]) && isset($nextprev[$linktype]['url'])) {

Indentation +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
     private function get_page_url() {
         $protocol = 'https://';
         if (DEVSITE) {
-          $protocol = 'http://';
+            $protocol = 'http://';
         }
         $url = $protocol . DOMAIN;
         if (array_key_exists('REQUEST_URI', $_SERVER)) {

Braces +12 added lines, -4 removed lines

@@ -81,7 +81,9 @@ 
 
             $parent_page = $DATA->page_metadata($this_page, 'parent');
             if ($parent_title = $DATA->page_metadata($parent_page, 'title')) {
-                if ($this->data['page_title']) $this->data['page_title'] .= ': ';
+                if ($this->data['page_title']) {
+                    $this->data['page_title'] .= ': ';
+                }
                 $this->data['page_title'] .= $parent_title;
             }
 
@@ -103,7 +105,9 @@ 
         // Meta keywords
         if (!$this->data['meta_keywords'] = $DATA->page_metadata($this_page, "meta_keywords")) {
             $this->data['meta_keywords'] = $this->keywords_title;
-            if ($this->data['meta_keywords']) $this->data['meta_keywords'] .= ', ';
+            if ($this->data['meta_keywords']) {
+                $this->data['meta_keywords'] .= ', ';
+            }
             $this->data['meta_keywords'] .= 'Hansard, Official Report, Parliament, government, House of Commons, House of Lords, MP, Peer, Member of Parliament, MPs, Peers, Lords, Commons, Scottish Parliament, Northern Ireland Assembly, MSP, MLA, MSPs, MLAs';
         }
 
@@ -204,7 +208,9 @@ 
             $p = $parent;
             while ($p) {
                 $p = $DATA->page_metadata($p, 'parent');
-                if ($p) $parents[] = $p;
+                if ($p) {
+                    $parents[] = $p;
+                }
             }
 
             $top_highlight = array_pop($parents);
@@ -279,7 +285,9 @@ 
             $menudata = $DATA->page_metadata($toppage, 'menu');
                 $text = $menudata['text'];
                 $title = $menudata['title'];
-            if (!$title) continue;
+            if (!$title) {
+                continue;
+            }
 
                 //get link and description for the menu ans add it to the array
             $class = $toppage == $this->nav_highlights['top'] ? 'on' : '';

Spacing +4 added lines, -4 removed lines

@@ -135,7 +135,7 @@ 
         if (isset($nextprev[$linktype]) && isset($nextprev[$linktype]['url'])) {
 
             if (isset($nextprev[$linktype]['body'])) {
-                $linktitle = _htmlentities( trim_characters($nextprev[$linktype]['body'], 0, 40) );
+                $linktitle = _htmlentities(trim_characters($nextprev[$linktype]['body'], 0, 40));
                 if (isset($nextprev[$linktype]['speaker']) &&
                     count($nextprev[$linktype]['speaker']) > 0) {
                     $linktitle = $nextprev[$linktype]['speaker']['name'] . ': ' . $linktitle;
@@ -162,10 +162,10 @@ 
 
         if ($nextprev) {
             // Four different kinds of back/forth links we might build.
-            $links = array ("first", "prev", "up", "next", "last");
+            $links = array("first", "prev", "up", "next", "last");
 
             foreach ($links as $type) {
-                if ( $link = $this->generate_next_prev_link( $nextprev, $type ) ) {
+                if ($link = $this->generate_next_prev_link($nextprev, $type)) {
 
                     $this->data['header_links'][] = $link;
                 }
@@ -258,7 +258,7 @@ 
         // Page names mapping to those in metadata.php.
         // Links in the top menu, and the sublinks we see if
         // we're within that section.
-        $nav_items = array (
+        $nav_items = array(
             array('home'),
             array('hansard', 'mps', 'peers', 'alldebatesfront', 'wranswmsfront', 'pbc_front', 'divisions_recent', 'calendar_summary', 'contact'),
             array('sp_home', 'spoverview', 'msps', 'spdebatesfront', 'spwransfront', 'contact'),

classes/SectionView/SectionView.php

Doc Comments +3 added lines

@@ -347,6 +347,9 @@
         return array($bodies, $speeches);
     }
 
+    /**
+     * @param integer $speeches
+     */
     private function annotateSpeeches($data, $bodies, $speeches) {
         global $THEUSER;
         $first_speech = null;

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -512,7 +512,7 @@
             if ($row['totalcomments'] > 1) {
                 $morecount = $row['totalcomments'] - 1;
                 $plural = $morecount == 1 ? 'annotation' : 'annotations';
-                $linktext = "Read $morecount more $plural";
+                $linktext = "read $morecount more $plural";
             }
 
         } else {

Spacing +32 added lines, -32 removed lines

@@ -32,7 +32,7 @@ 
             $data = $this->addCommonData($data);
         } elseif ($date = get_http_var('d')) {
             $data = $this->display_day($date);
-            if ( !isset($data['template']) ) {
+            if (!isset($data['template'])) {
                 $data['template'] = 'section/day';
             }
             $data = $this->addCommonData($data);
@@ -40,7 +40,7 @@ 
             $data = $this->display_section_or_speech();
         } else {
             $data = $this->display_front();
-            if ( !isset($data['template']) ) {
+            if (!isset($data['template'])) {
                 $data['template'] = 'section/recent';
             }
             $data['search_sections'] = $this->getSearchSections();
@@ -59,10 +59,10 @@ 
         $data['recess_major'] = $this->getRecessMajor($data);
 
         $nextprev = $DATA->page_metadata($this_page, 'nextprev');
-        if ( isset($nextprev['next']['url']) ) {
+        if (isset($nextprev['next']['url'])) {
             $data['next'] = $nextprev['next'];
         }
-        if ( isset($nextprev['prev']['url']) ) {
+        if (isset($nextprev['prev']['url'])) {
             $data['prev'] = $nextprev['prev'];
         }
 
@@ -71,7 +71,7 @@ 
         if (!isset($data['title']) && $parent_page != '') {
             $data['title'] = $DATA->page_metadata($parent_page, 'title');
         }
-        if ( $parent_page ) {
+        if ($parent_page) {
             $data['parent_title'] = $DATA->page_metadata($parent_page, 'title');
         }
 
@@ -87,7 +87,7 @@ 
 
         $urls = array_merge($urls, $this->getViewUrls());
 
-        if ( isset($data['info']['page']) ) {
+        if (isset($data['info']['page'])) {
             $day = new \MySociety\TheyWorkForYou\Url($data['info']['page']);
             $urls['day'] = $day;
         }
@@ -133,7 +133,7 @@ 
             $DATA->set_page_metadata($this_page, 'title', $year);
         }
 
-        $args = array ( 'year' => $year );
+        $args = array('year' => $year);
         $data = $this->list->display('calendar', $args, 'none');
         return $data;
     }
@@ -141,7 +141,7 @@ 
     protected function display_column($date, $column) {
         global $this_page;
         $this_page = $this->page_base;
-        $args = array( 'date' => $date, 'column' => $column );
+        $args = array('date' => $date, 'column' => $column);
         $content = $this->list->display('column', $args, 'none');
 
         $data = array();
@@ -166,12 +166,12 @@ 
     protected function display_day($date) {
         global $this_page;
         $this_page = $this->page_base . 'day';
-        $args = array ( 'date' => get_http_var('d') );
+        $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);
+        $args = array('year' => $year, 'month' => $month, 'day' => $day);
         $calendar = $this->list->display('calendar', $args, 'none');
-        if ( isset($calendar['years']) ) {
+        if (isset($calendar['years'])) {
             $data['calendar'] = $calendar['years'];
         }
         return $data;
@@ -181,7 +181,7 @@ 
         global $DATA, $this_page, $THEUSER;
 
         # += as we *don't* want to override any already supplied argument
-        $args += array (
+        $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.
@@ -198,14 +198,14 @@ 
             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') );
+                $URL->remove(array('id'));
             } else {
-                $URL->insert( array('id'=>$e->getMessage()) );
+                $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']) );
+            if ($args['s'] !== '') {
+                $URL->insert(array('s'=>$args['s']));
             }
             redirect($URL->generate('none'));
         }
@@ -273,7 +273,7 @@ 
         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 ) {
+            if ($this->major == 6) {
                 $data['email_alert_text'] = $data['section_title'];
             } else {
                 $data['email_alert_text'] = $data['info']['text_heading'];
@@ -320,7 +320,7 @@ 
             $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>';
+                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;
@@ -352,7 +352,7 @@ 
         $first_speech = null;
         $data['section_title'] = '';
         $subsection_title = '';
-        for ($i=0; $i<count($data['rows']); $i++) {
+        for ($i = 0; $i < count($data['rows']); $i++) {
             $row = $data['rows'][$i];
             $htype = $row['htype'];
             // HPOS should be defined below if it's needed; otherwise default to 0
@@ -375,7 +375,7 @@ 
                 # 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
@@ -416,47 +416,47 @@ 
 
     private function getCountryDetails() {
         $details = array(
-            1 => array (
+            1 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-commons',
                 'location' => '&ndash; in the House of Commons'
             ),
-            2 => array (
+            2 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-commons',
                 'location' => '&ndash; in Westminster Hall'
             ),
-            3 => array (
+            3 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-commons',
                 'location' => 'written question &ndash; answered'
             ),
-            4 => array (
+            4 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-commons',
                 'location' => 'written statement &ndash; made'
             ),
-            5 => array (
+            5 => array(
                 'country' => 'NORTHERN IRELAND',
                 'assembly' => 'ni',
                 'location' => '&ndash; in the Northern Ireland Assembly'
             ),
-            6 => array (
+            6 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-commons',
                 'location' => '&ndash; in a Public Bill Committee'
             ),
-            7 => array (
+            7 => array(
                 'country' => 'SCOTLAND',
                 'assembly' => 'scotland',
                 'location' => '&ndash; in the Scottish Parliament'
             ),
-            8 => array (
+            8 => array(
                 'country' => 'SCOTLAND',
                 'assembly' => 'scotland',
                 'location' => '&ndash; Scottish Parliament written question &ndash; answered'
             ),
-            101 => array (
+            101 => array(
                 'country' => 'UK',
                 'assembly' => 'uk-lords',
                 'location' => '&ndash; in the House of Lords'
@@ -471,7 +471,7 @@ 
         global $DATA, $this_page;
         $this_page = $this->page_base . 'front';
         $data = array();
-        if ( $this->index_template ) {
+        if ($this->index_template) {
             $data['template'] = $this->index_template;
         }
 
@@ -481,7 +481,7 @@ 
 
         $content['calendar'] = $class->display('calendar', array('months' => 1), 'none');
 
-        if ( $rssurl = $DATA->page_metadata($this_page, 'rss') ) {
+        if ($rssurl = $DATA->page_metadata($this_page, 'rss')) {
             $content['rssurl'] = $rssurl;
         }
 
@@ -496,7 +496,7 @@ 
     }
 
     //$totalcomments, $comment, $commenturl
-    function generate_commentteaser ($row) {
+    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:

tests/PartyTest.php

Doc Comments +3 added lines

@@ -118,6 +118,9 @@
         $this->assertEquals($expected, $position);
     }
 
+    /**
+     * @param string $method
+     */
     private function getAllPositions($method, $party = 'A Party') {
         $party = new MySociety\TheyWorkForYou\Party($party);
         $policies = new MySociety\TheyWorkForYou\Policies();

Spacing +8 added lines, -8 removed lines

@@ -11,7 +11,7 @@ 
      */
     public function getDataSet()
     {
-        return $this->createMySQLXMLDataSet(dirname(__FILE__).'/_fixtures/party.xml');
+        return $this->createMySQLXMLDataSet(dirname(__FILE__) . '/_fixtures/party.xml');
     }
 
     private function fetch_page($vars)
@@ -23,12 +23,12 @@ 
         $party = new MySociety\TheyWorkForYou\Party('A Party');
 
         $this->assertNotNull($party);
-        $this->assertEquals( 'A Party', $party->name );
+        $this->assertEquals('A Party', $party->name);
     }
 
     public function testCountMembers() {
         $party = new MySociety\TheyWorkForYou\Party('A Party');
-        $this->assertEquals( $party->getCurrentMemberCount(HOUSE_TYPE_COMMONS), 2 );
+        $this->assertEquals($party->getCurrentMemberCount(HOUSE_TYPE_COMMONS), 2);
     }
 
     public function testGetPolicyPositions() {
@@ -115,7 +115,7 @@ 
         $this->assertEquals($expectedResults, $positions);
 
         $party = new MySociety\TheyWorkForYou\Party('Labour/Co-operative');
-        $party->cache_position( $positions['810'] );
+        $party->cache_position($positions['810']);
 
         $position = $party->policy_position(810);
         $expected = ('voted a mixture of for and against');
@@ -133,7 +133,7 @@ 
 
     public function testMPPartyPolicyTextWhenDiffers()
     {
-        $page = $this->fetch_page( array( 'pid' => 2, 'url' => '/mp/2/test_current-mp/test_westminster_constituency' ) );
+        $page = $this->fetch_page(array('pid' => 2, 'url' => '/mp/2/test_current-mp/test_westminster_constituency'));
         $this->assertContains('Test Current-MP', $page);
         $this->assertContains('is a A Party MP', $page);
         $this->assertContains('sometimes <b>differs</b> from their party', $page);
@@ -141,14 +141,14 @@ 
 
     public function testSingleMemberPartyPolicyText()
     {
-        $page = $this->fetch_page( array( 'pid' => 7, 'url' => '/mp/7/test_second-party-mp/test_westminster_constituency' ) );
+        $page = $this->fetch_page(array('pid' => 7, 'url' => '/mp/7/test_second-party-mp/test_westminster_constituency'));
         $this->assertContains('Test Second-Party-MP', $page);
         $this->assertNotContains('is a A Second Party MP', $page);
     }
 
     public function testMPPartyPolicyWherePartyMissingPositions()
     {
-        $page = $this->fetch_page( array( 'pid' => 3, 'url' => '/mp/3/test_current-mp/test_westminster_constituency' ) );
+        $page = $this->fetch_page(array('pid' => 3, 'url' => '/mp/3/test_current-mp/test_westminster_constituency'));
         $this->assertContains('Test Current-MP', $page);
         $this->assertContains('is a A Party MP', $page);
         $this->assertNotContains('while most A Party MPs voted', $page);
@@ -156,7 +156,7 @@ 
 
     public function testMPPartyPolicyTextWhenAgrees()
     {
-        $page = $this->fetch_page( array( 'pid' => 6, 'url' => '/mp/6/test_further-mp/test_westminster_constituency' ) );
+        $page = $this->fetch_page(array('pid' => 6, 'url' => '/mp/6/test_further-mp/test_westminster_constituency'));
         $this->assertContains('Test Further-MP', $page);
         $this->assertContains('This is a selection of Miss Test Further-MP&rsquo;s votes', $page);
     }

www/docs/admin/report.php

Doc Comments +3 added lines

@@ -146,6 +146,9 @@
 
 
 
+/**
+ * @param string $template
+ */
 function get_template_contents($template) {
     // Fetches the contents of an email template so we can then
     // display it on the screen.

Spacing +10 added lines, -10 removed lines

@@ -6,7 +6,7 @@ 
 // where rid is a report_id and cid is a comment_id.
 
 include_once '../../includes/easyparliament/init.php';
-include_once (INCLUDESPATH."easyparliament/commentreport.php");
+include_once (INCLUDESPATH . "easyparliament/commentreport.php");
 
 $this_page = "admin_commentreport";
 
@@ -177,8 +177,8 @@ 
     global $this_page;
 
 #	$commentermail = preg_replace("/\n/", "<br>\n", get_template_contents('comment_deleted') );
-    $commentermail = preg_replace('/^Subject:.*\n/', '', get_template_contents('comment_deleted') );
-    $reportermail = preg_replace("/\n/", "<br>\n", get_template_contents('report_upheld') );
+    $commentermail = preg_replace('/^Subject:.*\n/', '', get_template_contents('comment_deleted'));
+    $reportermail = preg_replace("/\n/", "<br>\n", get_template_contents('report_upheld'));
 
     ?>
         <p><strong>You've chosen to delete this comment.</strong> You can now send an email to both the person who posted the comment, and the person who made the report. Uncheck a box to prevent an email from being sent. The comment will not be deleted until you click the button below.</p>
@@ -211,7 +211,7 @@ 
 
     global $this_page;
 
-    $reportermail = preg_replace("/\n/", "<br>\n", get_template_contents('report_declined') );
+    $reportermail = preg_replace("/\n/", "<br>\n", get_template_contents('report_declined'));
 
     ?>
         <p><strong>You have chosen not to delete this comment.</strong> You can now send an email to the person who made the report (uncheck the box to send no email). The report will not be resolved until you click the button below.</p>
@@ -243,7 +243,7 @@ 
         $upheld = false;
     }
 
-    $success = $REPORT->resolve ($upheld, $COMMENT);
+    $success = $REPORT->resolve($upheld, $COMMENT);
 
     if ($success) {
 
@@ -261,7 +261,7 @@ 
                 // The reporting user was logged in at the time,
                 // so get their email address.
                 $USER = new USER;
-                $USER->init( $REPORT->user_id() );
+                $USER->init($REPORT->user_id());
                 $email = $USER->email();
             } else {
                 // Non-logged-in user; they should have left their address.
@@ -269,10 +269,10 @@ 
             }
 
             // Prepare the data needed for either email.
-            $data = array (
+            $data = array(
                 'to' 			=> $email
             );
-            $merge = array (
+            $merge = array(
                 'FIRSTNAME' 	=> $REPORT->firstname(),
                 'LASTNAME' 		=> $REPORT->lastname(),
                 'REPORTBODY' 	=> strip_tags($REPORT->body())
@@ -308,12 +308,12 @@ 
             // Remove the anchor for their now deleted comment.
             $addcommentsurl = 'https://' . DOMAIN . preg_replace("/#.*$/", '#addcomment', $COMMENT->url());
 
-            $data = array (
+            $data = array(
                 'to' => $USER->email(),
                 'template' => 'comment_deleted_blank',
                 'subject' => 'One of your comments has been deleted',
             );
-            $merge = array (
+            $merge = array(
                 'REPLYBODY' => get_http_var('commentermail'),
                 'FIRSTNAME' 	=> $USER->firstname(),
                 'LASTNAME' 	=> $USER->lastname(),

www/docs/api/api_functions.php

Doc Comments +8 added lines

@@ -197,6 +197,9 @@ 
 
 # Output functions
 
+/**
+ * @param integer $last_mod
+ */
 function api_output($arr, $last_mod=null) {
     $output = get_http_var('output');
     if (!get_http_var('docs')) {
@@ -325,6 +328,11 @@ 
 
 # Call an API function
 
+/**
+ * @param string $function
+ * @param string $error
+ * @param string $type
+ */
 function api_call_user_func_or_error($function, $params, $error, $type) {
     if (function_exists($function))
         call_user_func_array($function, $params);

Indentation +10 added lines, -10 removed lines

@@ -146,18 +146,18 @@ 
 }
 
 function api_is_superuser_key($key) {
-  $db = new ParlDB;
-  $q = $db->query('SELECT api_key.user_id, users.status
+    $db = new ParlDB;
+    $q = $db->query('SELECT api_key.user_id, users.status
                FROM   api_key, users
                WHERE  users.user_id = api_key.user_id
                AND    api_key.api_key = :key', array(
                 ':key' => $key
                 ));
-  if (!$q->rows())
+    if (!$q->rows())
     return false;
-  if ($q->field(0, 'status') == 'Superuser')
+    if ($q->field(0, 'status') == 'Superuser')
     return true;
-  else
+    else
     return false;
 }
 
@@ -335,12 +335,12 @@ 
     // we only want to convert to iso if it's an actual API call
     // so skip this if it's a documentation page
     if (!get_http_var('docs')) {
-      // and then catch any errors in the conversion and just ignore
-      // them and return the unconverted results
-      $converted_out = @iconv('utf-8', 'iso-8859-1//TRANSLIT', $out);
-      if ($converted_out !== FALSE) {
+        // and then catch any errors in the conversion and just ignore
+        // them and return the unconverted results
+        $converted_out = @iconv('utf-8', 'iso-8859-1//TRANSLIT', $out);
+        if ($converted_out !== FALSE) {
         $out = $converted_out;
-      }
+        }
     }
 
     return $out;

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -338,7 +338,7 @@
       // and then catch any errors in the conversion and just ignore
       // them and return the unconverted results
       $converted_out = @iconv('utf-8', 'iso-8859-1//TRANSLIT', $out);
-      if ($converted_out !== FALSE) {
+      if ($converted_out !== false) {
         $out = $converted_out;
       }
     }

Spacing +15 added lines, -15 removed lines

@@ -132,7 +132,7 @@ 
 # Key-related functions
 
 function api_log_call($key) {
-    if ($key=='DOCS') return;
+    if ($key == 'DOCS') return;
     $ip = $_SERVER['REMOTE_ADDR'];
     $query = !empty($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
     $query = preg_replace('#key=[A-Za-z0-9]+&?#', '', $query);
@@ -197,14 +197,14 @@ 
 
 # Output functions
 
-function api_output($arr, $last_mod=null) {
+function api_output($arr, $last_mod = null) {
     $output = get_http_var('output');
     if (!get_http_var('docs')) {
         $cond = api_header($output, $last_mod);
         if ($cond) return;
     }
     if ($output == 'xml') {
-        $out = '<?xml version="1.0" encoding="utf-8"?>'."\n";
+        $out = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
         $out .= '<twfy>' . api_output_xml($arr) . '</twfy>';
     } elseif ($output == 'php') {
         $out = api_output_php($arr);
@@ -222,7 +222,7 @@ 
     print $out;
 }
 
-function api_header($o, $last_mod=null) {
+function api_header($o, $last_mod = null) {
     if ($last_mod && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
         $t = cond_parse_http_date($_SERVER['HTTP_IF_MODIFIED_SINCE']);
         if (isset($t) && $t >= $last_mod) {
@@ -248,7 +248,7 @@ 
     }
     #$type = 'text/plain';
     header("Content-Type: $type; charset=$charset");
-    if ($last_mod>0)
+    if ($last_mod > 0)
         header('Last-Modified: ' . date('r', $last_mod));
     return false;
 }
@@ -271,11 +271,11 @@ 
 }
 
 $api_xml_arr = 0;
-function api_output_xml($v, $k=null) {
+function api_output_xml($v, $k = null) {
     global $api_xml_arr;
     $verbose = get_http_var('verbose') ? "\n" : '';
     if (is_array($v)) {
-        if (count($v) && array_keys($v) === range(0, count($v)-1)) {
+        if (count($v) && array_keys($v) === range(0, count($v) - 1)) {
             $elt = 'match';
             $api_xml_arr++;
             $out = "<$elt>";
@@ -296,36 +296,36 @@ 
     }
 }
 
-function api_output_js($v, $level=0) {
+function api_output_js($v, $level = 0) {
     $verbose = get_http_var('verbose') ? "\n" : '';
     $out = '';
     if (is_array($v)) {
         # PHP arrays are both JS arrays and objects
-        if (count($v) && array_keys($v) === range(0, count($v)-1)) {
-            $out = '[' . join(",$verbose" , array_map('api_output_js', $v)) . ']';
+        if (count($v) && array_keys($v) === range(0, count($v) - 1)) {
+            $out = '[' . join(",$verbose", array_map('api_output_js', $v)) . ']';
         } else {
             $out = '{' . $verbose;
             $b = false;
             foreach ($v as $k => $vv) {
                 if ($b) $out .= ",$verbose";
                 if ($verbose) {
-                    $out .= str_repeat(' ', ($level+1)*2);
+                    $out .= str_repeat(' ', ($level + 1) * 2);
                     $out .= '"' . $k . '" : ';
                 } else {
                     $out .= '"' . $k . '":';
                 }
-                $out .= api_output_js($vv, $level+1);
+                $out .= api_output_js($vv, $level + 1);
                 $b = true;
             }
-            if ($verbose) $out .= "\n" . str_repeat(' ', $level*2);
+            if ($verbose) $out .= "\n" . str_repeat(' ', $level * 2);
             $out .= '}';
         }
     } elseif (is_null($v)) {
         $out = "null";
     } elseif (is_string($v)) {
         $out = '"' . str_replace(
-            array("\\",'"',"\n","\t","\r", "‶", "″", "“", "”"),
-            array("\\\\",'\"','\n','\t','\r', '\"', '\"', '\"', '\"'), $v) . '"';
+            array("\\", '"', "\n", "\t", "\r", "‶", "″", "“", "”"),
+            array("\\\\", '\"', '\n', '\t', '\r', '\"', '\"', '\"', '\"'), $v) . '"';
     } elseif (is_bool($v)) {
         $out = $v ? 'true' : 'false';
     } elseif (is_int($v) || is_float($v)) {

Braces +49 added lines, -29 removed lines

@@ -132,7 +132,9 @@ 
 # Key-related functions
 
 function api_log_call($key) {
-    if ($key=='DOCS') return;
+    if ($key=='DOCS') {
+        return;
+    }
     $ip = $_SERVER['REMOTE_ADDR'];
     $query = !empty($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
     $query = preg_replace('#key=[A-Za-z0-9]+&?#', '', $query);
@@ -153,23 +155,27 @@ 
                AND    api_key.api_key = :key', array(
                 ':key' => $key
                 ));
-  if (!$q->rows())
-    return false;
-  if ($q->field(0, 'status') == 'Superuser')
-    return true;
-  else
-    return false;
-}
+  if (!$q->rows()) {
+      return false;
+  }
+  if ($q->field(0, 'status') == 'Superuser') {
+      return true;
+  } else {
+      return false;
+  }
+  }
 
 function api_check_key($key) {
     $db = new ParlDB;
     $q = $db->query('SELECT user_id, disabled FROM api_key WHERE api_key = :key', array(
         ':key' => $key
         ));
-    if (!$q->rows())
-        return false;
-    if ($q->field(0, 'disabled'))
-        return 'disabled';
+    if (!$q->rows()) {
+            return false;
+    }
+    if ($q->field(0, 'disabled')) {
+            return 'disabled';
+    }
     return true;
 }
 
@@ -201,7 +207,9 @@ 
     $output = get_http_var('output');
     if (!get_http_var('docs')) {
         $cond = api_header($output, $last_mod);
-        if ($cond) return;
+        if ($cond) {
+            return;
+        }
     }
     if ($output == 'xml') {
         $out = '<?xml version="1.0" encoding="utf-8"?>'."\n";
@@ -212,7 +220,8 @@ 
         $out = api_output_rabx($arr);
     } elseif ($output == 'json') {
         $out = json_encode($arr, JSON_PRETTY_PRINT);
-    } else { # JS
+    } else {
+# JS
         $out = api_output_js($arr);
         $callback = get_http_var('callback');
         if (preg_match('#^[A-Za-z0-9._[\]]+$#', $callback)) {
@@ -248,8 +257,9 @@ 
     }
     #$type = 'text/plain';
     header("Content-Type: $type; charset=$charset");
-    if ($last_mod>0)
-        header('Last-Modified: ' . date('r', $last_mod));
+    if ($last_mod>0) {
+            header('Last-Modified: ' . date('r', $last_mod));
+    }
     return false;
 }
 
@@ -259,14 +269,18 @@ 
 
 function api_output_php($arr) {
     $out = serialize($arr);
-    if (get_http_var('verbose')) $out = str_replace(';', ";\n", $out);
+    if (get_http_var('verbose')) {
+        $out = str_replace(';', ";\n", $out);
+    }
     return $out;
 }
 
 function api_output_rabx($arr) {
     $out = '';
     rabx_wire_wr($arr, $out);
-    if (get_http_var('verbose')) $out = str_replace(',', ",\n", $out);
+    if (get_http_var('verbose')) {
+        $out = str_replace(',', ",\n", $out);
+    }
     return $out;
 }
 
@@ -307,7 +321,9 @@ 
             $out = '{' . $verbose;
             $b = false;
             foreach ($v as $k => $vv) {
-                if ($b) $out .= ",$verbose";
+                if ($b) {
+                    $out .= ",$verbose";
+                }
                 if ($verbose) {
                     $out .= str_repeat(' ', ($level+1)*2);
                     $out .= '"' . $k . '" : ';
@@ -317,7 +333,9 @@ 
                 $out .= api_output_js($vv, $level+1);
                 $b = true;
             }
-            if ($verbose) $out .= "\n" . str_repeat(' ', $level*2);
+            if ($verbose) {
+                $out .= "\n" . str_repeat(' ', $level*2);
+            }
             $out .= '}';
         }
     } elseif (is_null($v)) {
@@ -349,13 +367,14 @@ 
 # Call an API function
 
 function api_call_user_func_or_error($function, $params, $error, $type) {
-    if (function_exists($function))
-        call_user_func_array($function, $params);
-    elseif ($type == 'api')
-        api_error($error);
-    else
-        print "<p style='color:#cc0000'>$error</p>";
-}
+    if (function_exists($function)) {
+            call_user_func_array($function, $params);
+    } elseif ($type == 'api') {
+            api_error($error);
+    } else {
+            print "<p style='color:#cc0000'>$error</p>";
+    }
+    }
 
 # Used for testing for conditional responses
 
@@ -405,8 +424,9 @@ 
         $H = $ma[4];
         $M = $ma[5];
         $S = $ma[6];
-    } else
-        return null;
+    } else {
+            return null;
+    }
 
     return gmmktime($H, $M, $S, $m, $d, $Y);
 }

www/docs/api/api_getConstituencies.php

Doc Comments +4 added lines

@@ -143,6 +143,10 @@
  * Given two angles A1 and A2 on a circle expressed in radians, return the
  * smallest angle between them.
  */
+/**
+ * @param double $a1
+ * @param double $a2
+ */
 function _api_angle_between($a1, $a2) {
     if (abs($a1 - $a2) > M_PI) return 2*M_PI - abs($a1 - $a2);
     return abs($a1 - $a2);

Braces +6 added lines, -2 removed lines

@@ -108,7 +108,9 @@ 
     $geometry = _api_getGeometry();
     $out = array();
     foreach ($geometry['data'] as $name => $data) {
-        if (!isset($data['centre_lat']) || !isset($data['centre_lon'])) continue;
+        if (!isset($data['centre_lat']) || !isset($data['centre_lon'])) {
+            continue;
+        }
         $distance = R_e * acos(
             sin(deg2rad($lat)) * sin(deg2rad($data['centre_lat']))
             + cos(deg2rad($lat)) * cos(deg2rad($data['centre_lat']))
@@ -144,7 +146,9 @@ 
  * smallest angle between them.
  */
 function _api_angle_between($a1, $a2) {
-    if (abs($a1 - $a2) > M_PI) return 2*M_PI - abs($a1 - $a2);
+    if (abs($a1 - $a2) > M_PI) {
+        return 2*M_PI - abs($a1 - $a2);
+    }
     return abs($a1 - $a2);
 }
 

Spacing +5 added lines, -5 removed lines

@@ -41,11 +41,11 @@ 
         and c_main.main_name and constituency.name like :constituency_name and constituency.from_date <= date(now())
         and date(now()) <= constituency.to_date
         order by name', array(
-        ':constituency_name' => '%' . $s .'%'
+        ':constituency_name' => '%' . $s . '%'
         ));
     $output = array();
     $done = array();
-    for ($i=0; $i<$q->rows(); $i++) {
+    for ($i = 0; $i < $q->rows(); $i++) {
         $name = $q->field($i, 'name');
         if (!in_array($name, $done)) {
             $output[] = array(
@@ -70,10 +70,10 @@ 
 function api_getConstituencies($date = 'now()') {
     $db = new ParlDB;
     $q = $db->query('select cons_id, name from constituency
-        where main_name and from_date <= date('.$date.') and date('.$date.') <= to_date
+        where main_name and from_date <= date('.$date . ') and date(' . $date . ') <= to_date
         order by name');
     $output = array();
-    for ($i=0; $i<$q->rows(); $i++) {
+    for ($i = 0; $i < $q->rows(); $i++) {
         $output[] = array(
             # 'id' => $q->field($i, 'cons_id'),
             'name' => $q->field($i, 'name')
@@ -144,7 +144,7 @@ 
  * smallest angle between them.
  */
 function _api_angle_between($a1, $a2) {
-    if (abs($a1 - $a2) > M_PI) return 2*M_PI - abs($a1 - $a2);
+    if (abs($a1 - $a2) > M_PI) return 2 * M_PI - abs($a1 - $a2);
     return abs($a1 - $a2);
 }
 

www/docs/api/api_getHansard.php

Doc Comments +12 added lines

@@ -36,11 +36,17 @@ 
     ));
 }
 
+/**
+ * @param string $type
+ */
 function _api_getHansard_date($type, $d) {
     $args = array ('date' => $d);
     $LIST = _api_getListObject($type);
     $LIST->display('date', $args, 'api');
 }
+/**
+ * @param string $type
+ */
 function _api_getHansard_year($type, $y) {
     $args = array('year' => $y);
     $LIST = _api_getListObject($type);
@@ -98,6 +104,9 @@ 
     $LIST->display('search', $args, 'api');
 }
 
+/**
+ * @param string $type
+ */
 function _api_getHansard_gid($type, $gid) {
     $args = array('gid' => $gid);
     $LIST = _api_getListObject($type);
@@ -112,6 +121,9 @@ 
     }
 }
 
+/**
+ * @param string $type
+ */
 function _api_getHansard_department($type, $dept) {
     $args = array('department' => $dept);
     $LIST = _api_getListObject($type);

Braces +3 added lines, -1 removed lines

@@ -66,7 +66,9 @@
     if ($o == 'p') {
         $data = \MySociety\TheyWorkForYou\Utility\Search::searchByUsage($search);
         $out = array();
-        if (!isset($data['speakers'])) $data['speakers'] = array();
+        if (!isset($data['speakers'])) {
+            $data['speakers'] = array();
+        }
         foreach ($data['speakers'] as $pid => $s) {
             $out[$pid] = array(
                 'house' => $s['house'],

Spacing +7 added lines, -7 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-include_once INCLUDESPATH."easyparliament/member.php";
+include_once INCLUDESPATH . "easyparliament/member.php";
 
 function api_getHansard_front() {
 ?>
@@ -29,10 +29,10 @@ 
 }
 
 function api_getHansard_search($s) {
-    _api_getHansard_search( array(
+    _api_getHansard_search(array(
         's' => $s,
         'pid' => get_http_var('person')
-    ) );
+    ));
 }
 function api_getHansard_person($pid) {
     _api_getHansard_search(array(
@@ -41,7 +41,7 @@ 
 }
 
 function _api_getHansard_date($type, $d) {
-    $args = array ('date' => $d);
+    $args = array('date' => $d);
     $LIST = _api_getListObject($type);
     $LIST->display('date', $args, 'api');
 }
@@ -56,7 +56,7 @@ 
     $type = isset($array['type']) ? $array['type'] : '';
     $search = filter_user_input($search, 'strict');
     if ($pid) {
-        $search .= ($search?' ':'') . 'speaker:' . $pid;
+        $search .= ($search ? ' ' : '') . 'speaker:' . $pid;
     }
     if ($type) {
         $search .= " section:" . $type;
@@ -91,12 +91,12 @@ 
     }
 #    $query_desc_short = $SEARCHENGINE->query_description_short();
     $pagenum = get_http_var('page');
-    $args = array (
+    $args = array(
         's' => $search,
         'p' => $pagenum,
         'num' => get_http_var('num'),
         'pop' => 1,
-        'o' => ($o=='d' || $o=='r') ? $o : 'd',
+        'o' => ($o == 'd' || $o == 'r') ? $o : 'd',
     );
     $LIST = new HANSARDLIST();
     $LIST->display('search', $args, 'api');

www/docs/postcode/index.php

Doc Comments +6 added lines

@@ -46,6 +46,9 @@ 
 
 # ---
 
+/**
+ * @param string $error
+ */
 function postcode_error($error) {
     global $PAGE;
     $PAGE->page_start();
@@ -160,6 +163,9 @@ 
     return array($out, $sidebar);
 }
 
+/**
+ * @param MySociety\TheyWorkForYou\Member $MEMBER
+ */
 function member_redirect(&$MEMBER) {
     if ($MEMBER->valid) {
         $url = $MEMBER->url();

Braces +9 added lines, -3 removed lines

@@ -89,7 +89,9 @@ 
     $mp = array();
     if ($q->rows()) {
         $mp = $q->row(0);
-        if ($mp['left_house'] != '9999-12-31') $mp['former'] = true;
+        if ($mp['left_house'] != '9999-12-31') {
+            $mp['former'] = true;
+        }
     }
 
     $a = array_values($areas);
@@ -128,7 +130,9 @@ 
     $out = '';
     $out .= '<p>That postcode has multiple results, please pick who you are interested in:</p>';
     $out .= '<ul><li>Your ';
-    if (isset($mp['former'])) $out .= 'former ';
+    if (isset($mp['former'])) {
+        $out .= 'former ';
+    }
     $out .= '<strong>MP</strong> (Member of Parliament) is <a href="/mp/?p=' . $mp['person_id'] . '">';
     $out .= $mp['given_name'] . ' ' . $mp['family_name'] . '</a>, ' . $mp['constituency'] . '</li>';
     if ($mcon) {
@@ -138,7 +142,9 @@ 
         $out .= $mcon['given_name'] . ' ' . $mcon['family_name'] . '</a>, ' . $mcon['constituency'] . '</li>';
     }
     $out .= '<li>Your <strong>' . $areas[$area_type] . ' ' . $rep_type . 's</strong> ';
-    if ($rep_type=='MLA') $out .= '(Members of the Legislative Assembly)';
+    if ($rep_type=='MLA') {
+        $out .= '(Members of the Legislative Assembly)';
+    }
     $out .= ' ' . ($current ? 'are' : 'were') . ':';
     $out .= '<ul>';
     foreach ($mreg as $reg) {

Spacing +7 added lines, -7 removed lines

@@ -14,7 +14,7 @@ 
 
 $pc = preg_replace('#[^a-z0-9]#i', '', $pc);
 if (!validate_postcode($pc)) {
-    twfy_debug ('MP', "Can't display an MP because the submitted postcode wasn't of a valid form.");
+    twfy_debug('MP', "Can't display an MP because the submitted postcode wasn't of a valid form.");
     postcode_error("Sorry, " . _htmlentities($pc) . " isn't a valid postcode");
 }
 
@@ -57,7 +57,7 @@ 
     exit;
 }
 
-function fetch_mp($pc, $constituencies, $house=null) {
+function fetch_mp($pc, $constituencies, $house = null) {
     global $THEUSER;
     $args = array('constituency' => $constituencies['WMC']);
     if ($house) {
@@ -65,7 +65,7 @@ 
     }
     try {
         $MEMBER = new MEMBER($args);
-    } catch (MySociety\TheyWorkForYou\MemberException $e){
+    } catch (MySociety\TheyWorkForYou\MemberException $e) {
         postcode_error($e->getMessage());
     }
     if ($MEMBER->person_id()) {
@@ -108,12 +108,12 @@ 
     }
 
     $mcon = array(); $mreg = array();
-    for ($i=0; $i<$q->rows(); $i++) {
+    for ($i = 0; $i < $q->rows(); $i++) {
         $house = $q->field($i, 'house');
         $cons = $q->field($i, 'constituency');
-        if ($house==3) {
+        if ($house == 3) {
             $mreg[] = $q->row($i);
-        } elseif ($house==4) {
+        } elseif ($house == 4) {
             if ($cons == $areas['SPC']) {
                 $mcon = $q->row($i);
             } elseif ($cons == $areas['SPE']) {
@@ -138,7 +138,7 @@ 
         $out .= $mcon['given_name'] . ' ' . $mcon['family_name'] . '</a>, ' . $mcon['constituency'] . '</li>';
     }
     $out .= '<li>Your <strong>' . $areas[$area_type] . ' ' . $rep_type . 's</strong> ';
-    if ($rep_type=='MLA') $out .= '(Members of the Legislative Assembly)';
+    if ($rep_type == 'MLA') $out .= '(Members of the Legislative Assembly)';
     $out .= ' ' . ($current ? 'are' : 'were') . ':';
     $out .= '<ul>';
     foreach ($mreg as $reg) {