Merge pull request #3810 from colemanw/dynPath

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

diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php
index 9f01f56a6e6f42fbb407cbdc6e8c1a8124bba49c..0863962d248de2c03143926775cf033c60299d1e 100644 (file)
--- a/CRM/Campaign/BAO/Petition.php
+++ b/CRM/Campaign/BAO/Petition.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,11 +28,14 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey {
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
     // expire cookie in one day
@@ -55,7 +58,7 @@ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey {
         'sortOrder' => 'desc',
       );
       foreach ($sortParams as $name => $default) {
-        if (CRM_Utils_Array::value($name, $params)) {
+        if (!empty($params[$name])) {
           $sortParams[$name] = $params[$name];
         }
       }
@@ -95,11 +98,11 @@ INNER JOIN civicrm_option_group grp ON ( activity_type.option_group_id = grp.id
       $where[] = "( petition.activity_type_id = %1 )";
       $queryParams[1] = array($petitionTypeID, 'Positive');
     }
-    if (CRM_Utils_Array::value('title', $params)) {
+    if (!empty($params['title'])) {
       $where[] = "( petition.title LIKE %2 )";
       $queryParams[2] = array('%' . trim($params['title']) . '%', 'String');
     }
-    if (CRM_Utils_Array::value('campaign_id', $params)) {
+    if (!empty($params['campaign_id'])) {
       $where[] = '( petition.campaign_id = %3 )';
       $queryParams[3] = array($params['campaign_id'], 'Positive');
     }
@@ -194,7 +197,6 @@ SELECT  petition.id                         as id,
       $surveyInfo = CRM_Campaign_BAO_Petition::getSurveyInfo($params['sid']);
 
       // create activity
-      // activity status id (from /civicrm/admin/optionValue?reset=1&action=browse&gid=25)
       // 1-Schedule, 2-Completed
 
       $activityParams = array(
@@ -213,7 +215,7 @@ SELECT  petition.id                         as id,
       $activity = CRM_Activity_BAO_Activity::create($activityParams);
 
       // save activity custom data
-      if (CRM_Utils_Array::value('custom', $params) &&
+      if (!empty($params['custom']) &&
         is_array($params['custom'])
       ) {
         CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_activity', $activity->id);
@@ -226,6 +228,13 @@ SELECT  petition.id                         as id,
     return $activity;
   }
 
+  /**
+   * @param $activity_id
+   * @param $contact_id
+   * @param $petition_id
+   *
+   * @return bool
+   */
   function confirmSignature($activity_id, $contact_id, $petition_id) {
     // change activity status to completed (status_id = 2)
     // I wonder why do we need contact_id when we have activity_id anyway? [chastell]
@@ -272,8 +281,11 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
   /**
    * Function to get Petition Signature Total
    *
-   * @param boolean $all
-   * @param int $id
+   * @param $surveyId
+   *
+   * @return array
+   * @internal param bool $all
+   * @internal param int $id
    * @static
    */
   static function getPetitionSignatureTotalbyCountry($surveyId) {
@@ -314,8 +326,11 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
   /**
    * Function to get Petition Signature Total
    *
-   * @param boolean $all
-   * @param int $id
+   * @param $surveyId
+   *
+   * @return array
+   * @internal param bool $all
+   * @internal param int $id
    * @static
    */
   static function getPetitionSignatureTotal($surveyId) {
@@ -340,6 +355,11 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
   }
 
 
+  /**
+   * @param null $surveyId
+   *
+   * @return array
+   */
   public static function getSurveyInfo($surveyId = NULL) {
     $surveyInfo = array();
 
@@ -369,8 +389,12 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
   /**
    * Function to get Petition Signature Details
    *
-   * @param boolean $all
-   * @param int $id
+   * @param $surveyId
+   * @param null $status_id
+   *
+   * @return array
+   * @internal param bool $all
+   * @internal param int $id
    * @static
    */
   static function getPetitionSignature($surveyId, $status_id = NULL) {
@@ -467,6 +491,8 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
    *
    * @param int $surveyId
    * @param int $contactId
+   *
+   * @return array
    * @static
    */
   static function checkSignature($surveyId, $contactId) {
@@ -518,8 +544,11 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
    *
    * @param array $params (reference ) an assoc array of name/value pairs
    *
-   * @return
-   * @access public
+   * @param $sendEmailMode
+   *
+   * @throws Exception
+   * @return void
+  @access public
    * @static
    */
   public static function sendEmail($params, $sendEmailMode) {