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;

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;

www/docs/api/api_getPerson.php

Doc Comments +9 added lines

@@ -77,6 +77,9 @@ 
     }
 }
 
+/**
+ * @param MySociety\TheyWorkForYou\Db\Query $q
+ */
 function _api_getPerson_output($q, $flatten=false) {
     $output = array();
     $last_mod = 0;
@@ -95,10 +98,16 @@ 
     api_output($output, $last_mod);
 }
 
+/**
+ * @param integer $house
+ */
 function api_getPerson_constituency($constituency, $house) {
     _api_getPerson_constituency(array($constituency), $house);
 }
 
+/**
+ * @param integer $house
+ */
 function api_getPerson_postcode($pc, $house) {
     $pc = preg_replace('#[^a-z0-9 ]#i', '', $pc);
     $types = array();

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) {

classes/Search/Normal.php

Doc Comments +3 added lines

@@ -188,6 +188,9 @@
         return $items;
     }
 
+    /**
+     * @param \MySociety\TheyWorkForYou\Url $url
+     */
     private function generate_pagination_links($data, $url, $first, $last) {
         $links = array();
 

www/includes/utility.php

Doc Comments +23 added lines

@@ -318,6 +318,9 @@ 
 $format_date_months = array('', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December');
 $format_date_months_short = array('', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');
 
+/**
+ * @param string $format
+ */
 function format_date($date, $format) {
     global $format_date_months, $format_date_months_short;
     // Pass it a date (YYYY-MM-DD) and a
@@ -342,6 +345,9 @@ 
 }
 
 
+/**
+ * @param string $format
+ */
 function format_time($time, $format) {
     // Pass it a time (HH:MM:SS) and a
     // PHP date format string (eg, "H:i")
@@ -486,6 +492,7 @@ 
 
 /**
  * Filters user input to remove unwanted HTML tags etc
+ * @param string $filter_type
  */
 function filter_user_input($text, $filter_type) {
     // We use this to filter any major user input, especially comments.
@@ -750,12 +757,18 @@ 
 /* verp_envelope_sender RECIPIENT
  * Construct a VERP envelope sender for an email to RECIPIENT
  */
+/**
+ * @return string|null
+ */
 function twfy_verp_envelope_sender($recipient) {
     $envelope_sender = verp_envelope_sender($recipient, 'twfy', EMAILDOMAIN);
 
     return $envelope_sender;
 }
 
+/**
+ * @param string $message
+ */
 function send_email($to, $subject, $message, $bulk = false, $from = '', $want_bounces = false) {
     // Use this rather than PHP's mail() direct, so we can make alterations
     // easily to all the emails we send out from the site.
@@ -814,6 +827,9 @@ 
 }
 
 // Call this with a key name to get a COOKIE variable.
+/**
+ * @param string $name
+ */
 function get_cookie_var($name, $default='') {
     if (array_key_exists($name, $_COOKIE)) {
         return clean_var($_COOKIE[$name]);
@@ -1058,6 +1074,10 @@ 
     }
 }
 
+/**
+ * @param integer $major
+ * @param MySociety\TheyWorkForYou\Url $LISTURL
+ */
 function _major_summary_title($major, $data, $LISTURL, $daytext) {
     global $hansardmajors;
 
@@ -1107,6 +1127,9 @@ 
     return $return;
 }
 
+/**
+ * @param string|null $url
+ */
 function redirect($url) {
     if (defined('TESTING')) {
         print "Location: $url";

classes/Url.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
     /**
      * Remove Session Key/Value Pair
      *
-     * @param array $arr A list array of key names to remove
+     * @param string[] $arr A list array of key names to remove
      */
 
     public function remove($arr) {