X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FKey.php;h=aab92222c96a25997e603baa9b5b222f7cd197b7;hb=7da04cdea71382ff22ffd94e9b3ae9915c25422b;hp=9d96edaaa70c5fb634208303188f05f0ca00be6e;hpb=6628866da4eb17b8ff190928d8afdbee11526ae6;p=civicrm-core.git

diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php
index 9d96edaaa7..aab92222c9 100644
--- a/CRM/Core/Key.php
+++ b/CRM/Core/Key.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -56,6 +56,9 @@ class CRM_Core_Key {
     return self::$_key;
   }
 
+  /**
+   * @return mixed|null|string
+   */
   static function sessionID() {
     if (!self::$_sessionID) {
       $session = CRM_Core_Session::singleton();
@@ -72,12 +75,12 @@ class CRM_Core_Key {
    * Generate a form key based on form name, the current user session
    * and a private key. Modelled after drupal's form API
    *
-   * @param string  $value       name of the form
-   * @paeam boolean $addSequence should we add a unique sequence number to the end of the key
+   * @param string $name
+   * @param bool $addSequence should we add a unique sequence number to the end of the key
    *
    * @return string       valid formID
    * @static
-   * @acess public
+   * @access public
    */
   static function get($name, $addSequence = FALSE) {
     $privateKey = self::privateKey();
@@ -95,12 +98,13 @@ class CRM_Core_Key {
   /**
    * Validate a form key based on the form name
    *
-   * @param string $formKey
+   * @param string $key
    * @param string $name
+   * @param bool $addSequence
    *
    * @return string $formKey if valid, else null
    * @static
-   * @acess public
+   * @access public
    */
   static function validate($key, $name, $addSequence = FALSE) {
     if (!is_string($key)) {
@@ -125,6 +129,11 @@ class CRM_Core_Key {
     return $key;
   }
 
+  /**
+   * @param $key
+   *
+   * @return bool
+   */
   static function valid($key) {
     // a valid key is a 32 digit hex number
     // followed by an optional _ and a number between 1 and 10000