<?php
/************************************************************************
 * Mailer v0.2.1-FINAL                                Start: 07/25/2011 *
 * ===================                          Last change: 07/25/2011 *
 *                                                                      *
 * -------------------------------------------------------------------- *
 * File              : forced_functions.php                             *
 * -------------------------------------------------------------------- *
 * Short description : Functions for ext-forced                         *
 * -------------------------------------------------------------------- *
 * Kurzbeschreibung  : Funktionen fuer ext-forced                       *
 * -------------------------------------------------------------------- *
 * $Revision::                                                        $ *
 * $Date::                                                            $ *
 * $Tag:: 0.2.1-FINAL                                                 $ *
 * $Author::                                                          $ *
 * -------------------------------------------------------------------- *
 * Copyright (c) 2003 - 2009 by Roland Haeder                           *
 * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
 * For more information visit: http://www.mxchange.org                  *
 *                                                                      *
 * This program is free software; you can redistribute it and/or modify *
 * it under the terms of the GNU General Public License as published by *
 * the Free Software Foundation; either version 2 of the License, or    *
 * (at your option) any later version.                                  *
 *                                                                      *
 * This program is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
 * GNU General Public License for more details.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program; if not, write to the Free Software          *
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
 * MA  02110-1301  USA                                                  *
 ************************************************************************/

// Some security stuff...
if (!defined('__SECURITY')) {
	die();
} // END - if

// Template helper function to create selection box for all forced-ad types
function doTemplateForcedAdTypeSelectionBox ($templateName, $clear = false, $default = NULL) {
	// Add all types through the filter
	$forcedAdTypes = runFilterChain('add_forced_ads_types', array());

	// Handle it over to generateSelectionBoxFromArray()
	$content = generateSelectionBoxFromArray($forcedAdTypes, 'forced_ads_type', 'type');

	// Return prepared content
	return $content;
}

// Translate the status IN/OUT
function translateForcedAdType ($status) {
	// Is the status empty?
	if (empty($status)) {
		$status = 'EMPTY';
	} // END - if

	// Default status is unknown
	$return = '{%message,ADMIN_FORCED_AD_TYPE_UNKNOWN=' . $status . '%}';

	// Construct message id
	$messageId = 'ADMIN_FORCED_AD_TYPE_' . $status;

	// Is it there?
	if (isMessageIdValid($messageId)) {
		// Then use it as message string
		$return = '{--' . $messageId . '--}';
	} // END - if

	// Return the status
	return $return;
}

// Handles the XML node 'extra-parameter-forced-ads-reload-lock-list'
function doXmlExtraParameterForcedAdsReloadLockList ($resource, $attributes) {
	// There should be no attributes
	if (count($attributes) > 0) {
		// Please don't add any attributes to foo-list nodes
		debug_report_bug(__FUNCTION__, __LINE__, 'Expected 0 attributes because this is a foo-list node, got ' . count($attributes));
	} elseif (!isset($GLOBALS['__XML_ARGUMENTS']['doXmlCallbackFunction']['extra_list']['forced_ads_reload_lock_list'])) {
		// This list should be created already
		debug_report_bug(__FUNCTION__, __LINE__, 'forced_ads_reload_lock_list should be already created.');
	}
}

// Handles the XML node 'extra-parameter-forced-ads-reload-lock-list-entry'
function doXmlExtraParameterForcedAdsReloadLockListEntry ($resource, $attributes) {
	// There are three attributes, by default
	if (count($attributes) != 3) {
		// Not the right count
		debug_report_bug(__FUNCTION__, __LINE__, 'Expected 3 attributes, got ' . count($attributes));
	} elseif (!isset($attributes['NAME'])) {
		// 'NAME' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute NAME not found.');
	} elseif (!isset($attributes['TYPE'])) {
		// 'TYPE' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute TYPE not found.');
	} elseif (!isInvalidXmlType($attributes['TYPE'])) {
		// No valid type
		debug_report_bug(__FUNCTION__, __LINE__, 'TYPE is not valid, got: ' . $attributes['TYPE']);
	} elseif (!isset($attributes['VALUE'])) {
		// 'VALUE' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute VALUE not found.');
	} elseif (!isXmlValueValid($attributes['TYPE'], $attributes['VALUE'])) {
		// Not valid/verifyable
		debug_report_bug(__FUNCTION__, __LINE__, 'Attribute VALUE does not validate. TYPE=' . $attributes['TYPE'] . ',VALUE=' . $attributes['VALUE']);
	} elseif (!isset($GLOBALS['__XML_ARGUMENTS']['doXmlCallbackFunction']['extra_list']['forced_ads_reload_lock_list'])) {
		// doXmlCallbackFunction is missing
		debug_report_bug(__FUNCTION__, __LINE__, 'Required XML node callback-function/extra-parameter-list/forced-ads-reload-lock-list not included around this node. Please fix your XML.');
	}

	// Add the entry to the list
	addXmlValueToCallbackAttributes('extra_list', $attributes, 'forced_ads_reload_lock_list');
}

// Handles the XML node 'extra-parameter-forced-ads-min-stay-list'
function doXmlExtraParameterForcedAdsMinStayList ($resource, $attributes) {
	// There should be no attributes
	if (count($attributes) > 0) {
		// Please don't add any attributes to foo-list nodes
		debug_report_bug(__FUNCTION__, __LINE__, 'Expected 0 attributes because this is a foo-list node, got ' . count($attributes));
	} elseif (!isset($GLOBALS['__XML_ARGUMENTS']['doXmlCallbackFunction']['extra_list']['forced_ads_min_stay_list'])) {
		// This list should be created already
		debug_report_bug(__FUNCTION__, __LINE__, 'forced_ads_min_stay_list should be already created.');
	}
}

// Handles the XML node 'extra-parameter-forced-ads-min-stay-list-entry'
function doXmlExtraParameterForcedAdsMinStayListEntry ($resource, $attributes) {
	// There are three attributes, by default
	if (count($attributes) != 3) {
		// Not the right count
		debug_report_bug(__FUNCTION__, __LINE__, 'Expected 3 attributes, got ' . count($attributes));
	} elseif (!isset($attributes['NAME'])) {
		// 'NAME' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute NAME not found.');
	} elseif (!isset($attributes['TYPE'])) {
		// 'TYPE' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute TYPE not found.');
	} elseif (!isInvalidXmlType($attributes['TYPE'])) {
		// No valid type
		debug_report_bug(__FUNCTION__, __LINE__, 'TYPE is not valid, got: ' . $attributes['TYPE']);
	} elseif (!isset($attributes['VALUE'])) {
		// 'VALUE' not found
		debug_report_bug(__FUNCTION__, __LINE__, 'Required attribute VALUE not found.');
	} elseif (!isXmlValueValid($attributes['TYPE'], $attributes['VALUE'])) {
		// Not valid/verifyable
		debug_report_bug(__FUNCTION__, __LINE__, 'Attribute VALUE does not validate. TYPE=' . $attributes['TYPE'] . ',VALUE=' . $attributes['VALUE']);
	} elseif (!isset($GLOBALS['__XML_ARGUMENTS']['doXmlCallbackFunction']['extra_list']['forced_ads_min_stay_list'])) {
		// doXmlCallbackFunction is missing
		debug_report_bug(__FUNCTION__, __LINE__, 'Required XML node callback-function/extra-parameter-list/forced-ads-min-stay-list not included around this node. Please fix your XML.');
	}

	// Add the entry to the list
	addXmlValueToCallbackAttributes('extra_list', $attributes, 'forced_ads_min_stay_list');
}

// [EOF]
?>