<?php 
/**
*
* Class DocumentLink
*
* Represents a document link as per the database document_link table
* Used to chain documents together in the collaboration process
*
* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
* @date 14 May 2003
* @package lib.documentmanagement
*/


class DocumentLink {

	/** primary key value */
	var $iId;
	/** primary key of user responsible for creating document */
	var $iUserID;
	/** document title name */	
	var $sDocumentTitle;
	/** primary key of document to use as template */
	var $iTemplateDocumentID;	

	/**
	* Default constructor
	*
	* @param 	Name of document field
	* @param 	Document field data type
	*
	*/
	function DocumentLink($sNewDocumentTitle, $iUserID, $iNewTemplateDocumentID) {
		//object not created yet
		global $default;
		$this->iID = -1;
		$this->iUserID = $iUserID;
		$this->iTemplateDocumentID = $iNewTemplateDocumentID;
		

	}

	/**
	* Get the document field's primary key value
	*
	* @return int document field's primary key value
	*
	*/
	function getID() {
		return $this -> iId;
	}

	/**
	* Get the document field's name
	*
	* @return String document field's name
	*
	*/
	function getName() {
		return $this -> sName;
	}

	/**
	* Set the document field's name
	*
	* @param 	Document field's new name
	*
	*/
	function setName($sNewValue) {
		$this -> sName = $sNewValue;
	}

	/**
	* Get the document field's data type
	*
	* @return String document field's data type
	*
	*/
	function getDataType() {
		return $this -> sDataType;
	}

	/**
	* Set the document field's data type
	*
	* @param 	Document field's new data type
	*
	*/
	function setDataType($sNewValue) {
		$this -> sDataType = $sNewValue;
	}

	/**
	* Get the document field's generic or not
	*
	* @return String document field's data type
	*
	*/
	function getIsGeneric() {
		return $this -> bIsGeneric;
	}

	/**
	* Set the document field's genericness
	*
	* @param 	Document field's new data type
	*
	*/
	function setIsGeneric($sNewValue) {
		$this -> bIsGeneric = $sNewValue;
	}

	/**
	* Get the document field's lookup or not
	*
	* @return String document field's data type
	*
	*/
	function getHasLookup() {
		return $this -> bHasLookup;
	}

	/**
	* Set the document field's lookup
	*
	* @param 	Document field's new data type
	*
	*/
	function setHasLookup($sNewValue) {
		$this -> bHasLookup = $sNewValue;
	}

	/**
	* Store the current object in the database
	*
	* @return boolean on successful store, false otherwise and set $_SESSION["errorMessage"]
	*
	*/
	function create() {
		global $default, $lang_err_database, $lang_err_object_exists;
		//if the object hasn't been created
		if ($this -> iId < 0) {
			$sql = $default -> db;
			$result = $sql -> query("INSERT INTO ".$default -> owl_fields_table." (name, data_type,is_generic,has_lookup) VALUES ('".addslashes($this -> sName)."', '".addslashes($this -> sDataType)."', '".$this -> bIsGeneric."', '".$this -> bHasLookup."')");
			if ($result) {
				$this -> iId = $sql -> insert_id();
				return true;
			}
			$_SESSION["errorMessage"] = $lang_err_database;
			return false;
		}
		$_SESSION["errorMessage"] = $lang_err_object_exists."id = ".$this -> iId." table = document_fields";
		return false;
	}

	/**
	* Update the values in the database table with the object's current values
	*
	* @return boolean true on successful update, false otherwise and set $_SESSION["errorMessage"]
	*
	*/
	function update() {
		global $default, $lang_err_database, $lang_err_object_key;
		//only update if the object has been stored
		if ($this -> iId > 0) {
			$sql = $default -> db;
			$result = $sql -> query("UPDATE ".$default -> owl_fields_table." SET name = '".addslashes($this -> sName)."', data_type = '".addslashes($this -> sDataType)."', is_generic = '".$this -> bIsGeneric."', has_lookup = '".$this -> bHasLookup."' WHERE id = $this->iId");
			if ($result) {
				return true;
			}
			$_SESSION["errorMessage"] = $lang_err_database;
			return false;
		}
		$_SESSION["errorMessage"] = $lang_err_object_key;
		return false;
	}

	/**
	* Delete the current object from the database
	*
	* @return boolean true on successful deletion, false otherwise and set $_SESSION["errorMessage"]
	*
	*/
	function delete() {
		global $default, $lang_err_database, $lang_err_object_key;
		//only delete the object if it exists in the database
		if ($this -> iId >= 0) {
			$sql = $default -> db;
			$result = $sql -> query("DELETE FROM $default->owl_fields_table WHERE id = $this->iId");
			if ($result) {
				return true;
			}
			$_SESSION["errorMessage"] = $lang_err_database;
			return false;
		}
		$_SESSION["errorMessage"] = $lang_err_object_key;
		return false;
	}

	/**
	* Static function.
	* Given a document_fields primary key it will create a 
	* DocumentFields object and populate it with the 
	* corresponding database values
	*
	* @return DocumentField populated DocumentField object on successful query, false otherwise and set $_SESSION["errorMessage"]
	*/
	function & get($iDocumentFieldsID) {
		global $default;
		$sql = $default -> db;
		$result = $sql -> query("SELECT * FROM $default->owl_fields_table WHERE id = $iDocumentFieldsID");
		if ($result) {
			if ($sql -> next_record()) {
				$oDocumentField = & new DocumentField(stripslashes($sql -> f("name")), stripslashes($sql -> f("data_type")), $sql -> f("is_generic"), $sql -> f("has_lookup"));
				$oDocumentField -> iId = $sql -> f("id");
				return $oDocumentField;
			}
			$_SESSION["errorMessage"] = $lang_err_object_not_exist."id = ".$iDocumentID." table = $default->owl_fields_table";
			return false;
		}
		$_SESSION["errorMessage"] = $lang_err_database;
		return false;
	}

	/**
	* Static function.
	* Gets all generic fields
	* DocumentFields object and populate it with the 
	* corresponding database values
	*
	* @return DocumentField populated DocumentField object on successful query, false otherwise and set $_SESSION["errorMessage"]
	*/
	function getGenericFields() {
		global $default, $lang_err_database;
		$aFields;
		settype($aFields, "array");
		$sql = $default -> db;
		$result = $sql -> query("SELECT name, id FROM ".$default -> owl_fields_table." Where is_generic = 1");
		if ($result) {
			$iCount = 0;
			while ($sql -> next_record()) {

				$aFields[$iCount]["id"] = $sql -> f("id");
				$aFields[$iCount]["name"] = $sql -> f("name");
				$iCount ++;
			}
			return $aFields;
		}
		$_SESSION["errorMessage"] = $lang_err_database;
		return false;
	}

	/* Static function.  Given a documenttype...will find all fields belongin to it
	*
	* @return DocumentFieldLink populated DocumentFieldLink object on success, false otherwise and set $_SESSION["errorMessage"]
	*/
	function getAllSpecificFields() {
		global $default, $lang_err_database;
		$aFields;
		settype($aFields, "array");
		$sql = $default -> db;
		$result = $sql -> query("SELECT id, name FROM ".$default -> owl_fields_table." Where is_generic = 0");
		if ($result) {
			$iCount = 0;
			while ($sql -> next_record()) {

				$aFields[$iCount]["id"] = $sql -> f("id");
				$aFields[$iCount]["name"] = $sql -> f("name");
				$iCount ++;
			}
			return $aFields;
		}
		$_SESSION["errorMessage"] = $lang_err_database;
		return false;
	}

	/* Static function.  Given a documenttype...will find all fields belongin to it
	*
	* @return DocumentFieldLink populated DocumentFieldLink object on success, false otherwise and set $_SESSION["errorMessage"]
	*/
	function isFieldLinkedToType() {
		global $default, $lang_err_database;
		$sql = $default -> db;
		$query = "SELECT * FROM ".$default -> owl_document_type_fields_table." Where field_id = $this->iId";
		$sql -> query($query);
		$rows = $sql -> num_rows($sql);

		if ($rows > 0) {
			return true;
		} else {
			return false;
		}
		$_SESSION["errorMessage"] = $lang_err_database;
		return false;
	}

	/* Static function.  Given a documenttype...will find all fields belongin to it
	*
	* @return DocumentFieldLink populated DocumentFieldLink object on success, false otherwise and set $_SESSION["errorMessage"]
	*/
	function getAllDataTypes() {
		global $default, $lang_err_database;
		$aDataTypes;
		settype($aDataTypes, "array");
		$sql = $default -> db;
		$result = $sql -> query("SELECT id, name FROM ".$default -> owl_data_types_table);
		if ($result) {
			$iCount = 0;
			while ($sql -> next_record()) {

				$aDataTypes[$iCount]["id"] = $sql -> f("id");
				$aDataTypes[$iCount]["name"] = $sql -> f("name");
				$iCount ++;
			}
			return $aDataTypes;
		}
		$_SESSION["errorMessage"] = $lang_err_database;
		return false;
	}
}

?>