<?php
/*=====================================================================*
|| ###################################################################
|| # Blue Static ISSO Framework
|| # Copyright (c)2005-2008 Blue Static
|| #
|| # 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; version 2 of the License.
|| #
|| # 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 Street, Fifth Floor, Boston, MA 02110-1301, USA
|| ###################################################################
\*=====================================================================*/

/**
 * Printer Element Abstract Class (PrinterAbstract.php)
 *
 * @package	ISSO
 */

/**
 * Printer Element
 *
 * This abstract class is used for all printer elements and describes
 * the basic functionality of an element.
 *
 * @author		Blue Static
 * @copyright	Copyright (c)2005 - 2008, Blue Static
 * @package		ISSO
 *
 */
abstract class BSPrinterAbstract
{
	/**
	 * Style information
	 * @var array
	 */
	protected $style = array();
	
	/**
	 * The CSS class to use
	 * @var string
	 */
	protected $cssClass = ':swap:';
	
	/**
	 * DOM ID of the element
	 * @var string
	 */
	protected $id;
	
	/**
	 * Fluent object instantiation
	 */
	public abstract static function make();
	
	/**
	 * Tells the element to paint itself (and any children)
	 */
	public abstract function paint();
	
	/**
	 * To-string method which invokes paint()
	 */
	public function __toString()
	{
		return $this->paint();
	}
	
	/**
	 * Sets the CSS class to use. Use ":swap:" to alternate
	 *
	 * @param	string	CSS class
	 * 
	 * @return	fluent interface
	 */
	public function setCssClass($class)
	{
		$this->cssClass = $class;
		return $this;
	}
	
	/**
	 * Sets the style information
	 * 
	 * @param	array Style attributes
	 * 
	 * @return	fluent interface
	 */
	public function setStyle(Array $attributes)
	{
		$this->style = $attributes;
		return $this;
	}
	
	/**
	 * Sets the DOM/CSS ID of the element
	 *
	 * @param	string	The ID
	 *
	 * @return	fluent interface
	 */
	public function setId($id)
	{
		$this->id = $id;
		return $this;
	}
	
	/**
	 * Returns a string of style attributes, that include id, style, and class
	 *
	 * @return	string	Style attributes
	 */
	protected function _prepareStyle()
	{
		if (empty($this->style) && empty($this->cssClass) && empty($this->id))
		{
			return;
		}
		
		if ($this->cssClass == ':swap:')
		{
			BSFunctions::swap_css_classes();
			$class = BSFunctions::$cssClass;
		}
		else
		{
			$class = $this->cssClass;
		}
		
		$attrs = array();
		
		foreach ($this->style as $prop => $value)
		{
			$attrs[] = $prop . ': ' . $value;
		}
		
		$style = implode('; ', $attrs);

		$string = '';
		if ($class)
		{
			$string .= ' class="' . $class . '"';
		}
		if ($style)
		{
			$string .= ' style="' . $style . '"';
		}
		if ($this->id)
		{
			$string .= ' id="' . $this->id . '"';
		}
		
		return $string;
	}
}

?>