5 * This class allows to consume the API, either from within a module that knows civicrm already:
8 * require_once('api/class.api.php');
9 * $api = new civicrm_api3();
12 * or from any code on the same server as civicrm
15 * require_once('/your/civi/folder/api/class.api.php');
16 * // the path to civicrm.settings.php
17 * $api = new civicrm_api3 (array('conf_path'=> '/your/path/to/your/civicrm/or/joomla/site));
20 * or to query a remote server via the rest api
23 * $api = new civicrm_api3 (array ('server' => 'http://example.org',
24 * 'api_key'=>'theusersecretkey',
25 * 'key'=>'thesitesecretkey'));
28 * No matter how initialised and if civicrm is local or remote, you use the class the same way.
31 * $api->{entity}->{action}($params);
34 * So, to get the individual contacts:
37 * if ($api->Contact->Get(array('contact_type'=>'Individual','return'=>'sort_name,current_employer')) {
38 * // each key of the result array is an attribute of the api
39 * echo "\n contacts found " . $api->count;
40 * foreach ($api->values as $c) {
41 * echo "\n".$c->sort_name. " working for ". $c->current_employer;
43 * // in theory, doesn't append
45 * echo $api->errorMsg();
49 * Or, to create an event:
52 * if ($api->Event->Create(array('title'=>'Test','event_type_id' => 1,'is_public' => 1,'start_date' => 19430429))) {
53 * echo "created event id:". $api->id;
55 * echo $api->errorMsg();
59 * To make it easier, the Actions can either take for input an
60 * associative array $params, or simply an id. The following two lines
64 * $api->Activity->Get (42);
65 * $api->Activity->Get (array('id'=>42));
69 * You can also get the result like civicrm_api does, but as an object
70 * instead of an array (eg $entity->attribute instead of
71 * $entity['attribute']).
74 * $result = $api->result;
75 * // is the json encoded result
82 * @param array API configuration.
84 function __construct($config = NULL) {
86 $this->input
= array();
87 $this->lastResult
= array();
88 if (isset($config) && isset($config['server'])) {
89 // we are calling a remote server via REST
91 $this->uri
= $config['server'];
92 if (isset($config['path'])) {
93 $this->uri
.= "/" . $config['path'];
96 $this->uri
.= '/sites/all/modules/civicrm/extern/rest.php';
98 $this->uri
.= '?json=1';
99 if (isset($config['key'])) {
100 $this->key
= $config['key'];
103 die("\nFATAL:param['key] missing\n");
105 if (isset($config['api_key'])) {
106 $this->api_key
= $config['api_key'];
109 die("\nFATAL:param['api_key] missing\n");
113 if (isset($config) && isset($config['conf_path'])) {
114 define('CIVICRM_SETTINGS_PATH', $config['conf_path'] . '/civicrm.settings.php');
115 require_once CIVICRM_SETTINGS_PATH
;
116 require_once 'CRM/Core/ClassLoader.php';
117 require_once 'api/api.php';
118 require_once "api/v3/utils.php";
119 CRM_Core_ClassLoader
::singleton()->register();
120 $this->cfg
= CRM_Core_Config
::singleton();
124 $this->cfg
= CRM_Core_Config
::singleton();
131 public function __toString() {
132 return json_encode($this->lastResult
);
138 public function __call($action, $params) {
139 // @TODO Check if it's a valid action.
140 if (isset($params[0])) {
141 return $this->call($this->currentEntity
, $action, $params[0]);
144 return $this->call($this->currentEntity
, $action, $this->input
);
151 public static function __callStatic($name, $arguments) {
152 // Should we implement it ?
153 echo "Calling static method '$name' " . implode(', ', $arguments) . "\n";
159 function remoteCall($entity, $action, $params = array()) {
160 $fields = "key={$this->key}&api_key={$this->api_key}";
161 $query = $this->uri
. "&entity=$entity&action=$action";
162 foreach ($params as $k => $v) {
163 $fields .= "&$k=" . urlencode($v);
165 if (function_exists('curl_init')) {
166 // To facilitate debugging without leaking info, entity & action
167 // are GET, other data is POST.
169 curl_setopt($ch, CURLOPT_URL
, $query);
170 curl_setopt($ch, CURLOPT_POST
, count($params) +
2);
171 curl_setopt($ch, CURLOPT_POSTFIELDS
, $fields);
172 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
173 $result = curl_exec($ch);
174 // CiviCRM expects to get back a CiviCRM error object.
175 if (curl_errno($ch)) {
178 $res->error_message
= curl_error($ch);
179 $res->level
= "cURL";
180 $res->error
= array('cURL error' => curl_error($ch));
186 // Should be discouraged, because the API credentials and data
187 // are submitted as GET data, increasing chance of exposure..
188 $result = file_get_contents($query . '&' . $fields);
190 if (!$res = json_decode($result)) {
193 $res->error_message
= 'Unable to parse returned JSON';
194 $res->level
= 'json_decode';
195 $res->error
= array('Unable to parse returned JSON' => $result);
196 $res->row_result
= $result;
201 function call($entity, $action = 'Get', $params = array()) {
202 if (is_int($params)) {
203 $params = array('id' => $params);
205 elseif (is_string($params)) {
206 $params = json_decode($params);
209 if (!isset($params['version'])) {
210 $params['version'] = 3;
212 if (!isset($params['sequential'])) {
213 $params['sequential'] = 1;
217 $this->lastResult
= $this->remoteCall($entity, $action, $params);
220 // Converts a multi-dimentional array into an object.
221 $this->lastResult
= json_decode(json_encode(civicrm_api($entity, $action, $params)));
223 // Reset the input to be ready for a new call.
224 $this->input
= array();
225 if (property_exists($this->lastResult
, 'is_error')) {
226 return !$this->lastResult
->is_error
;
228 // getsingle doesn't have is_error.
233 * Helper method for long running programs (eg bots).
236 global $_DB_DATAOBJECT;
237 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as & $c) {
238 if (!$c->connection
->ping()) {
239 $c->connect($this->cfg
->dsn
);
240 if (!$c->connection
->ping()) {
241 die("we couldn't connect");
248 * Return the last error message.
250 function errorMsg() {
251 return $this->lastResult
->error_message
;
258 CRM_Core_DAO
::init($this->cfg
->dsn
);
264 public function attr($name, $value = NULL) {
265 if ($value === NULL) {
266 if (property_exists($this->lastResult
, $name)) {
267 return $this->lastResult
->$name;
271 $this->input
[$name] = $value;
279 public function is_error() {
280 return (property_exists($this->lastResult
, 'is_error') && $this->lastResult
->is_error
);
286 public function is_set($name) {
287 return (isset($this->lastResult
->$name));
293 public function __get($name) {
294 // @TODO Test if valid entity.
295 if (strtolower($name) !== $name) {
296 // Cheap and dumb test to differentiate call to
297 // $api->Entity->Action & value retrieval.
298 $this->currentEntity
= $name;
301 if ($name === 'result') {
302 return $this->lastResult
;
304 if ($name === 'values') {
305 return $this->lastResult
->values
;
307 if (property_exists($this->lastResult
, $name)) {
308 return $this->lastResult
->$name;
310 $this->currentEntity
= $name;
315 * Or use $api->value.
317 public function values() {
318 if (is_array($this->lastResult
)) {
319 return $this->lastResult
['values'];
322 return $this->lastResult
->values
;
327 * Or use $api->result.
329 public function result() {
330 return $this->lastResult
;