phpdoc and added document path and heading

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@2169 c91229c3-7414-0410-bfa2-8a42b809f60b

phpdoc and added document path and heading
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@2169 c91229c3-7414-0410-bfa2-8a42b809f60b
Michael Joseph
1 parent f5a29ea5
Showing 12 changed files with 147 additions and 137 deletions
presentation/lookAndFeel/knowledgeTree/documentmanagement/addDocumentLinkBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/addDocumentLinkUI.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/collaborationBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/collaborationUI.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifyBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifyGenericMetaDataBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifyGenericMetaDataUI.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifySpecificMetaDataBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifySpecificMetaDataUI.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/modifyUI.inc
presentation/lookAndFeel/knowledgeTree/documentmanagement/removeDocumentLinkBL.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/removeDocumentLinkUI.inc
 <?php
-
 /**
-* Business Logic to link a two documents together in a parent child
-* relationship
-*
-* Expected form variable:
-* o $fDocumentID - primary key of document user is currently viewing
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 22 May 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*/
+ * $Id$
+ *  
+ * Business Logic to link a two documents together in a parent child
+ * relationship
+ *
+ * Expected form variable:
+ * o $fDocumentID - primary key of document user is currently viewing
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
@@ -20,6 +22,7 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternCustom.inc");
 	require_once("$default->fileSystemRoot/lib/security/permission.inc");
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
+	require_once("documentUI.inc");
 	require_once("addDocumentLinkUI.inc");
 	if (Permission::userHasDocumentWritePermission($fDocumentID)) {
@@ -40,7 +43,6 @@ if (checkSession()) {
 				$main->setHasRequiredFields(true);
 				$main->setErrorMessage("An error occured whilst attempting to link the two documents");	
 				$main->render();	
-				
 			}			
 		} else {
 			//display the add page
@@ -53,10 +55,6 @@ if (checkSession()) {
 			$main->setHasRequiredFields(true);				
 			$main->render();
 		}
-		
-	}
-		
-		
+	}		
 }
-
 ?>
 \ No newline at end of file
 <?php
 /**
-* Presentation logic used to link one document to another
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 22 May 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*/
-
-
-/*function renderHeading($sHeading) {
-    global $default;
-    $sSectionName = $default->siteMap->getSectionName(substr($_SERVER["PHP_SELF"], strlen($default->rootUrl), strlen($_SERVER["PHP_SELF"])));
-    $sColor = $default->siteMap->getSectionColour($sSectionName, "th");
-    $sToRender  = "<table border=\"0\" width=\"100%\">\n";
-    $sToRender .= "<tr align=\"left\"><th class=\"sectionHeading\" bgcolor=\"$sColor\"><font color=\"ffffff\">$sHeading</font></th></tr>\n";
-    $sToRender .= "<tr/>\n";
-    $sToRender .= "<tr/>\n";
-    $sToRender .= "</table>\n";
-    return $sToRender;
-}*/
+ * $Id$
+ *
+ * Presentation logic used to link one document to another
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 function getPage($iDocumentID) {
 	global $default;
 	$sToRender = renderHeading("Document Linking");
+	$sToRender .= displayDocumentPath($iDocumentID);	
 	$sToRender .= "<table>";
 	$sToRender .= "<tr>";
 	//had a slight problem with netscape 4.7x - it doesn't support disabled.  So I had to use
@@ -75,8 +66,5 @@ function getNetscapeDisableScript() {
 	$sToRender .= "}\n";
 	$sToRender .= "//--></script>\n\n";
 	return $sToRender;
-	
 }
-
-
 ?>
 \ No newline at end of file
 <?php
 /**
-* Document collaboration business logic - contains business logic to set up
-* document approval process
-*
-* Required form variables:
-*	o fFolderCollaborationID - primary key of folder collaboration entry we are viewing
-*	o fDocumentID - primary key of document this folder collaboration entry is for
-*	o fIsActive - whether the document collaboration set is active or not
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 28 January 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*
-*/
+ * $Id$
+ *  
+ * Document collaboration business logic - contains business logic to set up
+ * document approval process
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * Required form variables:
+ *	o fFolderCollaborationID - primary key of folder collaboration entry we are viewing
+ *	o fDocumentID - primary key of document this folder collaboration entry is for
+ *	o fIsActive - whether the document collaboration set is active or not
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
@@ -30,6 +32,7 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
 	require_once("$default->fileSystemRoot/lib/security/permission.inc");	
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternCustom.inc");
+	require_once("documentUI.inc");
 	require_once("collaborationUI.inc");
 <?php
 /**
-* Presentation data for collaborationBL.php
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 28 January 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*
-*/
+ * $Id$
+ *  
+ * Presentation data for collaborationBL.php
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 function getGroupRow($iGroupID) {	
 	$oGroup = Group::get($iGroupID);
@@ -47,7 +49,9 @@ function getDocumentRoutingPage($iGroupID, $iUserID, $iRoleID, $iSequenceNumber,
 	$sSectionName = $default->siteMap->getSectionName(substr($_SERVER["PHP_SELF"], strlen($default->rootUrl), strlen($_SERVER["PHP_SELF"])));
 	$sTDBGColour = $default->siteMap->getSectionColour($sSectionName, "td");
 	$sTHBGColour = $default->siteMap->getSectionColour($sSectionName, "th");
-	return "<table cellspacing=2, cellpadding=2, border=0>\n" .
+	return 	renderHeading("Edit Document Approval Routing") .
+			displayDocumentPath($fDocumentID) .
+			"<table cellspacing=2, cellpadding=2, border=0>\n" .
 			"<caption><b>Document Routing</b></caption>\n" .
 			"<tr>\n" .
 			"<td bgcolor=\"$sTDBGColour\"><b>Group</b></td><td>".getGroupRow($iGroupID)."</td>\n" .
 <?php
 /**
-* Business logic data used to modify documents (will use modifyUI.inc)
-*
-* Expected form variables:
-*	o fDocumentID - primary key of document being edited
-* Optional form variables
-*	o fForUpdate - generated when user clicks update on page and results in database update
-*	o fFirstEdit - generated from the document upload page when the user first uploads a document.
-*				   Is used to force the user to enter the necessary generic meta data
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 24 January 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*
-*/
+ * $Id$
+ *
+ * Business logic data used to modify documents (will use modifyUI.inc)
+ *
+ * Expected form variables:
+ *	o fDocumentID - primary key of document being edited
+ * Optional form variables
+ *	o fForUpdate - generated when user clicks update on page and results in database update
+ *	o fFirstEdit - generated from the document upload page when the user first uploads a document.
+ *				   Is used to force the user to enter the necessary generic meta data
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
@@ -29,6 +31,7 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternEditableTableSqlQuery.inc");
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternEditableListFromQuery.inc");
 	require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/modifyUI.inc");
+	require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/documentUI.inc");
 	require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/foldermanagement/folderUI.inc");				
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
 <?php
 /**
-* Expected form variables:
-*	o fDocumentID - primary key of document being editid
-* Optional form variables:
-*	o fFirstTime - set by addDocumentBL on first time uploads and forces the user to
-*				   fill out the generic meta data
-* 
-* 
-*/
+ * $Id$
+ *
+ * Expected form variables:
+ *	o fDocumentID - primary key of document being editid
+ * Optional form variables:
+ *	o fFirstTime - set by addDocumentBL on first time uploads and forces the user to
+ *				   fill out the generic meta data
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
@@ -19,6 +21,7 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternEditableTableSqlQuery.inc");
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternMetaData.inc");					
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
+	require_once("documentUI.inc");
 	require_once("modifyGenericMetaDataUI.inc");
 	if (Permission::userHasDocumentWritePermission($fDocumentID)) {
 <?php
-
+/**
+ * $Id$
+ *
+ * Contains HTML information required to display the generic meta data edit page.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
+ 
 function getEditableGenericMetaData($iDocumentID, $iDocumentTypeID) {
     global $default;
     $sQuery = "SELECT DISTINCT $iDocumentID AS document_id, COALESCE(DFL.id, -1) AS id, DF.id AS document_field_id, DFL.value AS value, DF.name AS field_name " .
@@ -25,7 +33,10 @@ function getEditableGenericMetaData($iDocumentID, $iDocumentTypeID) {
 function getPage($iDocumentID, $iDocumentTypeID, $fFirstEdit) {
 	global $default;
-	$sToRender = "<table>\n";
+	
+	$sToRender .= renderHeading("Edit Generic Meta Data");
+	$sToRender .= displayDocumentPath($iDocumentID);
+	$sToRender .= "<table>\n";
 	$sToRender .= "<tr>\n";		
 	$sToRender .= "<td>\n";
 	$sToRender .= getEditableGenericMetaData($iDocumentID, $iDocumentTypeID);
@@ -54,5 +65,4 @@ function getPage($iDocumentID, $iDocumentTypeID, $fFirstEdit) {
 	return $sToRender;
 }
-
-?>
+?>
 \ No newline at end of file
 <?php
 /**
-* Business logic to modify type specific meta data for a document
-* 
-* @author Rob Cherry, Jam Warehouse South Africa (Pty) Ltd
-* @date 28 February 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*/
+ * $Id$
+ *
+ * Business logic to modify type specific meta data for a document
+ * 
+ * @author Rob Cherry, Jam Warehouse South Africa (Pty) Ltd
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
-if (checkSession()) {
-	
+if (checkSession()) {	
 	require_once("$default->fileSystemRoot/lib/security/permission.inc");
 	require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc");
 	require_once("$default->fileSystemRoot/lib/foldermanagement/Folder.inc");
@@ -18,6 +18,7 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternEditableTableSqlQuery.inc");
 	require_once("$default->fileSystemRoot/lib/visualpatterns/PatternMetaData.inc");					
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
+	require_once("documentUI.inc");
 	require_once("modifySpecificMetaDataUI.inc");
 	if (Permission::userHasDocumentWritePermission($fDocumentID)) {
@@ -30,7 +31,5 @@ if (checkSession()) {
         $main->setHasRequiredFields(true);		
 		$main->render();
 	}
-	
 }
-
-?>
+?>
 \ No newline at end of file
 <?php
-
 /**
-* Presentation information used by modifySpecificMetaDataBL.php
-* 
-* @author Rob Cherry, Jam Warehouse South Africa (Pty) Ltd
-* @date 28 February 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*/
+ * $Id$
+ *
+ * Presentation information used by modifySpecificMetaDataBL.php
+ * 
+ * @author Rob Cherry, Jam Warehouse South Africa (Pty) Ltd
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 function getEditableTypeSpecificMetaData($iDocumentID, $iDocumentTypeID) {
     global $default;    
@@ -34,7 +34,9 @@ function getEditableTypeSpecificMetaData($iDocumentID, $iDocumentTypeID) {
 function getPage($iDocumentID, $iDocumentTypeID, $bFirstEdit) {
 	global $default;
-	$sToRender = "<table>\n";
+	$sToRender .= renderHeading("Edit Type Specific Meta Data");
+	$sToRender .= displayDocumentPath($iDocumentID);	
+	$sToRender .= "<table>\n";
 	$sToRender .= "<tr>\n";		
 	$sToRender .= "<td>\n";
 	$sToRender .= getEditableTypeSpecificMetaData($iDocumentID, $iDocumentTypeID);
@@ -62,7 +64,4 @@ function getPage($iDocumentID, $iDocumentTypeID, $bFirstEdit) {
 	return $sToRender;
 }
-
-?>
-
-
+?>
 \ No newline at end of file
 <?php
-
 /**
-* Presentation data used to modify documents (will be used by modifyBL.inc)
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 24 January 2003
-* @package presentation.lookAndFeel.knowledgeTree.documentmanagement
-*
-*/
+ * $Id$
+ *
+ * Presentation data used to modify documents (will be used by modifyBL.inc)
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ *
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 function renderDocumentPath($oDocument) {
     $sDocumentPath = displayFolderPathLink(Folder::getFolderPathAsArray($oDocument->getFolderID()), Folder::getFolderPathNamesAsArray($oDocument->getFolderID())) . " > " . $oDocument->getName();
@@ -21,8 +22,8 @@ function renderEditableDocumentData($oDocument, $iDocumentTypeID) {
 	$sToRender;
 	if ($oDocument) {
-		$sToRender = "<table>\n";
-		$sToRender .= "<caption>Document Data</caption>\n";
+		$sToRender .= "<table>\n";
+		$sToRender .= "<caption><strong>Document Data</strong></caption>\n";
 		$sToRender .= "<tr>\n";		
 		$sToRender .= "<td bgcolor=\"$sTDBGColour\">\n";
 		$sToRender .= "<b>Document Title </b>\n";
@@ -62,7 +63,9 @@ function getDocumentType($iFolderID, $iDocumentTypeID) {
 function renderPage($oDocument, $iDocumentTypeID, $fFirstEdit) {
     global $default;	
-    $sToRender = "<table border = 0>\n";
+	$sToRender = renderHeading("Edit Document Details");
+	$sToRender .= displayDocumentPath($oDocument->getID());	
+    $sToRender .= "<table border = 0>\n";
     $sToRender .= "<tr>\n";
     $sToRender .= "<td>\n";
     $sToRender .= renderEditableDocumentData($oDocument, $iDocumentTypeID) . "\n";
 <?php
 /**
-* Business logic for unlinking a parent document from a child documenbt
-*
-* Expected form variables:
-*	$fDocumentLinkID - primary key of document link to delete
-*	$fChildDocumentID - primary key of child document to which parent document is linked
-*	$fParentDocumentID - primary key of parent document
-*
-* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
-* @date 22 May 2003
-*
-*/
-
-
+ * $Id$
+ *  
+ * Business logic for unlinking a parent document from a child documenbt
+ *
+ * Expected form variables:
+ *	$fDocumentLinkID - primary key of document link to delete
+ *	$fChildDocumentID - primary key of child document to which parent document is linked
+ *	$fParentDocumentID - primary key of parent document
+ *
+ * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
+ * 
+ * @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
+ * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
+ */
 require_once("../../../../config/dmsDefaults.php");
 if (checkSession()) {
@@ -21,9 +22,9 @@ if (checkSession()) {
 	require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc");	
 	require_once("$default->fileSystemRoot/lib/documentmanagement/DocumentLink.inc");
 	require_once("$default->fileSystemRoot/presentation/Html.inc");
+	require_once("documentUI.inc");
 	require_once("removeDocumentLinkUI.inc");
-	
-	
+
 	if (Permission::userHasDocumentWritePermission($fParentDocumentID)) {
 		if (isset($fForDelete)) {
 			//deleting a document link
@@ -69,6 +70,4 @@ if (checkSession()) {
 		$main->render();
 	}
 }
-
-
 ?>
 \ No newline at end of file
@@ -21,6 +21,7 @@
 function getPage($sParentDocumentName, $sChildDocumentName, $iParentDocumentID) {
 	global $default;
 	$sToRender = renderHeading("Unlink document");
+	$sToRender .= displayDocumentPath($iParentDocumentID);
 	$sToRender .= "<table>\n";
 	$sToRender .= "<tr>\n";	
 	$sToRender .= "<td>You have chosen to delete the link between the document '$sParentDocumentName' and the document '$sChildDocumentName'</td>\n";