CRM-15988 - Cleanup internal use of entity names
[civicrm-core.git] / CRM / Core / ShowHideBlocks.php
index 161732998788ff4680aa380291bcd37cc0293d7c..3680230bc6c6d60e02e6ece94c24b59df161331b 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -42,21 +42,21 @@ class CRM_Core_ShowHideBlocks {
   static $_showIcon, $_hideIcon;
 
   /**
-   * The array of ids of blocks that will be shown
+   * The array of ids of blocks that will be shown.
    *
    * @var array
    */
   protected $_show;
 
   /**
-   * The array of ids of blocks that will be hidden
+   * The array of ids of blocks that will be hidden.
    *
    * @var array
    */
   protected $_hide;
 
   /**
-   * Class constructor
+   * Class constructor.
    *
    * @param array $show
    *   Initial value of show array.
@@ -64,7 +64,6 @@ class CRM_Core_ShowHideBlocks {
    *   Initial value of hide array.
    *
    * @return \CRM_Core_ShowHideBlocks the newly created object
-   * @access public
    */
   public function __construct($show = NULL, $hide = NULL) {
     if (!empty($show)) {
@@ -83,10 +82,9 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Load icon vars used in hide and show links
+   * Load icon vars used in hide and show links.
    *
    * @return void
-   * @static
    */
   public static function setIcons() {
     if (!isset(self::$_showIcon)) {
@@ -97,7 +95,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Add the values from this class to the template
+   * Add the values from this class to the template.
    *
    * @return void
    */
@@ -128,7 +126,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Add a value to the show array
+   * Add a value to the show array.
    *
    * @param string $name
    *   Id to be added.
@@ -143,7 +141,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Add a value to the hide array
+   * Add a value to the hide array.
    *
    * @param string $name
    *   Id to be added.
@@ -158,7 +156,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * 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.
@@ -174,7 +172,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Create links that we can use in the form
+   * Create links that we can use in the form.
    *
    * @param CRM_Core_Form $form
    *   The form object.
@@ -187,7 +185,6 @@ class CRM_Core_ShowHideBlocks {
    *
    * @param bool $assign
    *
-   * @static
    *
    * @return void
    */
@@ -209,7 +206,7 @@ class CRM_Core_ShowHideBlocks {
   }
 
   /**
-   * Create html link elements that we can use in the form
+   * Create html link elements that we can use in the form.
    *
    * @param CRM_Core_Form $form
    *   The form object.
@@ -271,4 +268,5 @@ class CRM_Core_ShowHideBlocks {
       );
     }
   }
+
 }