explode/explode_api_client.php

   1 <?php
   2         /**
   3          * @file explodelib.php Explode API interface library.
   4          *
   5          * This is a library / reference implementation for interfacing with the explode API.
   6          * It should be noted that the Explode API is still under development and is subject to
   7          * change.
   8          *
   9          * I will try to keep this sample API up to date, but the website documentation should
  10          * be taken as the canonical source.
  11          *
  12          * It is compatible with both PHP4 & 5.
  13          *
  14          * @author Marcus Povey <marcus@dushka.co.uk>
  15          * @version 0.2
  16          */
  17
  18
  19         /** API endpoint.
  20          * You should not ever have to change this, but this could be useful to developers.
  21          */
  22         $xmlurl = "http://ex.plode.us/mod/explodeapi/";
  23
  24         /**
  25          * Encode a raw rest call.
  26          * @param $method array An array of 'key' => 'value' of your api parameters.
  27          * @return object Query result as a php object.
  28          */
  29         function explode_rawcall($method)
  30         {
  31                 // Get the endpoint
  32                 global $xmlurl;
  33
  34                 // Declare an array
  35                 $encoded_params = array();
  36
  37                 // Hard code the format - we're using PHP, so lets use PHP serialisation.
  38                 $method['format'] = "php";
  39
  40                 // URL encode all the parameters
  41                 foreach ($method as $k => $v){
  42                         $encoded_params[] = urlencode($k).'='.urlencode($v);
  43                 }
  44
  45                 // Put together the query string
  46                 $url = $xmlurl."?".implode('&', $encoded_params);
  47
  48                 // Send the query and get the result and decode.
  49                 $rsp = file_get_contents($url);
  50                 return unserialize($rsp);
  51         }
  52
  53         /**
  54          * Get a list of users.
  55          *
  56          * @param $limit int The number of users to return, default 25.
  57          * @param $offset int Offset in the search.
  58          */
  59         function users_index($limit = 25, $offset = 0)
  60         {
  61                 $param = array();
  62
  63                 $param['limit'] = $limit;
  64                 $param['offset'] = $offset;
  65                 $param['method'] = "users.index";
  66
  67                 return explode_rawcall($param);
  68         }
  69
  70         /**
  71          * Get some information about a user.
  72          *
  73          * @param $userid int The user id to display
  74          */
  75         function users_view($userid)
  76         {
  77                 $param = array();
  78
  79                 $param['userid'] = $userid;
  80                 $param['method'] = "users.view";
  81
  82                 return explode_rawcall($param);
  83         }
  84
  85         /**
  86          * Get some information about a user from a username and service.
  87          *
  88          * @param string $username The user to look for.
  89          * @param int $service The service id.
  90          */
  91         function users_viewbyusername($username, $service)
  92         {
  93                 $param = array();
  94
  95                 $param['username'] = $username;
  96                 $param['service'] = $service;
  97                 $param['method'] = "users.viewbyusername";
  98
  99                 return explode_rawcall($param);
 100         }
 101
 102         /**
 103          * Get the user's friends.
 104          *
 105          * @param $userid int The user id to display
 106          */
 107         function users_getfriends($userid)
 108         {
 109                 $param = array();
 110
 111                 $param['userid'] = $userid;
 112                 $param['method'] = "users.getfriends";
 113
 114                 return explode_rawcall($param);
 115         }
 116
 117         /**
 118          * Get the users who have made this user their friend.
 119          *
 120          * @param $userid int The user id to display
 121          */
 122         function users_getfriendsof($userid)
 123         {
 124                 $param = array();
 125
 126                 $param['userid'] = $userid;
 127                 $param['method'] = "users.getfriendsof";
 128
 129                 return explode_rawcall($param);
 130         }
 131
 132         /**
 133          * Get a list of users by interest.
 134          *
 135          * @param $tag string The tag. Multiple tags can be specified by using "and" eg. "music and chocolate".
 136          * @param $limit int The number of users to return, default 25.
 137          * @param $offset int Offset in the search.
 138          */
 139         function users_findusersbytag($tag, $limit = 25, $offset = 0)
 140         {
 141                 $param = array();
 142
 143                 $param['method'] = "users.findusersbytag";
 144                 $param['tag'] = $tag;
 145                 $param['limit'] = $limit;
 146                 $param['offset'] = $offset;
 147
 148                 return explode_rawcall($param);
 149         }
 150
 151         /**
 152          * Search for users by (user)name or name, essentially executing an explode name search.
 153          *
 154          * @param $username string Username to look for.
 155          * @param $limit int The number of users to return, default 25.
 156          * @param $offset int Offset in the search.
 157          * @param $servicelist string Optional service list.
 158          */
 159         function users_findusersbyname($username, $limit = 25, $offset = 0, $servicelist = "")
 160         {
 161                 $param = array();
 162
 163                 $param['username'] = $username;
 164                 $param['limit'] = $limit;
 165                 $param['offset'] = $offset;
 166                 $param['servicelist'] = $servicelist;
 167                 $param['method'] = "users.findusersbyname";
 168
 169                 return explode_rawcall($param);
 170         }
 171
 172         /**
 173          * Get a list of services.
 174          *
 175          * @param $limit int The number of users to return, default 25.
 176          * @param $offset int Offset in the search.
 177          */
 178         function services_index($limit = 25, $offset = 0)
 179         {
 180                 $param = array();
 181
 182                 $param['limit'] = $limit;
 183                 $param['offset'] = $offset;
 184                 $param['method'] = "services.index";
 185
 186                 return explode_rawcall($param);
 187         }
 188
 189         /**
 190          * Get some information about a service.
 191          *
 192          * @param $serviceid int The id of the service
 193          */
 194         function services_view($serviceid)
 195         {
 196                 $param = array();
 197
 198                 $param['serviceid'] = $serviceid;
 199                 $param['method'] = "services.view";
 200
 201                 return explode_rawcall($param);
 202         }
 203
 204         /**
 205          * Search for services by service by either the full or short name.
 206          *
 207          * @param $name string The name of the service
 208          */
 209         function services_findservicesbyname($name)
 210         {
 211                 $param = array();
 212
 213                 $param['name'] = $name;
 214                 $param['method'] = "services.findservicesbyname";
 215
 216                 return explode_rawcall($param);
 217         }
 218
 219         /**
 220          * Get a list of comments (public comment wall).
 221          *
 222          * @param $limit int The number of users to return, default 25.
 223          * @param $offset int Offset in the search.
 224          */
 225         function comments_index($limit = 25, $offset = 0)
 226         {
 227                 $param = array();
 228
 229                 $param['limit'] = $limit;
 230                 $param['offset'] = $offset;
 231                 $param['method'] = "comments.index";
 232
 233                 return explode_rawcall($param);
 234         }
 235
 236         /**
 237          * Get information about a comment.
 238          *
 239          * @param $commentid int The comment id
 240          */
 241         function comments_view($commentid)
 242         {
 243                 $param = array();
 244
 245                 $param['method'] = "comments.view";
 246                 $param['commentid'] = $commentid;
 247
 248                 return explode_rawcall($param);
 249         }
 250
 251         /**
 252          * Get the user's comments (comment wall).
 253          *
 254          * @param $userid int The user id of the user who's comment wall will be retrieved.
 255          * @param $limit int The number of users to return, default 25.
 256          * @param $offset int Offset in the search.
 257          */
 258         function comments_user($userid, $limit = 25, $offset = 0)
 259         {
 260                 $param = array();
 261
 262                 $param['userid'] = $userid;
 263                 $param['limit'] = $limit;
 264                 $param['offset'] = $offset;
 265                 $param['method'] = "comments.user";
 266
 267                 return explode_rawcall($param);
 268         }
 269
 270 ?>