Autocomplete::onClose() - Code Metrics - jcheron/phalcon-jquery - Measure and Improve Code Quality continuously with Scrutinizer

Autocomplete::onClose() A
last analyzed 2017-03-26 14:06 UTC

↳ Parent: Autocomplete

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Ajax\ui\Components;

use Ajax\JsUtils;
use Phalcon\Text;
use Phalcon\Mvc\Url;
use Ajax\ui\Properties\Position;
use Ajax\common\components\SimpleComponent;

/**
 * JQuery UI Autocomplete component
 * @author jc
 * @version 1.001
 */
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 (Text::startsWith($url, "/")) {
			$u=$this->js->getDi()->get("url");
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
			$url=$u->getBaseUri().$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."%");
	}

	/**
	 * 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);
	}
}

1			<?php
2
3			namespace Ajax\ui\Components;
4
5			use Ajax\JsUtils;
6			use Phalcon\Text;
7			use Phalcon\Mvc\Url;
8			use Ajax\ui\Properties\Position;
9			use Ajax\common\components\SimpleComponent;
10
11			/**
12			* JQuery UI Autocomplete component
13			* @author jc
14			* @version 1.001
15			*/
16			class Autocomplete extends SimpleComponent {
17
18			public function __construct(JsUtils $js) {
19			parent::__construct($js);
20			$this->uiName="autocomplete";
21			$this->setParam("minLength", 3);
22			}
23
24			/**
25			* Define source property with an ajax request based on $url
26			* $url must return a JSON array of values
27			* @param String $url
28			* @return $this
29			*/
30			public function setAjaxSource($url) {
31			if (Text::startsWith($url, "/")) {
32			$u=$this->js->getDi()->get("url");
			0 ignored issues – show Bug introduced 2016-06-02 00:46 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Ajax\JsUtils` as the method `getDi()` does only exist in the following sub-classes of `Ajax\JsUtils`: `Ajax\php\phalcon\JsUtils`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
33			$url=$u->getBaseUri().$url;
34			}
35			$ajax="%function (request, response) {
36			$.ajax({
37			url: '{$url}',
38			dataType: 'jsonp',
39			data: {q : request.term},
40			success: function(data) {response(data);}
41			});
42			}%";
43			return $this->setParam("source", $ajax);
44			}
45
46			/**
47			* Define the source property
48			* with a JSON Array of values
49			* Example : ["Bordeaux","Alsace","Bourgogne"]
50			* Example : [{value : "BO", label : "Bordeaux"}, {value : "AL", label : "Alsace"}, {value : "BOU", label : "Bourgogne"}]
51			* @param String $source
52			* @return $this
53			*/
54			public function setSource($source) {
55			$source=str_ireplace(array (
56			"\"",
57			"'"
58			), "%quote%", $source);
59			return $this->setParam("source", "%".$source."%");
60			}
61
62			/**
63			* If set to true the first item will automatically be focused when the menu is shown.
64			* default : false
65			* @param Boolean $value
66			* @return $this
67			*/
68			public function setAutofocus($value) {
69			return $this->setParamCtrl("autoFocus", $value, "is_bool");
70			}
71
72			/**
73			* The delay in milliseconds between when a keystroke occurs and when a search is performed.
74			* A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data,
75			* while being less responsive.
76			* default : 300
77			* @param int $value
78			* @return $this
79			*/
80			public function setDelay($value) {
81			return $this->setParamCtrl("delay", $value, "is_int");
82			}
83
84			/**
85			* Disables the autocomplete if set to true.
86			* @param Boolean $value default : false
87			* @return $this
88			*/
89			public function setDisabled($value) {
90			return $this->setParamCtrl("disabled", $value, "is_bool");
91			}
92
93			/**
94			* The minimum number of characters a user must type before a search is performed.
95			* Zero is useful for local data with just a few items,
96			* but a higher value should be used when a single character search could match a few thousand items.
97			* @param int $value default : 1
98			* @return $this
99			*/
100			public function setMinLength($value) {
101			return $this->setParamCtrl("minLength", $value, "is_int");
102			}
103
104			/**
105			* Identifies the position of the suggestions menu in relation to the associated input element.
106			* The of option defaults to the input element, but you can specify another element to position against.
107			* You can refer to the jQuery UI Position utility for more details about the various options.
108			* @param int $position default : { my: "left top", at: "left bottom", collision: "none" }
109			* @return $this
110			*/
111			public function setPosition(Position $position) {
112			return $this->setParam("position", $position->getParams());
113			}
114
115			/**
116			* Triggered when the field is blurred, if the value has changed.
117			* @param string $jsCode
118			* @return $this
119			*/
120			public function onChange($jsCode) {
121			return $this->addEvent("change", $jsCode);
122			}
123
124			/**
125			* Triggered when the menu is hidden.
126			* Not every close event will be accompanied by a change event.
127			* @param string $jsCode
128			* @return $this
129			*/
130			public function onClose($jsCode) {
131			return $this->addEvent("close", $jsCode);
132			}
133
134			/**
135			* Triggered when focus is moved to an item (not selecting).
136			* The default action is to replace the text field's value with the value of the focused item,
137			* though only if the event was triggered by a keyboard interaction.
138			* Canceling this event prevents the value from being updated, but does not prevent the menu item from being focused.
139			* @param string $jsCode
140			* @return $this
141			*/
142			public function onFocus($jsCode) {
143			return $this->addEvent("focus", $jsCode);
144			}
145
146			/**
147			* Triggered when the suggestion menu is opened or updated.
148			* @param string $jsCode
149			* @return $this
150			*/
151			public function onOpen($jsCode) {
152			return $this->addEvent("open", $jsCode);
153			}
154
155			/**
156			* Triggered after a search completes, before the menu is shown.
157			* Useful for local manipulation of suggestion data, where a custom source option callback is not required.
158			* 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.
159			* @param string $jsCode
160			* @return $this
161			*/
162			public function onResponse($jsCode) {
163			return $this->addEvent("response", $jsCode);
164			}
165
166			/**
167			* Triggered before a search is performed, after minLength and delay are met.
168			* If canceled, then no request will be started and no items suggested.
169			* @param string $jsCode
170			* @return $this
171			*/
172			public function onSearch($jsCode) {
173			return $this->addEvent("search", $jsCode);
174			}
175
176			/**
177			* Triggered when an item is selected from the menu.
178			* The default action is to replace the text field's value with the value of the selected item.
179			* Canceling this event prevents the value from being updated, but does not prevent the menu from closing.
180			* @param string $jsCode
181			* @return $this
182			*/
183			public function onSelect($jsCode) {
184			return $this->addEvent("select", $jsCode);
185			}
186			}

jcheron / phalcon-jquery

Autocomplete::onClose() A last analyzed 2017-03-26 14:06 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Autocomplete::onClose() A
last analyzed 2017-03-26 14:06 UTC