mysociety / theyworkforyou

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);
         }
     }

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");