<?php

/**
 * This file contains the iwp_field_hidden class
 *
 * @version $Id$
 * 
 *
 * @package IWP
 * @subpackage IWP_FormFields
 */

/**
 * Hidden Field Class
 * This class is used by the api form class to generate a hidden field
 *
 * @package IWP
 * @subpackage IWP_FormFields
 */

class iwp_field_hidden extends iwp_field {

	/**
	 * This is the form field type of the field
	 *
	 * @var string
	 */
	public $type = 'hidden';

	protected $Language = array();
	protected $showName = false;
	protected $showLabel = false;

	/**
	 * __construct
	 * The constructor which calls the parent constructor that sets up the field name if it is passed in during the initialization
	 *
	 * @var string
	 */
	function __construct($name=null){
		parent::__construct($name);
	}

	/**
	 * GetFieldOutput
	 * Returns the HTML for this field. It generates the relevant parts, assigns them to template variables and returns a parse template file.
	 *
	 * @return string Returns the field HTML
	 */
	function GetFieldOutput($setOnly=false){
		$inputField = $this->Prepend.'<input type="hidden" id="'. iwp_htmlspecialchars($this->FieldName) .'" name="'. iwp_htmlspecialchars($this->FieldName) .'" value="'. iwp_htmlspecialchars($this->FieldValue) .'"';
		$inputField .= $this->GetAttributes();
		$inputField .= ' />'.$this->Append;

		parent::GetFieldOutput();
		if(!$setOnly){
			return $inputField;
		}
		return '';
	}

	/**
	 * Validate
	 * This is the function that data for this field is passed to to ensure it was submitted properly.
	 *
	 * @return string|boolean If the data is not valid, it will return false, if it is valid it will return a value
	 */
	function Validate($arrData){
		return $arrData[$this->FieldName];
	}

}