Commit cdbba8801050ffc8d5a6a241df2013d8e04eb75b

Authored by Michael Joseph
1 parent 93e1ea51

integrated checkin and checkout forms with view document page


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@1204 c91229c3-7414-0410-bfa2-8a42b809f60b
presentation/lookAndFeel/knowledgeTree/documentmanagement/viewUI.inc
... ... @@ -15,7 +15,8 @@
15 15  
16 16 function renderDocumentPath($oDocument) {
17 17 global $default;
18   - $sDocumentPath = displayFolderPathLink(Folder::getFolderPathAsArray($oDocument->getFolderID()), Folder::getFolderPathNamesAsArray($oDocument->getFolderID()), "$default->rootUrl/control.php?action=browse") . " > <a href=\"" . $_SERVER["PHP_SELF"] . "?fDocumentID=" . $oDocument->getID() . "&fForInlineView=1\">" . $oDocument->getName() . "</a>";
  18 + //$sDocumentPath = displayFolderPathLink(Folder::getFolderPathAsArray($oDocument->getFolderID()), Folder::getFolderPathNamesAsArray($oDocument->getFolderID()), "$default->rootUrl/control.php?action=browse") . " > <a href=\"" . $_SERVER["PHP_SELF"] . "?fDocumentID=" . $oDocument->getID() . "&fForInlineView=1\">" . $oDocument->getName() . "</a>";
  19 + $sDocumentPath = displayFolderPathLink(Folder::getFolderPathAsArray($oDocument->getFolderID()), Folder::getFolderPathNamesAsArray($oDocument->getFolderID()), "$default->rootUrl/control.php?action=browse") . " > <a href=\"$default->rootUrl/presentation/lookAndFeel/knowledgeTree/documentmanagement/viewBL.php?fDocumentID=" . $oDocument->getID() . "&fForInlineView=1\">" . $oDocument->getName() . "</a>";
19 20 return "<table border=1 width = 100%><tr><td>$sDocumentPath</td></tr></table>\n";
20 21 }
21 22  
... ... @@ -232,6 +233,136 @@ function getViewPage($oDocument) {
232 233 return $sToRender;
233 234 }
234 235  
  236 +/**
  237 + * Displays the document view page with additional input controls
  238 + * for checking out the document
  239 + *
  240 + * @param object the document to view and check out
  241 + */
  242 +function getCheckOutEditPage($oDocument, $bCheckedOut = false) {
  243 + global $default;
  244 + $sToRender = renderDocumentPath($oDocument) . "\n<br>\n";
  245 + $sToRender .= "<table border = 0>\n";
  246 + $sToRender .= "<tr>\n";
  247 + $sToRender .= "<td>\n";
  248 + $sToRender .= "\t<table border = 0 width = 280>\n";
  249 + $sToRender .= "\t<tr width>\n";
  250 + $sToRender .= "\t\t<td>" . wrapInTable(renderDocumentData($oDocument)) . "</td>\n";
  251 + $sToRender .= "\t</tr>\n";
  252 + $sToRender .= "\t<tr>\n";
  253 + $sToRender .= "\t<td>" . wrapInTable(renderGenericMetaData($oDocument)) . "</td>\n";
  254 + $sToRender .= "\t<tr>\n";
  255 + $sToRender .= "\t<tr>\n";
  256 + $sToRender .= "\t\t<td>" . wrapInTable(renderTypeSpecificMetaData($oDocument)) . "</td>\n";
  257 + $sToRender .= "\t</tr>\n";
  258 + $sToRender .= "\t</table>\n";
  259 + $sToRender .= "</td>\n";
  260 + $sToRender .= "<td valign=top>\n";
  261 + $sToRender .= "\t<table border = 0, width = 230>\n";
  262 + $sToRender .= "\t<tr>\n";
  263 + $sToRender .= "\t\t<td>" . wrapInTable(renderNonEditableDocumentRouting($oDocument)) . "</td>\n";
  264 + $sToRender .= "\t<tr>\n";
  265 + $sToRender .= "\t<tr>\n";
  266 + if ($bCheckedOut) {
  267 + $sToRender .= "\t\t<td>" . wrapInTable("You have now checked out this document. No one else can make updates to the document while you have it checked out. Click the Download button to get the latest version of the file. Please check it back in, as soon as you finish working on it.") . "</td>\n";
  268 + } else {
  269 + $sToRender .= "\t\t<td>" . wrapInTable(renderCheckOutPage($oDocument)) . "</td>\n";
  270 + }
  271 + $sToRender .= "\t</tr>";
  272 + $sToRender .= "\t</table>";
  273 + $sToRender .= "</td>\n";
  274 + $sToRender .= "</tr>\n";
  275 + $sToRender .= "</table>";
  276 + $sToRender .= "<table>\n";
  277 + $sToRender .= "<tr>\n";
  278 + $sToRender .= "<td><a href=\"" . $_SERVER["PHP_SELF"] . "?fDocumentID=" . $oDocument->getID() . "&fForDownload=1\"><img src=\"$default->graphicsUrl/widgets/download.gif\" border=\"0\" /></a></td>\n";
  279 + $sToRender .= "<td><a href=\"" . generateControllerLink("emailDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/email.gif\" border=\"0\" /></a></td>\n";
  280 +
  281 + // display the check in button if the document is checked out
  282 + if ($oDocument->getIsCheckedOut()) {
  283 + $sToRender .= "<td><a href=\"" . generateControllerLink("checkInDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/checkin.gif\" border=\"0\" /></a></td>\n";
  284 + // otherwise display the check out button
  285 + } else {
  286 + $sToRender .= "<td><a href=\"" . generateControllerLink("checkOutDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/checkout.gif\" border=\"0\" /></a></td>\n";
  287 + }
  288 +
  289 + // display the unsubscribe button if the user is subscribed to the document
  290 + if (Subscription::exists($_SESSION["userID"], $oDocument->getID(), SubscriptionConstants::subscriptionType("DocumentSubscription"))) {
  291 + $sToRender .= "<td><a href=\"" . generateControllerLink("removeSubscription", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/unsubscribe.gif\" border=\"0\" /></a></td>\n";
  292 + // otherwise display the subscribe button
  293 + } else {
  294 + $sToRender .= "<td><a href=\"" . generateControllerLink("addSubscription", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/subscribe.gif\" border=\"0\" /></a></td>\n";
  295 + }
  296 +
  297 + $sToRender .= "</tr>\n";
  298 + $sToRender .= "</table>\n";
  299 +
  300 + return $sToRender;
  301 +}
  302 +
  303 +/**
  304 + * Displays the document view page with additional input controls
  305 + * for checking in the document
  306 + *
  307 + * @param object the document to view and check out
  308 + */
  309 +function getCheckInEditPage($oDocument) {
  310 + global $default;
  311 + $sToRender = renderDocumentPath($oDocument) . "\n<br>\n";
  312 + $sToRender .= "<table border = 0>\n";
  313 + $sToRender .= "<tr>\n";
  314 + $sToRender .= "<td>\n";
  315 + $sToRender .= "\t<table border = 0 width = 280>\n";
  316 + $sToRender .= "\t<tr width>\n";
  317 + $sToRender .= "\t\t<td>" . wrapInTable(renderDocumentData($oDocument)) . "</td>\n";
  318 + $sToRender .= "\t</tr>\n";
  319 + $sToRender .= "\t<tr>\n";
  320 + $sToRender .= "\t<td>" . wrapInTable(renderGenericMetaData($oDocument)) . "</td>\n";
  321 + $sToRender .= "\t<tr>\n";
  322 + $sToRender .= "\t<tr>\n";
  323 + $sToRender .= "\t\t<td>" . wrapInTable(renderTypeSpecificMetaData($oDocument)) . "</td>\n";
  324 + $sToRender .= "\t</tr>\n";
  325 + $sToRender .= "\t</table>\n";
  326 + $sToRender .= "</td>\n";
  327 + $sToRender .= "<td valign=top>\n";
  328 + $sToRender .= "\t<table border = 0, width = 230>\n";
  329 + $sToRender .= "\t<tr>\n";
  330 + $sToRender .= "\t\t<td>" . wrapInTable(renderNonEditableDocumentRouting($oDocument)) . "</td>\n";
  331 + $sToRender .= "\t<tr>\n";
  332 + $sToRender .= "\t<tr>\n";
  333 + $sToRender .= "\t\t<td>" . wrapInTable(renderCheckInPage($oDocument)) . "</td>\n";
  334 + $sToRender .= "\t</tr>";
  335 + $sToRender .= "\t</table>";
  336 + $sToRender .= "</td>\n";
  337 + $sToRender .= "</tr>\n";
  338 + $sToRender .= "</table>";
  339 + $sToRender .= "<table>\n";
  340 + $sToRender .= "<tr>\n";
  341 + $sToRender .= "<td><a href=\"" . $_SERVER["PHP_SELF"] . "?fDocumentID=" . $oDocument->getID() . "&fForDownload=1\"><img src=\"$default->graphicsUrl/widgets/download.gif\" border=\"0\" /></a></td>\n";
  342 + $sToRender .= "<td><a href=\"" . generateControllerLink("emailDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/email.gif\" border=\"0\" /></a></td>\n";
  343 +
  344 + // display the check in button if the document is checked out
  345 + if ($oDocument->getIsCheckedOut()) {
  346 + $sToRender .= "<td><a href=\"" . generateControllerLink("checkInDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/checkin.gif\" border=\"0\" /></a></td>\n";
  347 + // otherwise display the check out button
  348 + } else {
  349 + $sToRender .= "<td><a href=\"" . generateControllerLink("checkOutDocument", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/checkout.gif\" border=\"0\" /></a></td>\n";
  350 + }
  351 +
  352 + // display the unsubscribe button if the user is subscribed to the document
  353 + if (Subscription::exists($_SESSION["userID"], $oDocument->getID(), SubscriptionConstants::subscriptionType("DocumentSubscription"))) {
  354 + $sToRender .= "<td><a href=\"" . generateControllerLink("removeSubscription", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/unsubscribe.gif\" border=\"0\" /></a></td>\n";
  355 + // otherwise display the subscribe button
  356 + } else {
  357 + $sToRender .= "<td><a href=\"" . generateControllerLink("addSubscription", "fDocumentID=" . $oDocument->getID()) . "\"><img src=\"$default->graphicsUrl/widgets/subscribe.gif\" border=\"0\" /></a></td>\n";
  358 + }
  359 +
  360 + $sToRender .= "</tr>\n";
  361 + $sToRender .= "</table>\n";
  362 +
  363 + return $sToRender;
  364 +}
  365 +
235 366 function wrapInTable($sHtml) {
236 367 return "\n\t\t\t<table border = 1, width = 100%><tr><td>$sHtml</td></tr></table>\n";
237 368 }
... ...