CRM/Core/ShowHideBlocks.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Core_ShowHideBlocks {
  36
  37   /**
  38    * The icons prefixed to block show and hide links.
  39    *
  40    * @var string
  41    */
  42   static $_showIcon, $_hideIcon;
  43
  44   /**
  45    * The array of ids of blocks that will be shown
  46    *
  47    * @var array
  48    */
  49   protected $_show;
  50
  51   /**
  52    * The array of ids of blocks that will be hidden
  53    *
  54    * @var array
  55    */
  56   protected $_hide;
  57
  58   /**
  59    * Class constructor
  60    *
  61    * @param array $show
  62    *   Initial value of show array.
  63    * @param array $hide
  64    *   Initial value of hide array.
  65    *
  66    * @return \CRM_Core_ShowHideBlocks the newly created object
  67    * @access public
  68    */
  69   public function __construct($show = NULL, $hide = NULL) {
  70     if (!empty($show)) {
  71       $this->_show = $show;
  72     }
  73     else {
  74       $this->_show = array();
  75     }
  76
  77     if (!empty($hide)) {
  78       $this->_hide = $hide;
  79     }
  80     else {
  81       $this->_hide = array();
  82     }
  83   }
  84
  85   /**
  86    * Load icon vars used in hide and show links
  87    *
  88    * @return void
  89    * @static
  90    */
  91   public static function setIcons() {
  92     if (!isset(self::$_showIcon)) {
  93       $config = CRM_Core_Config::singleton();
  94       self::$_showIcon = '<img src="' . $config->resourceBase . 'i/TreePlus.gif" class="action-icon" alt="' . ts('show field or section') . '"/>';
  95       self::$_hideIcon = '<img src="' . $config->resourceBase . 'i/TreeMinus.gif" class="action-icon" alt="' . ts('hide field or section') . '"/>';
  96     }
  97   }
  98
  99   /**
 100    * Add the values from this class to the template
 101    *
 102    * @return void
 103    */
 104   public function addToTemplate() {
 105     $hide = $show = '';
 106
 107     $first = TRUE;
 108     foreach (array_keys($this->_hide) as $h) {
 109       if (!$first) {
 110         $hide .= ',';
 111       }
 112       $hide .= "'$h'";
 113       $first = FALSE;
 114     }
 115
 116     $first = TRUE;
 117     foreach (array_keys($this->_show) as $s) {
 118       if (!$first) {
 119         $show .= ',';
 120       }
 121       $show .= "'$s'";
 122       $first = FALSE;
 123     }
 124
 125     $template = CRM_Core_Smarty::singleton();
 126     $template->assign_by_ref('hideBlocks', $hide);
 127     $template->assign_by_ref('showBlocks', $show);
 128   }
 129
 130   /**
 131    * Add a value to the show array
 132    *
 133    * @param string $name
 134    *   Id to be added.
 135    *
 136    * @return void
 137    */
 138   public function addShow($name) {
 139     $this->_show[$name] = 1;
 140     if (array_key_exists($name, $this->_hide)) {
 141       unset($this->_hide[$name]);
 142     }
 143   }
 144
 145   /**
 146    * Add a value to the hide array
 147    *
 148    * @param string $name
 149    *   Id to be added.
 150    *
 151    * @return void
 152    */
 153   public function addHide($name) {
 154     $this->_hide[$name] = 1;
 155     if (array_key_exists($name, $this->_show)) {
 156       unset($this->_show[$name]);
 157     }
 158   }
 159
 160   /**
 161    * Create a well formatted html link from the smaller pieces
 162    *
 163    * @param string $name
 164    *   Name of the link.
 165    * @param string $href
 166    * @param string $text
 167    * @param string $js
 168    *
 169    * @return string
 170    *   the formatted html link
 171    */
 172   public static function linkHtml($name, $href, $text, $js) {
 173     return '<a name="' . $name . '" id="' . $name . '" href="' . $href . '" ' . $js . ">$text</a>";
 174   }
 175
 176   /**
 177    * Create links that we can use in the form
 178    *
 179    * @param CRM_Core_Form $form
 180    *   The form object.
 181    * @param string $prefix
 182    *   The attribute that we are referencing.
 183    * @param string $showLinkText
 184    *   The text to be shown for the show link.
 185    * @param string $hideLinkText
 186    *   The text to be shown for the hide link.
 187    *
 188    * @param bool $assign
 189    *
 190    * @static
 191    *
 192    * @return void
 193    */
 194   public static function links(&$form, $prefix, $showLinkText, $hideLinkText, $assign = TRUE) {
 195     $showCode = "cj('#id_{$prefix}').show(); cj('#id_{$prefix}_show').hide();";
 196     $hideCode = "cj('#id_{$prefix}').hide(); cj('#id_{$prefix}_show').show(); return false;";
 197
 198     self::setIcons();
 199     $values         = array();
 200     $values['show'] = self::linkHtml("${prefix}_show", "#${prefix}_hide", self::$_showIcon . $showLinkText, "onclick=\"$showCode\"");
 201     $values['hide'] = self::linkHtml("${prefix}_hide", "#${prefix}", self::$_hideIcon . $hideLinkText, "onclick=\"$hideCode\"");
 202
 203     if ($assign) {
 204       $form->assign($prefix, $values);
 205     }
 206     else {
 207       return $values;
 208     }
 209   }
 210
 211   /**
 212    * Create html link elements that we can use in the form
 213    *
 214    * @param CRM_Core_Form $form
 215    *   The form object.
 216    * @param int $index
 217    *   The current index of the element being processed.
 218    * @param int $maxIndex
 219    *   The max number of elements that will be processed.
 220    * @param string $prefix
 221    *   The attribute that we are referencing.
 222    * @param string $showLinkText
 223    *   The text to be shown for the show link.
 224    * @param string $hideLinkText
 225    *   The text to be shown for the hide link.
 226    * @param string $elementType
 227    *   The set the class.
 228    * @param string $hideLink
 229    *   The hide block string.
 230    *
 231    * @return void
 232    */
 233   public function linksForArray(&$form, $index, $maxIndex, $prefix, $showLinkText, $hideLinkText, $elementType = NULL, $hideLink = NULL) {
 234     $showHidePrefix = str_replace(array("]", "["), array("", "_"), $prefix);
 235     $showHidePrefix = "id_" . $showHidePrefix;
 236     if ($index == $maxIndex) {
 237       $showCode = $hideCode = "return false;";
 238     }
 239     else {
 240       $next = $index + 1;
 241       if ($elementType) {
 242         $showCode = "cj('#${prefix}_${next}_show').show(); return false;";
 243         if ($hideLink) {
 244           $hideCode = $hideLink;
 245         }
 246         else {
 247           $hideCode = "cj('#${prefix}_${next}_show, #${prefix}_${next}').hide(); return false;";
 248         }
 249       }
 250       else {
 251         $showCode = "cj('#{$showHidePrefix}_{$next}_show').show(); return false;";
 252         $hideCode = "cj('#{$showHidePrefix}_{$next}_show, #{$showHidePrefix}_{$next}').hide(); return false;";
 253       }
 254     }
 255
 256     self::setIcons();
 257     if ($elementType) {
 258       $form->addElement('link', "${prefix}[${index}][show]", NULL, "#${prefix}_${index}", self::$_showIcon . $showLinkText,
 259         array('onclick' => "cj('#${prefix}_${index}_show').hide(); cj('#${prefix}_${index}').show();" . $showCode)
 260       );
 261       $form->addElement('link', "${prefix}[${index}][hide]", NULL, "#${prefix}_${index}", self::$_hideIcon . $hideLinkText,
 262         array('onclick' => "cj('#${prefix}_${index}').hide(); cj('#${prefix}_${index}_show').show();" . $hideCode)
 263       );
 264     }
 265     else {
 266       $form->addElement('link', "${prefix}[${index}][show]", NULL, "#${prefix}_${index}", self::$_showIcon . $showLinkText,
 267         array('onclick' => "cj('#{$showHidePrefix}_{$index}_show').hide(); cj('#{$showHidePrefix}_{$index}').show();" . $showCode)
 268       );
 269       $form->addElement('link', "${prefix}[${index}][hide]", NULL, "#${prefix}_${index}", self::$_hideIcon . $hideLinkText,
 270         array('onclick' => "cj('#{$showHidePrefix}_{$index}').hide(); cj('#{$showHidePrefix}_{$index}_show').show();" . $hideCode)
 271       );
 272     }
 273   }
 274 }