Checkbox.php

<?php

/**
 * This file is part of the Nette Framework (https://nette.org)
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
 */

declare(strict_types=1);

namespace Nette\Forms\Controls;

use Nette;
use Nette\Utils\Html;


/**
 * Check box control. Allows the user to select a true or false condition.
 */
class Checkbox extends BaseControl
{
	/** @var Html  wrapper element template */
	private $wrapper;


	/**
	 * @param  string|object
	 */
	public function __construct($label = null)
	{
		parent::__construct($label);
		$this->control->type = 'checkbox';
		$this->wrapper = Html::el();
		$this->setOption('type', 'checkbox');
	}


	/**
	 * Sets control's value.
	 * @return static
	 * @internal
	 */
	public function setCurrentValue($value)
	{
		if (!is_scalar($value) && $value !== null) {
			throw new Nette\InvalidArgumentException(sprintf("Value must be scalar or null, %s given in field '%s'.", gettype($value), $this->name));
		}
		$this->value = (bool) $value;
		return $this;
	}


	/**
	 * Is control filled?
	 */
	public function isFilled(): bool
	{
		return $this->getValue() !== false; // back compatibility
	}


	/**
	 * Generates control's HTML element.
	 */
	public function getControl(): Html
	{
		return $this->wrapper->setHtml($this->getLabelPart()->insert(0, $this->getControlPart()));
	}


	/**
	 * Bypasses label generation.
	 */
	public function getLabel($caption = null): void
	{
	}


	public function getControlPart(): Html
	{
		return parent::getControl()->checked($this->value);
	}


	public function getLabelPart(): Html
	{
		return parent::getLabel();
	}


	/**
	 * Returns wrapper HTML element template.
	 */
	public function getSeparatorPrototype(): Html
	{
		return $this->wrapper;
	}
}