TActiveDatePicker::raiseCallbackEvent() - Code Metrics - Inspection of "Activecontrols: avoid updating client side if the..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c7ab73...cc5395 )

by Fabio

created 2016-03-06 18:40 UTC

TActiveDatePicker::raiseCallbackEvent() A

↳ Parent: TActiveDatePicker

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

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

<?php
/**
 * TActiveDatePicker class file
 *
 * @author Bradley Booms <[email protected]>
 * @author Christophe Boulain <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @copyright Copyright &copy; 2005-2015 The PRADO Group
 * @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
 * @package System.Web.UI.ActiveControls
 */

/**
 * Load active control adapter.
 */
Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');

/**
 * TActiveDatePicker class
 *
 * The active control counter part to date picker control.
 * When the date selection is changed, the {@link onCallback OnCallback} event is
 * raised.
 *
 * @author Bradley Booms <[email protected]>
 * @author Christophe Boulain <[email protected]>
 * @package System.Web.UI.ActiveControls
 * @since 3.1.3
 */
class TActiveDatePicker extends TDatePicker  implements ICallbackEventHandler, IActiveControl

{

	/**
	 * @return boolean a value indicating whether an automatic postback to the server
     * will occur whenever the user modifies the text in the TActiveDatePicker control and
     * then tabs out of the component. Defaults to true.
	 */
	public function getAutoPostBack()
	{
		return $this->getViewState('AutoPostBack',true);
	}

	/**
	 * Sets the value indicating if postback automatically.
	 * An automatic postback to the server will occur whenever the user
	 * modifies the text in the TActiveDatePicker control and then tabs out of the component.
	 * @param boolean the value indicating if postback automatically
	 */
	public function setAutoPostBack($value)
	{
		$this->setViewState('AutoPostBack',TPropertyValue::ensureBoolean($value),true);
	}

	/**
	 * Get javascript date picker options.
	 * @return array date picker client-side options
	 */
	protected function getDatePickerOptions()
	{
		$options = parent::getDatePickerOptions();
		$options['CausesValidation']=$this->getCausesValidation();
		$options['ValidationGroup']=$this->getValidationGroup();
		$options['EventTarget'] = $this->getUniqueID();
		$options['ShowCalendar'] = $this->getShowCalendar();
		$options['AutoPostBack'] = $this->getAutoPostBack();
		return $options;
	}

	/**
	 * Creates a new callback control, sets the adapter to
	 * TActiveControlAdapter. If you override this class, be sure to set the
	 * adapter appropriately by, for example, by calling this constructor.
	 */
	public function __construct()
	{
		parent::__construct();
		$this->setAdapter(new TActiveControlAdapter($this));
	}

	/**
	 * @return TBaseActiveCallbackControl standard callback control options.
	 */
	public function getActiveControl(){
		return $this->getAdapter()->getBaseActiveControl();
	}

	/**
	 * Client-side Text property can only be updated after the OnLoad stage.
	 * @param string text content for the textbox
	 */
	public function setText($value){
		if(parent::getText() === $value)
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
			return;

		parent::setText($value);
		if($this->getActiveControl()->canUpdateClientSide() && $this->getHasLoadedPostData()){
			$cb=$this->getPage()->getCallbackClient();
			$cb->setValue($this, $value);
			if ($this->getInputMode()==TDatePickerInputMode::DropDownList)
			{
				$s = Prado::createComponent('System.Util.TDateTimeStamp');
				$date = $s->getDate($this->getTimeStampFromText());
				$id=$this->getClientID();
				$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'day', 'Value', $date['mday'], 'select');
				$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'month', 'Value', $date['mon']-1, 'select');
				$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'year', 'Value', $date['year'], 'select');

			}
		}
	}

	/**
	 * Raises the callback event. This method is required by {@link
	 * ICallbackEventHandler} interface.
	 * This method is mainly used by framework and control developers.
	 * @param TCallbackEventParameter the event parameter
	 */
 	public function raiseCallbackEvent($param){
		$this->onCallback($param);
	}

	/**
	 * This method is invoked when a callback is requested. The method raises
	 * 'OnCallback' event to fire up the event handlers. If you override this
	 * method, be sure to call the parent implementation so that the event
	 * handler can be invoked.
	 * @param TCallbackEventParameter event parameter to be passed to the event handlers
	 */
	public function onCallback($param){
		$this->raiseEvent('OnCallback', $this, $param);
	}

	/**
	 * Registers the javascript code to initialize the date picker.
	 */

	protected function registerCalendarClientScriptPre()
	{
		$cs = $this->getPage()->getClientScript();
		$cs->registerPradoScript("activedatepicker");
	}

	protected function renderClientControlScript($writer)
	{
		$cs = $this->getPage()->getClientScript();
		if(!$cs->isEndScriptRegistered('TDatePicker.spacer'))
		{
			$spacer = $this->getAssetUrl('spacer.gif');
			$code = "Prado.WebUI.TDatePicker.spacer = '$spacer';";
			$cs->registerEndScript('TDatePicker.spacer', $code);
		}

		$options = TJavaScript::encode($this->getDatePickerOptions());
		$code = "new Prado.WebUI.TActiveDatePicker($options);";
		$cs->registerEndScript("prado:".$this->getClientID(), $code);
	}

	/**
	 * @return TActiveDatePickerClientScript javascript validator event options.
	 */
	protected function createClientScript()
	{
		return new TActiveDatePickerClientScript;
	}
}

/**
 * TActiveDatePickerClientScript class.
 *
 * Client-side date picker event {@link setOnDateChanged OnDateChanged}
 * can be modified through the {@link TActiveDatePicker::getClientSide ClientSide}
 * property of a date picker.
 *
 * The <tt>OnDateChanged</tt> event is raise when the date picker's date
 * is changed.
 * The formatted date according to {@link TDatePicker::getDateFormat DateFormat} is sent
 * as parameter to this event
 *
 * @author Fabio Bas <ctrlaltca[at]gmail[dot]com>
 * @package System.Web.UI.ActiveControls
 * @since 3.2.1
 */
class TActiveDatePickerClientScript extends TCallbackClientSide
{
	/**
	 * Javascript code to execute when the date picker's date is changed.
	 * @param string javascript code
	 */
	public function setOnDateChanged($javascript)
	{
		$this->setFunction('OnDateChanged', $javascript);
	}

	/**
	 * @return string javascript code to execute when the date picker's date is changed.
	 */
	public function getOnDateChanged()
	{
		return $this->getOption('OnDateChanged');
	}
}

1			<?php
2			/**
3			* TActiveDatePicker class file
4			*
5			* @author Bradley Booms <[email protected]>
6			* @author Christophe Boulain <[email protected]>
7			* @link https://github.com/pradosoft/prado
8			* @copyright Copyright © 2005-2015 The PRADO Group
9			* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
10			* @package System.Web.UI.ActiveControls
11			*/
12
13			/**
14			* Load active control adapter.
15			*/
16			Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');
17
18			/**
19			* TActiveDatePicker class
20			*
21			* The active control counter part to date picker control.
22			* When the date selection is changed, the {@link onCallback OnCallback} event is
23			* raised.
24			*
25			* @author Bradley Booms <[email protected]>
26			* @author Christophe Boulain <[email protected]>
27			* @package System.Web.UI.ActiveControls
28			* @since 3.1.3
29			*/
30			class TActiveDatePicker extends TDatePicker implements ICallbackEventHandler, IActiveControl
			0 ignored issues – show Coding Style introduced 2016-02-29 19:57 UTC by Report Bug Copy Issue Report Expected 1 space before implements keyword; 2 found Loading history...
31			{
32
33			/**
34			* @return boolean a value indicating whether an automatic postback to the server
35			* will occur whenever the user modifies the text in the TActiveDatePicker control and
36			* then tabs out of the component. Defaults to true.
37			*/
38			public function getAutoPostBack()
39			{
40			return $this->getViewState('AutoPostBack',true);
41			}
42
43			/**
44			* Sets the value indicating if postback automatically.
45			* An automatic postback to the server will occur whenever the user
46			* modifies the text in the TActiveDatePicker control and then tabs out of the component.
47			* @param boolean the value indicating if postback automatically
48			*/
49			public function setAutoPostBack($value)
50			{
51			$this->setViewState('AutoPostBack',TPropertyValue::ensureBoolean($value),true);
52			}
53
54			/**
55			* Get javascript date picker options.
56			* @return array date picker client-side options
57			*/
58			protected function getDatePickerOptions()
59			{
60			$options = parent::getDatePickerOptions();
61			$options['CausesValidation']=$this->getCausesValidation();
62			$options['ValidationGroup']=$this->getValidationGroup();
63			$options['EventTarget'] = $this->getUniqueID();
64			$options['ShowCalendar'] = $this->getShowCalendar();
65			$options['AutoPostBack'] = $this->getAutoPostBack();
66			return $options;
67			}
68
69			/**
70			* Creates a new callback control, sets the adapter to
71			* TActiveControlAdapter. If you override this class, be sure to set the
72			* adapter appropriately by, for example, by calling this constructor.
73			*/
74			public function __construct()
75			{
76			parent::__construct();
77			$this->setAdapter(new TActiveControlAdapter($this));
78			}
79
80			/**
81			* @return TBaseActiveCallbackControl standard callback control options.
82			*/
83			public function getActiveControl(){
84			return $this->getAdapter()->getBaseActiveControl();
85			}
86
87			/**
88			* Client-side Text property can only be updated after the OnLoad stage.
89			* @param string text content for the textbox
90			*/
91			public function setText($value){
92			if(parent::getText() === $value)
			1 ignored issue – show Comprehensibility Bug introduced 2016-03-06 18:58 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getText()` instead of `setText()`). Are you sure this is correct? If so, you might want to change this to `$this->getText()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
93			return;
94
95			parent::setText($value);
96			if($this->getActiveControl()->canUpdateClientSide() && $this->getHasLoadedPostData()){
97			$cb=$this->getPage()->getCallbackClient();
98			$cb->setValue($this, $value);
99			if ($this->getInputMode()==TDatePickerInputMode::DropDownList)
100			{
101			$s = Prado::createComponent('System.Util.TDateTimeStamp');
102			$date = $s->getDate($this->getTimeStampFromText());
103			$id=$this->getClientID();
104			$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'day', 'Value', $date['mday'], 'select');
105			$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'month', 'Value', $date['mon']-1, 'select');
106			$cb->select($id.TControl::CLIENT_ID_SEPARATOR.'year', 'Value', $date['year'], 'select');
107
108			}
109			}
110			}
111
112			/**
113			* Raises the callback event. This method is required by {@link
114			* ICallbackEventHandler} interface.
115			* This method is mainly used by framework and control developers.
116			* @param TCallbackEventParameter the event parameter
117			*/
118			public function raiseCallbackEvent($param){
119			$this->onCallback($param);
120			}
121
122			/**
123			* This method is invoked when a callback is requested. The method raises
124			* 'OnCallback' event to fire up the event handlers. If you override this
125			* method, be sure to call the parent implementation so that the event
126			* handler can be invoked.
127			* @param TCallbackEventParameter event parameter to be passed to the event handlers
128			*/
129			public function onCallback($param){
130			$this->raiseEvent('OnCallback', $this, $param);
131			}
132
133			/**
134			* Registers the javascript code to initialize the date picker.
135			*/
136
137			protected function registerCalendarClientScriptPre()
138			{
139			$cs = $this->getPage()->getClientScript();
140			$cs->registerPradoScript("activedatepicker");
141			}
142
143			protected function renderClientControlScript($writer)
144			{
145			$cs = $this->getPage()->getClientScript();
146			if(!$cs->isEndScriptRegistered('TDatePicker.spacer'))
147			{
148			$spacer = $this->getAssetUrl('spacer.gif');
149			$code = "Prado.WebUI.TDatePicker.spacer = '$spacer';";
150			$cs->registerEndScript('TDatePicker.spacer', $code);
151			}
152
153			$options = TJavaScript::encode($this->getDatePickerOptions());
154			$code = "new Prado.WebUI.TActiveDatePicker($options);";
155			$cs->registerEndScript("prado:".$this->getClientID(), $code);
156			}
157
158			/**
159			* @return TActiveDatePickerClientScript javascript validator event options.
160			*/
161			protected function createClientScript()
162			{
163			return new TActiveDatePickerClientScript;
164			}
165			}
166
167			/**
168			* TActiveDatePickerClientScript class.
169			*
170			* Client-side date picker event {@link setOnDateChanged OnDateChanged}
171			* can be modified through the {@link TActiveDatePicker::getClientSide ClientSide}
172			* property of a date picker.
173			*
174			* The <tt>OnDateChanged</tt> event is raise when the date picker's date
175			* is changed.
176			* The formatted date according to {@link TDatePicker::getDateFormat DateFormat} is sent
177			* as parameter to this event
178			*
179			* @author Fabio Bas <ctrlaltca[at]gmail[dot]com>
180			* @package System.Web.UI.ActiveControls
181			* @since 3.2.1
182			*/
183			class TActiveDatePickerClientScript extends TCallbackClientSide
184			{
185			/**
186			* Javascript code to execute when the date picker's date is changed.
187			* @param string javascript code
188			*/
189			public function setOnDateChanged($javascript)
190			{
191			$this->setFunction('OnDateChanged', $javascript);
192			}
193
194			/**
195			* @return string javascript code to execute when the date picker's date is changed.
196			*/
197			public function getOnDateChanged()
198			{
199			return $this->getOption('OnDateChanged');
200			}
201			}

pradosoft / prado

Push — master ( c7ab73...cc5395 )

TActiveDatePicker::raiseCallbackEvent() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like