Commit 64dfc3bae766cccaff2ad5a889c213016a49c56b

Authored by michael
1 parent 1c2ce567

refactored check in/out ui pages to separate files


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@2165 c91229c3-7414-0410-bfa2-8a42b809f60b
presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc 0 → 100644
  1 +<?php
  2 +
  3 +/**
  4 + * $Id$
  5 + *
  6 + * HTML information for document stuff.
  7 + *
  8 + * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
  9 + *
  10 + * @version $Revision$
  11 + * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
  12 + * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
  13 + */
  14 +
  15 +/**
  16 + * Prompts the user for a check in comment and revision type
  17 + *
  18 + * @param object the document we're checking in
  19 + */
  20 +function renderCheckInPage($oDocument) {
  21 + global $default;
  22 +
  23 + $sToRender = "<table>\n";
  24 + $sToRender .= "<tr><td>Select the file to check in:</td></tr>\n";
  25 + $sToRender .= "<tr><td><input type=\"file\" name=\"fFile\">";
  26 + /*
  27 + $sToRender .= "<tr><td><input type=\"file\" name=\"browse\" style=\"display:none\">";
  28 + $sToRender .= "<input type=\"text\" name=\"fFile\"\>\n";
  29 + $sToRender .= "<a href=\"#\" onClick=\"document.MainForm.browse.click();document.MainForm.fFile.value=document.MainForm.browse.value;return false;\">";
  30 + $sToRender .= "<img src=\"$default->graphicsUrl/widgets/browse.gif\" alt=\"browse\" border=\"0\"></a>\n";
  31 + */
  32 + $sToRender .= "</td></tr>\n";
  33 + $sToRender .= "</table>\n";
  34 +
  35 + $sToRender .= "<table>\n";
  36 + $sToRender .= "<tr><td>Enter a check in comment for '" . $oDocument->getName() . "'</td></tr>\n";
  37 + $sToRender .= "<tr/>\n";
  38 + $sToRender .= "<tr><td><input type=\"text\" name=\"fCheckInComment\" size=\"30\"/></td></tr>\n";
  39 + $sToRender .= "<input type=\"hidden\" name=\"fForStore\" value=\"1\"/>\n";
  40 + $sToRender .= "<input type=\"hidden\" name=\"fDocumentID\" value=\"" . $oDocument->getID() . "\"/>\n";
  41 + // if collaboration has started then revisions are minor
  42 + if (DocumentCollaboration::documentCollaborationStarted($oDocument->getID())) {
  43 + $sToRender .= "<input type=\"hidden\" name=\"fCheckInType\" value=\"minor\"/>\n";
  44 + // else there is no collaboration, revisions are major (or override?)
  45 + } else {
  46 + $sToRender .= "<input type=\"hidden\" name=\"fCheckInType\" value=\"major\"/>\n";
  47 + }
  48 +
  49 + /*
  50 + $sToRender .= "<tr><td>\n";
  51 + $sToRender .= "<input type=\"radio\" name=\"fCheckInType\" value=\"minor\" checked /> Minor Revision\n";
  52 + $sToRender .= "</tr></td>\n";
  53 + $sToRender .= "<tr><td>\n";
  54 + $sToRender .= "<input type=\"radio\" name=\"fCheckInType\" value=\"major\"/> Major Revision\n";
  55 + $sToRender .= "</tr></td>\n";
  56 + */
  57 + $sToRender .= "</table>\n";
  58 +
  59 + $sToRender .= "<table>\n";
  60 + $sToRender .= "<tr>\n";
  61 + $sToRender .= "<td><input type=\"image\" border=\"0\" src =\"$default->graphicsUrl/widgets/checkin.gif\" value=\"Submit\" onClick=\"if (validRequired(document.MainForm.fFile, 'Check-In File') && validRequired(document.MainForm.fCheckInComment, 'Check-In Comment')) { return confirm('Are you sure you want to overwrite " . $oDocument->getName() . " with ' + document.MainForm.fFile.value + '?'); } else return false;\"/>\n";
  62 + $sToRender .= "<a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
  63 + $sToRender .= "</tr>\n";
  64 + $sToRender .= "</table>\n";
  65 +
  66 + /*
  67 + $sToRender .= "\n\n<script language=\"javascript\">\n<!--\n";
  68 + $sToRender .= "function validateCheckIn() {\n";
  69 + $sToRender .= "alert('blah'); return false;\n";
  70 + $sToRender .= " if (validRequired(document.MainForm.fFile, 'Check-In File') && validRequired(document.MainForm.fCheckInComment, 'Check-In Comment')) {\n";
  71 + $sToRender .= " var directoryTokensArray=document.MainForm.fComment.split('\');\n";
  72 + $sToRender .= " if (directoryTokensArray.length == 0) {\n";
  73 + $sToRender .= " directoryTokensArray = document.MainForm.fComment.split('/');\n";
  74 + $sToRender .= " }\n";
  75 + //$sToRender .= "alert('filename=' + directoryTokensArray[directoryTokensArray.length-1]);\n";
  76 + $sToRender .= " if ('" . $oDocument->getFileName() . "' <> directoryTokensArray[directoryTokensArray.length-1]) {\n";
  77 + $sToRender .= " alert('Please check in the same file, you attempted to check in ' + document.MainForm.fComment + '!');\n";
  78 + $sToRender .= " return false;\n";
  79 + $sToRender .= " } else {\n";
  80 + $sToRender .= " return confirm('Are you sure you want to overwrite " . $oDocument->getName() . " with ' + document.MainForm.fFile.value + '?');\n";
  81 + $sToRender .= " }\n";
  82 + $sToRender .= " } else {\n";
  83 + $sToRender .= " return false;\n";
  84 + $sToRender .= " }\n";
  85 + $sToRender .= "}\n";
  86 + $sToRender .= "//-->\n</script>\n\n";
  87 + */
  88 + return $sToRender;
  89 +}
  90 +
  91 +/**
  92 + * Displays the document view page with additional input controls
  93 + * for checking in the document
  94 + *
  95 + * @param object the document to view and check out
  96 + */
  97 +function getCheckInPage($oDocument) {
  98 + return getPage($oDocument, false, renderCheckInPage($oDocument));
  99 +}
  100 +?>
0 101 \ No newline at end of file
... ...
presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc 0 → 100644
  1 +<?php
  2 +
  3 +/**
  4 + * $Id$
  5 + *
  6 + * HTML information for document stuff.
  7 + *
  8 + * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
  9 + *
  10 + * @version $Revision$
  11 + * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
  12 + * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
  13 + */
  14 +
  15 +/**
  16 + * Prompts the user for a checkout comment
  17 + *
  18 + * @param object the document we're checking out
  19 + */
  20 +function renderCheckOutPage($oDocument) {
  21 + global $default;
  22 +
  23 + $sToRender = "<table>\n";
  24 + $sToRender .= "<tr><td>Enter a check out comment for '" . $oDocument->getName() . "'</td></tr>\n";
  25 + $sToRender .= "<tr/>\n";
  26 + $sToRender .= "<tr><td><input type=\"text\" name=\"fCheckOutComment\" size=\"30\"/></td></tr>\n";
  27 + $sToRender .= "<tr><td><input type=\"hidden\" name=\"fForStore\" value=\"1\"/></td></tr>\n";
  28 + $sToRender .= "<tr><td><input type=\"hidden\" name=\"fDocumentID\" value=\"" . $oDocument->getID() . "\"/></td></tr>\n";
  29 + $sToRender .= "<tr>\n";
  30 + $sToRender .= "</tr>\n";
  31 + $sToRender .= "<tr>\n";
  32 + $sToRender .= "<td><input type=\"image\" border=\"0\" src =\"$default->graphicsUrl/widgets/checkout.gif\" value=\"Submit\"/>\n";
  33 + $sToRender .= "<a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
  34 + $sToRender .= "</tr>\n";
  35 + $sToRender .= "</table>\n";
  36 +
  37 + return $sToRender;
  38 +}
  39 +
  40 +/**
  41 + * Displays the document view page with additional input controls
  42 + * for checking out the document
  43 + *
  44 + * @param object the document to view and check out
  45 + */
  46 +function getCheckOutPage($oDocument, $bCheckedOut = false) {
  47 + global $default;
  48 +
  49 + if ($bCheckedOut) {
  50 + $sToRender .= "<table>";
  51 + $sToRender .= "<tr><td>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></tr>\n";
  52 + $sToRender .= "<tr><td><a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "&fForDownload=1\"><img src=\"$default->graphicsUrl/widgets/download.gif\" border=\"0\" /></a>\n";
  53 + $sToRender .= "<a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"$default->graphicsUrl/widgets/back.gif\" border=\"0\" /></a></td>\n";
  54 + $sToRender .= "</table>";
  55 + } else {
  56 + $sToRender .= renderCheckOutPage($oDocument);
  57 + }
  58 +
  59 + return getPage($oDocument, false, $sToRender);
  60 +}
  61 +?>
0 62 \ No newline at end of file
... ...
presentation/lookAndFeel/knowledgeTree/documentmanagement/documentUI.inc
... ... @@ -78,90 +78,6 @@ function displayDocumentLink($oDocument, $bDisplayFullPath = false) {
78 78 $sIconPath . "&nbsp;" . $sLinkText);
79 79 }
80 80  
81   -/**
82   - * Prompts the user for a check in comment and revision type
83   - *
84   - * @param object the document we're checking in
85   - */
86   -function renderCheckInPage($oDocument) {
87   - global $default;
88   -
89   - $sToRender = "<table>\n";
90   - $sToRender .= "<tr><td>Select the file to check in:</td></tr>\n";
91   - $sToRender .= "<tr><td><input type=\"file\" name=\"fFile\">";
92   - /*
93   - $sToRender .= "<tr><td><input type=\"file\" name=\"browse\" style=\"display:none\">";
94   - $sToRender .= "<input type=\"text\" name=\"fFile\"\>\n";
95   - $sToRender .= "<a href=\"#\" onClick=\"document.MainForm.browse.click();document.MainForm.fFile.value=document.MainForm.browse.value;return false;\">";
96   - $sToRender .= "<img src=\"$default->graphicsUrl/widgets/browse.gif\" alt=\"browse\" border=\"0\"></a>\n";
97   - */
98   - $sToRender .= "</td></tr>\n";
99   - $sToRender .= "</table>\n";
100   -
101   - $sToRender .= "<table>\n";
102   - $sToRender .= "<tr><td>Enter a check in comment for '" . $oDocument->getName() . "'</td></tr>\n";
103   - $sToRender .= "<tr/>\n";
104   - $sToRender .= "<tr><td><input type=\"text\" name=\"fCheckInComment\" size=\"30\"/></td></tr>\n";
105   - $sToRender .= "<tr><td><input type=\"hidden\" name=\"fForStore\" value=\"1\"/></td></tr>\n";
106   - $sToRender .= "<tr><td><input type=\"hidden\" name=\"fDocumentID\" value=\"" . $oDocument->getID() . "\"/></td></tr>\n";
107   - $sToRender .= "<tr><td>\n";
108   -
109   - // if collaboration has started then revisions are minor
110   - if (DocumentCollaboration::documentCollaborationStarted($oDocument->getID())) {
111   - $sToRender .= "<input type=\"hidden\" name=\"fCheckInType\" value=\"minor\"/>\n";
112   - // else there is no collaboration, revisions are major (or override?)
113   - } else {
114   - $sToRender .= "<input type=\"hidden\" name=\"fCheckInType\" value=\"major\"/>\n";
115   - }
116   - $sToRender .= "</tr></td>\n";
117   - /*
118   - $sToRender .= "<tr><td>\n";
119   - $sToRender .= "<input type=\"radio\" name=\"fCheckInType\" value=\"minor\" checked /> Minor Revision\n";
120   - $sToRender .= "</tr></td>\n";
121   - $sToRender .= "<tr><td>\n";
122   - $sToRender .= "<input type=\"radio\" name=\"fCheckInType\" value=\"major\"/> Major Revision\n";
123   - $sToRender .= "</tr></td>\n";
124   - */
125   - $sToRender .= "</table>\n";
126   -
127   - $sToRender .= "<table>\n";
128   - $sToRender .= "<tr>\n";
129   - $sToRender .= "</tr>\n";
130   - $sToRender .= "<tr>\n";
131   - $sToRender .= "<td><input type=\"image\" border=\"0\" src =\"$default->graphicsUrl/widgets/checkin.gif\" value=\"Submit\" onClick=\"if (validRequired(document.MainForm.fFile, 'Check-In File') && validRequired(document.MainForm.fCheckInComment, 'Check-In Comment')) { return confirm('Are you sure you want to overwrite " . $oDocument->getName() . " with ' + document.MainForm.fFile.value + '?'); } else return false;\"/>\n";
132   - $sToRender .= "<a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
133   - $sToRender .= "</tr>\n";
134   - $sToRender .= "</table>\n";
135   -
136   - return $sToRender;
137   -}
138   -
139   -
140   -/**
141   - * Prompts the user for a checkout comment
142   - *
143   - * @param object the document we're checking out
144   - */
145   -function renderCheckOutPage($oDocument) {
146   - global $default;
147   -
148   - $sToRender = "<table>\n";
149   - $sToRender .= "<tr><td>Enter a check out comment for '" . $oDocument->getName() . "'</td></tr>\n";
150   - $sToRender .= "<tr/>\n";
151   - $sToRender .= "<tr><td><input type=\"text\" name=\"fCheckOutComment\" size=\"30\"/></td></tr>\n";
152   - $sToRender .= "<tr><td><input type=\"hidden\" name=\"fForStore\" value=\"1\"/></td></tr>\n";
153   - $sToRender .= "<tr><td><input type=\"hidden\" name=\"fDocumentID\" value=\"" . $oDocument->getID() . "\"/></td></tr>\n";
154   - $sToRender .= "<tr>\n";
155   - $sToRender .= "</tr>\n";
156   - $sToRender .= "<tr>\n";
157   - $sToRender .= "<td><input type=\"image\" border=\"0\" src =\"$default->graphicsUrl/widgets/checkout.gif\" value=\"Submit\" onClick=\"return validRequired(document.MainForm.fCheckOutComment, 'Check-Out Comment');\" />\n";
158   - $sToRender .= "<a href=\"$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
159   - $sToRender .= "</tr>\n";
160   - $sToRender .= "</table>\n";
161   -
162   - return $sToRender;
163   -}
164   -
165 81 function renderErrorPage($sErrorMessage, $iDocumentID = -1) {
166 82 global $default;
167 83 return "<p class=\"errorText\">$sErrorMessage</p>\n" .
... ...