Merge pull request #6523 from eileenmcnaughton/CRM-16955

[civicrm-core.git] / CRM / Core / Key.php

diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php
index e7454e2bad882ce677d36301516b5b5658d7007b..af82575886ffbd3fbe88b1171923db3f232061fb 100644 (file)
--- a/CRM/Core/Key.php
+++ b/CRM/Core/Key.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -38,11 +38,10 @@ class CRM_Core_Key {
   static $_sessionID = NULL;
 
   /**
-   * Generate a private key per session and store in session
+   * Generate a private key per session and store in session.
    *
-   * @return string private key for this session
-   * @static
-   * @access private
+   * @return string
+   *   private key for this session
    */
   public static function privateKey() {
     if (!self::$_key) {
@@ -76,16 +75,16 @@ class CRM_Core_Key {
    * and a private key. Modelled after drupal's form API
    *
    * @param string $name
-   * @param bool $addSequence should we add a unique sequence number to the end of the key
+   * @param bool $addSequence
+   *   Should we add a unique sequence number to the end of the key.
    *
-   * @return string       valid formID
-   * @static
-   * @access public
+   * @return string
+   *   valid formID
    */
   public static function get($name, $addSequence = FALSE) {
     $privateKey = self::privateKey();
-    $sessionID  = self::sessionID();
-    $key        = md5($sessionID . $name . $privateKey);
+    $sessionID = self::sessionID();
+    $key = md5($sessionID . $name . $privateKey);
 
     if ($addSequence) {
       // now generate a random number between 1 and 100K and add it to the key
@@ -96,15 +95,14 @@ class CRM_Core_Key {
   }
 
   /**
-   * Validate a form key based on the form name
+   * Validate a form key based on the form name.
    *
    * @param string $key
    * @param string $name
    * @param bool $addSequence
    *
-   * @return string $formKey if valid, else null
-   * @static
-   * @access public
+   * @return string
+   *   if valid, else null
    */
   public static function validate($key, $name, $addSequence = FALSE) {
     if (!is_string($key)) {
@@ -155,5 +153,5 @@ class CRM_Core_Key {
     // ensure that hash is a 32 digit hex number
     return preg_match('#[0-9a-f]{32}#i', $hash) ? TRUE : FALSE;
   }
-}
 
+}