<?php
/**
 *  Copyright (C) 2010  Kai Dorschner
 *
 *  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/>.
 *
 * @author Kai Dorschner <the-hide@address.com>
 * @copyright Copyright 2010, Kai Dorschner
 * @license http://www.gnu.org/licenses/gpl.html GPLv3
 * @package mocovi
 * @subpackage controls
 */

/**
 * This control is used to write general texts without breaks.
 *
 * The main feature is that you can give a "textToken" option instead of the
 * accurate text. This value will be translated into the current language by
 * the {@translator}
 *
 * @see translator
 * @package mocovi
 * @subpackage controls
 * @todo Also highlight Google Search keywords!!
 */
class text_control extends Control
{
	protected $defaultOptions = array
		( 'textToken' => ''
		);

	/**
	 * @override
	 */
	protected function _beforeRunChilds()
	{
		if(strlen($this->getOption('textToken')) > 0)
		{
			$node = $this->getText();
			if(!is_null($node))
			{
				if($node->nodeType == XML_ELEMENT_NODE)
					foreach($node->childNodes as $child)
					{
						ControlFactory::create($child)
							->load($this->node)
							->run()
						;
					}
			}
			return false;
		}
		return true;
	}

	/**
	 * Return either the translated text as node or the source node.
	 *
	 * @access protected
	 * @return DomNode
	 */
	protected function getText()
	{
		if($token = $this->getOption('textToken'))
			return Translator::translateToken($token);
		return $this->sourceNode;
	}
}