InputfieldChosenSelect.module

<?php

/**
 * InputfieldChosenSelect module
 *
 * Inputfield for the ProcessWire FieldtypePage. Progressively enhanced single
 * value select.
 *
 * Copyright (C) 2015 Benjamin Milde
 * Licensed under MIT License, see LICENSE.md
 * 
 * http://www.kobrakai.de
 *
 * http://www.processwire.com
 * http://www.ryancramer.com
 *
 */

class InputfieldChosenSelect extends InputfieldSelect {

	protected $chosenOptions = array();
	protected $supportedAdminThemes = array(
		"AdminThemeReno", 
		"AdminThemeDefault",
		"AdminThemeUikit"
	);

	public static function getModuleInfo() {
		return array(
			'title' => __('Inputfield Chosen Select', __FILE__), // Module Title
			'summary' => __('Inputfield for the ProcessWire FieldtypePage. Progressively enhanced single value select. IMPORTANT: Please note the change in the naming of the Inputfield', __FILE__), // Module Summary
			'version' => 125, 
			);
	}

	public function init() {
		parent::init();
		wire('modules')->get('JqueryCore'); // required by jQuery UI
		wire('modules')->get('JqueryUI');

		$this->setChosenOption('width', "100%");
		$this->setChosenOption('search_contains', 'true');

		// TODO: remove this after a few versions
		$pagefields = $this->fields->find("type=FieldtypePage");
		foreach($pagefields as $pagefield){
			if($pagefield->derefAsPage == 0 && $pagefield->inputfield === "InputfieldChosenSelect"){
				$this->warning("The module has been updated to incorporate a single-select Inputfield, which led to a change to the previous Inputfield's name. You seem to still have fields with the old Inputfield selected. These will now show single selects, so please change them. Please make sure InputfieldChosenSelectMultiple is even installed, too.");
				break;
			}
		}
		foreach($pagefields as $pagefield){
			if($pagefield->derefAsPage == 0 && $pagefield->inputfield === "InputfieldChosenSelect"){
				$this->warning("Please update <a href='{$this->config->urls->admin}setup/field/edit?id={$pagefield->id}#InputfieldWrapper12'>{$pagefield->name}</a> to use InputfieldChosenSelectMultiple.", Notice::allowMarkup);
			}
		}
	}

	public function setChosenOption($key, $value) {
		$this->chosenOptions[$key] = $value; 
	}

	/**
	 * Called before render()
	 *
	 * @param Inputfield $parent
	 * @param bool $renderValueMode
	 * @return bool
	 *
	 */
	public function renderReady(Inputfield $parent = null, $renderValueMode = false) {
		$class = $this->className(); 
		$info = self::getModuleInfo();
		$ver = $info['version'];

		$this->config->scripts->add($this->config->urls->$class . "chosen/chosen.jquery.min.js?v=$ver");
		$this->config->styles->add($this->config->urls->$class . "chosen/chosen.min.css?v=$ver");

		// Special styles per admin theme
		if(in_array($this->adminTheme, $this->supportedAdminThemes)){
			$this->config->styles->add($this->config->urls->$class . $this->adminTheme . ".css?v=$ver");
		}

		if(!$this->required) $this->setChosenOption('allow_single_deselect', 'true');
		if($this->placeholder) $this->setChosenOption('placeholder_text_single', $this->placeholder);
		if($this->noresult) $this->setChosenOption('no_results_text', $this->noresult);
		
		$this->config->js($this->id, $this->chosenOptions);

		return parent::renderReady($parent, $renderValueMode);

	}

	public function ___install() {
		$data = $this->modules->getModuleConfigData("InputfieldPage");
		array_push($data["inputfieldClasses"], $this->className());
		$this->modules->saveModuleConfigData("InputfieldPage", $data);
	}

	public function ___uninstall() {
		$fields = wire('fields')->find("type=FieldtypePage");

		foreach($fields as $field){
			if($field->inputfield !== $this->className()) $fields->remove($field);
		}

		$this->warning($this->className()." was used in following fields: ".$fields->implode(", ", "name"));

		$data = $this->modules->getModuleConfigData("InputfieldPage");

		if(in_array($this->className(), $data["inputfieldClasses"])){
			$key = array_search($this->className(), $data["inputfieldClasses"]);
			unset($data["inputfieldClasses"][$key]);

			$this->modules->saveModuleConfigData("InputfieldPage", $data);
		}
	}

	public function ___getConfigInputfields() {

		$inputfields = parent::___getConfigInputfields();

		$f = wire('modules')->get('InputfieldText');
		$f->attr('name', 'placeholder');
		$f->attr('value', $this->placeholder);
		$f->label = $this->_('Placeholder Text');
		$f->description = $this->_('Placeholder-text to be displayed in empty field.'); 
		$inputfields->add($f);
		
		$f = wire('modules')->get('InputfieldText');
	    	$f->attr('name', 'noresult');
	    	$f->attr('value', $this->noresult);
	    	$f->label = $this->_('No result');
	    	$f->description = $this->_('Message to display if no result is found.');
	    	$inputfields->add($f);

		return $inputfields;
	}
	
}