Source for file EditTags.php
Documentation is available at EditTags.php
// include the config file
require_once '../util/AlphaConfig.inc';
require_once $config->get('sysRoot'). 'alpha/controller/Edit.php';
require_once $config->get('sysRoot'). 'alpha/model/TagObject.inc';
require_once $config->get('sysRoot'). 'alpha/controller/AlphaControllerInterface.inc';
require_once $config->get('sysRoot'). 'alpha/exceptions/IllegalArguementException.inc';
require_once $config->get('sysRoot'). 'alpha/exceptions/BONotFoundException.inc';
require_once $config->get('sysRoot'). 'alpha/exceptions/FailedSaveException.inc';
require_once $config->get('sysRoot'). 'alpha/view/AlphaView.inc';
* Controller used to edit TagObjects related to the BO indicated in the supplied
* @package alpha::controller
* @author John Collins <dev@alphaframework.org>
* @version $Id: EditTags.php 1341 2011-03-17 15:02:02Z johnc $
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
private static $logger = null;
* constructor to set up the object
self::$logger = new Logger('EditTags');
self::$logger->debug('>>__construct()');
// ensure that the super class constructor is called, indicating the rights group
parent::__construct('Admin');
// set up the title and meta details
self::$logger->debug('<<__construct');
* @throws IllegalArguementException
* @throws FileNotFoundException
public function doGET($params) {
self::$logger->debug('>>doGET($params=['. var_export($params, true). '])');
// ensure that a bo is provided
if (isset ($params['bo']))
// ensure that a OID is provided
if (isset ($params['oid']))
$tags = $this->BO->getPropObject('tags')->getRelatedObjects();
echo '<table cols="3" class="edit_view">';
echo '<form action="'. $_SERVER['REQUEST_URI']. '" method="POST">';
echo '<tr><td colspan="3"><h3>The following tags were found:</h3></td></tr>';
$labels = $tag->getDataLabels();
$temp = new StringBox($tag->getPropObject('content'), $labels['content'], 'content_'. $tag->getID(), '');
echo $temp->render(false);
$js = "$('#dialogDiv').text('Are you sure you wish to delete this tag?');
'OK': function(event, ui) {
$('#deleteOID').attr('value', '". $tag->getID(). "');
$('#deleteForm').submit();
'Cancel': function(event, ui) {
$('#dialogDiv').dialog('open');
$button = new Button($js, "Delete", "deleteBut");
echo $button->render(). '</td></tr>';
echo '<tr><td colspan="3"><h3>Add a new tag:</h3></td></tr>';
echo $temp->render(false);
echo '</td><td></td></tr>';
echo '<tr><td colspan="3">';
$temp = new Button('submit', 'Save', 'saveBut');
$msg = 'Unable to load the BO of id ['. $params['oid']. '], error was ['. $e->getMessage(). ']';
self::$logger->error($msg);
throw new FileNotFoundException($msg);
self::$logger->debug('<<doGET');
* @throws SecurityException
* @throws IllegalArguementException
public function doPOST($params) {
self::$logger->debug('>>doPOST($params=['. var_export($params, true). '])');
// check the hidden security fields before accepting the form POST data
throw new SecurityException('This page cannot accept post data from remote servers!');
// ensure that a bo is provided
if (isset ($params['bo']))
// ensure that a OID is provided
if (isset ($params['oid']))
if (isset ($params['saveBut'])) {
$tags = $this->BO->getPropObject('tags')->getRelatedObjects();
foreach ($tags as $tag) {
// handle new tag if posted
if(isset ($params['new_value']) && trim($params['new_value']) != '') {
$newTag->set('taggedOID', $BOoid);
$newTag->set('taggedClass', $BOName);
* The unique key has most-likely been violated because this BO is already tagged with this
self::$logger->error('Unable to save the tags of id ['. $params['oid']. '], error was ['. $e->getMessage(). ']');
if (!empty($params['deleteOID'])) {
$tag->load($params['deleteOID']);
$content = $tag->get('content');
self::$logger->error('Unable to delete the tag of id ['. $params['deleteOID']. '], error was ['. $e->getMessage(). ']');
self::$logger->warn($e->getMessage());
}catch (IllegalArguementException $e) {
self::$logger->error($e->getMessage());
}catch (BONotFoundException $e) {
self::$logger->warn($e->getMessage());
$this->setStatusMessage(AlphaView::displayErrorMessage('Failed to load the requested item from the database!'));
self::$logger->debug('<<doPOST');
* Using this callback to blank the new_value field when the page loads, regardless of anything being posted
$html .= '<script language="javascript">';
$html .= 'function clearNewField() {';
$html .= ' document.getElementById("new_value").value = "";';
$html .= 'addOnloadEvent(clearNewField);';
// now build the new controller if this file is called directly
if ('EditTags.php' == basename($_SERVER['PHP_SELF'])) {
$controller->doPOST($_REQUEST);
$controller->doGET($_GET);
|