<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
return self::$_key;
}
+ /**
+ * @return mixed|null|string
+ */
static function sessionID() {
if (!self::$_sessionID) {
$session = CRM_Core_Session::singleton();
* 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();
/**
* 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)) {
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