smtech / canvas-ics-sync

include/class/CanvasApiProcess.class.php

Doc Comments +6 added lines

@@ -240,6 +240,9 @@ 
 		return $this->call(CANVAS_API_PUT, $path, $data, $throwsExceptions);
 	}
 	
+	/**
+	 * @param string $page
+	 */
 	private function pageLink($page) {
 		if (array_key_exists($page, $this->lastCall['pagination'])) {
 			$this->pagePest = new Pest($this->lastCall['pagination'][$page]);
@@ -264,6 +267,9 @@ 
 		return $this->pageLink('last');
 	}
 	
+	/**
+	 * @param string $page
+	 */
 	private function getPageNumber($page) {
 		if (array_key_exists($page, $this->lastCall['pagination'])) {
 			parse_str(parse_url($this->lastCall['pagination'][$page], PHP_URL_QUERY), $query);

include/Pest.php

Doc Comments +1 added lines, -1 removed lines

@@ -217,7 +217,7 @@
     /**
      * Do CURL request
      * @param resource $curl
-     * @return mixed
+     * @return string
      * @throws Pest_Curl_Exec
      * @throws Pest_Curl_Meta
      */

Indentation +500 added lines, -500 removed lines

@@ -9,514 +9,514 @@
  */
 class Pest
 {
-    /**
-     * @var array Default CURL options
-     */
-    public $curl_opts = array(
-        CURLOPT_RETURNTRANSFER => true, // return result instead of echoing
-        CURLOPT_SSL_VERIFYPEER => false, // stop cURL from verifying the peer's certificate
-        CURLOPT_FOLLOWLOCATION => false, // follow redirects, Location: headers
-        CURLOPT_MAXREDIRS => 10, // but dont redirect more than 10 times
-        CURLOPT_HTTPHEADER => array()
-    );
-
-    /**
-     * @var string Base URL
-     */
-    public $base_url;
-
-    /**
-     * @var array Last response
-     */
-    public $last_response;
-
-    /**
-     * @var array Last request
-     */
-    public $last_request;
-
-    /**
-     * @var array Last headers
-     */
-    public $last_headers;
-
-    /**
-     * @var bool Throw exceptions on HTTP error codes
-     */
-    public $throw_exceptions = true;
-
-
-    /**
-     * Class constructor
-     * @param string $base_url
-     * @throws Exception
-     */
-    public function __construct($base_url)
-    {
-        if (!function_exists('curl_init')) {
-            throw new Exception('CURL module not available! Pest requires CURL. See http://php.net/manual/en/book.curl.php');
-        }
-
-        /*
+	/**
+	 * @var array Default CURL options
+	 */
+	public $curl_opts = array(
+		CURLOPT_RETURNTRANSFER => true, // return result instead of echoing
+		CURLOPT_SSL_VERIFYPEER => false, // stop cURL from verifying the peer's certificate
+		CURLOPT_FOLLOWLOCATION => false, // follow redirects, Location: headers
+		CURLOPT_MAXREDIRS => 10, // but dont redirect more than 10 times
+		CURLOPT_HTTPHEADER => array()
+	);
+
+	/**
+	 * @var string Base URL
+	 */
+	public $base_url;
+
+	/**
+	 * @var array Last response
+	 */
+	public $last_response;
+
+	/**
+	 * @var array Last request
+	 */
+	public $last_request;
+
+	/**
+	 * @var array Last headers
+	 */
+	public $last_headers;
+
+	/**
+	 * @var bool Throw exceptions on HTTP error codes
+	 */
+	public $throw_exceptions = true;
+
+
+	/**
+	 * Class constructor
+	 * @param string $base_url
+	 * @throws Exception
+	 */
+	public function __construct($base_url)
+	{
+		if (!function_exists('curl_init')) {
+			throw new Exception('CURL module not available! Pest requires CURL. See http://php.net/manual/en/book.curl.php');
+		}
+
+		/*
          * Only enable CURLOPT_FOLLOWLOCATION if safe_mode and open_base_dir are
          * not in use
          */
-        if (ini_get('open_basedir') == '' && strtolower(ini_get('safe_mode')) == 'off') {
-            $this->curl_opts['CURLOPT_FOLLOWLOCATION'] = true;
-        }
-
-        $this->base_url = $base_url;
-
-        // The callback to handle return headers
-        // Using PHP 5.2, it cannot be initialised in the static context
-        $this->curl_opts[CURLOPT_HEADERFUNCTION] = array($this, 'handle_header');
-    }
-
-    /**
-     * Setup authentication
-     *
-     * @param string $user
-     * @param string $pass
-     * @param string $auth  Can be 'basic' or 'digest'
-     */
-    public function setupAuth($user, $pass, $auth = 'basic')
-    {
-        $this->curl_opts[CURLOPT_HTTPAUTH] = constant('CURLAUTH_' . strtoupper($auth));
-        $this->curl_opts[CURLOPT_USERPWD] = $user . ":" . $pass;
-    }
-
-    /**
-     * Setup proxy
-     * @param string $host
-     * @param int $port
-     * @param string $user Optional.
-     * @param string $pass Optional.
-     */
-    public function setupProxy($host, $port, $user = NULL, $pass = NULL)
-    {
-        $this->curl_opts[CURLOPT_PROXYTYPE] = 'HTTP';
-        $this->curl_opts[CURLOPT_PROXY] = $host;
-        $this->curl_opts[CURLOPT_PROXYPORT] = $port;
-        if ($user && $pass) {
-            $this->curl_opts[CURLOPT_PROXYUSERPWD] = $user . ":" . $pass;
-        }
-    }
-
-    /**
-     * Perform HTTP GET request
-     *
-     * @param string $url
-     * @param array $data
-     * @param array $headers
-     * @return string
-     */
-    public function get($url, $data = array(), $headers=array())
-    {
-        if (!empty($data)) {
-            $pos = strpos($url, '?');
-            if ($pos !== false) {
-                $url = substr($url, 0, $pos);
-            }
-            $url .= '?' . http_build_query($data);
-        }
-
-        $curl_opts = $this->curl_opts;
+		if (ini_get('open_basedir') == '' && strtolower(ini_get('safe_mode')) == 'off') {
+			$this->curl_opts['CURLOPT_FOLLOWLOCATION'] = true;
+		}
+
+		$this->base_url = $base_url;
+
+		// The callback to handle return headers
+		// Using PHP 5.2, it cannot be initialised in the static context
+		$this->curl_opts[CURLOPT_HEADERFUNCTION] = array($this, 'handle_header');
+	}
+
+	/**
+	 * Setup authentication
+	 *
+	 * @param string $user
+	 * @param string $pass
+	 * @param string $auth  Can be 'basic' or 'digest'
+	 */
+	public function setupAuth($user, $pass, $auth = 'basic')
+	{
+		$this->curl_opts[CURLOPT_HTTPAUTH] = constant('CURLAUTH_' . strtoupper($auth));
+		$this->curl_opts[CURLOPT_USERPWD] = $user . ":" . $pass;
+	}
+
+	/**
+	 * Setup proxy
+	 * @param string $host
+	 * @param int $port
+	 * @param string $user Optional.
+	 * @param string $pass Optional.
+	 */
+	public function setupProxy($host, $port, $user = NULL, $pass = NULL)
+	{
+		$this->curl_opts[CURLOPT_PROXYTYPE] = 'HTTP';
+		$this->curl_opts[CURLOPT_PROXY] = $host;
+		$this->curl_opts[CURLOPT_PROXYPORT] = $port;
+		if ($user && $pass) {
+			$this->curl_opts[CURLOPT_PROXYUSERPWD] = $user . ":" . $pass;
+		}
+	}
+
+	/**
+	 * Perform HTTP GET request
+	 *
+	 * @param string $url
+	 * @param array $data
+	 * @param array $headers
+	 * @return string
+	 */
+	public function get($url, $data = array(), $headers=array())
+	{
+		if (!empty($data)) {
+			$pos = strpos($url, '?');
+			if ($pos !== false) {
+				$url = substr($url, 0, $pos);
+			}
+			$url .= '?' . http_build_query($data);
+		}
+
+		$curl_opts = $this->curl_opts;
         
-        $curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
-
-        $curl = $this->prepRequest($curl_opts, $url);
-        $body = $this->doRequest($curl);
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Prepare request
-     *
-     * @param array $opts
-     * @param string $url
-     * @return resource
-     * @throws Pest_Curl_Init
-     */
-    protected function prepRequest($opts, $url)
-    {
-        if (strncmp($url, $this->base_url, strlen($this->base_url)) != 0) {
-            $url = rtrim($this->base_url, '/') . '/' . ltrim($url, '/');
-        }
-
-        $curl = curl_init($url);
-        if ($curl === false) {
-            throw new Pest_Curl_Init($this->processError(curl_error($curl), 'curl'));
-        }
-
-        foreach ($opts as $opt => $val)
-            curl_setopt($curl, $opt, $val);
-
-        $this->last_request = array(
-            'url' => $url
-        );
-
-        if (isset($opts[CURLOPT_CUSTOMREQUEST]))
-            $this->last_request['method'] = $opts[CURLOPT_CUSTOMREQUEST];
-        else
-            $this->last_request['method'] = 'GET';
-
-        if (isset($opts[CURLOPT_POSTFIELDS]))
-            $this->last_request['data'] = $opts[CURLOPT_POSTFIELDS];
-
-        return $curl;
-    }
+		$curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
+
+		$curl = $this->prepRequest($curl_opts, $url);
+		$body = $this->doRequest($curl);
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Prepare request
+	 *
+	 * @param array $opts
+	 * @param string $url
+	 * @return resource
+	 * @throws Pest_Curl_Init
+	 */
+	protected function prepRequest($opts, $url)
+	{
+		if (strncmp($url, $this->base_url, strlen($this->base_url)) != 0) {
+			$url = rtrim($this->base_url, '/') . '/' . ltrim($url, '/');
+		}
+
+		$curl = curl_init($url);
+		if ($curl === false) {
+			throw new Pest_Curl_Init($this->processError(curl_error($curl), 'curl'));
+		}
+
+		foreach ($opts as $opt => $val)
+			curl_setopt($curl, $opt, $val);
+
+		$this->last_request = array(
+			'url' => $url
+		);
+
+		if (isset($opts[CURLOPT_CUSTOMREQUEST]))
+			$this->last_request['method'] = $opts[CURLOPT_CUSTOMREQUEST];
+		else
+			$this->last_request['method'] = 'GET';
+
+		if (isset($opts[CURLOPT_POSTFIELDS]))
+			$this->last_request['data'] = $opts[CURLOPT_POSTFIELDS];
+
+		return $curl;
+	}
     
-    /**
-     * Determines if a given array is numerically indexed or not
-     *
-     * @param array $array
-     * @return boolean
-     */
-    protected function _isNumericallyIndexedArray($array)
-    {
-        return !(bool)count(array_filter(array_keys($array), 'is_string'));
-    }
+	/**
+	 * Determines if a given array is numerically indexed or not
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	protected function _isNumericallyIndexedArray($array)
+	{
+		return !(bool)count(array_filter(array_keys($array), 'is_string'));
+	}
     
-    /**
-     * Flatten headers from an associative array to a numerically indexed array of "Name: Value"
-     * style entries like CURLOPT_HTTPHEADER expects. Numerically indexed arrays are not modified.
-     *
-     * @param array $headers
-     * @return array
-     */
-    protected function prepHeaders($headers)
-    {
-        if ($this->_isNumericallyIndexedArray($headers)) {
-            return $headers;
-        }
+	/**
+	 * Flatten headers from an associative array to a numerically indexed array of "Name: Value"
+	 * style entries like CURLOPT_HTTPHEADER expects. Numerically indexed arrays are not modified.
+	 *
+	 * @param array $headers
+	 * @return array
+	 */
+	protected function prepHeaders($headers)
+	{
+		if ($this->_isNumericallyIndexedArray($headers)) {
+			return $headers;
+		}
         
-        $flattened = array();
-        foreach ($headers as $name => $value) {
-             $flattened[] = $name . ': ' . $value;
-        }
+		$flattened = array();
+		foreach ($headers as $name => $value) {
+			 $flattened[] = $name . ': ' . $value;
+		}
         
-        return $flattened;
-    }
-
-    /**
-     * Process error
-     * @param string $body
-     * @return string
-     */
-    protected function processError($body)
-    {
-        // Override this in classes that extend Pest.
-        // The body of every erroneous (non-2xx/3xx) GET/POST/PUT/DELETE
-        // response goes through here prior to being used as the 'message'
-        // of the resulting Pest_Exception
-        return $body;
-    }
-
-    /**
-     * Do CURL request
-     * @param resource $curl
-     * @return mixed
-     * @throws Pest_Curl_Exec
-     * @throws Pest_Curl_Meta
-     */
-    private function doRequest($curl)
-    {
-        $this->last_headers = array();
-        $this->last_response = array();
-
-        // curl_error() needs to be tested right after function failure
-        $this->last_response["body"] = curl_exec($curl);
-        if ($this->last_response["body"] === false && $this->throw_exceptions) {
-            throw new Pest_Curl_Exec(curl_error($curl));
-        }
-
-        $this->last_response["meta"] = curl_getinfo($curl);
-        if ($this->last_response["meta"] === false && $this->throw_exceptions) {
-            throw new Pest_Curl_Meta(curl_error($curl));
-        }
-
-        curl_close($curl);
-
-        $this->checkLastResponseForError();
-
-        return $this->last_response["body"];
-    }
-
-    /**
-     * Check last response for error
-     *
-     * @throws Pest_Conflict
-     * @throws Pest_Gone
-     * @throws Pest_Unauthorized
-     * @throws Pest_ClientError
-     * @throws Pest_MethodNotAllowed
-     * @throws Pest_NotFound
-     * @throws Pest_BadRequest
-     * @throws Pest_UnknownResponse
-     * @throws Pest_InvalidRecord
-     * @throws Pest_ServerError
-     * @throws Pest_Forbidden
-     */
-    protected function checkLastResponseForError()
-    {
-        if (!$this->throw_exceptions)
-            return;
-
-        $meta = $this->last_response['meta'];
-        $body = $this->last_response['body'];
-
-        if ($meta === false)
-            return;
-
-        $err = null;
-        switch ($meta['http_code']) {
-            case 400:
-                throw new Pest_BadRequest($this->processError($body));
-                break;
-            case 401:
-                throw new Pest_Unauthorized($this->processError($body));
-                break;
-            case 403:
-                throw new Pest_Forbidden($this->processError($body));
-                break;
-            case 404:
-                throw new Pest_NotFound($this->processError($body));
-                break;
-            case 405:
-                throw new Pest_MethodNotAllowed($this->processError($body));
-                break;
-            case 409:
-                throw new Pest_Conflict($this->processError($body));
-                break;
-            case 410:
-                throw new Pest_Gone($this->processError($body));
-                break;
-            case 422:
-                // Unprocessable Entity -- see http://www.iana.org/assignments/http-status-codes
-                // This is now commonly used (in Rails, at least) to indicate
-                // a response to a request that is syntactically correct,
-                // but semantically invalid (for example, when trying to
-                // create a resource with some required fields missing)
-                throw new Pest_InvalidRecord($this->processError($body));
-                break;
-            default:
-                if ($meta['http_code'] >= 400 && $meta['http_code'] <= 499)
-                    throw new Pest_ClientError($this->processError($body));
-                elseif ($meta['http_code'] >= 500 && $meta['http_code'] <= 599)
-                    throw new Pest_ServerError($this->processError($body)); elseif (!isset($meta['http_code']) || $meta['http_code'] >= 600) {
-                    throw new Pest_UnknownResponse($this->processError($body));
-                }
-        }
-    }
-
-    /**
-     * Process body
-     * @param string $body
-     * @return string
-     */
-    protected function processBody($body)
-    {
-        // Override this in classes that extend Pest.
-        // The body of every GET/POST/PUT/DELETE response goes through
-        // here prior to being returned.
-        return $body;
-    }
-
-    /**
-     * Perform HTTP HEAD request
-     * @param string $url
-     * @return string
-     */
-    public function head($url)
-    {
-        $curl_opts = $this->curl_opts;
-        $curl_opts[CURLOPT_NOBODY] = true;
-
-        $curl = $this->prepRequest($this->curl_opts, $url);
-        $body = $this->doRequest($curl);
-
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Perform HTTP POST request
-     *
-     * @param string $url
-     * @param array $data
-     * @param array $headers
-     * @return string
-     */
-    public function post($url, $data, $headers = array())
-    {
-        $data = $this->prepData($data);
-
-        $curl_opts = $this->curl_opts;
-        $curl_opts[CURLOPT_CUSTOMREQUEST] = 'POST';
-        if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
-        $curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
-        $curl_opts[CURLOPT_POSTFIELDS] = $data;
-
-        $curl = $this->prepRequest($curl_opts, $url);
-        $body = $this->doRequest($curl);
-
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Prepare data
-     * @param array $data
-     * @return array|string
-     */
-    public function prepData($data)
-    {
-        if (is_array($data)) {
-            $multipart = false;
-
-            foreach ($data as $item) {
-                if (is_string($item) && strncmp($item, "@", 1) == 0 && is_file(substr($item, 1))) {
-                    $multipart = true;
-                    break;
-                }
-            }
-
-            return ($multipart) ? $data : http_build_query($data);
-        } else {
-            return $data;
-        }
-    }
-
-    /**
-     * Perform HTTP PUT request
-     *
-     * @param string $url
-     * @param array $data
-     * @param array $headers
-     * @return string
-     */
-    public function put($url, $data, $headers = array())
-    {
-        $data = $this->prepData($data);
-
-        $curl_opts = $this->curl_opts;
-        $curl_opts[CURLOPT_CUSTOMREQUEST] = 'PUT';
-        if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
-        $curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
-        $curl_opts[CURLOPT_POSTFIELDS] = $data;
-
-        $curl = $this->prepRequest($curl_opts, $url);
-        $body = $this->doRequest($curl);
-
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Perform HTTP PATCH request
-     *
-     * @param string $url
-     * @param array $data
-     * @param array $headers
-     * @return string
-     */
-    public function patch($url, $data, $headers = array())
-    {
-        $data = (is_array($data)) ? http_build_query($data) : $data;
-
-        $curl_opts = $this->curl_opts;
-        $curl_opts[CURLOPT_CUSTOMREQUEST] = 'PATCH';
-        $headers[] = 'Content-Length: ' . strlen($data);
-        $curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
-        $curl_opts[CURLOPT_POSTFIELDS] = $data;
-
-        $curl = $this->prepRequest($curl_opts, $url);
-        $body = $this->doRequest($curl);
-
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Perform HTTP DELETE request
-     *
-     * @param string $url
-     * @param array $headers
-     * @return string
-     */
-    public function delete($url, $data, $headers=array())
-    {
-        $data = $this->prepData($data);
-
-        $curl_opts = $this->curl_opts;
-        $curl_opts[CURLOPT_CUSTOMREQUEST] = 'DELETE';
-        if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
-        $curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
-        $curl_opts[CURLOPT_POSTFIELDS] = $data;
-
-        $curl = $this->prepRequest($curl_opts, $url);
-        $body = $this->doRequest($curl);
-
-        $body = $this->processBody($body);
-
-        return $body;
-    }
-
-    /**
-     * Get last response body
-     *
-     * @return string
-     */
-    public function lastBody()
-    {
-        return $this->last_response['body'];
-    }
-
-    /**
-     * Get last response status
-     *
-     * @return int
-     */
-    public function lastStatus()
-    {
-        return $this->last_response['meta']['http_code'];
-    }
-
-    /**
-     * Return the last response header (case insensitive) or NULL if not present.
-     * HTTP allows empty headers (e.g. RFC 2616, Section 14.23), thus is_null()
-     * and not negation or empty() should be used.
-     *
-     * @param string $header
-     * @return string
-     */
-    public function lastHeader($header)
-    {
-        if (empty($this->last_headers[strtolower($header)])) {
-            return NULL;
-        }
-        return $this->last_headers[strtolower($header)];
-    }
-
-    /**
-     * Handle header
-     * @param $ch
-     * @param $str
-     * @return int
-     */
-    private function handle_header($ch, $str)
-    {
-        if (preg_match('/([^:]+):\s(.+)/m', $str, $match)) {
-            $this->last_headers[strtolower($match[1])] = trim($match[2]);
-        }
-        return strlen($str);
-    }
+		return $flattened;
+	}
+
+	/**
+	 * Process error
+	 * @param string $body
+	 * @return string
+	 */
+	protected function processError($body)
+	{
+		// Override this in classes that extend Pest.
+		// The body of every erroneous (non-2xx/3xx) GET/POST/PUT/DELETE
+		// response goes through here prior to being used as the 'message'
+		// of the resulting Pest_Exception
+		return $body;
+	}
+
+	/**
+	 * Do CURL request
+	 * @param resource $curl
+	 * @return mixed
+	 * @throws Pest_Curl_Exec
+	 * @throws Pest_Curl_Meta
+	 */
+	private function doRequest($curl)
+	{
+		$this->last_headers = array();
+		$this->last_response = array();
+
+		// curl_error() needs to be tested right after function failure
+		$this->last_response["body"] = curl_exec($curl);
+		if ($this->last_response["body"] === false && $this->throw_exceptions) {
+			throw new Pest_Curl_Exec(curl_error($curl));
+		}
+
+		$this->last_response["meta"] = curl_getinfo($curl);
+		if ($this->last_response["meta"] === false && $this->throw_exceptions) {
+			throw new Pest_Curl_Meta(curl_error($curl));
+		}
+
+		curl_close($curl);
+
+		$this->checkLastResponseForError();
+
+		return $this->last_response["body"];
+	}
+
+	/**
+	 * Check last response for error
+	 *
+	 * @throws Pest_Conflict
+	 * @throws Pest_Gone
+	 * @throws Pest_Unauthorized
+	 * @throws Pest_ClientError
+	 * @throws Pest_MethodNotAllowed
+	 * @throws Pest_NotFound
+	 * @throws Pest_BadRequest
+	 * @throws Pest_UnknownResponse
+	 * @throws Pest_InvalidRecord
+	 * @throws Pest_ServerError
+	 * @throws Pest_Forbidden
+	 */
+	protected function checkLastResponseForError()
+	{
+		if (!$this->throw_exceptions)
+			return;
+
+		$meta = $this->last_response['meta'];
+		$body = $this->last_response['body'];
+
+		if ($meta === false)
+			return;
+
+		$err = null;
+		switch ($meta['http_code']) {
+			case 400:
+				throw new Pest_BadRequest($this->processError($body));
+				break;
+			case 401:
+				throw new Pest_Unauthorized($this->processError($body));
+				break;
+			case 403:
+				throw new Pest_Forbidden($this->processError($body));
+				break;
+			case 404:
+				throw new Pest_NotFound($this->processError($body));
+				break;
+			case 405:
+				throw new Pest_MethodNotAllowed($this->processError($body));
+				break;
+			case 409:
+				throw new Pest_Conflict($this->processError($body));
+				break;
+			case 410:
+				throw new Pest_Gone($this->processError($body));
+				break;
+			case 422:
+				// Unprocessable Entity -- see http://www.iana.org/assignments/http-status-codes
+				// This is now commonly used (in Rails, at least) to indicate
+				// a response to a request that is syntactically correct,
+				// but semantically invalid (for example, when trying to
+				// create a resource with some required fields missing)
+				throw new Pest_InvalidRecord($this->processError($body));
+				break;
+			default:
+				if ($meta['http_code'] >= 400 && $meta['http_code'] <= 499)
+					throw new Pest_ClientError($this->processError($body));
+				elseif ($meta['http_code'] >= 500 && $meta['http_code'] <= 599)
+					throw new Pest_ServerError($this->processError($body)); elseif (!isset($meta['http_code']) || $meta['http_code'] >= 600) {
+					throw new Pest_UnknownResponse($this->processError($body));
+				}
+		}
+	}
+
+	/**
+	 * Process body
+	 * @param string $body
+	 * @return string
+	 */
+	protected function processBody($body)
+	{
+		// Override this in classes that extend Pest.
+		// The body of every GET/POST/PUT/DELETE response goes through
+		// here prior to being returned.
+		return $body;
+	}
+
+	/**
+	 * Perform HTTP HEAD request
+	 * @param string $url
+	 * @return string
+	 */
+	public function head($url)
+	{
+		$curl_opts = $this->curl_opts;
+		$curl_opts[CURLOPT_NOBODY] = true;
+
+		$curl = $this->prepRequest($this->curl_opts, $url);
+		$body = $this->doRequest($curl);
+
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Perform HTTP POST request
+	 *
+	 * @param string $url
+	 * @param array $data
+	 * @param array $headers
+	 * @return string
+	 */
+	public function post($url, $data, $headers = array())
+	{
+		$data = $this->prepData($data);
+
+		$curl_opts = $this->curl_opts;
+		$curl_opts[CURLOPT_CUSTOMREQUEST] = 'POST';
+		if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
+		$curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
+		$curl_opts[CURLOPT_POSTFIELDS] = $data;
+
+		$curl = $this->prepRequest($curl_opts, $url);
+		$body = $this->doRequest($curl);
+
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Prepare data
+	 * @param array $data
+	 * @return array|string
+	 */
+	public function prepData($data)
+	{
+		if (is_array($data)) {
+			$multipart = false;
+
+			foreach ($data as $item) {
+				if (is_string($item) && strncmp($item, "@", 1) == 0 && is_file(substr($item, 1))) {
+					$multipart = true;
+					break;
+				}
+			}
+
+			return ($multipart) ? $data : http_build_query($data);
+		} else {
+			return $data;
+		}
+	}
+
+	/**
+	 * Perform HTTP PUT request
+	 *
+	 * @param string $url
+	 * @param array $data
+	 * @param array $headers
+	 * @return string
+	 */
+	public function put($url, $data, $headers = array())
+	{
+		$data = $this->prepData($data);
+
+		$curl_opts = $this->curl_opts;
+		$curl_opts[CURLOPT_CUSTOMREQUEST] = 'PUT';
+		if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
+		$curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
+		$curl_opts[CURLOPT_POSTFIELDS] = $data;
+
+		$curl = $this->prepRequest($curl_opts, $url);
+		$body = $this->doRequest($curl);
+
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Perform HTTP PATCH request
+	 *
+	 * @param string $url
+	 * @param array $data
+	 * @param array $headers
+	 * @return string
+	 */
+	public function patch($url, $data, $headers = array())
+	{
+		$data = (is_array($data)) ? http_build_query($data) : $data;
+
+		$curl_opts = $this->curl_opts;
+		$curl_opts[CURLOPT_CUSTOMREQUEST] = 'PATCH';
+		$headers[] = 'Content-Length: ' . strlen($data);
+		$curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
+		$curl_opts[CURLOPT_POSTFIELDS] = $data;
+
+		$curl = $this->prepRequest($curl_opts, $url);
+		$body = $this->doRequest($curl);
+
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Perform HTTP DELETE request
+	 *
+	 * @param string $url
+	 * @param array $headers
+	 * @return string
+	 */
+	public function delete($url, $data, $headers=array())
+	{
+		$data = $this->prepData($data);
+
+		$curl_opts = $this->curl_opts;
+		$curl_opts[CURLOPT_CUSTOMREQUEST] = 'DELETE';
+		if (!is_array($data)) $headers[] = 'Content-Length: ' . strlen($data);
+		$curl_opts[CURLOPT_HTTPHEADER] = $this->prepHeaders($headers);
+		$curl_opts[CURLOPT_POSTFIELDS] = $data;
+
+		$curl = $this->prepRequest($curl_opts, $url);
+		$body = $this->doRequest($curl);
+
+		$body = $this->processBody($body);
+
+		return $body;
+	}
+
+	/**
+	 * Get last response body
+	 *
+	 * @return string
+	 */
+	public function lastBody()
+	{
+		return $this->last_response['body'];
+	}
+
+	/**
+	 * Get last response status
+	 *
+	 * @return int
+	 */
+	public function lastStatus()
+	{
+		return $this->last_response['meta']['http_code'];
+	}
+
+	/**
+	 * Return the last response header (case insensitive) or NULL if not present.
+	 * HTTP allows empty headers (e.g. RFC 2616, Section 14.23), thus is_null()
+	 * and not negation or empty() should be used.
+	 *
+	 * @param string $header
+	 * @return string
+	 */
+	public function lastHeader($header)
+	{
+		if (empty($this->last_headers[strtolower($header)])) {
+			return NULL;
+		}
+		return $this->last_headers[strtolower($header)];
+	}
+
+	/**
+	 * Handle header
+	 * @param $ch
+	 * @param $str
+	 * @return int
+	 */
+	private function handle_header($ch, $str)
+	{
+		if (preg_match('/([^:]+):\s(.+)/m', $str, $match)) {
+			$this->last_headers[strtolower($match[1])] = trim($match[2]);
+		}
+		return strlen($str);
+	}
 }
 
 class Pest_Exception extends Exception

phpicalendar/caldav.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
 		return $basePath;
 	}
 
+	/**
+	 * @param string $absolutePath
+	 */
 	function deletePath($absolutePath) {
 		$dirs = array();
 		$paths = array();

phpicalendar/functions/admin_functions.php

Doc Comments +3 added lines

@@ -208,6 +208,9 @@
 //
 // arg0: string version of php to check against
 // return boolean true if $version is >= current php version
+/**
+ * @param string $version
+ */
 function check_php_version($version) {
 	// intval used for version like "4.0.4pl1"
 	$testVer=intval(str_replace(".", "",$version));

Indentation +9 added lines, -9 removed lines

@@ -222,15 +222,15 @@
 // arg0: string filename
 // returns boolean is the uploaded a file
 function is_uploaded_file_v4 ($filename) {
-    if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
-        $tmp_file = dirname(tempnam('', ''));
-    }
-    $tmp_file .= '/' . basename($filename);
-    // For Windows compat
-    $filename = str_replace ("\\", "/", $filename);
-    $tmp_file = str_replace ("\\", "/", $tmp_file);
-    // User might have trailing slash in php.ini... 
-    return (ereg_replace('/+', '/', $tmp_file) == $filename);
+	if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
+		$tmp_file = dirname(tempnam('', ''));
+	}
+	$tmp_file .= '/' . basename($filename);
+	// For Windows compat
+	$filename = str_replace ("\\", "/", $filename);
+	$tmp_file = str_replace ("\\", "/", $tmp_file);
+	// User might have trailing slash in php.ini... 
+	return (ereg_replace('/+', '/', $tmp_file) == $filename);
 }
 
 // return the appropriate error message if the file upload had an error

phpicalendar/functions/date_functions.php

Doc Comments +9 added lines

@@ -75,6 +75,9 @@ 
  * Resolve relative paths
  * Utility function for remote_filemtime()
  */
+/**
+ * @param string $rel_path
+ */
 function resolve_path($url, $rel_path) {
 	if (parse_url($rel_path) !== FALSE) {
 		// Path is a URL
@@ -224,6 +227,9 @@ 
 // $have is the current offset (ie, '-0500')
 // $want is the wanted offset (ie, '-0700')
 // $time is the unixtime relative to $have
+/**
+ * @param integer $time
+ */
 function calcTime($have, $want, $time) {
 	if ($have == 'none' || $want == 'none') return $time;
 	$have_secs = calcOffset($have);
@@ -233,6 +239,9 @@ 
 	return $time;
 }
 
+/**
+ * @param integer $time
+ */
 function chooseOffset($time, $timezone = '') {
 	global $tz_array, $summary;
 	switch ($timezone) {

phpicalendar/functions/draw_functions.php

Doc Comments +7 added lines

@@ -38,6 +38,9 @@ 
 
 // word wrap function that returns specified number of lines
 // when lines is 0, it returns the entire string as wordwrap() does it
+/**
+ * @param integer $length
+ */
 function word_wrap($str, $length, $lines=0) {
 	if ($lines > 0) {
 		$len = $length * $lines;
@@ -51,6 +54,10 @@ 
 
 // String intercept By Bleakwind
 // utf-8:$byte=3 | gb2312:$byte=2 | big5:$byte=2
+/**
+ * @param integer $start
+ * @param double $len
+ */
 function bite_str($string, $start, $len, $byte=3){
 	$str = "";
 	$count = 0;

phpicalendar/functions/init/sanitize.php

Doc Comments +2 added lines

@@ -35,6 +35,7 @@ 
 
 /**
  * Truncate a string to a specific number of words
+ * @param integer $count
  */
 function chopToWordCount($string, $count) {
     $wc = str_word_count($string);
@@ -49,6 +50,7 @@ 
 
 /**
  * Strip "dangerous" HTML to make it safe to print to web browsers
+ * @param string $string
  */
 function sanitizeForWeb($string) {
     $string = preg_replace('/<br\s*\/?>/', "\n", $string);

Indentation +30 added lines, -30 removed lines

@@ -14,22 +14,22 @@ 
  * @return mixed
  */
 function recursiveSanitize($value) {
-    if (is_array($value)) {
-        $valmod = array();
-        foreach ($value as $key => $subval) {
-            if (is_array($subval)) {
-                $subval = recursiveSanitize($subval);
-            } else {
-                $subval = strip_tags($subval);
-            }
-            $valmod[$key] = $subval;
-        }
-        $value = $valmod;
-    } else {
-        $value = strip_tags($value);
-    }
+	if (is_array($value)) {
+		$valmod = array();
+		foreach ($value as $key => $subval) {
+			if (is_array($subval)) {
+				$subval = recursiveSanitize($subval);
+			} else {
+				$subval = strip_tags($subval);
+			}
+			$valmod[$key] = $subval;
+		}
+		$value = $valmod;
+	} else {
+		$value = strip_tags($value);
+	}
     
-    return $value;
+	return $value;
 }
 
 
@@ -37,34 +37,34 @@ 
  * Truncate a string to a specific number of words
  */
 function chopToWordCount($string, $count) {
-    $wc = str_word_count($string);
-    if ($wc > $count) {
+	$wc = str_word_count($string);
+	if ($wc > $count) {
 	$words = str_word_count($string, 2);
 	$last_word = array_slice($words, $count, 1, true);
 	$pos = key($last_word);
 	$string = substr($string, 0, $pos) . '...';
-    }
-    return $string;
+	}
+	return $string;
 }
 
 /**
  * Strip "dangerous" HTML to make it safe to print to web browsers
  */
 function sanitizeForWeb($string) {
-    $string = preg_replace('/<br\s*\/?>/', "\n", $string);
+	$string = preg_replace('/<br\s*\/?>/', "\n", $string);
 
-    $string = str_replace('&#36;', '$', $string);
-    $string = str_replace('&', '&amp;', $string);
-    $string = str_replace('<', '&lt;', $string);
-    $string = str_replace('>', '&gt;', $string);
-    $string = str_replace('\'', '&#39;', $string);
-    $string = str_replace('"', '&#34;', $string);
-    $string = str_replace('$', '&#36;', $string);
+	$string = str_replace('&#36;', '$', $string);
+	$string = str_replace('&', '&amp;', $string);
+	$string = str_replace('<', '&lt;', $string);
+	$string = str_replace('>', '&gt;', $string);
+	$string = str_replace('\'', '&#39;', $string);
+	$string = str_replace('"', '&#34;', $string);
+	$string = str_replace('$', '&#36;', $string);
 
-    $string = str_replace("\n", '<br />', $string);
-    $string = str_replace("\t", ' &nbsp; &nbsp; ', $string);
+	$string = str_replace("\n", '<br />', $string);
+	$string = str_replace("\t", ' &nbsp; &nbsp; ', $string);
 
-    return $string;
+	return $string;
 }
 
 

phpicalendar/functions/is_daylight.php

Doc Comments +3 added lines

@@ -2,6 +2,9 @@
 /* 	values are offset in hhmm (not seconds!) relative to GMT
 	case The first value is for standard, and the second value is for daylight
 */
+/**
+ * @param string $timezone
+ */
 function is_daylight($time, $timezone){
 	global $tz_array, $summary;
 	# default to std time, overwrite if daylight.

phpicalendar/functions/parse/overlapping_events.php

Doc Comments +3 added lines

@@ -1,6 +1,9 @@
 <?php
 // function to determine maximum necessary columns per day
 // actually an algorithm to get the smallest multiple for two numbers
+/**
+ * @param integer $b
+ */
 function kgv($a, $b) {
 	$x = $a;
 	$y = $b;