parse.php

<?php 
/**
Library to use parse.com rest API.

 Some examples on how to use:

 //
 // CREATE OBJECT
 // 
 
  	$parse = new parseRestClient(array(
		'appid' => 'YOUR APPLICATION ID',
		'masterkey' => 'YOUR MASTER KEY ID'
	));
  

 //
 // CREATE EXAMPLE
 // 
	$params = array(
		'className' => 'gameScore',
		'object' => array(
			'score' => 500,
			'name' => 'Andrew Scofield'
		)
	);
	
	$request = $parse->create($params);

  
 // 
 // GET EXAMPLE
 //  
 
	$params = array(
		'className' => 'gameScore',
 		'objectId' => 'Ed1nuqPvcm'
	);
	
	$request = $parse->get($params);
  
  
 // 
 //QUERY EXAMPLE
 //
	
	$params = array(
		'className' => 'gameScore',
		'query' => array(
			'score'=> array(
				'$gt' => 500
			) 
		),
		'order' => '-score',
		'limit' => '2',
		'skip' => '2'
	);
	
	$request = $parse->query($params);
 
  
 // 
 // UPDATE EXAMPLE
 //  
 
	$params = array(
		'className' => 'gameScore',
 		'objectId' => 'Ed1nuqPvcm',
		'object' => array(
			'score' => 500,
			'name' => 'Andrew Scofield'
		)
	);
	
	$request = $parse->update($params);
  
  
 // 
 // DELETE EXAMPLE
 //  
 
	$params = array(
		'className' => 'gameScore',
 		'objectId' => 'Ed1nuqPvcm',
	);
	
	$request = $parse->delete($params);
  
  
 *  * 
 * 
 */


class ParseRestClient{

	private $appid = '';
	private $masterkey = '';
	private $parseUrl = 'https://api.parse.com/1/classes/';
	private $enableDebug = '';

/**
 * When creating a new parseRestClient object
 * send array with 'masterkey' and 'appid'
 * 
 */
	public function __construct($config){
		if(isset($config['appid']) && isset($config['masterkey'])){
			$this->appid = $config['appid'];
			$this->masterkey = $config['masterkey'];			
		}
		else{
			die('You must include your Application Id and Master Key');
		}
		
		if(isset($config['enableDebug'])) {
			$this->enableDebug = $config['enableDebug'];
		}
	}

/*
 * All requests go through this function
 * There are functions that filter all the different request types
 * No need to use this function directly  
 * 
 */	
	private function request($args){
		$c = curl_init();
		curl_setopt($c, CURLOPT_TIMEOUT, 5);
		curl_setopt($c, CURLOPT_USERAGENT, 'parseRestClient/1.0');
		curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($c, CURLOPT_USERPWD,  $this->appid . ':' . $this->masterkey);
		curl_setopt($c, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
		curl_setopt($c, CURLOPT_CUSTOMREQUEST, $args['method']);
		curl_setopt($c, CURLOPT_URL, $this->parseUrl . $args['url']);

		if($args['method'] == 'PUT' || $args['method'] == "POST"){
			$postData = json_encode($args['payload']);
			curl_setopt($c, CURLOPT_POSTFIELDS, $postData );
		}
		else{
			$postData = array();
			if(isset($args['query'])){
				$postData['where'] = json_encode( $args['query'] );
			}
			if(isset($args['order'])){
				$postData['order'] = $args['order'];
			}
			if(isset($args['limit'])){
				$postData['limit'] = $args['limit'];
			}
			if(isset($args['count'])){
				$postData['count'] = $args['count'];
			}
			if(isset($args['skip'])){
				$postData['skip'] = $args['skip'];
			}
			if(count($postData) > 0){
				$query = "";
				foreach ($postData as $key => $value) {
					$query .= '&'.$key.'='.$value;
				}
				curl_setopt($c, CURLOPT_URL, $this->parseUrl . $args['url'].'?'.$query);
			}
			
			if($this->enableDebug == true) {
				echo "PostData: \n";
				print_r($postData);
				echo "Query:\n";
				echo $query."\n";
			}

		}

		$response = curl_exec($c);
		$httpCode = curl_getinfo($c, CURLINFO_HTTP_CODE);
	
		
		if($this->enableDebug == true) {
			echo "Response: ".$response."\n";
		}
		
		return array('code'=>$httpCode, 'response'=>$response);
	}


	public function create($args){
		$params = array(
			'url' => $args['className'],
			'method' => 'POST',
			'payload' => $args['object']
		);

		$return = $this->request($params);

		return $this->checkResponse($return,'201');

	}	

/*
 * Used to get a parse.com object  
 * 
 * @param array $args - argument hash:
 * 
 * className: string of className
 * objectId: (optional) the objectId of the object you want to update. If none, will return multiple objects from className
 * 
 * @return string $return
 * 
 */
	public function get($args){
		$params = array(
			'url' => $args['className'].'/'.$args['objectId'],
			'method' => 'GET'
		);

		$return = $this->request($params);

		return $this->checkResponse($return,'200');
	}	

/*
 * Used to update a parse.com object  
 * 
 * @param array $args - argument hash:
 * 
 * className: string of className
 * objectId: the objectId of the object you want to update
 * object: object to update in place of old one  
 * 
 * @return string $return
 * 
 */
	public function update($args){
		$params = array(
			'url' => $args['className'].'/'.$args['objectId'],
			'method' => 'PUT',
			'payload' => $args['object']
		);

		$return = $this->request($params);

		return $this->checkResponse($return,'200');
	}

/*
 * Used to query parse.com.  
 * 
 * @param array $args - argument hash:
 * 
 * className: string of className
 * query: array containing query. See: https://www.parse.com/docs/rest#data-querying 
 * order: (optional) used to sort by the field name. use a minus (-) before field name to reverse sort
 * limit: (optional) limit number of results
 * skip:  (optional) used to paginate results
 * 
 * @return string $return
 * 
 */

	public function query($args){
		$params = array(
			'url' => $args['className'],
			'method' => 'GET'
		);

		if(isset($args['query'])){
			$params['query'] = $args['query'];
		}
/*		else{
			die('you should use the get method if you are not inluding a query');
		}*/
		if(isset($args['order'])){
			$params['order'] = $args['order'];
		}
		if(isset($args['limit'])){
			$params['limit'] = $args['limit'];
		}
		if(isset($args['skip'])){
			$params['skip'] = $args['skip'];
		}
		if(isset($args['count'])){
			$params['count'] = $args['count'];
		}

		$return = $this->request($params);

		return $this->checkResponse($return,'200');

	}

/*
 * Used to get a parse.com object  
 * 
 * @param array $args - argument hash:
 * 
 * className: string of className
 * objectId: (optional) the objectId of the object you want to update. If none, will return multiple objects from className
 * 
 * @return string $return
 * 
 */
	public function delete($args){
		$params = array(
			'url' => $args['className'].'/'.$args['objectId'],
			'method' => 'DELETE'
		);

		$return = $this->request($params);

		return $this->checkResponse($return,'200');
	}	


/*
 * Checks for correct/expected response code.
 * 
 * @param array $return, string $code 
 * 
 * @return string $return['response]
 * 
 */
	private function checkResponse($return,$code){
		//TODO: Need to also check for response for a correct result from parse.com
		if($return['code'] != $code){
			die('failed to get response '.$code.', response code was: '.$return['code']);
		}
		else{
			return $return['response'];
		}
	}
}

?>