mysociety / theyworkforyou

classes/Data.php

Doc Comments +3 added lines

@@ -159,6 +159,9 @@
         }
     }
 
+    /**
+     * @param string $type
+     */
     private function getMetadata($args="", $type) {
         // $type is either 'page' or 'section'
         global $this_page, $this_section;

Spacing +11 added lines, -11 removed lines

@@ -54,7 +54,7 @@ 
 
     public function __construct() {
 
-        include_once METADATAPATH;	// defined in config.php
+        include_once METADATAPATH; // defined in config.php
 
     }
 
@@ -114,7 +114,7 @@ 
      */
 
     public function set_page_metadata($page, $key, $value) {
-        $this->setMetadata(array("page"=>$page,"key"=>$key,"value"=>$value));
+        $this->setMetadata(array("page"=>$page, "key"=>$key, "value"=>$value));
     }
 
     /**
@@ -126,7 +126,7 @@ 
      */
 
     public function set_section_metadata($section, $key, $value) {
-        $this->setMetadata(array("section"=>$section,"key"=>$key,"value"=>$value));
+        $this->setMetadata(array("section"=>$section, "key"=>$key, "value"=>$value));
     }
 
     /**
@@ -150,7 +150,7 @@ 
      */
 
     public function test_for_metadata($type, $item, $key) {
-        $dataarray =& $this->$type;
+        $dataarray = & $this->$type;
 
         if (isset($dataarray[$item][$key])) {
             return true;
@@ -159,7 +159,7 @@ 
         }
     }
 
-    private function getMetadata($args="", $type) {
+    private function getMetadata($args = "", $type) {
         // $type is either 'page' or 'section'
         global $this_page, $this_section;
 
@@ -167,21 +167,21 @@ 
             $item = $args[$type];
             $key = $args['key'];
         } else {
-            $var = "this_".$type;
+            $var = "this_" . $type;
             $item = $$var; // $this_page or $this_section.
             $key = $args;
         }
 
         twfy_debug("DATA", "$type: $item, $key");
-        $dataarray =& $this->$type;
+        $dataarray = & $this->$type;
 
         if ($this->test_for_metadata($type, $item, $key)) {
             $return = $dataarray[$item][$key];
-            $debugtext = "Key: ".$type."[".$item."][".$key."]";
+            $debugtext = "Key: " . $type . "[" . $item . "][" . $key . "]";
 
         } elseif ($this->test_for_metadata($type, "default", $key)) {
             $return = $dataarray["default"][$key];
-            $debugtext = "Key: ".$type."['default'][".$key."]";
+            $debugtext = "Key: " . $type . "['default'][" . $key . "]";
 
         } else {
             $return = false;
@@ -206,9 +206,9 @@ 
         $key = $args["key"];
         $value = $args["value"];
 
-        twfy_debug("DATA", "Setting: ".$type."[".$item."][".$key."] = '" . print_r($value, 1) . "'");
+        twfy_debug("DATA", "Setting: " . $type . "[" . $item . "][" . $key . "] = '" . print_r($value, 1) . "'");
 
-        $dataarray =& $this->$type;
+        $dataarray = & $this->$type;
         $dataarray[$item][$key] = $value;
     }
 

classes/Db/Query.php

Doc Comments +12 added lines

@@ -175,6 +175,11 @@ 
     }
 
     // After SELECT.
+
+    /**
+     * @param integer $row_index
+     * @param string $column_name
+     */
     public function field($row_index, $column_name) {
         if ($this->rows > 0)
             return $this->data[$row_index][$column_name];
@@ -187,6 +192,10 @@ 
     }
 
     // After SELECT.
+
+    /**
+     * @param integer $row_index
+     */
     public function row($row_index) {
         if ($this->success && $this->rows > 0)
             return $this->data[$row_index];
@@ -224,6 +233,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $errormsg
+     */
     public function error($errormsg) {
         // When a query goes wrong...
         $this->success = false;

Indentation -1 removed lines

@@ -72,7 +72,6 @@
  * - `$this->field(n,col)` returns an empty string.
  * - `$this->insert_id()` returns `null`.
  * - `$this->affected_rows()` returns `null`.
-
  */
 
 class Query {

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

@@ -78,16 +78,16 @@ 
 class Query {
 
     public $success = true;
-    public $rows = NULL;
+    public $rows = null;
     public $data = array();
-    public $insert_id = NULL;
-    public $affected_rows = NULL;
+    public $insert_id = null;
+    public $affected_rows = null;
 
     public function __construct($conn) {
         $this->conn = $conn;
     }
 
-    public function query($sql="", $params = NULL) {
+    public function query($sql="", $params = null) {
 
         if (empty($sql)) {
             $this->success = false;
@@ -104,7 +104,7 @@ 
         twfy_debug ("SQL", $sql);
         twfy_debug ("SQL", print_r($params, 1));
 
-        if ($params !== NULL) {
+        if ($params !== null) {
             // Prepare and execute a statement
             $pdoStatement = $this->conn->prepare($sql);
 

Spacing +5 added lines, -5 removed lines

@@ -87,7 +87,7 @@ 
         $this->conn = $conn;
     }
 
-    public function query($sql="", $params = NULL) {
+    public function query($sql = "", $params = NULL) {
 
         if (empty($sql)) {
             $this->success = false;
@@ -101,8 +101,8 @@ 
             return;
         }
 
-        twfy_debug ("SQL", $sql);
-        twfy_debug ("SQL", print_r($params, 1));
+        twfy_debug("SQL", $sql);
+        twfy_debug("SQL", print_r($params, 1));
 
         if ($params !== NULL) {
             // Prepare and execute a statement
@@ -133,7 +133,7 @@ 
 
         if (!$this->success) return;
 
-        if ( (!$pdoStatement) or (empty($pdoStatement)) ) {
+        if ((!$pdoStatement) or (empty($pdoStatement))) {
             // A failed query.
             $this->success = false;
 
@@ -155,7 +155,7 @@ 
             }
             $this->affected_rows = $pdoStatement->rowCount();
 
-            twfy_debug ("SQLRESULT", array($this, 'displayResult'));
+            twfy_debug("SQLRESULT", array($this, 'displayResult'));
             // mysql_free_result($q);
         }
     }

Braces +19 added lines, -10 removed lines

@@ -112,7 +112,8 @@ 
 
                 if (is_int($paramValue)) {
                     $paramType = \PDO::PARAM_INT;
-                } else {
+                }
+                else {
                     $paramType = \PDO::PARAM_STR;
                 }
 
@@ -121,7 +122,8 @@ 
 
             $pdoStatement->execute();
 
-        } else {
+        }
+        else {
             // Execute the raw query
             $pdoStatement = $this->conn->query($sql);
         }
@@ -131,13 +133,16 @@ 
             $this->error($this->conn->errorCode() . ': ' . $this->conn->errorInfo()[2]);
         }
 
-        if (!$this->success) return;
+        if (!$this->success) {
+            return;
+        }
 
         if ( (!$pdoStatement) or (empty($pdoStatement)) ) {
             // A failed query.
             $this->success = false;
 
-        } else {
+        }
+        else {
 
             // A successful SELECT, SHOW, EXPLAIN or DESCRIBE query.
             $this->success = true;
@@ -150,7 +155,8 @@ 
             // Sanity check that lastInsertId() is actually a number, otherwise panic
             if (is_numeric($this->conn->lastInsertId())) {
                 $this->insert_id = (int) $this->conn->lastInsertId();
-            } else {
+            }
+            else {
                 throw new Exception('Last connection ID was not numeric!');
             }
             $this->affected_rows = $pdoStatement->rowCount();
@@ -176,8 +182,9 @@ 
 
     // After SELECT.
     public function field($row_index, $column_name) {
-        if ($this->rows > 0)
-            return $this->data[$row_index][$column_name];
+        if ($this->rows > 0) {
+                    return $this->data[$row_index][$column_name];
+        }
         return "";
     }
 
@@ -188,8 +195,9 @@ 
 
     // After SELECT.
     public function row($row_index) {
-        if ($this->success && $this->rows > 0)
-            return $this->data[$row_index];
+        if ($this->success && $this->rows > 0) {
+                    return $this->data[$row_index];
+        }
         return array();
     }
 
@@ -212,7 +220,8 @@ 
                     if ($n == "email" || $n == "password" || $n == "postcode") {
                         // Don't want to risk this data being displayed on any page.
                         $html .= "<td>**MASKED**</td>";
-                    } else {
+                    }
+                    else {
                         $html .= "<td>" . _htmlentities($field) . "</td>";
                     }
                 }

classes/Db/Connection.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
      * @param string $db_pass The password for the database user
      * @param string $db_name The name of the database
      *
-     * @return true If the connection has been created successfully.
+     * @return boolean If the connection has been created successfully.
      */
 
     public function init($db_host, $db_user, $db_pass, $db_name) {

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

@@ -102,7 +102,7 @@
      * @return Query An object containing the results of the query.
      */
 
-    public function query($sql, $params = NULL) {
+    public function query($sql, $params = null) {
 
         $start = getmicrotime();
         $q = new \MySociety\TheyWorkForYou\Db\Query($this->conn);

Spacing +2 added lines, -2 removed lines

@@ -111,7 +111,7 @@ 
         $duration = getmicrotime() - $start;
         global $mysqltotalduration;
         $mysqltotalduration += $duration;
-        twfy_debug ("SQL", "Complete after $duration seconds.");
+        twfy_debug("SQL", "Complete after $duration seconds.");
         // We could also output $q->mysql_info() here, but that's for
         // PHP >= 4.3.0.
         return $q;
@@ -126,7 +126,7 @@ 
 
     public function display_total_duration() {
         global $mysqltotalduration;
-        twfy_debug ("TIME", "Total time for MySQL queries on this page: " . $mysqltotalduration . " seconds.");
+        twfy_debug("TIME", "Total time for MySQL queries on this page: " . $mysqltotalduration . " seconds.");
     }
 
     /**

www/includes/easyparliament/init.php

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

@@ -92,7 +92,7 @@
 include_once (INCLUDESPATH."easyparliament/user.php");
 
 // Test to see if this is a new-style template using the renderer class.
-if (! isset($new_style_template) OR $new_style_template !== TRUE) {
+if (! isset($new_style_template) or $new_style_template !== true) {
 
     // This is an old-style page. Use the old page classes.
     include_once (INCLUDESPATH."easyparliament/page.php");

Spacing +25 added lines, -25 removed lines

@@ -4,7 +4,7 @@ 
 First some things to help make our PHP nicer and betterer
 ********************************************************************************/
 
-error_reporting (E_ALL);
+error_reporting(E_ALL);
 
 /********************************************************************************
 Now some constants that are the same for live and dev versions
@@ -12,22 +12,22 @@ 
 ********************************************************************************/
 
 // In case we need to switch these off globally at some point...
-define ("ALLOWCOMMENTS", true);
-define ("ALLOWTRACKBACKS", true);
+define("ALLOWCOMMENTS", true);
+define("ALLOWTRACKBACKS", true);
 
 // These variables are so we can keep date/time formats consistent across the site
 // and change them easily.
 // Formats here: http://www.php.net/manual/en/function.date.php
-define ("LONGERDATEFORMAT",		"l, j F Y");// Monday, 31 December 2003
-define ("LONGDATEFORMAT", 		"j F Y"); 	// 31 December 2003
-define ("SHORTDATEFORMAT", 		"j M Y");	// 31 Dec 2003
-define ("TIMEFORMAT", 			"g:i a");	// 11:59 pm
+define("LONGERDATEFORMAT", "l, j F Y"); // Monday, 31 December 2003
+define("LONGDATEFORMAT", "j F Y"); // 31 December 2003
+define("SHORTDATEFORMAT", "j M Y"); // 31 Dec 2003
+define("TIMEFORMAT", "g:i a"); // 11:59 pm
 
-define ("SHORTDATEFORMAT_SQL",	"%e %b %Y"); // 31 Dec 2003
-define ("TIMEFORMAT_SQL", 		"%l:%i %p"); // 11:59 PM
+define("SHORTDATEFORMAT_SQL", "%e %b %Y"); // 31 Dec 2003
+define("TIMEFORMAT_SQL", "%l:%i %p"); // 11:59 PM
 
 // Where we store the postcode of users if they search for an MP by postcode.
-define ('POSTCODE_COOKIE', 		'eppc');
+define('POSTCODE_COOKIE', 'eppc');
 
 /********************************************************************************
 And now all the files we'll include on every page.
@@ -41,7 +41,7 @@ 
 twfy_debug_timestamp("after including utility.php");
 
 // Set the default timezone
-if(function_exists('date_default_timezone_set')) date_default_timezone_set(TIMEZONE);
+if (function_exists('date_default_timezone_set')) date_default_timezone_set(TIMEZONE);
 
 // Only do clever things with errors if we're not testing, otherwise show as default
 
@@ -70,42 +70,42 @@ 
 
 // The time the page starts, so we can display the total at the end.
 // getmicrotime() is in utiltity.php.
-define ("STARTTIME", getmicrotime());
+define("STARTTIME", getmicrotime());
 if (!isset($_SERVER['WINDIR'])) {
     $rusage = getrusage();
-    define ('STARTTIMES', $rusage['ru_stime.tv_sec']*1000000 + $rusage['ru_stime.tv_usec']);
-    define ('STARTTIMEU', $rusage['ru_utime.tv_sec']*1000000 + $rusage['ru_utime.tv_usec']);
+    define('STARTTIMES', $rusage['ru_stime.tv_sec'] * 1000000 + $rusage['ru_stime.tv_usec']);
+    define('STARTTIMEU', $rusage['ru_utime.tv_sec'] * 1000000 + $rusage['ru_utime.tv_usec']);
 }
 
 $DATA = new \MySociety\TheyWorkForYou\Data;
 
 class ParlDB extends \MySociety\TheyWorkForYou\Db\Connection {
     public function __construct() {
-        $this->init (OPTION_TWFY_DB_HOST, OPTION_TWFY_DB_USER, OPTION_TWFY_DB_PASS, OPTION_TWFY_DB_NAME);
+        $this->init(OPTION_TWFY_DB_HOST, OPTION_TWFY_DB_USER, OPTION_TWFY_DB_PASS, OPTION_TWFY_DB_NAME);
     }
 }
 
-include_once (INCLUDESPATH."url.php");
+include_once (INCLUDESPATH . "url.php");
 
 $filter = new \MySociety\TheyWorkForYou\Utility\LibFilter;
 
-include_once (INCLUDESPATH."easyparliament/user.php");
+include_once (INCLUDESPATH . "easyparliament/user.php");
 
 // Test to see if this is a new-style template using the renderer class.
-if (! isset($new_style_template) OR $new_style_template !== TRUE) {
+if (!isset($new_style_template) OR $new_style_template !== TRUE) {
 
     // This is an old-style page. Use the old page classes.
-    include_once (INCLUDESPATH."easyparliament/page.php");
+    include_once (INCLUDESPATH . "easyparliament/page.php");
 
 }
 
-include_once (INCLUDESPATH."easyparliament/hansardlist.php");
-include_once (INCLUDESPATH."dbtypes.php");
-include_once (INCLUDESPATH."easyparliament/commentlist.php");
-include_once (INCLUDESPATH."easyparliament/comment.php");
-include_once (INCLUDESPATH."easyparliament/trackback.php");
+include_once (INCLUDESPATH . "easyparliament/hansardlist.php");
+include_once (INCLUDESPATH . "dbtypes.php");
+include_once (INCLUDESPATH . "easyparliament/commentlist.php");
+include_once (INCLUDESPATH . "easyparliament/comment.php");
+include_once (INCLUDESPATH . "easyparliament/trackback.php");
 
 // Added in as new module by Richard Allan MP
-include_once (INCLUDESPATH."easyparliament/alert.php");
+include_once (INCLUDESPATH . "easyparliament/alert.php");
 
 twfy_debug_timestamp("at end of init.php");

classes/Utility/LibFilter.php

Spacing +16 added lines, -16 removed lines

@@ -209,7 +209,7 @@ 
             }, $data);
 
         foreach (array_keys($this->tag_counts) as $tag) {
-            for ($i=0; $i<$this->tag_counts[$tag]; $i++) {
+            for ($i = 0; $i < $this->tag_counts[$tag]; $i++) {
                 $data .= "</$tag>";
             }
         }
@@ -228,7 +228,7 @@ 
                 if (!in_array($name, $this->no_close)) {
                     if (isset($this->tag_counts[$name])) {
                         $this->tag_counts[$name]--;
-                        return '</'.$name.'>';
+                        return '</' . $name . '>';
                     }
                 }
             } else {
@@ -244,9 +244,9 @@ 
             $ending = $matches[3];
             if (in_array($name, array_keys($this->allowed))) {
                 $params = "";
-                preg_match_all("/([a-z0-9]+)=([\"'])(.*?)\\2/si", $body, $matches_2, PREG_SET_ORDER);		# <foo a="b" />
-                preg_match_all("/([a-z0-9]+)(=)([^\"\s']+)/si", $body, $matches_1, PREG_SET_ORDER);		# <foo a=b />
-                preg_match_all("/([a-z0-9]+)=([\"'])([^\"']*?)\s*$/si", $body, $matches_3, PREG_SET_ORDER);	# <foo a="b />
+                preg_match_all("/([a-z0-9]+)=([\"'])(.*?)\\2/si", $body, $matches_2, PREG_SET_ORDER); # <foo a="b" />
+                preg_match_all("/([a-z0-9]+)(=)([^\"\s']+)/si", $body, $matches_1, PREG_SET_ORDER); # <foo a=b />
+                preg_match_all("/([a-z0-9]+)=([\"'])([^\"']*?)\s*$/si", $body, $matches_3, PREG_SET_ORDER); # <foo a="b />
                 $matches = array_merge($matches_1, $matches_2, $matches_3);
 
                 foreach ($matches as $match) {
@@ -275,7 +275,7 @@ 
                 if ($ending) {
                     $ending = ' /';
                 }
-                return '<'.$name.$params.$ending.'>';
+                return '<' . $name . $params . $ending . '>';
             } else {
                 return '';
             }
@@ -286,7 +286,7 @@ 
             if ($this->strip_comments) {
                 return '';
             } else {
-                return '<'.$data.'>';
+                return '<' . $data . '>';
             }
         }
 
@@ -302,7 +302,7 @@ 
 
         if (preg_match("/^([^:]+)\:/si", $data, $matches)) {
             if (!in_array($matches[1], $this->allowed_protocols)) {
-                $data = '#'.substr($data, strlen($matches[1])+1);
+                $data = '#' . substr($data, strlen($matches[1]) + 1);
             }
         }
 
@@ -352,7 +352,7 @@ 
         # if there are less than 5, just allow it as-is
         #
 
-        if (strlen($data_notags)<5) {
+        if (strlen($data_notags) < 5) {
             return $data;
         }
 
@@ -397,7 +397,7 @@ 
             $data
         );
 
-        return $m[1].$data.$m[3];
+        return $m[1] . $data . $m[3];
     }
 
     #####################################################################################
@@ -474,7 +474,7 @@ 
 
 
 
-        return $m[1].$m[2].$m[3];
+        return $m[1] . $m[2] . $m[3];
     }
 
 
@@ -496,7 +496,7 @@ 
 
         if ($term != ';') {
 
-            return '&amp;'.$preamble;
+            return '&amp;' . $preamble;
         }
 
         #
@@ -505,7 +505,7 @@ 
 
         if ($this->is_valid_entity($preamble)) {
 
-            return '&'.$preamble;
+            return '&' . $preamble;
         }
 
 
@@ -513,7 +513,7 @@ 
         # not an allowed antity, so escape the ampersand
         #
 
-        return '&amp;'.$preamble;
+        return '&amp;' . $preamble;
     }
 
 
@@ -562,7 +562,7 @@ 
     # inside strings. within general text, we decode hex/dec entities.
     #
 
-    public function decode_entities($data, $in_attribute=1) {
+    public function decode_entities($data, $in_attribute = 1) {
 
         $data = preg_replace_callback('!(&)#(\d+);?!', array($this, 'decode_dec_entity'), $data);
         $data = preg_replace_callback('!(&)#x([0-9a-f]+);?!i', array($this, 'decode_hex_entity'), $data);
@@ -603,7 +603,7 @@ 
         #
 
         if ($d > 127) {
-            if ($orig_type == '%') { return '%'.dechex($d); }
+            if ($orig_type == '%') { return '%' . dechex($d); }
             if ($orig_type == '&') { return "&#$d;"; }
         }
 

Braces +13 added lines, -6 removed lines

@@ -177,7 +177,8 @@ 
             $data = preg_replace("/<([^>]*?)(?=<|$)/", "<$1>", $data);
             $data = preg_replace("/(^|>)([^<]*?)(?=>)/", "$1<$2", $data);
 
-        } else {
+        }
+        else {
 
             #
             # escape stray brackets
@@ -231,7 +232,8 @@ 
                         return '</'.$name.'>';
                     }
                 }
-            } else {
+            }
+            else {
                 return '';
             }
         }
@@ -268,7 +270,8 @@ 
                 if (!$ending) {
                     if (isset($this->tag_counts[$name])) {
                         $this->tag_counts[$name]++;
-                    } else {
+                    }
+                    else {
                         $this->tag_counts[$name] = 1;
                     }
                 }
@@ -276,7 +279,8 @@ 
                     $ending = ' /';
                 }
                 return '<'.$name.$params.$ending.'>';
-            } else {
+            }
+            else {
                 return '';
             }
         }
@@ -285,7 +289,8 @@ 
         if (preg_match("/^!--(.*)--$/si", $data)) {
             if ($this->strip_comments) {
                 return '';
-            } else {
+            }
+            else {
                 return '<'.$data.'>';
             }
         }
@@ -324,7 +329,9 @@ 
             while (1) {
                 $len = strlen($data);
                 $data = preg_replace("/<({$tags})(\s[^>]*)?(><\\/\\1>|\\/>)/", '', $data);
-                if ($len == strlen($data)) break;
+                if ($len == strlen($data)) {
+                    break;
+                }
             }
         }