<?php
/**
 * A helper for generating blocks (div or span) on web pages
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright(c) 2007, 2008 Roland Haeder, this is free software
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.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 3 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, see <http://www.gnu.org/licenses/>.
 */
class WebBlockHelper extends BaseHelper implements HelpableTemplate {
	/**
	 * Name of the block
	 */
	private $blockName = "";

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set part description
		$this->setObjectDescription("A helper for generating web blocks");
	}

	/**
	 * Creates the helper class
	 *
	 * @param	$templateInstance	An instance of a template engine
	 * @param	$bloclName			Name of the block we shall generate
	 * @return	$helperInstance		A prepared instance of this class
	 */
	public final static function createWebBlockHelper (CompileableTemplate $templateInstance, $blockName) {
		// Get new instance
		$helperInstance = new WebBlockHelper();

		// Set template instance
		$helperInstance->setTemplateInstance($templateInstance);

		// Set block name
		$helperInstance->setBlockName($blockName);

		// Return the prepared instance
		return $helperInstance;
	}

	/**
	 * Setter for block name
	 *
	 * @param	$bloclName			Name of the block we shall generate
	 * @return	void
	 */
	protected final function setBlockName ($blockName) {
		$this->blockName = (string) $blockName;
	}

	/**
	 * Getter for block name
	 *
	 * @return	$bloclName			Name of the block we shall generate
	 */
	public final function getBlockName () {
		return $this->blockName;
	}

	/**
	 * Flush the content out,e g. to a template variable
	 *
	 * @return	void
	 */
	public function flushContent () {
		$this->partialStub();
	}
}

// [EOF]
?>