class civicrm_api3 {
/**
- * @param array API configuration.
+ * Class constructor.
+ *
+ * @param array $config API configuration.
*/
- function __construct($config = NULL) {
+ public function __construct($config = NULL) {
$this->local = TRUE;
- $this->input = array();
- $this->lastResult = array();
+ $this->input = [];
+ $this->lastResult = [];
if (isset($config) && isset($config['server'])) {
// we are calling a remote server via REST
$this->local = FALSE;
else {
$this->uri .= '/sites/all/modules/civicrm/extern/rest.php';
}
- $this->uri .= '?json=1';
if (isset($config['key'])) {
$this->key = $config['key'];
}
return;
}
if (isset($config) && isset($config['conf_path'])) {
- define('CIVICRM_SETTINGS_PATH', $config['conf_path'] . '/civicrm.settings.php');
+ if (!defined('CIVICRM_SETTINGS_PATH')) {
+ define('CIVICRM_SETTINGS_PATH', $config['conf_path'] . '/civicrm.settings.php');
+ }
require_once CIVICRM_SETTINGS_PATH;
require_once 'CRM/Core/ClassLoader.php';
require_once 'api/api.php';
}
/**
+ * Convert to string.
+ *
* @return string
*/
public function __toString() {
}
/**
- * Perform action
+ * Perform action.
+ *
* @param $action
* @param $params
+ *
* @return bool
*/
public function __call($action, $params) {
}
/**
- * As of PHP 5.3.0
- * @param $name
- * @param $arguments
- */
- public static function __callStatic($name, $arguments) {
- // Should we implement it ?
- echo "Calling static method '$name' " . implode(', ', $arguments) . "\n";
- }
-
- /**
- * Call via rest
+ * Call via rest.
+ *
* @param $entity
* @param $action
* @param array $params
+ *
* @return \stdClass
*/
- function remoteCall($entity, $action, $params = array()) {
- $fields = "key={$this->key}&api_key={$this->api_key}";
- $query = $this->uri . "&entity=$entity&action=$action";
- foreach ($params as $k => $v) {
- $fields .= "&$k=" . urlencode($v);
- }
+ private function remoteCall($entity, $action, $params = []) {
+ $query = $this->uri . "?entity=$entity&action=$action";
+ $fields = http_build_query([
+ 'key' => $this->key,
+ 'api_key' => $this->api_key,
+ 'json' => json_encode($params),
+ ]);
+
if (function_exists('curl_init')) {
// To facilitate debugging without leaking info, entity & action
// are GET, other data is POST.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $query);
- curl_setopt($ch, CURLOPT_POST, count($params) + 2);
+ curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
// CiviCRM expects to get back a CiviCRM error object.
if (curl_errno($ch)) {
- $res = new stdClass;
+ $res = new stdClass();
$res->is_error = 1;
$res->error_message = curl_error($ch);
$res->level = "cURL";
- $res->error = array('cURL error' => curl_error($ch));
+ $res->error = ['cURL error' => curl_error($ch)];
return $res;
}
curl_close($ch);
$result = file_get_contents($query . '&' . $fields);
}
if (!$res = json_decode($result)) {
- $res = new stdClass;
+ $res = new stdClass();
$res->is_error = 1;
$res->error_message = 'Unable to parse returned JSON';
$res->level = 'json_decode';
- $res->error = array('Unable to parse returned JSON' => $result);
+ $res->error = ['Unable to parse returned JSON' => $result];
$res->row_result = $result;
}
return $res;
}
/**
+ * Call api function.
+ *
* @param $entity
* @param string $action
* @param array $params
*
* @return bool
*/
- function call($entity, $action = 'Get', $params = array()) {
+ private function call($entity, $action = 'Get', $params = []) {
if (is_int($params)) {
- $params = array('id' => $params);
+ $params = ['id' => $params];
}
elseif (is_string($params)) {
$params = json_decode($params);
$this->lastResult = json_decode(json_encode(civicrm_api($entity, $action, $params)));
}
// Reset the input to be ready for a new call.
- $this->input = array();
+ $this->input = [];
if (property_exists($this->lastResult, 'is_error')) {
return !$this->lastResult->is_error;
}
/**
* Helper method for long running programs (eg bots).
*/
- function ping() {
+ public function ping() {
global $_DB_DATAOBJECT;
foreach ($_DB_DATAOBJECT['CONNECTIONS'] as & $c) {
if (!$c->connection->ping()) {
* Return the last error message.
* @return string
*/
- function errorMsg() {
+ public function errorMsg() {
return $this->lastResult->error_message;
}
/**
- * Initialize
+ * Initialize.
*/
- function init() {
+ public function init() {
CRM_Core_DAO::init($this->cfg->dsn);
}
/**
+ * Get attribute.
+ *
* @param $name
* @param null $value
+ *
* @return $this
*/
public function attr($name, $value = NULL) {
}
/**
+ * Is this an error.
+ *
* @return bool
*/
public function is_error() {
}
/**
+ * Check if var is set.
+ *
* @param string $name
+ *
* @return bool
*/
public function is_set($name) {
}
/**
- * @param $name
+ * Get object.
+ *
+ * @param string $name
+ *
* @return $this
*/
public function __get($name) {
public function result() {
return $this->lastResult;
}
+
}