Merge pull request #6071 from sudhabisht/CRM-16719
[civicrm-core.git] / CRM / Upgrade / Incremental / Legacy.php
index 7743a01e00205e7996b01feac5651af676ee545f..c0175dce1b246538da009c0077b1bfc5e72f8c28 100644 (file)
@@ -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.                                    |
  |                                                                    |
  | 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$
  *
  */
 class CRM_Upgrade_Incremental_Legacy {
 
   /**
-   * Compute any messages which should be displayed before upgrade
+   * Compute any messages which should be displayed before upgrade.
    *
-   * @param $preUpgradeMessage
-   *   String, alterable.
+   * @param string $preUpgradeMessage
+   *   alterable.
    * @param $currentVer
    * @param $latestVer
    */
@@ -81,7 +81,10 @@ SELECT  id
       version_compare($upgradeTo, '3.4.beta3') >= 0
     ) {
       $config = CRM_Core_Config::singleton();
-      $preUpgradeMessage .= '<br />' . ts("As per <a href='%1'>the related blog post</a>, we are making contact names, addresses and mailings monolingual; the values entered for the default locale (%2) will be preserved and values for other locales removed.", array(1 => 'http://civicrm.org/blogs/shot/multilingual-civicrm-3440-making-some-fields-monolingual', 2 => $config->lcMessages));
+      $preUpgradeMessage .= '<br />' . ts("As per <a href='%1'>the related blog post</a>, we are making contact names, addresses and mailings monolingual; the values entered for the default locale (%2) will be preserved and values for other locales removed.", array(
+            1 => 'http://civicrm.org/blogs/shot/multilingual-civicrm-3440-making-some-fields-monolingual',
+            2 => $config->lcMessages,
+          ));
     }
 
     if (version_compare($currentVer, '3.4.6') == -1 &&
@@ -103,13 +106,13 @@ SELECT  id
     if (file_exists($ofcFile)) {
       if (@unlink($ofcFile)) {
         $preUpgradeMessage .= '<br />' . ts('This system included an outdated, insecure script (%1). The file was automatically deleted.', array(
-          1 => $ofcFile,
-        ));
+            1 => $ofcFile,
+          ));
       }
       else {
         $preUpgradeMessage .= '<br />' . ts('This system includes an outdated, insecure script (%1). Please delete it.', array(
-          1 => $ofcFile,
-        ));
+            1 => $ofcFile,
+          ));
       }
     }
 
@@ -158,9 +161,9 @@ SELECT  id
       return;
     }
 
-    $html     = NULL;
+    $html = NULL;
     $pathName = dirname(dirname(__FILE__));
-    $flag     = FALSE;
+    $flag = FALSE;
     foreach ($workflows as $workflow => $title) {
       $name = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
         $workflow,
@@ -198,17 +201,20 @@ SELECT  id
     if ($flag == TRUE) {
       $html = "<ul>" . $html . "<ul>";
 
-      $message .= '<br />' . ts("The default copies of the message templates listed below will be updated to handle new features or correct a problem. Your installation has customized versions of these message templates, and you will need to apply the updates manually after running this upgrade. <a href='%1' style='color:white; text-decoration:underline; font-weight:bold;' target='_blank'>Click here</a> for detailed instructions. %2", array(1 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Message+Templates#MessageTemplates-UpgradesandCustomizedSystemWorkflowTemplates', 2 => $html));
+      $message .= '<br />' . ts("The default copies of the message templates listed below will be updated to handle new features or correct a problem. Your installation has customized versions of these message templates, and you will need to apply the updates manually after running this upgrade. <a href='%1' style='color:white; text-decoration:underline; font-weight:bold;' target='_blank'>Click here</a> for detailed instructions. %2", array(
+            1 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Message+Templates#MessageTemplates-UpgradesandCustomizedSystemWorkflowTemplates',
+            2 => $html,
+          ));
     }
   }
 
   /**
-   * Compute any messages which should be displayed after upgrade
+   * Compute any messages which should be displayed after upgrade.
    *
-   * @param $postUpgradeMessage
-   *   String, alterable.
-   * @param $rev
-   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+   * @param string $postUpgradeMessage
+   *   alterable.
+   * @param string $rev
+   *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public static function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
@@ -242,7 +248,10 @@ SELECT  id
 
         if (!empty($subTypeTemplates)) {
           $subTypeTemplates = implode(',', $subTypeTemplates);
-          $postUpgradeMessage .= '<br />' . ts('You are using custom template for contact subtypes: %1.', array(1 => $subTypeTemplates)) . '<br />' . ts('You need to move these subtype templates to the SubType directory in %1 and %2 respectively.', array(1 => 'CRM/Contact/Form/Edit', 2 => 'CRM/Contact/Page/View'));
+          $postUpgradeMessage .= '<br />' . ts('You are using custom template for contact subtypes: %1.', array(1 => $subTypeTemplates)) . '<br />' . ts('You need to move these subtype templates to the SubType directory in %1 and %2 respectively.', array(
+                1 => 'CRM/Contact/Form/Edit',
+                2 => 'CRM/Contact/Page/View',
+              ));
         }
       }
     }
@@ -270,10 +279,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_alpha1($rev) {
     for ($stepID = 1; $stepID <= 4; $stepID++) {
@@ -295,9 +304,9 @@ SELECT  count( id ) as statusCount
       $template = CRM_Core_Smarty::singleton();
 
       $eventFees = array();
-      $query     = "SELECT og.id ogid FROM civicrm_option_group og WHERE og.name LIKE  %1";
-      $params    = array(1 => array('civicrm_event_page.amount%', 'String'));
-      $dao       = CRM_Core_DAO::executeQuery($query, $params);
+      $query = "SELECT og.id ogid FROM civicrm_option_group og WHERE og.name LIKE  %1";
+      $params = array(1 => array('civicrm_event_page.amount%', 'String'));
+      $dao = CRM_Core_DAO::executeQuery($query, $params);
       while ($dao->fetch()) {
         $eventFees[$dao->ogid] = $dao->ogid;
       }
@@ -315,10 +324,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_1_2($rev) {
     $formName = "CRM_Upgrade_TwoOne_Form_TwoOneTwo";
@@ -343,9 +352,8 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * This function should check if if need to skip current sql file
+   * This function should check if if need to skip current sql file.
    * Name of this function will change according to the latest release
-   *
    */
   public static function upgrade_2_2_alpha3($rev) {
     // skip processing sql file, if fresh install -
@@ -357,10 +365,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta1($rev) {
     if (!CRM_Core_DAO::checkFieldExists('civicrm_pcp_block', 'notify_email')) {
@@ -372,21 +380,23 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta2($rev) {
     $template = CRM_Core_Smarty::singleton();
     if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
-        'CRM_Contact_Form_Search_Custom_ZipCodeRange', 'id', 'name'
-      )) {
+      'CRM_Contact_Form_Search_Custom_ZipCodeRange', 'id', 'name'
+    )
+    ) {
       $template->assign('customSearchAbsentAll', TRUE);
     }
     elseif (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
-        'CRM_Contact_Form_Search_Custom_MultipleValues', 'id', 'name'
-      )) {
+      'CRM_Contact_Form_Search_Custom_MultipleValues', 'id', 'name'
+    )
+    ) {
       $template->assign('customSearchAbsent', TRUE);
     }
     $upgrade = new CRM_Upgrade_Form();
@@ -394,10 +404,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta3($rev) {
     $template = CRM_Core_Smarty::singleton();
@@ -410,10 +420,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_alpha1($rev) {
 
@@ -431,10 +441,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_alpha1($rev) {
 
@@ -452,10 +462,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_7($rev) {
     $upgrade = new CRM_Upgrade_Form();
@@ -485,10 +495,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_2($rev) {
 
@@ -508,10 +518,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_4($rev) {
     //make sure 'Deceased' membership status present in db,CRM-5636
@@ -529,17 +539,19 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_0($rev) {
     // upgrade all roles who have 'access CiviEvent' permission, to also have
     // newly added permission 'edit_all_events', CRM-5472
     $config = CRM_Core_Config::singleton();
     if (is_callable(array(
-      $config->userSystem, 'replacePermission'))) {
+      $config->userSystem,
+      'replacePermission',
+    ))) {
       $config->userSystem->replacePermission('access CiviEvent', array('access CiviEvent', 'edit all events'));
     }
 
@@ -558,10 +570,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_3($rev) {
     $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
@@ -572,10 +584,10 @@ SELECT  count( id ) as statusCount
   }
 
   /**
-   * Perform an incremental upgrade
+   * Perform an incremental upgrade.
    *
-   * @param $rev
-   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+   * @param string $rev
+   *   the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_4($rev) {
     $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
@@ -584,4 +596,5 @@ SELECT  count( id ) as statusCount
     $upgrade = new CRM_Upgrade_Form();
     $upgrade->processSQL($rev);
   }
+
 }