| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.5 | |
| 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 initial value of show array |
| 62 | * @param array $hide initial value of hide array |
| 63 | * |
| 64 | * @return \CRM_Core_ShowHideBlocks the newly created object@access public |
| 65 | */ |
| 66 | function __construct($show = NULL, $hide = NULL) { |
| 67 | if (!empty($show)) { |
| 68 | $this->_show = $show; |
| 69 | } |
| 70 | else { |
| 71 | $this->_show = array(); |
| 72 | } |
| 73 | |
| 74 | if (!empty($hide)) { |
| 75 | $this->_hide = $hide; |
| 76 | } |
| 77 | else { |
| 78 | $this->_hide = array(); |
| 79 | } |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * load icon vars used in hide and show links |
| 84 | * |
| 85 | * @return void |
| 86 | * @access public |
| 87 | * @static |
| 88 | */ |
| 89 | static function setIcons() { |
| 90 | if (!isset(self::$_showIcon)) { |
| 91 | $config = CRM_Core_Config::singleton(); |
| 92 | self::$_showIcon = '<img src="' . $config->resourceBase . 'i/TreePlus.gif" class="action-icon" alt="' . ts('show field or section') . '"/>'; |
| 93 | self::$_hideIcon = '<img src="' . $config->resourceBase . 'i/TreeMinus.gif" class="action-icon" alt="' . ts('hide field or section') . '"/>'; |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * add the values from this class to the template |
| 99 | * |
| 100 | * @return void |
| 101 | * @access public |
| 102 | */ |
| 103 | function addToTemplate() { |
| 104 | $hide = $show = ''; |
| 105 | |
| 106 | $first = TRUE; |
| 107 | foreach (array_keys($this->_hide) as $h) { |
| 108 | if (!$first) { |
| 109 | $hide .= ','; |
| 110 | } |
| 111 | $hide .= "'$h'"; |
| 112 | $first = FALSE; |
| 113 | } |
| 114 | |
| 115 | $first = TRUE; |
| 116 | foreach (array_keys($this->_show) as $s) { |
| 117 | if (!$first) { |
| 118 | $show .= ','; |
| 119 | } |
| 120 | $show .= "'$s'"; |
| 121 | $first = FALSE; |
| 122 | } |
| 123 | |
| 124 | $template = CRM_Core_Smarty::singleton(); |
| 125 | $template->assign_by_ref('hideBlocks', $hide); |
| 126 | $template->assign_by_ref('showBlocks', $show); |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Add a value to the show array |
| 131 | * |
| 132 | * @param string $name id to be added |
| 133 | * |
| 134 | * @return void |
| 135 | * @access public |
| 136 | */ |
| 137 | function addShow($name) { |
| 138 | $this->_show[$name] = 1; |
| 139 | if (array_key_exists($name, $this->_hide)) { |
| 140 | unset($this->_hide[$name]); |
| 141 | } |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Add a value to the hide array |
| 146 | * |
| 147 | * @param string $name id to be added |
| 148 | * |
| 149 | * @return void |
| 150 | * @access public |
| 151 | */ |
| 152 | function addHide($name) { |
| 153 | $this->_hide[$name] = 1; |
| 154 | if (array_key_exists($name, $this->_show)) { |
| 155 | unset($this->_show[$name]); |
| 156 | } |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * create a well formatted html link from the smaller pieces |
| 161 | * |
| 162 | * @param string $name name of the link |
| 163 | * @param string $href |
| 164 | * @param string $text |
| 165 | * @param string $js |
| 166 | * |
| 167 | * @return string the formatted html link |
| 168 | * @access public |
| 169 | */ |
| 170 | static function linkHtml($name, $href, $text, $js) { |
| 171 | return '<a name="' . $name . '" id="' . $name . '" href="' . $href . '" ' . $js . ">$text</a>"; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Create links that we can use in the form |
| 176 | * |
| 177 | * @param CRM_Core_Form $form the form object |
| 178 | * @param string $prefix the attribute that we are referencing |
| 179 | * @param string $showLinkText the text to be shown for the show link |
| 180 | * @param string $hideLinkText the text to be shown for the hide link |
| 181 | * |
| 182 | * @param bool $assign |
| 183 | * |
| 184 | * @static |
| 185 | * |
| 186 | * @return void |
| 187 | * @access public |
| 188 | */ |
| 189 | static function links(&$form, $prefix, $showLinkText, $hideLinkText, $assign = TRUE) { |
| 190 | $showCode = "cj('#id_{$prefix}').show(); cj('#id_{$prefix}_show').hide();"; |
| 191 | $hideCode = "cj('#id_{$prefix}').hide(); cj('#id_{$prefix}_show').show(); return false;"; |
| 192 | |
| 193 | self::setIcons(); |
| 194 | $values = array(); |
| 195 | $values['show'] = self::linkHtml("${prefix}_show", "#${prefix}_hide", self::$_showIcon . $showLinkText, "onclick=\"$showCode\""); |
| 196 | $values['hide'] = self::linkHtml("${prefix}_hide", "#${prefix}", self::$_hideIcon . $hideLinkText, "onclick=\"$hideCode\""); |
| 197 | |
| 198 | if ($assign) { |
| 199 | $form->assign($prefix, $values); |
| 200 | } |
| 201 | else { |
| 202 | return $values; |
| 203 | } |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Create html link elements that we can use in the form |
| 208 | * |
| 209 | * @param CRM_Core_Form $form the form object |
| 210 | * @param int $index the current index of the element being processed |
| 211 | * @param int $maxIndex the max number of elements that will be processed |
| 212 | * @param string $prefix the attribute that we are referencing |
| 213 | * @param string $showLinkText the text to be shown for the show link |
| 214 | * @param string $hideLinkText the text to be shown for the hide link |
| 215 | * @param string $elementType the set the class |
| 216 | * @param string $hideLink the hide block string |
| 217 | * |
| 218 | * @return void |
| 219 | * @access public |
| 220 | */ |
| 221 | function linksForArray(&$form, $index, $maxIndex, $prefix, $showLinkText, $hideLinkText, $elementType = NULL, $hideLink = NULL) { |
| 222 | $showHidePrefix = str_replace(array("]", "["), array("", "_"), $prefix); |
| 223 | $showHidePrefix = "id_" . $showHidePrefix; |
| 224 | if ($index == $maxIndex) { |
| 225 | $showCode = $hideCode = "return false;"; |
| 226 | } |
| 227 | else { |
| 228 | $next = $index + 1; |
| 229 | if ($elementType) { |
| 230 | $showCode = "cj('#${prefix}_${next}_show').show(); return false;"; |
| 231 | if ($hideLink) { |
| 232 | $hideCode = $hideLink; |
| 233 | } |
| 234 | else { |
| 235 | $hideCode = "cj('#${prefix}_${next}_show, #${prefix}_${next}').hide(); return false;"; |
| 236 | } |
| 237 | } |
| 238 | else { |
| 239 | $showCode = "cj('#{$showHidePrefix}_{$next}_show').show(); return false;"; |
| 240 | $hideCode = "cj('#{$showHidePrefix}_{$next}_show, #{$showHidePrefix}_{$next}').hide(); return false;"; |
| 241 | } |
| 242 | } |
| 243 | |
| 244 | self::setIcons(); |
| 245 | if ($elementType) { |
| 246 | $form->addElement('link', "${prefix}[${index}][show]", NULL, "#${prefix}_${index}", self::$_showIcon . $showLinkText, |
| 247 | array('onclick' => "cj('#${prefix}_${index}_show').hide(); cj('#${prefix}_${index}').show();" . $showCode) |
| 248 | ); |
| 249 | $form->addElement('link', "${prefix}[${index}][hide]", NULL, "#${prefix}_${index}", self::$_hideIcon . $hideLinkText, |
| 250 | array('onclick' => "cj('#${prefix}_${index}').hide(); cj('#${prefix}_${index}_show').show();" . $hideCode) |
| 251 | ); |
| 252 | } |
| 253 | else { |
| 254 | $form->addElement('link', "${prefix}[${index}][show]", NULL, "#${prefix}_${index}", self::$_showIcon . $showLinkText, |
| 255 | array('onclick' => "cj('#{$showHidePrefix}_{$index}_show').hide(); cj('#{$showHidePrefix}_{$index}').show();" . $showCode) |
| 256 | ); |
| 257 | $form->addElement('link', "${prefix}[${index}][hide]", NULL, "#${prefix}_${index}", self::$_hideIcon . $hideLinkText, |
| 258 | array('onclick' => "cj('#{$showHidePrefix}_{$index}').hide(); cj('#{$showHidePrefix}_{$index}_show').show();" . $hideCode) |
| 259 | ); |
| 260 | } |
| 261 | } |
| 262 | } |
| 263 | |