From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Tue, 24 Mar 2015 04:18:18 +0000 (+1300)
Subject: phpcs code cleanup
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=1a4e6781a5313b2325b3db83d3cfdd417f894a73;p=civicrm-core.git

phpcs code cleanup
---

diff --git a/CRM/Core/BAO/Cache.php b/CRM/Core/BAO/Cache.php
index 031c8c2d09..3e9fb559ce 100644
--- a/CRM/Core/BAO/Cache.php
+++ b/CRM/Core/BAO/Cache.php
@@ -25,14 +25,6 @@
  +--------------------------------------------------------------------+
  */
 
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
- */
-
 /**
  * BAO object for civicrm_cache table. This is a database cache and is persisted across sessions. Typically we use
  * this to store meta data (like profile fields, custom fields etc).
@@ -119,7 +111,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
         $dao->component_id = $componentID;
         $dao->find();
 
-        $result = array(); // array($path => $data)
+        $result = array();
         while ($dao->fetch()) {
           $result[$dao->path] = unserialize($dao->data);
         }
@@ -144,8 +136,6 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
    *   (required) The path under which this item is stored.
    * @param int $componentID
    *   The optional component ID (so componenets can share the same name space).
-   *
-   * @return void
    */
   public static function setItem(&$data, $group, $path, $componentID = NULL) {
     if (self::$_cache === NULL) {
@@ -190,16 +180,13 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
   }
 
   /**
-   * Delete all the cache elements that belong to a group OR
-   * delete the entire cache if group is not specified
+   * Delete all the cache elements that belong to a group OR delete the entire cache if group is not specified.
    *
    * @param string $group
    *   The group name of the entries to be deleted.
    * @param string $path
    *   Path of the item that needs to be deleted.
-   * @param bool|\booleab $clearAll clear all caches
-   *
-   * @return void
+   * @param bool $clearAll clear all caches
    */
   public static function deleteGroup($group = NULL, $path = NULL, $clearAll = TRUE) {
     $dao = new CRM_Core_DAO_Cache();
@@ -231,6 +218,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
 
   /**
    * This function takes entries from the session array and stores it in the cache.
+   *
    * It also deletes the entries from the $_SESSION object (for a smaller session size)
    *
    * @param array $names
@@ -239,8 +227,6 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
    *                     (in the case of profile)
    * @param bool $resetSession
    *   Should session state be reset on completion of DB store?.
-   *
-   * @return void
    */
   public static function storeSessionToCache($names, $resetSession = TRUE) {
     foreach ($names as $key => $sessionName) {
@@ -282,6 +268,8 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
    */
 
   /**
+   * Restore session from cache.
+   *
    * @param string $names
    */
   public static function restoreSessionFromCache($names) {
@@ -306,14 +294,14 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
   }
 
   /**
-   * Do periodic cleanup of the CiviCRM session table. Also delete all session cache entries
-   * which are a couple of days old. This keeps the session cache to a manageable size
+   * Do periodic cleanup of the CiviCRM session table.
+   *
+   * Also delete all session cache entries which are a couple of days old.
+   * This keeps the session cache to a manageable size
    *
    * @param bool $session
    * @param bool $table
    * @param bool $prevNext
-   *
-   * @return void
    */
   public static function cleanup($session = FALSE, $table = FALSE, $prevNext = FALSE) {
     // clean up the session cache every $cacheCleanUpNumber probabilistically
@@ -372,7 +360,10 @@ AND    CREATE_TIME < date_sub( NOW( ), INTERVAL $timeIntervalDays day )
       );
 
       $params = array(
-        1 => array(date('Y-m-d H:i:s', time() - $timeIntervalMins * 60), 'String'),
+        1 => array(
+          date('Y-m-d H:i:s', time() - $timeIntervalMins * 60),
+          'String',
+        ),
       );
       foreach ($transactionPages as $trPage) {
         $params[] = array("%${trPage}%", 'String');