/*
 * Copyright (c) 2024, Tribal Limited
 * All rights reserved.
 * 
 * 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 following disclaimer.
 *     * 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 Zenario, Tribal Limited 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 TRIBAL LTD 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.
 */

/*
	This file contains JavaScript source code.
	The code here is not the code you see in your browser. Before this file is downloaded:
	
		1. Compilation macros are applied (e.g. "foreach" is a macro for "for .. in ... hasOwnProperty").
		2. It is minified (e.g. using Google Closure Compiler).
		3. It may be bundled together with other files (this is to reduce the number of http requests on a page).
	
	For more information, see js_minify.shell.php for steps (1) and (2), and visitor.bundle.js.php for step (3).
*/


/**
  * This section lists all of the JavaScript functions and variables available to modules on the client side.
 */


zenario.lib(function(
	undefined,
	URLBasePath,
	document, window, windowOpener, windowParent,
	zenario, zenarioA, zenarioT, zenarioAB, zenarioAT, zenarioO,
	encodeURIComponent
	//N.b. the rest of the shortcut functions that normally go here haven't been defined yet!
	//They are actually defined below.
) {
	"use strict";


	zenario.__moduleBaseClass = function(
		moduleId, moduleClassName, moduleClassNameForPhrases,
		zenario, undefined
	) {
	
		this.moduleId = moduleId;
		this.moduleClassName = moduleClassName;
		this.moduleClassNameForPhrases = moduleClassNameForPhrases;
	
		/*
			Variables
			(See environment_variables.inc.php for their descriptions)
		*/
	
		this.cID = zenario.cID;
		this.cType = zenario.cType;
		this.cVersion = zenario.cVersion;
		this.languageId = zenario.langId;
	
	
		/*
			Utility Functions
		*/
	
		//Launch an AJAX request to your Plugin's handleAJAX placeholder method
		//Warning: This uses zenario.nonAsyncAJAX() so is deprecated!
		this.AJAX = function(requests, post, useCache) {
			return zenario.moduleNonAsyncAJAX(this.moduleClassName, requests, post, false, useCache);
		};
	 
		//Launch a JSON request to your Plugin's handleAJAX placeholder method
		//Warning: This uses zenario.nonAsyncAJAX() so is deprecated!
		this.JSON = function(requests, post, useCache) {
			return zenario.moduleNonAsyncAJAX(this.moduleClassName, requests, post, true, useCache);
		};
	
	
	

	
		this.AJAXLink = function(requests) {
			return zenario.AJAXLink(this.moduleClassName, requests);
		};
	
		this.pluginAJAXLink = function(slotNameOrContainedElement, requests) {
			return zenario.pluginAJAXLink(this.moduleClassName, slotNameOrContainedElement, requests);
		};
	
		this.showFileLink = function(requests) {
			return zenario.showFileLink(this.moduleClassName, requests);
		};
	
		this.pluginShowFileLink = function(slotNameOrContainedElement, requests) {
			return zenario.pluginShowFileLink(this.moduleClassName, slotNameOrContainedElement, requests);
		};
	
		this.showImageLink = function(requests) {
			return zenario.showImageLink(this.moduleClassName, requests);
		};
	
		this.pluginShowImageLink = function(slotNameOrContainedElement, requests) {
			return zenario.pluginShowImageLink(this.moduleClassName, slotNameOrContainedElement, requests);
		};
	
		this.showStandalonePageLink = function(requests) {
			return zenario.showStandalonePageLink(this.moduleClassName, requests);
		};
	
		this.pluginShowStandalonePageLink = function(slotNameOrContainedElement, requests) {
			return zenario.pluginShowStandalonePageLink(this.moduleClassName, slotNameOrContainedElement, requests);
		};
	
		this.visitorTUIXLink = function(path, requests, mode) {
			return zenario.visitorTUIXLink(this.moduleClassName, path, requests, mode);
		};
	
		this.pluginVisitorTUIXLink = function(slotNameOrContainedElement, path, requests, mode) {
			return zenario.pluginVisitorTUIXLink(this.moduleClassName, slotNameOrContainedElement, path, requests, mode);
		};
	
		this.showSingleSlotLink = function(slotNameOrContainedElement, requests, hideLayout, cID, cType) {
			return zenario.showSingleSlotLink(this.moduleClassName, slotNameOrContainedElement, requests, hideLayout, cID, cType);
		};
	
		this.showFloatingBoxLink = function(slotNameOrContainedElement, requests) {
			return zenario.showFloatingBoxLink(this.moduleClassName, slotNameOrContainedElement, requests);
		};

	
	
	
	
	
	
	
	
		/**
		* The floatingBoxAnchor() method allows Plugin Developers to create a hyperlink which calls a
		* zenario-themed alert box to appear when an Admin clicks on it.
		* 
		* If a Plugin Developer wishes to have a confirmation box and not an alert box, then the $buttons
		* input can be passed the HTML needed for the buttons they wish to appear.
		* 
		* Note that this will only work in Admin mode.
		*/
		this.floatingMessage = function(html, buttonsHTML, warning) {
			if (zenario.inAdminMode) {
				zenarioA.floatingBox(html, buttonsHTML, warning);
			}
		};
	
		//Returns the instance id of this Plugin.
		//Warning: If you have more than one instance on a page then it's not defined which one will be returned
		this.instanceId = function() {
			foreach (this.slots as i) {
				return this.slots[i].instanceId;
			}
			return false;
		};
	
		//Fetch your visitor phrases via AJAX.
		this.loadPhrases = function(code) {
			return zenario.loadPhrases(this.moduleClassNameForPhrases, code);
		};
	
		//Fetch one of your visitor phrases via AJAX.
		this.phrase = function(text, mrg) {
			return zenario.phrase(this.moduleClassNameForPhrases, text, mrg);
		};
	
		this.readyPhrasesOnBrowser = function(phrases) {
			zenario.readyPhrasesOnBrowser(this.moduleClassNameForPhrases, phrases);
		};
	
		this.nphrase = function(text, pluralText, n, mrg) {
			return zenario.nPhrase(this.moduleClassNameForPhrases, text, pluralText, n, mrg);
		};
	 
		//Go to a content item
		this.goToItem = function(cID, cType, request) {
			zenario.goToURL(zenario.linkToItem(cID, cType, request));
		};
	 
		//Go to a URL
		this.goToURL = function(url) {
			zenario.goToURL(url);
		};
	
		//Reload the contents of a slot.
		this.refreshPluginSlot = function(slotNameOrContainedElement, requests, scrollToTopOfSlot, fadeOutAndIn) {
			var slotName = zenario.getSlotnameFromEl(slotNameOrContainedElement);
		
			if (slotName === false) {
				return;
			}
		
			if (scrollToTopOfSlot === undefined) {
				scrollToTopOfSlot = true;
			}
		
			if (fadeOutAndIn === undefined) {
				fadeOutAndIn = true;
			}
		
			zenario.refreshPluginSlot(slotName, 'lookup', requests, true, scrollToTopOfSlot, fadeOutAndIn);
		};
	
		//Scroll to the top of a slot
		this.scrollToSlotTop = function(slotNameOrContainedElement, neverScrollDown) {
			var slotName = zenario.getSlotnameFromEl(slotNameOrContainedElement);
			zenario.scrollToSlotTop(slotName, neverScrollDown);
		};
	
		//Returns the slot name that this Plugin is in
		//Warning: If this Plugin is in more than one slot on a page then it's not defined which one be returned
		this.slotName = function() {
			foreach (this.slots as var i) {
				return this.slots[i].slotName;
			}
			return false;
		};
	
		this.slots = {};
		this.outerSlots = {};
	};
});