JacksonRiver / springboard_modules

capwiz_connect/capwiz_connect_js/capwiz_connect_js.module

Doc Comments +4 added lines

@@ -242,6 +242,7 @@ 
  *    The capwiz object to work with, either an action or a user
  * @param Array
  *    The full array of data returned from the capwiz form
+ * @param string $type
  * @return Object
  *    An object of values depending on the type
  */
@@ -326,6 +327,9 @@ 
   return $values;
 }
 
+/**
+ * @param string $field
+ */
 function _capwiz_connect_js_preg_array_keys($field, $array) {
   $pattern = '/' . str_replace('%int', '[0-9]+', $field) . '/';
   $keys = array_keys($array);

capwiz_connect/CapwizConnect.inc

Doc Comments +1 added lines, -1 removed lines

@@ -347,7 +347,7 @@
   /**
    * Get the definition of a specific user field
    *
-   * @param $field_name
+   * @param string $field_name
    *   Key of the custom field, matching to the field->name value
    */
   public function getSpecificCustomUserField($field_name) {

dsr/dsr.email.inc

Doc Comments +6 added lines

@@ -120,11 +120,17 @@
 
 }
 
+/**
+ * @param string $type
+ */
 function dsr_email_report_link($type, $start_date, $end_date) {
   global $base_url;
   return $base_url . '/' . DSR_RECONCILIATION_PATH . '/report/' . $type . '/' . date('Y-m-d', strtotime($start_date)) . '/' . date('Y-m-d', strtotime($end_date)) . "\n";
 }
 
+/**
+ * @param string $suffix
+ */
 function _dsr_text_results($suffix, $stats) {
   if (isset($stats["salesforce_$suffix"]['types'])) {
     foreach ($stats["salesforce_$suffix"]['types'] as $label => $data) {

dsr/dsr.module

Doc Comments +5 added lines, -1 removed lines

@@ -443,7 +443,7 @@ 
 /**
  * Runs soql statements to retrieve donations.
  *
- * @param $soql
+ * @param string $soql
  *   The SOQL select statement to run.
  */
 function _dsr_run_soql_opportunity_select($soql) {
@@ -551,6 +551,10 @@ 
   return _dsr_compile_dates($date1, $date2);
 }
 
+/**
+ * @param string|null $date1
+ * @param string|null $date2
+ */
 function _dsr_compile_dates($date1, $date2) {
   return array(
     'start' => $date1,

dsr/includes/dsr.queries.inc

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 /**
  * Perform aggregate query on Salesforce data by donation status and date range
  *
- * @param type $status
+ * @param string $status
  * @param type $start_date
  * @param type $end_date
  * @return type

email_wrappers/email_wrappers.module

Doc Comments +4 added lines, -2 removed lines

@@ -630,7 +630,7 @@ 
  * email template node object.
  *
  * @return
- * returns BCC field values as a comma-separated string.
+ string returns BCC field values as a comma-separated string.
  */
 function _email_wrappers_concat_bcc($node) {
   $bccs = array();
@@ -650,7 +650,7 @@ 
  * @param $form
  * form array
  *
- * @param $field_key
+ * @param string $field_key
  * Valid options: subject, from_name, from_address
  *
  * @param $value
@@ -672,6 +672,7 @@ 
 
 /**
  * Generate modal preview.
+ * @param string $op
  */
 function _email_wrappers_preview($op, $message, $nid) {
 
@@ -707,6 +708,7 @@ 
 /**
  * Quick and dirty helper function to dredge up the cid of a webform component
  * given the standard array of components and a form key.
+ * @param string $form_key
  */
 function _email_wrappers_get_cid($components, $form_key) {
   foreach ($components as $cid => $component) {

fundraiser/fundraiser.module

Doc Comments +7 added lines, -1 removed lines

@@ -674,7 +674,7 @@ 
  *    An array of values usually from the field configuration
  * @param $fieldset Array
  *    Formapi fieldset
- * @param $name String
+ * @param string $name String
  *    Name of the fieldset
  *
  * @return Array
@@ -845,6 +845,7 @@ 
 
 /**
  * Generate donation ask amount fields, used by donation form
+ * @param integer $index
  */
 function _fundraiser_ask_form($amount_values = array(), $index, $node) {
   $form['amount'] = array(
@@ -1247,6 +1248,7 @@ 
 /**
  * Process through given submission fields to change their display form on the fly. Recursive.
  * Calling module provides the identity of the display glue module. Usually webform, could be sustainers.
+ * @param string $calling_module
  */
 function fundraiser_display_form_fields($calling_module, &$form, $form_state, $field_info = NULL) {
   if ($field_info == NULL) {
@@ -1499,6 +1501,7 @@ 
 
 /**
  * Donation processing, a given donation needs to be commented on.
+ * @param string $comment
  */
 function fundraiser_donation_comment($donation, $comment, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
   // Make a log entry
@@ -2136,6 +2139,7 @@ 
 
 /**
  * Create a refund object.
+ * @param stdClass $refund
  */
 function fundraiser_refund_create($refund) {
   // Call hooks to create the donation. The glue module handles everything else once handed fundraisers info.
@@ -2379,6 +2383,7 @@ 
 /**
  * Helper function, check if given string is an email format. Generically useful function.
  * Future plans: this may need to be moved to a toolkit module for use by all our modules.
+ * @param string $mail
  */
 function _fundraiser_validate_email($mail) {
   // eregi is depr in PHP 5.3. Replaced with preg_match, adding lower case options.
@@ -2732,6 +2737,7 @@ 
 
 /**
  * DB function for updating the stats in fundraiser_tracking.
+ * @param string $field
  */
 function _fundraiser_update_tracking_value($nid, $field) {
   $tracking = _fundraiser_get_tracking_by_nid($nid);

fundraiser/modules/fundraiser_ab/fundraiser_ab.module

Doc Comments +1 added lines

@@ -63,6 +63,7 @@
 /**
  * Implements hook_webform_ab_valid_webforms().
  * Return an array of donation forms that may be included in an A/B Test.
+ * @param string $webform_types
  */
 function fundraiser_ab_webform_ab_valid_webforms($webform_types) {
   if ($webform_types == 'fundraiser') {

fundraiser/modules/fundraiser_commerce/fundraiser_commerce.module

Doc Comments +3 added lines

@@ -1511,6 +1511,7 @@ 
 
 /**
  * Helper function, derives a valid username from an e-mail address.
+ * @param string $email
  */
 function _fundraiser_commerce_email_to_username($email) {
   $name = substr($email, 0, strpos($email, '@'));
@@ -1693,6 +1694,8 @@ 
 
 /**
  * Helper function, wrapper for encrypt function.
+ * @param string $input
+ * @return string
  */
 function _fundraiser_commerce_encrypt($input) {
   if (module_exists('encrypt')) {