| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
/**
* Number of seconds we should let a soap process idle
- * @static
*/
static $soap_timeout = 0;
/**
* Simple ping function to test for liveness.
*
- * @param string $var The string to be echoed
+ * @param string $var
+ * The string to be echoed.
*
- * @return string $var
+ * @return string
*/
public function ping($var) {
$session = CRM_Core_Session::singleton();
}
/**
- * Verify a SOAP key
+ * Verify a SOAP key.
*
- * @param string $key The soap key generated by authenticate()
+ * @param string $key
+ * The soap key generated by authenticate().
*
* @throws SoapFault
* @return void
throw new SoapFault('Client', 'Invalid key');
}
-
if (self::$soap_timeout &&
$t > ($session->get('soap_time') + self::$soap_timeout)
) {
}
/**
- * Authentication wrapper to the UF Class
+ * Authentication wrapper to the UF Class.
*
- * @param string $name Login name
- * @param string $pass Password
+ * @param string $name
+ * Login name.
+ * @param string $pass
+ * Password.
*
* @param bool $loadCMSBootstrap
*
* @throws SoapFault
- * @return string The SOAP Client key
- * @static
+ * @return string
+ * The SOAP Client key
*/
public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
- require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->ufClass) . '.php');
+ require_once str_replace('_', DIRECTORY_SEPARATOR, $this->ufClass) . '.php';
- if ($this->ufClass == 'CRM_Utils_System_Joomla'){
- $loadCMSBootstrap = true;
+ if ($this->ufClass == 'CRM_Utils_System_Joomla') {
+ $loadCMSBootstrap = TRUE;
}
$className = $this->ufClass;
- $result =& $className::authenticate($name, $pass, $loadCMSBootstrap );
+ $result =& $className::authenticate($name, $pass, $loadCMSBootstrap);
if (empty($result)) {
throw new SoapFault('Client', 'Invalid login');
return sha1($result[2]);
}
- /*** MAILER API ***/
+ /**
+ * MAILER API.
+ */
public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
$this->verify($key);
$params = array(
$params['version'] = 3;
return civicrm_api('contact', 'get', $params);
}
-}
+}