5 This class allows to consume the API, either from within a module that knows civicrm already:
7 require_once('api/class/api.php');
8 $api = new civicrm_api3();
10 or from any code on the same server as civicrm
12 require_once('/your/civi/folder/api/class.api.php');
13 // the path to civicrm.settings.php
14 $api = new civicrm_api3 (array('conf_path'=> '/your/path/to/your/civicrm/or/joomla/site));
16 or to query a remote server via the rest api
18 $api = new civicrm_api3 (array ('server' => 'http://example.org','api_key'=>'theusersecretkey','key'=>'thesitesecretkey'));
20 no matter how initialised and if civicrm is local or remote, you use the class the same way
22 $api->{entity}->{action}($params);
24 so to get the individual contacts
26 if ($api->Contact->Get(array(
27 'contact_type'=>'Individual','return'=>'sort_name,current_employer')) {
28 // each key of the result array is an attribute of the api
29 echo "\n contacts found " . $api->count;
30 foreach ($api->values as $c) {
31 echo "\n".$c->sort_name. " working for ". $c->current_employer;
33 // in theory, doesn't append
35 echo $api->errorMsg();
40 if ($api->Event->Create(array(
41 'title'=>'Test','event_type_id' => 1,'is_public' => 1,'start_date' => 19430429))) {
42 echo "created event id:". $api->id;
44 echo $api->errorMsg();
47 To make it easier, the Actions can either take for input an associative array $params, or simply an id
49 $api->Activity->Get (42);
53 $api->Activity->Get (array('id'=>42));
55 you can too get the result like what civicrm_api does, but as an object instead of an array (eg $entity->attribute instead of $entity['attribute']
57 $result = $api->result;
58 // is the json encoded result
63 function __construct($config = NULL) {
65 $this->input
= array();
66 $this->lastResult
= array();
67 if (isset($config) && isset($config['server'])) {
68 // we are calling a remote server via REST
70 $this->uri
= $config['server'];
71 if (isset($config['path'])) {
72 $this->uri
.= "/" . $config['path'];
74 else $this->uri
.= '/sites/all/modules/civicrm/extern/rest.php';
75 $this->uri
.= '?json=1';
76 if (isset($config['key'])) {
77 $this->key
= $config['key'];
80 die("\nFATAL:param['key] missing\n");
82 if (isset($config['api_key'])) {
83 $this->api_key
= $config['api_key'];
86 die("\nFATAL:param['api_key] missing\n");
91 if (isset($config) && isset($config['conf_path'])) {
92 define('CIVICRM_SETTINGS_PATH', $config['conf_path'] . '/civicrm.settings.php');
93 require_once CIVICRM_SETTINGS_PATH
;
94 require_once 'CRM/Core/Classloader.php';
95 require_once 'api/api.php';
96 require_once "api/v3/utils.php";
97 CRM_Core_Classloader
::singleton()->register();
98 $this->cfg
= CRM_Core_Config
::singleton();
102 $this->cfg
= CRM_Core_Config
::singleton();
106 public function __toString() {
107 return json_encode($this->lastResult
);
110 public function __call($action, $params) {
111 // TODO : check if it's a valid action
112 if (isset($params[0])) {
113 return $this->call($this->currentEntity
, $action, $params[0]);
116 return $this->call($this->currentEntity
, $action, $this->input
);
120 /** As of PHP 5.3.0 */
121 public static function __callStatic($name, $arguments) {
122 // Should we implement it ?
123 echo "Calling static method '$name' " . implode(', ', $arguments) . "\n";
126 function remoteCall($entity, $action, $params = array(
128 $fields = "key={$this->key}&api_key={$this->api_key}";
129 $query = $this->uri
. "&entity=$entity&action=$action";
130 foreach ($params as $k => $v) {
131 $fields .= "&$k=" . urlencode($v);
133 if (function_exists('curl_init')) {
134 //to make it easier to debug but avoid leaking info, entity&action are the url, the rest is in the POST
136 curl_setopt($ch, CURLOPT_URL
, $query);
137 curl_setopt($ch, CURLOPT_POST
, count($params) +
2);
138 curl_setopt($ch, CURLOPT_POSTFIELDS
, $fields);
139 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
142 $result = curl_exec($ch);
144 return json_decode($result);
145 // not good, all in get when should be in post.
148 $result = file_get_contents($query . '&' . $fields);
149 return json_decode($result);
153 function call($entity, $action = 'Get', $params = array(
155 if (is_int($params)) {
156 $params = array('id' => $params);
158 elseif (is_string($params)) {
159 $params = json_decode($params);
162 if (!isset($params['version'])) {
164 $params['version'] = 3;
166 if (!isset($params['sequential'])) {
167 $params['sequential'] = 1;
171 $this->lastResult
= $this->remoteCall($entity, $action, $params);
174 // easiest to convert a multi-dimentional array into an object
175 $this->lastResult
= json_decode(json_encode(civicrm_api($entity, $action, $params)));
177 // reset the input to be ready for a new call
178 $this->input
= array();
179 if (property_exists($this->lastResult
, 'is_error')) {
180 return !$this->lastResult
->is_error
;
182 // getsingle doesn't have is_error
186 //* helper method for long running programs (eg bots)
188 global $_DB_DATAOBJECT;
189 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as & $c) {
190 if (!$c->connection
->ping()) {
191 $c->connect($this->cfg
->dsn
);
192 if (!$c->connection
->ping()) {
193 die("we couldn't connect");
199 function errorMsg() {
200 return $this->lastResult
->error_message
;
204 CRM_Core_DAO
::init($this->cfg
->dsn
);
211 * $api->attr ('id',42) //set the id
216 public function attr($name, $value = NULL) {
217 if ($value === NULL) {
218 if (property_exists($this->lastResult
, $name)) {
219 return $this->lastResult
->$name;
223 $this->input
[$name] = $value;
228 public function is_error() {
229 return (property_exists($this->lastResult
, 'is_error') && $this->lastResult
->is_error
);
232 public function is_set($name) {
233 return (isset($this->lastResult
->$name));
236 /* public function __set($name, $value) {
237 echo "Setting '$name' to '$value'\n";
243 public function __get($name) {
244 //TODO, test if valid entity
245 if (strtolower($name) !== $name) {
246 //cheap and dumb test to differenciate call to $api->Entity->Action & value retrieval
247 $this->currentEntity
= $name;
251 if ($name === 'result') {
253 return $this->lastResult
;
255 if ($name === 'values') {
256 return $this->lastResult
->values
;
259 if (property_exists($this->lastResult
, $name)) {
261 return $this->lastResult
->$name;
264 $this->currentEntity
= $name;
269 // or use $api->value
270 public function values() {
271 if (is_array($this->lastResult
)) {
272 return $this->lastResult
['values'];
274 else return $this->lastResult
->values
;
277 // or use $api->result
278 public function result() {
279 return $this->lastResult
;