subscriptionUI.inc 7.91 KB
<?php

/**
 * $Id$
 *
 * UI for subscription pages.
 *
 * Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
 *
 * @version $Revision$
 * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
 * @package presentation.lookAndFeel.knowledgeTree.subscriptions
 */

/**
 * Displays all current subscriptions with remove checkbox
 */
function renderManagePage() {
    global $default;
    
    // retrieve subscriptions for this user
    $aFolderSubscriptions = SubscriptionManager::retrieveUserSubscriptions($_SESSION["userID"], SubscriptionConstants::subscriptionType("FolderSubscription"));
    $aDocumentSubscriptions = SubscriptionManager::retrieveUserSubscriptions($_SESSION["userID"], SubscriptionConstants::subscriptionType("DocumentSubscription"));    
    $bNoSubscriptions  = ( (count($aFolderSubscriptions) == 0) && (count($aDocumentSubscriptions) == 0) ) ? true : false; 

	$sToRender  = "<table>\n";
    if ($bNoSubscriptions) {
        $sToRender .= "<tr><td>You are not subscribed to any documents or folders.</td></tr>\n";       
    } else {
        $sToRender .= "<tr><td>The documents and folders you're subscribed to are listed below.</td></tr>\n";
        $sToRender .= "<tr><td>Select the subscriptions you'd like to unsubscribe from, and click 'Unsubscribe'</td></tr>\n";
    }
	$sToRender .= "<tr/>\n";
    $sToRender .= "<tr/>\n";
    
    // loop through them    
    for ($i = 0; $i < count($aFolderSubscriptions); $i++) {
        $sToRender .= "\t<tr>\n";
        $sToRender .= "\t\t<td>\n";
        $sToRender .= "<input type=\"checkbox\" name=\"fFolderSubscriptionIDs[]\" value=\"" . $aFolderSubscriptions[$i]->getID() . "\"/>\n";        
        if ($aFolderSubscriptions[$i]->getIsAlerted()) {
            $sToRender .= $aFolderSubscriptions[$i]->getAlertLink() . "\n";
        } else {
            $sToRender .= $aFolderSubscriptions[$i]->getContentLink() . "\n";
        }
        $sToRender .= "\t\t</td>\n";
        $sToRender .= "\t</tr>\n";
    }
    for ($i = 0; $i < count($aDocumentSubscriptions); $i++) {
        $sToRender .= "\t<tr>\n";
        $sToRender .= "\t\t<td>\n";
        $sToRender .= "<input type=\"checkbox\" name=\"fDocumentSubscriptionIDs[]\" value=\"" . $aDocumentSubscriptions[$i]->getID() . "\"/>\n";        
        if ($aDocumentSubscriptions[$i]->getIsAlerted()) {
            $sToRender .= $aDocumentSubscriptions[$i]->getAlertLink() . "\n";
        } else {
            $sToRender .= $aDocumentSubscriptions[$i]->getContentLink() . "\n";
        }
        $sToRender .= "\t\t</td>\n";
        $sToRender .= "\t</tr>\n";
    }    

	$sToRender .= "<tr/>\n";
	$sToRender .= "<tr/>\n";
    $sToRender .= "<tr><td>";
    if (!$bNoSubscriptions) {
        $sToRender .= "<input type=\"image\" src=\"$default->graphicsUrl/widgets/unsubscribe.gif\"/></a>\n";
    }
  	$sToRender .= "<a href=\"$default->rootUrl/control.php?action=dashboard\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a>\n";
	$sToRender .= "</td></tr>\n";
    $sToRender .= "</table>\n";
    
    return $sToRender;
}

/**
 * Asks for confirmation for removing multiple subscriptions
 * 
 * @param array subscriptions to remove
 */
function renderMultipleRemoveConfirmationPage($aFolderSubscriptions, $aDocumentSubscriptions) {
    global $default;
    
	$sToRender  = "<table>\n";
    $sToRender .= "<tr><td>You have chosen to delete the following subscription(s):</td></tr>\n";
	$sToRender .= "<tr/>\n";
    $sToRender .= "<tr/>\n";
    
    // loop through them
    for ($i = 0; $i < count($aFolderSubscriptions); $i++) {
        $sToRender .= "\t<tr>\n";
        $sToRender .= "\t\t<td>\n";
        $sToRender .= $aFolderSubscriptions[$i]->getContentDisplayPath() . "\n";
        $sToRender .= "\t\t</td>\n";
        $sToRender .= "\t</tr>\n";
        $sToRender .= "<input type=\"hidden\" name=\"fFolderSubscriptionIDs[]\" value=\"" . $aFolderSubscriptions[$i]->getID() . "\"/>";
    }
    
    for ($i = 0; $i < count($aDocumentSubscriptions); $i++) {
        $sToRender .= "\t<tr>\n";
        $sToRender .= "\t\t<td>\n";
        $sToRender .= $aDocumentSubscriptions[$i]->getContentDisplayPath() . "\n";
        $sToRender .= "\t\t</td>\n";
        $sToRender .= "\t</tr>\n";
        $sToRender .= "<input type=\"hidden\" name=\"fDocumentSubscriptionIDs[]\" value=\"" . $aDocumentSubscriptions[$i]->getID() . "\"/>";
    }
    
    $sToRender .= "<tr/>\n";
    $sToRender .= "<tr/>\n";
	$sToRender .= "<td>Select 'Unsubscribe' to confirm the deletion(s), or 'Cancel' to cancel them</td>\n";
    $sToRender .= "<tr/>\n";
    $sToRender .= "<tr/>\n";
    $sToRender .= "<input type=\"hidden\" name=\"fConfirmed\" value=\"1\"/>";
    $sToRender .= "<tr><td><input type=\"image\" src=\"$default->graphicsUrl/widgets/unsubscribe.gif\"/></a>\n";    
	$sToRender .= "<a href=\"javascript:history.go(-1)\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
	$sToRender .= "</tr>\n";
    $sToRender .= "</table>\n";
    
    return $sToRender;
}

 /**
 * Confirms the users subscription deletion
 *
 * @param object the subscription
 */
function renderRemoveConfirmationPage($oSubscription) {
	global $default;
	
    $sContentType = $oSubscription->getSubscriptionTypeName();
    if ($sContentType == "folder") {
        $sContentName = Folder::getFolderName($oSubscription->getExternalID());
        $sContentUrl = "fFolderID=" . $oSubscription->getExternalID();
    } else {
        $sContentName = Document::getDocumentName($oSubscription->getExternalID());
        $sContentUrl = "fDocumentID=" . $oSubscription->getExternalID();        
    }
 
	$sToRender  = "<table>\n";
	$sToRender .= "<tr><td>You have chosen to delete the your $sContentType subscription to '$sContentName'.</td></tr>\n";
	$sToRender .= "<tr/>\n";
	$sToRender .= "<tr/>\n";
	$sToRender .= "<td>Select 'Unsubscribe' to confirm the deletion, or 'Cancel' to cancel it</td>\n";
	$sToRender .= "</tr>\n";
    $sToRender .= "<tr/>\n";
    $sToRender .= "<tr><td><a href=\"$default->rootUrl/control.php?action=removeSubscription&$sContentUrl&fConfirmed=1\"><img src =\"$default->graphicsUrl/widgets/unsubscribe.gif\" border=\"0\"/></a>\n";
	$sToRender .= "<a href=\"" . $oSubscription->getContentUrl() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
	$sToRender .= "</tr>\n";
	$sToRender .= "</table>\n";
	
	return $sToRender;
}

/**
 * Confirms the users subscription addition
 *
 * @param object the subscription 
 */
function renderAddConfirmationPage($oSubscription) {
	global $default;
	
    $sContentType = $oSubscription->getSubscriptionTypeName();
    if ($sContentType == "folder") {
        $sContentName = Folder::getFolderName($oSubscription->getExternalID());
        $sContentUrl = "fFolderID=" . $oSubscription->getExternalID();
    } else {
        $sContentName = Document::getDocumentName($oSubscription->getExternalID());
        $sContentUrl = "fDocumentID=" . $oSubscription->getExternalID();        
    }
 
	$sToRender  = "<table>\n";
	$sToRender .= "<tr><td>You have chosen to subscribe to the $sContentType entitled '$sContentName'.</td></tr>\n";
	$sToRender .= "<tr/>\n";
	$sToRender .= "<tr>\n";
	$sToRender .= "<td>Select 'Subscribe' to confirm the subscription, or 'Cancel' to cancel it</td>\n";
	$sToRender .= "</tr>\n";
    $sToRender .= "<tr/>\n";
    $sToRender .= "<tr><td><a href=\"$default->rootUrl/control.php?action=addSubscription&$sContentUrl&fConfirmed=1\"><img src =\"$default->graphicsUrl/widgets/subscribe.gif\" border=\"0\"/></a>\n";
	$sToRender .= "<a href=\"" . $oSubscription->getContentUrl() . "\"><img src=\"$default->graphicsUrl/widgets/cancel.gif\" border=\"0\"></a></td>\n";
	$sToRender .= "</tr>\n";
	$sToRender .= "</table>\n";
	
	return $sToRender;    
}

function renderErrorPage($sErrorMessage) {
    global $default;
    return "<p class=\"errorText\">$sErrorMessage</p>\n" .
           "<a href=\"javascript:history.go(-1)\"><img src=\"$default->graphicsUrl/widgets/back.gif\" border=\"0\"/></a>\n";
}
?>