Merge branch '4.6' into 'master'

[civicrm-core.git] / CRM / Campaign / BAO / Survey.php

diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php
index 96661f31b20117e7571c50a1cc47547dbdd5a61b..45ecdd462b0a2b5895e37f43d15ef13dfb46e74b 100644 (file)
--- a/CRM/Campaign/BAO/Survey.php
+++ b/CRM/Campaign/BAO/Survey.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -40,21 +40,14 @@ require_once 'CRM/Campaign/DAO/Survey.php';
 class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey {
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * campaign_id.
+   * Retrieve DB object based on input parameters.
+   *
+   * It also stores all the retrieved values in the default array.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
-   */
-
-  /**
-   * The action links that we need to display for the browse screen
-   *
-   * @param array $params
-   * @param $defaults
    *
    * @return CRM_Campaign_DAO_Survey|null
    */
@@ -71,7 +64,7 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey {
   }
 
   /**
-   * Takes an associative array and creates a Survey object
+   * Takes an associative array and creates a Survey object.
    *
    * the function extract all the params it needs to initialize the create a
    * survey object.
@@ -246,7 +239,7 @@ SELECT  survey.id                         as id,
   }
 
   /**
-   * Get Surveys
+   * Get Surveys.
    *
    * @param bool $onlyActive
    *   Retrieve only active surveys.
@@ -306,14 +299,9 @@ SELECT  survey.id    as id,
   }
 
   /**
-   * Get Surveys activity types
-   *
-   *
+   * Get Survey activity types.
    */
-  static function getSurveyActivityType(
-    $returnColumn = 'label',
-    $includePetitionActivityType = FALSE
-  ) {
+  public static function getSurveyActivityType($returnColumn = 'label', $includePetitionActivityType = FALSE) {
     static $activityTypes;
     $cacheKey = "{$returnColumn}_{$includePetitionActivityType}";
 
@@ -341,7 +329,7 @@ SELECT  survey.id    as id,
   }
 
   /**
-   * Get Surveys custom groups
+   * Get Surveys custom groups.
    *
    * @param array $surveyTypes
    *   an array of survey type id.
@@ -381,7 +369,7 @@ SELECT  survey.id    as id,
   }
 
   /**
-   * Update the is_active flag in the db
+   * Update the is_active flag in the db.
    *
    * @param int $id
    *   Id of the database record.
@@ -389,14 +377,14 @@ SELECT  survey.id    as id,
    *   Value we want to set the is_active field.
    *
    * @return Object
-   *   DAO object on sucess, null otherwise
+   *   DAO object on success, null otherwise
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Campaign_DAO_Survey', $id, 'is_active', $is_active);
   }
 
   /**
-   * Delete the survey
+   * Delete the survey.
    *
    * @param int $id
    *   Survey id.
@@ -449,7 +437,7 @@ SELECT  survey.id    as id,
     foreach ($returnProperties as $property => $ignore) {
       $value = (in_array($property, array(
         'city',
-        'street_address'
+        'street_address',
       ))) ? 'address' : $property;
       switch ($property) {
         case 'sort_name':
@@ -522,9 +510,7 @@ Group By  contact.id";
    * @return array
    *   array of survey activity.
    */
-  static function voterActivityDetails(
-    $surveyId, $voterIds, $interviewerId = NULL,
-    $statusIds = array()) {
+  public static function voterActivityDetails($surveyId, $voterIds, $interviewerId = NULL, $statusIds = array()) {
     $activityDetails = array();
     if (!$surveyId ||
       !is_array($voterIds) || empty($voterIds)
@@ -585,7 +571,7 @@ INNER JOIN  civicrm_activity_contact activityAssignment
    * @return array
    *   An array of survey activity.
    */
-  static function getSurveyActivities(
+  public static function getSurveyActivities(
     $surveyId,
     $interviewerId = NULL,
     $statusIds = NULL,
@@ -718,7 +704,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
   }
 
   /**
-   * This function retrieve all option groups which are created as a result set
+   * This function retrieve all option groups which are created as a result set.
    *
    * @param string $valueColumnName
    * @return array
@@ -742,7 +728,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
    *
    * @param int $activityId
    *   Activity id.
-   * @return boolean
+   * @return bool
    */
   public static function isSurveyActivity($activityId) {
     $isSurveyActivity = FALSE;
@@ -766,7 +752,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
   }
 
   /**
-   * This function retrive all response options of survey
+   * This function retrive all response options of survey.
    *
    * @param int $surveyId
    *   Survey id.
@@ -788,7 +774,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
   }
 
   /**
-   * This function return all voter links with respecting permissions
+   * This function return all voter links with respecting permissions.
    *
    * @param int $surveyId
    * @param bool $enclosedInUL
@@ -840,13 +826,12 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
     if (CRM_Core_Permission::check('access CiviReport')) {
       $reportID = self::getReportID($surveyId);
       if ($reportID) {
-        $voterLinks['report'] =
-          array(
-            'name' => 'report',
-            'url' => "civicrm/report/instance/{$reportID}",
-            'qs' => 'reset=1',
-            'title' => ts('View Survey Report'),
-          );
+        $voterLinks['report'] = array(
+          'name' => 'report',
+          'url' => "civicrm/report/instance/{$reportID}",
+          'qs' => 'reset=1',
+          'title' => ts('View Survey Report'),
+        );
       }
     }
 
@@ -941,7 +926,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
   }
 
   /**
-   * Get survey supportable profile types
+   * Get survey supportable profile types.
    */
   public static function surveyProfileTypes() {
     static $profileTypes;
@@ -955,7 +940,7 @@ INNER JOIN  civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
   }
 
   /**
-   * Get the valid survey response fields those
+   * Get the valid survey response fields those.
    * are configured with profile and custom fields.
    *
    * @param int $surveyId
@@ -1147,10 +1132,11 @@ UPDATE  civicrm_activity
       case 'activity_type_id':
         $campaignCompId = CRM_Core_Component::getComponentID('CiviCampaign');
         if ($campaignCompId) {
-          $params['condition'] = array("component_id={$campaignCompId}", "v.name != 'Petition'");
+          $params['condition'] = array("component_id={$campaignCompId}");
         }
         break;
     }
     return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
   }
+
 }