Autocomplete::onOpen() - Code Metrics - phpMv/phpMv-UI - Measure and Improve Code Quality continuously with Scrutinizer

Autocomplete::onOpen() A
last analyzed 2024-09-19 23:29 UTC

↳ Parent: Autocomplete
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0
<?php
namespace Ajax\ui\components;

use Ajax\JsUtils;
use Ajax\ui\properties\Position;
use Ajax\common\components\SimpleComponent;
use Ajax\service\JString;

/**
 * JQuery UI Autocomplete component
 *
 * @author jc
 * @version 1.0.2
 */
class Autocomplete extends SimpleComponent {

	public function __construct(JsUtils $js) {
		parent::__construct($js);
		$this->uiName = "autocomplete";
		$this->setParam("minLength", 3);
	}

	/**
	 * Define source property with an ajax request based on $url
	 * $url must return a JSON array of values
	 *
	 * @param String $url
	 * @return $this
	 */
	public function setAjaxSource($url) {
		if (JString::startsWith($url, "/")) {
			$url = $this->js->getUrl($url);
		}
		$ajax = "%function (request, response) {
			$.ajax({
				url: '{$url}',
				dataType: 'jsonp',
				data: {q : request.term},
				success: function(data) {response(data);}
			});
		}%";
		return $this->setParam("source", $ajax);
	}

	/**
	 * Define the source property
	 * with a JSON Array of values
	 * Example : ["Bordeaux","Alsace","Bourgogne"]
	 * Example : [{value : "BO", label : "Bordeaux"}, {value : "AL", label : "Alsace"}, {value : "BOU", label : "Bourgogne"}]
	 *
	 * @param String $source
	 * @return $this
	 */
	public function setSource($source) {
		$source = str_ireplace(array(
			"\"",
			"'"
		), "%quote%", $source);
		return $this->setParam("source", "%" . $source . "%");
		return $this->setParam("source", "%" . /** @scrutinizer ignore-type */ $source . "%");
	}

	/**
	 * If set to true the first item will automatically be focused when the menu is shown.
	 * default : false
	 *
	 * @param Boolean $value
	 * @return $this
	 */
	public function setAutofocus($value) {
		return $this->setParamCtrl("autoFocus", $value, "is_bool");
	}

	/**
	 * The delay in milliseconds between when a keystroke occurs and when a search is performed.
	 * A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data,
	 * while being less responsive.
	 * default : 300
	 *
	 * @param int $value
	 * @return $this
	 */
	public function setDelay($value) {
		return $this->setParamCtrl("delay", $value, "is_int");
	}

	/**
	 * Disables the autocomplete if set to true.
	 *
	 * @param Boolean $value
	 *        	default : false
	 * @return $this
	 */
	public function setDisabled($value) {
		return $this->setParamCtrl("disabled", $value, "is_bool");
	}

	/**
	 * The minimum number of characters a user must type before a search is performed.
	 * Zero is useful for local data with just a few items,
	 * but a higher value should be used when a single character search could match a few thousand items.
	 *
	 * @param int $value
	 *        	default : 1
	 * @return $this
	 */
	public function setMinLength($value) {
		return $this->setParamCtrl("minLength", $value, "is_int");
	}

	/**
	 * Identifies the position of the suggestions menu in relation to the associated input element.
	 * The of option defaults to the input element, but you can specify another element to position against.
	 * You can refer to the jQuery UI Position utility for more details about the various options.
	 *
	 * @param int $position
	 *        	default : { my: "left top", at: "left bottom", collision: "none" }
	 * @return $this
	 */
	public function setPosition(Position $position) {
		return $this->setParam("position", $position->getParams());
	}

	/**
	 * Triggered when the field is blurred, if the value has changed.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onChange($jsCode) {
		return $this->addEvent("change", $jsCode);
	}

	/**
	 * Triggered when the menu is hidden.
	 * Not every close event will be accompanied by a change event.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onClose($jsCode) {
		return $this->addEvent("close", $jsCode);
	}

	/**
	 * Triggered when focus is moved to an item (not selecting).
	 * The default action is to replace the text field's value with the value of the focused item,
	 * though only if the event was triggered by a keyboard interaction.
	 * Canceling this event prevents the value from being updated, but does not prevent the menu item from being focused.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onFocus($jsCode) {
		return $this->addEvent("focus", $jsCode);
	}

	/**
	 * Triggered when the suggestion menu is opened or updated.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onOpen($jsCode) {
		return $this->addEvent("open", $jsCode);
	}

	/**
	 * Triggered after a search completes, before the menu is shown.
	 * Useful for local manipulation of suggestion data, where a custom source option callback is not required.
	 * This event is always triggered when a search completes, even if the menu will not be shown because there are no results or the Autocomplete is disabled.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onResponse($jsCode) {
		return $this->addEvent("response", $jsCode);
	}

	/**
	 * Triggered before a search is performed, after minLength and delay are met.
	 * If canceled, then no request will be started and no items suggested.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onSearch($jsCode) {
		return $this->addEvent("search", $jsCode);
	}

	/**
	 * Triggered when an item is selected from the menu.
	 * The default action is to replace the text field's value with the value of the selected item.
	 * Canceling this event prevents the value from being updated, but does not prevent the menu from closing.
	 *
	 * @param string $jsCode
	 * @return $this
	 */
	public function onSelect($jsCode) {
		return $this->addEvent("select", $jsCode);
	}
}

phpMv / phpMv-UI

Autocomplete::onOpen() A last analyzed 2024-09-19 23:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Autocomplete::onOpen() A
last analyzed 2024-09-19 23:29 UTC
