Better doc. Option for returning json

diversen · diversen · commit ed8632ab974c · 2015-08-05T14:54:45.000+02:00
diff --git a/example/api_call.php b/example/api_call.php
@@ -3,7 +3,7 @@
 // Step tree: Call the API
 
 // Autoload
-include_once "../../../autoload.php";
+include_once "../vendor/autoload.php";
 
 // Very small boot file. Starts session. Defines constants. 
 include_once "boot.php";
@@ -17,7 +17,7 @@
 // Simple call - get current users credentials
 // This can also be done without scope
 $command = "/user";
-$res = $api->apiCall($command);
+$res = $api->apiCall($command, 'GET', null);
 if (!$res) {
     print_r($api->errors); die;
 }
diff --git a/src/githubapi.php b/src/githubapi.php
@@ -2,7 +2,7 @@
 
 namespace diversen;
 
-use diversen\mycurl as mycurl;
+use diversen\mycurl;
 /**
  * contains simple class for using oauth with github
  * @package githubapi
@@ -23,40 +23,53 @@ class githubapi {
      */
     public $errors = array ();
     
-    
+    /**
+     * @var holding return code
+     * @var string 
+     */
     public $returnCode = null;
     /**
-     * we need a github OAuth login url from configuration
-     * @param array $config e.g. <code>config = array (
-     *                              'redirect_uri' => 'http://cos/test/callback.php',
-     *                              'client_id' => 'app id',
-     *                              'state' =>  md5(uniqid()),
-     *                              'scope' => 'user'
-     *                           );</code>
+     * We need a github OAuth login url from configuration
+     * @param array $config e.g. 
+     * 
+     * <code>
+     * $config = array (
+     *     'redirect_uri' => 'http://localhost:8080/callback.php',
+     *     'client_id' => 'app id',
+     *     'state' =>  md5(uniqid()),
+     *     'scope' => 'user'
+     * );
+     * </code>
+     * 
      * If you don't set scope you can only get users basic profile info,
-     * but you can use it as e.g login methdod anyway
+     * but you can still use it as e.g. a login method.
+     *  
      * @return string $url a github url where you can obtain users accept of 
      *                     using his account according to scope
      */
     public function getAccessUrl ($config) {
-
         $_SESSION['state'] = $config['state'];     
         $url = 'https://github.com/login/oauth/authorize';
         $query =  http_build_query($config);
         $url.= '?' . $query;    
         return $url;
-
     }
 
     /**
-     * sets the access token in a session variable, which
+     * Sets the access token in a session variable, which
      * then can be used when calling the api
-     * @param array $post e.g. <code>$post = array (
-     *                               'redirect_uri' => 'http://cos/test/callback.php',
-     *                               'client_id' => 'app_id',
-     *                               'client_secret' => 'app_secret',
-     *                          );</code>
+     * @param array $post e.g. 
+     * 
+     * <code>
+     * $post = array (
+     *     'redirect_uri' => 'http://localhost:8080/callback.php',
+     *     'client_id' => 'app_id',
+     *     'client_secret' => 'app_secret',
+     * );
+     * </code>
+     * 
      * @return boolean $res true on success and false on failure
+     *                 any errors will be stored in githubapi::$errors
      */
     public function setAccessToken ($post) {
         if (isset($_GET['error'])) {
@@ -87,27 +100,27 @@ public function setAccessToken ($post) {
     }
 
     /**
-     * Commands to call se
-     * http://developer.github.com/v3/
-     * For a full listing
+     * Make an API call. For all 
+     * 
+     * @see http://developer.github.com/v3/
+     * 
      * @param string $command e.g "/users"
-     * @param string $request e.g "POST" or PATCH, if empty it is a GET
+     * @param string $request e.g "POST" or PATCH, DELETE - if empty it is a GET
      * @param array $post vaiables $_POST variables to send
-     * @return array $ary response from github server
+     * @param boolean $json should we return output as json. Default is false
+     * @return boolean|array false if failure. Else: $ary response from github server
      */
-    public function apiCall ($command, $request = null, $post = null) {
+    public function apiCall ($command, $request = null, $post = null, $json = false) {
         if (!isset($_SESSION['access_token']) || empty($_SESSION['access_token'])) {
             $this->errors[] = 'No valid token';
             return false;
             
         }
         $end_point = 'https://api.github.com';
         $command = $end_point . "$command";
-
         $command.= "?access_token=$_SESSION[access_token]";
 
         $c = new mycurl($command);
-        
         if (isset($request)) {
             $c->setRequest($request);
         }
@@ -119,8 +132,11 @@ public function apiCall ($command, $request = null, $post = null) {
         $c->createCurl();
         $resp = $c->getWebPage();
         $this->returnCode = $c->getHttpStatus();
-        $ary = json_decode($resp, true);  
-        return $ary;
+        if ($json) {
+            return $resp;
+        } else {
+            $ary = json_decode($resp, true);  
+            return $ary;
+        }
     }
-    
 }
