From d83a3991c7f830d4f44847907f163b11b66cf3c7 Mon Sep 17 00:00:00 2001
From: vivekarora <vivek11112@gmail.com>
Date: Mon, 26 Aug 2013 13:31:29 +0530
Subject: [PATCH] CRM-13187 -  Word Replacement API,BAO and XML

----------------------------------------
* CRM-13187: hrui: Change breadcrumb from "CiviCRM" to "CiviHR"
  http://issues.civicrm.org/jira/browse/CRM-13187
---
 CRM/Core/BAO/WordReplacement.php    | 178 ++++++++++++++++++++++++++++
 api/v3/WordReplacement.php          |  91 ++++++++++++++
 xml/schema/Core/WordReplacement.xml |  59 +++++++++
 3 files changed, 328 insertions(+)
 create mode 100644 CRM/Core/BAO/WordReplacement.php
 create mode 100644 api/v3/WordReplacement.php
 create mode 100644 xml/schema/Core/WordReplacement.xml

diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php
new file mode 100644
index 0000000000..4968492a4e
--- /dev/null
+++ b/CRM/Core/BAO/WordReplacement.php
@@ -0,0 +1,178 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | 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-2013
+ * $Id$
+ *
+ */
+
+/**
+ *
+ */
+class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement {
+
+  function __construct() {
+    parent::__construct();
+  }  
+  /**
+   * Takes a bunch of params that are needed to match certain criteria and
+   * retrieves the relevant objects. 
+   *
+   * @param array $params   (reference ) an assoc array of name/value pairs
+   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   *
+   * @return object CRM_Core_DAO_WordRepalcement object
+   * @access public
+   * @static
+   */
+    
+  static function retrieve(&$params, &$defaults) {
+    return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_WordRepalcement', $params, $defaults);
+  }
+
+  /**
+   * Get the domain BAO
+   *
+   * @return null|object CRM_Core_BAO_WordRepalcement
+   * @access public
+   * @static
+   */
+  static function getWordReplacement($reset = null) {
+    static $wordReplacement = NULL;
+    if (!$wordReplacement || $reset) {
+      $wordReplacement = new CRM_Core_BAO_WordRepalcement();
+      $wordReplacement->id = CRM_Core_Config::wordReplacementID();
+      if (!$wordReplacement->find(TRUE)) {
+        CRM_Core_Error::fatal();
+      }
+    }
+    return $wordReplacement;
+  }
+
+
+  /**
+   * Save the values of a WordReplacement
+   *
+   * @return WordReplacement array
+   * @access public
+   */
+  static function edit(&$params, &$id) {
+    $wordReplacement = new CRM_Core_DAO_WordReplacement();
+    $wordReplacement->id = $id;
+    $wordReplacement->copyValues($params);
+    $wordReplacement->save();
+    self::rebuild();
+    return $wordReplacement;
+  }
+
+  /**
+   * Create a new WordReplacement
+   *
+   * @return WordReplacement array
+   * @access public
+   */
+  static function create($params) {
+    if(array_key_exists("domain_id",$params) === false) {
+      $params["domain_id"] = CRM_Core_Config::domainID();  
+    }  
+    $wordReplacement = new CRM_Core_DAO_WordReplacement();
+    $wordReplacement->copyValues($params);
+    $wordReplacement->save();
+    self::rebuild();
+    return $wordReplacement;
+  }
+  
+  /**
+   * Delete website
+   *
+   * @param int $id WordReplacement id
+   *
+   * @return object
+   * @static
+   */
+  static function del($id) {
+    $dao = new CRM_Core_DAO_WordReplacement();
+    $dao->id = $id;
+    $dao->delete();
+    self::rebuild();
+    return $dao;
+  }
+  
+  /*
+   *   Rebuild 
+   */
+
+  static function rebuild() {
+    $id = CRM_Core_Config::domainID();  
+    $query = "SELECT find_word,replace_word FROM civicrm_word_replacement WHERE is_active = 1 AND domain_id = ".CRM_Utils_Type::escape($id, 'Integer');
+    $dao = CRM_Core_DAO::executeQuery($query);
+    $wordReplacement = array(); 
+    
+    while ($dao->fetch()) {
+      $wordReplacement[$dao->find_word] = $dao->replace_word;
+    }
+    
+    $overrides['enabled']['wildcardMatch'] = $wordReplacement;
+    
+    $config = CRM_Core_Config::singleton();
+    $domain = new CRM_Core_DAO_Domain();
+    $domain->find(TRUE);
+
+    if ($domain->locales && $config->localeCustomStrings) {
+      // for multilingual
+      $addReplacements = $config->localeCustomStrings;
+      $addReplacements[$config->lcMessages] = $overrides;
+      $stringOverride = serialize($addReplacements);
+    }
+    else {
+      // for single language
+      $stringOverride = serialize(array($config->lcMessages => $overrides));
+    }
+
+    $params = array('locale_custom_strings' => $stringOverride);
+    
+
+    $wordReplacementSettings = CRM_Core_BAO_Domain::edit($params, $id);
+
+    if ($wordReplacementSettings) {
+      // Reset navigation
+      CRM_Core_BAO_Navigation::resetNavigation();
+      // Clear js string cache
+      CRM_Core_Resources::singleton()->flushStrings();
+      
+      return true;
+    }
+    
+    return false;
+   
+  }
+    
+}
+
diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php
new file mode 100644
index 0000000000..7a1e2877c9
--- /dev/null
+++ b/api/v3/WordReplacement.php
@@ -0,0 +1,91 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*/
+
+/**
+ * File for the CiviCRM APIv3 domain functions
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_WordReplacement
+ *
+ * @copyright CiviCRM LLC (c) 2004-2013
+ * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
+ *
+ */
+
+/**
+ * Get CiviCRM Word Replacement details
+ * {@getfields word_replacement_create}
+ * 
+ */
+function civicrm_api3_word_replacement_get($params) {
+  $bao = new CRM_Core_BAO_WordReplacement();
+  _civicrm_api3_dao_set_filter($bao, $params, true, 'WordReplacement');
+  $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, true,'WordReplacement');
+
+  return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao);
+}
+
+
+/**
+ * Create a new Word Replacement
+ *
+ * @param array $params
+ *
+ * @return array
+ * 
+ * {@getfields word_replacement_create}
+ */
+function civicrm_api3_word_replacement_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Adjust Metadata for Create action
+ *
+ * The metadata is used for setting defaults, documentation & validation
+ * @param array $params array or parameters determined by getfields
+ */
+function _civicrm_api3_word_replacement_create_spec(&$params) {
+  unset($params['version']);
+}
+
+/**
+ * delete an existing word_replacement
+ *
+ *
+ * @param array $params  (reference) array containing id of the word_replacement
+ *                       to be deleted
+ *
+ * @return array  (referance) returns flag true if successfull, error
+ *                message otherwise
+ *
+ * @access public
+ */
+function civicrm_api3_word_replacement_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
\ No newline at end of file
diff --git a/xml/schema/Core/WordReplacement.xml b/xml/schema/Core/WordReplacement.xml
new file mode 100644
index 0000000000..eabc58f911
--- /dev/null
+++ b/xml/schema/Core/WordReplacement.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<table>
+  <base>CRM/Core</base>
+  <class>WordReplacement</class>
+  <name>civicrm_word_replacement</name>
+  <comment>Top-level hierarchy to support word replacement.</comment>
+  <add>4.4</add>
+  <field>
+    <name>id</name>
+    <type>int unsigned</type>
+    <required>true</required>
+    <comment>Word replacement ID</comment>
+    <add>4.4</add>
+  </field>
+  <primaryKey>
+    <name>id</name>
+    <autoincrement>true</autoincrement>
+  </primaryKey>
+  <field>
+    <name>find_word</name>
+    <type>varchar</type>
+    <length>255</length>
+    <comment>Word which need to be replaced</comment>
+    <add>4.4</add>
+  </field>
+  <field>
+    <name>replace_word</name>
+    <type>varchar</type>
+    <length>255</length>
+    <comment>Word which will replace the word in find</comment>
+    <add>4.4</add>
+  </field>
+  <field>
+    <name>is_active</name>
+    <title>Word Replacement is Active</title>
+    <type>boolean</type>
+    <comment>Is this entry active?</comment>
+    <add>4.4</add>
+  </field>
+  <index>
+    <name>UI_find</name>
+    <fieldName>find_word</fieldName>
+    <unique>true</unique>
+    <add>4.4</add>
+  </index>
+  <field>
+    <name>domain_id</name>
+    <type>int unsigned</type>
+    <comment>FK to Domain ID. This is for Domain specific word replacement</comment>
+    <add>1.1</add>
+  </field>
+  <foreignKey>
+    <name>domain_id</name>
+    <table>civicrm_domain</table>
+    <key>id</key>
+    <add>1.1</add>
+  </foreignKey>
+</table>
-- 
2.25.1