Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-01-26-14-28-00

[civicrm-core.git] / CRM / Utils / Recent.php

diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php
index 1d3bc8b509e4f507e9b275d65ab86e0b558de799..aa66d55454c8da18e66b9a40969ba8b402a5bdea 100644 (file)
--- a/CRM/Utils/Recent.php
+++ b/CRM/Utils/Recent.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -44,13 +43,12 @@ class CRM_Utils_Recent {
    *
    * @int
    */
-  CONST MAX_ITEMS = 10, STORE_NAME = 'CRM_Utils_Recent';
+  const MAX_ITEMS = 10, STORE_NAME = 'CRM_Utils_Recent';
 
   /**
    * The list of recently viewed items
    *
    * @var array
-   * @static
    */
   static private $_recent = NULL;
 
@@ -58,10 +56,8 @@ class CRM_Utils_Recent {
    * Initialize this class and set the static variables
    *
    * @return void
-   * @access public
-   * @static
    */
-  static function initialize() {
+  public static function initialize() {
     if (!self::$_recent) {
       $session = CRM_Core_Session::singleton();
       self::$_recent = $session->get(self::STORE_NAME);
@@ -74,11 +70,10 @@ class CRM_Utils_Recent {
   /**
    * Return the recently viewed array
    *
-   * @return array the recently viewed array
-   * @access public
-   * @static
+   * @return array
+   *   the recently viewed array
    */
-  static function &get() {
+  public static function &get() {
     self::initialize();
     return self::$_recent;
   }
@@ -86,19 +81,21 @@ class CRM_Utils_Recent {
   /**
    * Add an item to the recent stack
    *
-   * @param string $title the title to display
-   * @param string $url the link for the above title
-   * @param string $id object id
+   * @param string $title
+   *   The title to display.
+   * @param string $url
+   *   The link for the above title.
+   * @param string $id
+   *   Object id.
    * @param $type
    * @param int $contactId
    * @param string $contactName
    * @param array $others
    *
    * @return void
-   * @access public
-   * @static
    */
-  static function add($title,
+  public static function add(
+    $title,
     $url,
     $id,
     $type,
@@ -149,13 +146,12 @@ class CRM_Utils_Recent {
   /**
    * Delete an item from the recent stack
    *
-   * @param array $recentItem array of the recent Item to be removed
+   * @param array $recentItem
+   *   Array of the recent Item to be removed.
    *
    * @return void
-   * @access public
-   * @static
    */
-  static function del($recentItem) {
+  public static function del($recentItem) {
     self::initialize();
     $tempRecent = self::$_recent;
 
@@ -164,8 +160,9 @@ class CRM_Utils_Recent {
     // make sure item is not already present in list
     for ($i = 0; $i < count($tempRecent); $i++) {
       if (!($tempRecent[$i]['id'] == $recentItem['id'] &&
-          $tempRecent[$i]['type'] == $recentItem['type']
-        )) {
+        $tempRecent[$i]['type'] == $recentItem['type']
+      )
+      ) {
         self::$_recent[] = $tempRecent[$i];
       }
     }
@@ -177,13 +174,12 @@ class CRM_Utils_Recent {
   /**
    * Delete an item from the recent stack
    *
-   * @param string $id  contact id that had to be removed
+   * @param string $id
+   *   Contact id that had to be removed.
    *
    * @return void
-   * @access public
-   * @static
    */
-  static function delContact($id) {
+  public static function delContact($id) {
     self::initialize();
 
     $tempRecent = self::$_recent;
@@ -202,5 +198,5 @@ class CRM_Utils_Recent {
     $session = CRM_Core_Session::singleton();
     $session->set(self::STORE_NAME, self::$_recent);
   }
-}
 
+}