<?php
/*
	This script provides functions for returning data to the client from the
	server in a generic and uniform fashion. Returned data is an array.
	Custom elements for the array (usually sub-arrays, but not necessarily)
	can be added before sending to the client. In every case, the variable
	$GLOBALS['ALL_ERRORS'] is added to the array under the key 'ALL_ERRORS'. This
	variable should be global and comes from the errorHandler.php script.
	
	Functions of this script should be accessed through the $GLOBALS['RETURN_PLUGIN']
	oject, declared below.
*/

class serverReturnPluginObject {
	// all properties private
	private $data;
	
	// public methods
	public function __construct(){
		$this->data = array();
	}
	public function setItem($key, $item){
		$worked = false;
		if ($this->data[$key] = $item){ $worked = true;}
		return $worked;
	}
	public function setDataArray($userData){
		// sometimes it's easiest to set the whole data array in one go
		// it's important though that $userData is actually an array
		$this->data = (array)$userData;
	}
	public function getItemByKey($key){
		$value = null;
		if (array_key_exists($key,$this->data)){
			$value = $this->data[$key];
		}
		return $value;
	}
	public function getItemsByValue($value, $strict){
		// $strict = true, means do a strict '===' comparison
		$keys = array_keys($this->data, $value, $strict);
		return $keys;
	}
	public function getDataArray(){
		// sometimes it's easiest just to get the whole data array
		return $this->data;
	}
	public function getDataArrayWithErrors(){
		// sometimes you want the whole array plus errors
		$dataWithErrors = $this->data;
		if (isset($GLOBALS['ALL_ERRORS'])){
			$dataWithErrors['ALL_ERRORS'] = $GLOBALS['ALL_ERRORS'];
		} else{
			$dataWithErrors['ALL_ERRORS'] = array();
		}
		return $dataWithErrors;
	}
	public function send(){
		// exits script, sends $returnObject to client
		$dataToSend = $this->getDataArrayWithErrors();
		$jsonString = json_encode($dataToSend);
		die($jsonString);
	}
}

$GLOBALS['RETURN_PLUGIN'] = new serverReturnPluginObject();
?>