<?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 Table Element (PrinterTableElement.php)
*
* @package	ISSO
*/

require_once(ISSO . '/PrinterRootElementTable.php');
require_once(ISSO . '/PrinterBaseElement.php');

/**
* Printer Table Element
*
* This represents a table row that holds elements.
*
* @author		Blue Static
* @copyright	Copyright (c)2005 - 2008, Blue Static
* @package		ISSO
*
*/
class BSPrinterTableElement extends BSPrinterElement
{
	/**
	* Array of child nodes
	* @var array
	*/
	private $children = array();
	
	/**
	* Number of columns to span
	* @var integer
	*/
	private $colspan = 0;
	
	// ###################################################################
	/**
	* Creates a table element; takes a variable number of arguments which
	* are added as children in the order passed
	*
	* @param	BSPrinterTableElement...	Variable number (or no) children
	*/
	public function __construct()
	{
		$childs = func_get_args();
		if (is_array($childs))
		{
			$this->children = $childs;
		}
	}
	
	/**
	 * Makes a new instance of the object in a static fashion
	 *
	 * @return	object
	 */
	public static function make()
	{
		$obj = new ReflectionClass(__CLASS__);
		$args = func_get_args();
		return $obj->newInstanceArgs($args);
	}
	
	// ###################################################################
	/**
	* Prints a simple row of text and text
	*
	* @param	string	Label (left side)
	* @param	string	Value (right side)
	*
	* @return	BSPrinterTableElement	Table row element
	*/
	public static function row_label($label, $value)
	{
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterLabelElement($value));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Creates an input[text/password] field row
	*
	* @param	string	Label
	* @param	string	Field name
	* @param	mixed	Default value
	* @param	bool	A password field?
	*
	* @return	BPrinterTableElement	Table row element
	*/
	public static function row_text($label, $name, $value = null, $password = false)
	{
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterBaseElement(($password ? 'password' : 'text'), $name, $value));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Creates a submit row
	*
	* @param	array	Child elements to add before the buttons
	* @param	string	Save button text
	* @param	string	Reset button text
	*
	* @return	BSPrinterTableElement	Table row element
	*/
	public static function row_submit(Array $children = null, $save = ':submit:', $reset = ':reset:')
	{
		$build = '';
		if (sizeof($children) > 0)
		{
			foreach ($children as $child)
			{
				$build .= "\n\t\t\t" . $child->paint();
			}
		}
		
		$save = ($save == ':submit:' ? _('Submit') : $save);
		$reset = ($reset == ':reset:' ? _('Reset') : $reset);
		
		if (!is_null($save))
		{
			$elm = new BSPrinterBaseElement('submit', '__submit__', "  $save  ");
			$elm->setAccessKey('s');
			$build .= "\n\t\t\t" . $elm->paint();
		}
		
		if (!is_null($reset))
		{
			$elm = new BSPrinterBaseElement('reset', '__reset__', "  $reset  ");
			$elm->setAccessKey('r');
			$build .= "\n\t\t\t" . $elm->paint() . "\n\t\t";
		}
		
		$tr = new BSPrinterTableElement();
		$tr->addChild(new BSPrinterLabelElement($build));
		$tr->setCssClass('tfoot');
				
		return $tr;
	}
	
	// ###################################################################
	/**
	* Constructs a <select> row from an array of BSPrinterBaseElement's
	*
	* @param	string	Label
	* @param	string	Name
	* @param	array	Array of BSPrinterBaseElement[option]'s
	*
	* @return	BSPrinterTableElement	Table row
	*/
	public static function row_list($label, $name, Array $options)
	{
		$build = '';
		foreach ($options as $option)
		{
			if ($option->getType() == 'option')
			{
				$build .= $option->paint();
			}
			else
			{
				throw new Exception('Only BSPrinterBaseElement\'s of type "option" are allowed in BSPrinterTableElement::row_list()');
			}
		}
		
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterBaseElement('select', $name, $build));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Constructs a row from an array of BSPrinterBaseElement's of checkboxes
	*
	* @param	string	Label
	* @param	string	Name
	* @param	array	Array of BSPrinterBaseElement[checkbox]'s that follow array(box label => BSPrinterBaseElement)
	*
	* @return	BSPrinterTableElement	Table row
	*/
	public static function row_checkbox($label, $name, Array $boxes)
	{
		$build = '';
		foreach ($boxes as $boxLabel => $box)
		{
			if ($box->getType() == 'checkbox')
			{
				if ($box->getName() == null)
				{
					$box->setName($name . '[]');
				}
				$build .= '<div>' . $box->paint() . ' ' . $boxLabel . '</div>';
			}
			else
			{
				throw new Exception('Only BSPrinterBaseElement\'s of type "checkbox" are allowed in BSPrinterTableElement::row_checkbox()');
			}
		}
		
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterLabelElement($build));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Factory method to create an upload form element; requires that the
	* form this is attached to have the upload flag set
	*
	* @param	string	Label for the element
	* @param	string	Name of the <input>
	*
	* @return	BSPrinterTableElement	Upload form
	*/
	public static function row_upload($label, $name)
	{
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterBaseElement('upload', $name));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Creates a row with a radio select option for yes/no
	*
	* @param	string	Row label
	* @param	string	Name of the radio buttons
	* @param	bool	Yes is selected? (if false, No is selected)
	*
	* @return	BSPrinterTableElement	Yes-No row
	*/
	public static function row_yes_no($label, $name, $yes)
	{
		$elm = new BSPrinterBaseElement('radio', $name, 1);
		$elm->setActive($yes);
		
		$build = $elm->paint() . ' ' . _('Yes') . ' ';
				
		$elm = new BSPrinterBaseElement('radio', $name, 0);
		$elm->setActive(!$yes);
		
		$build .= $elm->paint() . ' ' . _('No');
		
		$tr = new BSPrinterTableElement();
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterLabelElement($build));
		return $tr;
	}
	
	// ###################################################################
	/**
	* Prints a row with a textarea
	*
	* @param	string	Label
	* @param	string	Textarea name
	* @param	string	Value to fill with
	*
	* @return	BSPrinterTableElement	Table row
	*/
	public static function row_textarea($label, $name, $value = null)
	{
		$tr = new BSPrinterTableElement();
		
		$tr->addChild(new BSPrinterLabelElement($label));
		$tr->addChild(new BSPrinterBaseElement('textarea', $name, $value));
		
		return $tr;
	}
	
	// ###################################################################
	/**
	* Returns the number of columns in this element
	*
	* @return	integer	Column count
	*/
	public function numberOfColumns()
	{
		return sizeof($this->children);
	}
	
	// ###################################################################
	/**
	* Adds a child node to the element
	*
	* @param	BSPrinterElement	A child element
	* 
	* @return	fluent interface
	*/
	public function addChild(BSPrinterElement $child)
	{
		$this->children[] = $child;
		return $this;
	}
	
	// ###################################################################
	/**
	* Sets the number of columns this row should have and pads the <td>
	* elements accordingly
	*
	* @param	integer	Column count
	* 
	* @return	fluent interface
	*/
	public function setColumnNumber($cols)
	{
		if ($cols < $this->numberOfColumns())
		{
			throw new Exception('You need to have at least ' . $this->numberOfColumns() . ' columns');
		}
		$this->colspan = $cols;
		return $this;
	}
	
	// ###################################################################
	/**
	* Returns the HTML for all printed children elements
	*
	* @return	string	Printed HTML
	*/
	protected function _paintChildren()
	{
		$builder = '';
		
		$numCols = $this->numberOfColumns();
		$even = true;
		
		if ($this->colspan % $numCols == 0)
		{
			$cols = $this->colspan / $numCols;
			$even = true;
		}
		else
		{
			$cols = intval($this->colspan / $numCols);
			$even = false;
		}
		
		$i = 0;
		foreach ($this->children as $child)
		{
			$i++;
			$colspan = (($i == $numCols && !$even) ? $cols + 1 : $cols);
			$builder .= "\n\t\t<td" . ($colspan > 1 ? ' colspan="' . $colspan . '"' : '') . ">" . $child->paint() . "</td>";
		}
		
		return $builder;
	}
	
	// ###################################################################
	/**
	* Paints the entire table row
	*
	* @return	string	Table row HTML
	*/
	public function paint()
	{
		return "\t<tr" . $this->_prepareStyle() . ">" . $this->_paintChildren() . "\n\t</tr>";
	}
}

?>