PHPFUI/InstaDoc
 
Copied!
<?php

namespace PHPFUI\Input;

/**
 * CheckBoxMenu allows you to create an array of checkboxes in a menu format.  The actual checkboxes are hidden and the user only sees the selected menu options
 *
 * An **All** button and a **Submit** button are also supported and can be added at any point in the menu.
 *
 * The class can be styled with the cbmenu class (similarly to the simple menu class)
 */
class CheckBoxMenu extends \PHPFUI\Menu
	{
	private ?\PHPFUI\MenuItem $allMenuItem = null;

	private string $callbackName = '';

	private string $className;

	private ?\PHPFUI\MenuItem $submitMenuItem = null;

	/**
	 * @param string $name is the name of the fields that will be posted as an array
	 */
	public function __construct(private string $name)
		{
		parent::__construct();
		$this->addClass('cbmenu');
		$this->className = $this->getId();
		}

	/**
	 * Add a select All button.  It is appended to the previously added checkboxes.
	 */
	public function addAll(string $name = 'All') : \PHPFUI\MenuItem
		{
		$this->allMenuItem = $this->addCheckBox($name, false, '', -1);
		$callback = $this->callbackName ? ($this->callbackName . '("' . $name . '","' . $name . '",active);') : '';
		$this->allMenuItem->setAttribute('onclick', 'var active,t=$(this);active=t.toggleClass("is-active").hasClass("is-active");var m=$(".' . $this->className .
				'");if(active){m.addClass("is-active");}else{m.removeClass("is-active");};var cb=$("li.' . $this->className .
				' input[type=checkbox]");cb.prop("checked",active);' . $callback . 'return false;');

		return $this->allMenuItem;
		}

	/**
	 * Add a new checkbox / MenuItem
	 *
	 * @param string $name to display to the user
	 * @param bool $active true if you want this checkbox set on initial display
	 * @param string $value to return when the checkbox is selected
	 * @param ?int $index optional index for the checkbox, defaults to [] (next), use -1 for no name
	 *
	 * @return \PHPFUI\MenuItem for further modification if needed
	 */
	public function addCheckBox(string $name, bool $active, string $value, ?int $index = null) : \PHPFUI\MenuItem
		{
		if (-1 == $index)
			{
			$hidden = new \PHPFUI\Input('checkbox', '', $value);
			$cbName = '';
			}
		else
			{
			$otherCount = 0;

			if ($this->allMenuItem)
				{
				++$otherCount;
				}

			if ($this->submitMenuItem)
				{
				++$otherCount;
				}
			$cbName = $this->name . '[' . ($index ?? \count($this) - $otherCount) . ']';
			$hidden = new \PHPFUI\Input('checkbox', $cbName, $value);
			}
		$hidden->addAttribute('style', 'display:none');

		if ($active)
			{
			$hidden->addAttribute('checked');
			}
		$hiddenId = $hidden->getId();
		$menuItem = new \PHPFUI\MenuItem($name, '#');
		$menuItem->add($hidden);

		$menuItem->addClass($this->className);
		$callback = $this->callbackName ? ($this->callbackName . '("' . $cbName . '","' . $value . '",active);') : '';
		$menuItem->addAttribute('onclick', 'var active,t=$(this);active=t.toggleClass("is-active").hasClass("is-active");$("#' .
														$hiddenId . '").prop("checked",active);' . $callback . 'return false;');
		$menuItem->setActive($active);

		$this->addMenuItem($menuItem);

		return $menuItem;
		}

	/**
	 * Add a Submit button in the menu style.  It is appended to the previously added checkboxes.
	 *
	 * @param string $name of the posted field
	 */
	public function addSubmit(\PHPFUI\Form $form, string $name = 'Submit') : \PHPFUI\MenuItem
		{
		$this->submitMenuItem = new \PHPFUI\MenuItem($name, '#');
		$formId = $form->getId();
		$this->submitMenuItem->addAttribute('onclick', '$("#' . $formId . '").submit();return false;');
		$this->addMenuItem($this->submitMenuItem);

		return $this->submitMenuItem;
		}

	/**
	 * Return the class name for the menu items.
	 */
	public function getMenuItemClass() : string
		{
		return $this->className;
		}

	/**
	 * This javascript function will be called with the field name (including [index]), value and active flag when ever the menu is changed.
	 * If the All MenuItem is clicked, then the callback is passed the all text for name and value.
	 *
	 * This callback must be set before adding anything to the menu. Previously added items will not have the callback.
	 *
	 * Parameters for the function are field name with index in [], value and boolean indicating active. No return value is supported.
	 */
	public function setJavaScriptCallback(string $functionName) : static
		{
		$this->callbackName = $functionName;

		return $this;
		}

	protected function getStart() : string
		{
		if ($this->allMenuItem)
			{
			foreach ($this->menuItems as $item)
				{
				if (! $item->getActive() && $this->allMenuItem != $item && $this->submitMenuItem != $item)
					{
					return parent::getStart();
					}
				}
			$this->allMenuItem->setActive();
			}

		return parent::getStart();
		}
	}
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration