<?php
//
// +---------------------------------------------------------------------------+
// | Nitro :: Module :: HelloWorld                                             |
// +---------------------------------------------------------------------------+
// | Copyright (c) 2006-2008 June Systems BV                                   |
// +---------------------------------------------------------------------------+
// | This library is free software; you can redistribute it and/or modify it   |
// | under the terms of the GNU Lesser General Public License as published by  |
// | the Free Software Foundation; either version 2.1 of the License, or (at   |
// | your option) any later version.                                           |
// |                                                                           |
// | This library 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 Lesser   |
// | General Public License for more details.                                  |
// |                                                                           |
// | You should have received a copy of the GNU Lesser General Public License  |
// | along with this library; if not, write to the Free Software Foundation,   |
// | Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA            |
// +---------------------------------------------------------------------------+
// | Authors: Siggi Oskarsson <hide@address.com>                          |
// +---------------------------------------------------------------------------+
//
// $Id: HelloWorld.inc.php 229 2008-04-17 09:20:31Z oli $
//
// Nitro's Hello WorldL Module class.
//

/**
 * This file contains the Nitro Hello World Module
 * 
 * You can use this module as a template for creating your own
 * modules.
 *
 * @author			Siggi Oskarsson
 * @copyright		June Systems BV, 2006-2008
 * @version			$Revision: 1.0 $
 * @package			Modules
 */

/**
 * Include prototype module class
 */
require_once "Nitro/Module.inc.php";

/**
 * HTML module class
 *
 * This module contains the Nitro Hello World class.
 *
 * @package	Modules
 * @author	Siggi Oskarsson <hide@address.com>
 * @copyright	June Systems BV, 2006-2008
 * @access public
 */
class NitroModuleHelloWorld extends NitroModule {
	/**
	 * @var	string Module ID string
	 */
	var $IDString = "NitroModuleHelloWorld";
	
	/**
	 * HTML module constructor function
	 *
	 * @param int $ObjectID Integer with the current ObjectID
	 * @param mixed $Settings Array with the Module Settings, default is FALSE
	 * @access	public
	 */
	function NitroModuleHelloWorld($ObjectID, $Settings = FALSE)
	{
		/**
		 * Call the parent constructor
		 */
		parent::NitroModule();

		/**
		 * Set ObjectID and ModuleSettings
		 */
		$this->ObjectID = $ObjectID;
		$this->SetModuleSettings($Settings);
	}
	
	/**
	 * Draw "Hello World" on to the current page.
	 * 
	 * This function is called by Nitro when drawing the object on the
	 * page. To implement your own module, basically you only have to implement
	 * the Draw() function.
	 * See the other modules in the Nitro/Modules/ directory for more examples of
	 * how to use the other features of Nitro to create modules.
	 *
	 * @param mixed $RunTimeSettings RunTimeSettings for the Object, default is FALSE
	 * @return mixed The drawn "Hello World" string
	 */
	function Draw($RunTimeSettings = FALSE)
	{
		return "Hello World";
	}
}
?>