Attachment #2537 for bug #4474




 * @package plugins.generic.customBlockManager
 * @class CustomBlockEditForm
 *
 * Form for conference managers to create and modify sidebar blocks
 * 
 */

import('form.Form');

class CustomBlockEditForm extends Form {
	/** @var $conferenceId int */
	var $conferenceId;

	/** @var $plugin object */
	var $plugin;


	/**
	 * Constructor
	 * @param $conferenceId int
	 */
	function CustomBlockEditForm(&$plugin, $conferenceId) {

		parent::Form($plugin->getTemplatePath() . 'editCustomBlockForm.tpl');

		$this->conferenceId = $conferenceId;
		$this->plugin =& $plugin;

		$this->addCheck(new FormValidatorPost($this));

	 * Initialize form data from current group group.
	 */
	function initData() {
		$conferenceId = $this->conferenceId;
		$plugin =& $this->plugin;

		// add the tiny MCE script 
		$this->addTinyMCE();
		$this->setData('blockContent', $plugin->getSetting($conferenceId, 0, 'blockContent'));
	}

	/**
	 * Add the tinyMCE script for editing sidebar blocks with a WYSIWYG editor
	 */
	function addTinyMCE() {
		$conferenceId = $this->conferenceId;
		$plugin =& $this->plugin;
		$templateMgr =& TemplateManager::getManager();

		// Enable TinyMCE with specific params
		$additionalHeadData = $templateMgr->get_template_vars('additionalHeadData');

		import('file.ConferenceFileManager');
		$publicFileManager = new PublicFileManager();
		$tinyMCE_script = '
		<script language="javascript" type="text/javascript" src="'.Request::getBaseUrl().'/'.TINYMCE_JS_PATH.'/tiny_mce.js"></script>

			theme_advanced_toolbar_align : "left",
			content_css : "' . Request::getBaseUrl() . '/styles/common.css", 
			relative_urls : false, 		
			document_base_url : "'. Request::getBaseUrl() .'/'.$publicFileManager->getConferenceFilesPath($conferenceId) .'/", 
			extended_valid_elements : "span[*], div[*]"
			});
		</script>';

	 */	 
	function save() {
		$plugin =& $this->plugin;
		$conferenceId = $this->conferenceId;
		$plugin->updateSetting($conferenceId, 0, 'blockContent', $this->getData('blockContent'));		
	}

}




			case 'blocks':
				$this->import('CustomBlockPlugin');
				
				$conference =& Request::getConference();
				if ( !$conference ) return false;
				
				$blocks = $this->getSetting($conference->getConferenceId(), 0, 'blocks');
				if ( !is_array($blocks) ) break;
				$i= 0;
				foreach ( $blocks as $block ) {

	 * Determine whether or not this plugin is enabled.
	 */
	function getEnabled() {
		$conference =& Request::getConference();
 		$conferenceId = $conference?$conference->getConferenceId():0;
		return $this->getSetting($conferenceId, 0, 'enabled');
	}

	/**
	 * Set the enabled/disabled state of this plugin
	 */
	function setEnabled($enabled) {
 		$conference =& Request::getConference();
 		$conferenceId = $conference?$conference->getConferenceId():0;
 		$this->updateSetting($conferenceId, 0, 'enabled', $enabled);
			return true;
		}
		return false;
	}

	/**


		$pageCrumbs = array(
			array(
				Request::url(null, null, 'user'),
				'navigation.user'
			),
			array(
				Request::url(null, null, 'manager'),
				'user.role.manager'
			)
		);
		
		$conference =& Request::getConference();
		
		switch ($verb) {
			case 'enable':

				break;
			case 'settings':
				$pageCrumbs[] = array(
					Request::url(null, null, 'manager', 'plugins'),
					Locale::translate('manager.plugins'),
					true
				);
				$templateMgr->assign('pageHierarchy', $pageCrumbs);

				$this->import('SettingsForm');
				$form = new SettingsForm($this, $conference->getConferenceId());
				$form->readInputData();
				
				if (Request::getUserVar('addBlock')) {

					$blocks = $form->getData('blocks');
					array_push($blocks, '');
					$form->_data['blocks'] = $blocks;

				} else if (($delBlock = Request::getUserVar('delBlock')) && count($delBlock) == 1) {
					// Delete an block
					$editData = true;

					}
					array_splice($blocks, $delBlock, 1);
					$form->_data['blocks'] = $blocks;

				} else if ( Request::getUserVar('save') ) {
					$editData = true;
					$form->execute();




			)
		);
		
		$conference =& Request::getConference();

		$this->import('CustomBlockEditForm');
		$form = new CustomBlockEditForm($this, $conference->getConferenceId());
		
		switch ($verb) {
			case 'enable':

				break;
			case 'edit':
				$pageCrumbs[] = array(
          Request::url(null, null, 'manager', 'plugins'),
					Locale::translate('manager.plugins'),
					true
				);

						'pageTitleTranslated' => $this->getDisplayName(),
						'pageHierarchy' => $pageCrumbs, 
						'message' => 'plugins.generic.customBlock.saved',
						'backLink' => Request::url(null, null, 'manager', 'plugins'),
						'backLinkLabel' => 'common.continue'
					));
					$templateMgr->display('common/message.tpl');

	 * @return string
	 */
	function getContents(&$templateMgr) {
		$conference =& Request::getConference();
		if (!$conference) return '';

		$templateMgr->assign('customBlockContent', $this->getSetting($conference->getConferenceId(), 0, 'blockContent'));
		return parent::getContents($templateMgr);

	}

(-)ojs2/plugins/generic/customBlockManager/locale/en_US/locale.xml (-1 / +1 lines)

Lines 15-21	Link Here

<locale name="en_US" full_name="U.S. English">

<locale name="en_US" full_name="U.S. English">

	<message key="plugins.generic.customBlockManager.displayName">Custom Block Manager</message>

	<message key="plugins.generic.customBlockManager.displayName">Custom Block Manager</message>

	<message key="plugins.generic.customBlockManager.description">This plugin lets you create addition sidebar blocks.  Once they are created, you can edit their content and rearrange them within the sidebars.</message>

	<message key="plugins.generic.customBlockManager.description">This plugin lets you create addition sidebar blocks.  Once they are created, you can edit their content and rearrange them within the sidebars.</message>

	<message key="plugin.generic.customBlockManager.introduction"><![CDATA[You can use this plugin to add or delete custom block plugins.  You can then edit the content through the <a href="{$systemPluginsUrl}">System Plugins</a> page (in the Blocks Plugin section).  To place your plugin in the desired location in the sidebar, go to <a href="{$setupStep56}">Setup step 5.6</a>]]></message>

	<message key="plugin.generic.customBlockManager.introduction"><![CDATA[You can use this plugin to add or delete custom block plugins.  You can then edit the content through the <a href="{$systemPluginsUrl}">System Plugins</a> page (in the Blocks Plugin section).  To place your plugin in the desired location in the sidebar, go to <a href="{$setupStep4}">Set up step 4</a>]]></message>

	<message key="plugins.generic.customBlockManager.settings">Settings</message>

	<message key="plugins.generic.customBlockManager.settings">Settings</message>

	<message key="plugins.generic.customBlockManager.description">This Plugin lets you manage custom sidebar blocks.  You can edit the blocks in the settings of each plugin that you create here.</message>

	<message key="plugins.generic.customBlockManager.description">This Plugin lets you manage custom sidebar blocks.  You can edit the blocks in the settings of each plugin that you create here.</message>

	<message key="plugins.generic.customBlockManager.blockName">Block Name</message>

	<message key="plugins.generic.customBlockManager.blockName">Block Name</message>




================================
=== OCS Custom Block Manager Plugin
=== Version: 1.0
=== Author: Juan Pablo Alperin <pkp@alperin.ca>
================================

About
-----
This plugin is intended to enable users to create customizable HTML blocks for the sidebars.  The plugin works in conjunction with Step 4 of the Conference Setup.

This plugin was ported from the OJS 2.3 Custom Block Manager Plugin.

License
-------


System Requirements
-------------------
??? Same requirements as the OCS 2.3 core.

??? Installation
------------
To install the plugin:
 - copy the plugin tar.gz file to your OCS/plugins/generic directory
 - to unzip the plugin inside the plugins/generic directory:
    $ tar xvzf customBlockManager-1.0.tar.gz 
 - enable the plugin by going to:  Home > User > Conference Management > System Plugins > Generic Plugins and selecting "ENABLE" under "Custom Block Manager Plugin"

Configuration
------------
The Plugin management interface can be found at Home -> User -> Conference Management > System Plugins > Generic Plugins.  Once the plugin is enabled, blocks can be added and deleted through this interface.  Blocks which are created through this interface will subsequently appear as their own Block Plugin (found under Plugin Management > Block Plugins) and their content can be edited by clicking on the "EDIT" link underneath the name.
NOTE: The plugin will NOT appear in the sidebar until a sidebar location has been chosen through Conference Manager -> Conference Site Management -> 4. Conference Style.


Contact/Support




 *
 * @class SettingsForm
 *
 * @brief Form for conference managers to add or delete sidebar blocks
 *
 */

import('form.Form');

class SettingsForm extends Form {
	/** @var $conferenceId int */
	var $conferenceId;

	/** @var $plugin object */
	var $plugin;


	/**
	 * Constructor
	 * @param $conferenceId int
	 */
	function SettingsForm(&$plugin, $conferenceId) {

		parent::Form($plugin->getTemplatePath() . 'settingsForm.tpl');

		$this->conferenceId = $conferenceId;
		$this->plugin =& $plugin;

	}

	 * Initialize form data from  the plugin settings to the form
	 */
	function initData() {
		$conferenceId = $this->conferenceId;
		$plugin =& $this->plugin;

		$templateMgr =& TemplateManager::getManager();

		$blocks = $plugin->getSetting($conferenceId, 0, 'blocks');

		if ( !is_array($blocks) ) {
			$this->setData('blocks', array());

	 */
	function execute() {
		$plugin =& $this->plugin;
		$conferenceId = $this->conferenceId;

		$pluginSettingsDAO =& DAORegistry::getDAO('PluginSettingsDAO');

		$deletedBlocks = explode(':',$this->getData('deletedBlocks'));
		foreach ($deletedBlocks as $deletedBlock) {
			$pluginSettingsDAO->deleteSetting($conferenceId, 0, $deletedBlock.'CustomBlockPlugin', 'enabled');
			$pluginSettingsDAO->deleteSetting($conferenceId, 0, $deletedBlock.'CustomBlockPlugin', 'seq');
			$pluginSettingsDAO->deleteSetting($conferenceId, 0, $deletedBlock.'CustomBlockPlugin', 'context');
			$pluginSettingsDAO->deleteSetting($conferenceId, 0, $deletedBlock.'CustomBlockPlugin', 'blockContent');
		}

		//sort the blocks in alphabetical order

		}

		// Update blocks
		$plugin->updateSetting($conferenceId, 0, 'blocks', $blocks);
		$this->setData('blocks',$blocks);
	}
}

Return to bug 4474