<?php

/**
 * This file contains the iwp_field_password class
 *
 * @package IWP
 * @subpackage IWP_FormFields
**/

/**
 * Password Field Class
 * This class is used by the api form class to generate a password field.
 *
 * @package IWP
 * @subpackage IWP_FormFields
**/
class iwp_field_password extends iwp_field {
	/**
	 * This is the form field type of the field
	 *
	 * @var string
	**/
	public $type = 'password';

	/**
	 * For holding whether the label should be shown for this field or not
	 *
	 * @var Boolean
	**/
	protected $showLabel = true;

	/**
	 * __construct
	 * The constructor which calls the parent constructor that sets up the field name if it is passed in during the initialization
	 *
	 * @var string
	**/
	public function __construct($name=null){
		parent::__construct($name);
		$this->SetAttribute('class', 'Field350');
	}

	/**
	 * 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
	 */
	public function GetFieldOutput($setOnly=false){
		$inputField = $this->Prepend.'<input type="password" id="'. iwp_htmlspecialchars($this->FieldName) .'" name="'. iwp_htmlspecialchars($this->FieldName) .'" value="'. iwp_htmlspecialchars($this->FieldValue) .'"';
		$inputField .= $this->GetAttributes();
		$inputField .= ' />'.$this->Append;

		//$helpTip = '';

		parent::GetFieldOutput();

		$this->template->Assign('inputField', $inputField);
		$this->template->Assign('FieldName', $this->FieldName);

		if(!$setOnly){
			return $this->template->ParseTemplate('form.field', true);
		}
		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
	 */
	public function Validate($arrData){
		return $arrData[$this->FieldName];
	}
}