<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
protected $_hide;
/**
- * class constructor
+ * Class constructor
*
- * @param array $show initial value of show array
- * @param array $hide initial value of hide array
+ * @param array $show
+ * Initial value of show array.
+ * @param array $hide
+ * Initial value of hide array.
*
- * @return \CRM_Core_ShowHideBlocks the newly created object@access public
+ * @return \CRM_Core_ShowHideBlocks the newly created object
*/
- function __construct($show = NULL, $hide = NULL) {
+ public function __construct($show = NULL, $hide = NULL) {
if (!empty($show)) {
$this->_show = $show;
}
}
/**
- * load icon vars used in hide and show links
+ * Load icon vars used in hide and show links
*
* @return void
- * @access public
- * @static
*/
- static function setIcons() {
+ public static function setIcons() {
if (!isset(self::$_showIcon)) {
$config = CRM_Core_Config::singleton();
self::$_showIcon = '<img src="' . $config->resourceBase . 'i/TreePlus.gif" class="action-icon" alt="' . ts('show field or section') . '"/>';
}
/**
- * add the values from this class to the template
+ * Add the values from this class to the template
*
* @return void
- * @access public
*/
- function addToTemplate() {
+ public function addToTemplate() {
$hide = $show = '';
$first = TRUE;
/**
* Add a value to the show array
*
- * @param string $name id to be added
+ * @param string $name
+ * Id to be added.
*
* @return void
- * @access public
*/
- function addShow($name) {
+ public function addShow($name) {
$this->_show[$name] = 1;
if (array_key_exists($name, $this->_hide)) {
unset($this->_hide[$name]);
/**
* Add a value to the hide array
*
- * @param string $name id to be added
+ * @param string $name
+ * Id to be added.
*
* @return void
- * @access public
*/
- function addHide($name) {
+ public function addHide($name) {
$this->_hide[$name] = 1;
if (array_key_exists($name, $this->_show)) {
unset($this->_show[$name]);
}
/**
- * create a well formatted html link from the smaller pieces
+ * Create a well formatted html link from the smaller pieces
*
- * @param string $name name of the link
+ * @param string $name
+ * Name of the link.
* @param string $href
* @param string $text
* @param string $js
*
- * @return string the formatted html link
- * @access public
+ * @return string
+ * the formatted html link
*/
- static function linkHtml($name, $href, $text, $js) {
+ public static function linkHtml($name, $href, $text, $js) {
return '<a name="' . $name . '" id="' . $name . '" href="' . $href . '" ' . $js . ">$text</a>";
}
/**
* Create links that we can use in the form
*
- * @param CRM_Core_Form $form the form object
- * @param string $prefix the attribute that we are referencing
- * @param string $showLinkText the text to be shown for the show link
- * @param string $hideLinkText the text to be shown for the hide link
+ * @param CRM_Core_Form $form
+ * The form object.
+ * @param string $prefix
+ * The attribute that we are referencing.
+ * @param string $showLinkText
+ * The text to be shown for the show link.
+ * @param string $hideLinkText
+ * The text to be shown for the hide link.
*
* @param bool $assign
*
- * @static
*
* @return void
- * @access public
*/
- static function links(&$form, $prefix, $showLinkText, $hideLinkText, $assign = TRUE) {
+ public static function links(&$form, $prefix, $showLinkText, $hideLinkText, $assign = TRUE) {
$showCode = "cj('#id_{$prefix}').show(); cj('#id_{$prefix}_show').hide();";
$hideCode = "cj('#id_{$prefix}').hide(); cj('#id_{$prefix}_show').show(); return false;";
self::setIcons();
- $values = array();
+ $values = array();
$values['show'] = self::linkHtml("${prefix}_show", "#${prefix}_hide", self::$_showIcon . $showLinkText, "onclick=\"$showCode\"");
$values['hide'] = self::linkHtml("${prefix}_hide", "#${prefix}", self::$_hideIcon . $hideLinkText, "onclick=\"$hideCode\"");
/**
* Create html link elements that we can use in the form
*
- * @param CRM_Core_Form $form the form object
- * @param int $index the current index of the element being processed
- * @param int $maxIndex the max number of elements that will be processed
- * @param string $prefix the attribute that we are referencing
- * @param string $showLinkText the text to be shown for the show link
- * @param string $hideLinkText the text to be shown for the hide link
- * @param string $elementType the set the class
- * @param string $hideLink the hide block string
+ * @param CRM_Core_Form $form
+ * The form object.
+ * @param int $index
+ * The current index of the element being processed.
+ * @param int $maxIndex
+ * The max number of elements that will be processed.
+ * @param string $prefix
+ * The attribute that we are referencing.
+ * @param string $showLinkText
+ * The text to be shown for the show link.
+ * @param string $hideLinkText
+ * The text to be shown for the hide link.
+ * @param string $elementType
+ * The set the class.
+ * @param string $hideLink
+ * The hide block string.
*
* @return void
- * @access public
*/
- function linksForArray(&$form, $index, $maxIndex, $prefix, $showLinkText, $hideLinkText, $elementType = NULL, $hideLink = NULL) {
+ public function linksForArray(&$form, $index, $maxIndex, $prefix, $showLinkText, $hideLinkText, $elementType = NULL, $hideLink = NULL) {
$showHidePrefix = str_replace(array("]", "["), array("", "_"), $prefix);
$showHidePrefix = "id_" . $showHidePrefix;
if ($index == $maxIndex) {
);
}
}
-}
+}
projects / civicrm-core.git / blobdiff