pradosoft / prado

framework/Web/UI/ActiveControls/TDraggable.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
 	 *   o 'True' or 'Revert' : The draggable will revert to it's original position
 	 *   o 'False' or 'None' : The draggable won't revert to it's original position
 	 *   o 'Failure' : The draggable will only revert if it's dropped on a non droppable area
-	 * @return TDraggableRevertOption true to revert
+	 * @return string true to revert
 	 */
 	public function getRevert()
 	{
@@ -118,7 +118,7 @@ 
 
 	/**
 	 * Determine if the element should be constrainted in one direction or not
-	 * @return CDraggableConstraint
+	 * @return string
 	 */
 	public function getConstraint()
 	{

Spacing +17 added lines, -17 removed lines

@@ -32,7 +32,7 @@ 
 	 * Set the handle id or css class
 	 * @param string
 	 */
-	public function setHandle ($value)
+	public function setHandle($value)
 	{
 		$this->setViewState('DragHandle', TPropertyValue::ensureString($value), null);
 	}
@@ -41,7 +41,7 @@ 
 	 * Get the handle id or css class
 	 * @return string
 	 */
-	public function getHandle ()
+	public function getHandle()
 	{
 		return $this->getViewState('DragHandle', null);
 	}
@@ -71,9 +71,9 @@ 
 	 */
 	public function setRevert($value)
 	{
-		if (strcasecmp($value,'true')==0 || $value===true)
+		if(strcasecmp($value, 'true')==0 || $value===true)
 			$value=TDraggableRevertOptions::Revert;
-		elseif (strcasecmp($value,'false')==0 || $value===false)
+		elseif(strcasecmp($value, 'false')==0 || $value===false)
 			$value=TDraggableRevertOptions::None;
 		$this->setViewState('Revert', TPropertyValue::ensureEnum($value, 'TDraggableRevertOptions'), true);
 	}
@@ -90,7 +90,7 @@ 
 	 *
 	 * @return TDraggableGhostingOption to clone the element
 	 */
-	public function getGhosting ()
+	public function getGhosting()
 	{
 		return $this->getViewState('Ghosting', TDraggableGhostingOptions::None);
 	}
@@ -107,11 +107,11 @@ 
 	 *  o "False" or "None" means no Ghosting options
 	 *
 	 */
-	public function setGhosting ($value)
+	public function setGhosting($value)
 	{
-		if (strcasecmp($value,'true')==0 || $value===true)
+		if(strcasecmp($value, 'true')==0 || $value===true)
 			$value=TDraggableGhostingOptions::Ghosting;
-		elseif (strcasecmp($value,'false')==0 || $value===false)
+		elseif(strcasecmp($value, 'false')==0 || $value===false)
 			$value=TDraggableGhostingOptions::None;
 		$this->setViewState('Ghosting', TPropertyValue::ensureEnum($value, 'TDraggableGhostingOptions'), TDraggableGhostingOptions::None);
 	}
@@ -154,11 +154,11 @@ 
 		parent::addAttributesToRender($writer);
 
 		$cs=$this->getPage()->getClientScript();
-		if ($this->getGhosting()==TDraggableGhostingOptions::SuperGhosting)
+		if($this->getGhosting()==TDraggableGhostingOptions::SuperGhosting)
 			$cs->registerPradoScript('dragdropextra');
 		else
 			$cs->registerPradoScript('dragdrop');
-		$writer->addAttribute('id',$this->getClientID());
+		$writer->addAttribute('id', $this->getClientID());
 		$options=TJavascript::encode($this->getPostBackOptions());
 		$class=$this->getClientClassName();
 		$code="new {$class}('{$this->getClientId()}', {$options}) ";
@@ -170,7 +170,7 @@ 
 	 * This method overrides the parent implementation.
 	 * @return string the javascript class name
 	 */
-	protected function getClientClassName ()
+	protected function getClientClassName()
 	{
 		return 'Draggable';
 	}
@@ -181,17 +181,17 @@ 
 	 */
 	protected function getPostBackOptions()
 	{
-		$options['ID'] = $this->getClientID();
+		$options['ID']=$this->getClientID();
 
-		if (($handle=$this->getHandle())!== null) $options['handle']=$handle;
-		if (($revert=$this->getRevert())===TDraggableRevertOptions::None)
+		if(($handle=$this->getHandle())!==null) $options['handle']=$handle;
+		if(($revert=$this->getRevert())===TDraggableRevertOptions::None)
 			$options['revert']=false;
-		elseif ($revert==TDraggableRevertOptions::Revert)
+		elseif($revert==TDraggableRevertOptions::Revert)
 			$options['revert']=true;
 		else
 			$options['revert']=strtolower($revert);
-		if (($constraint=$this->getConstraint())!==TDraggableConstraint::None) $options['constraint']=strtolower($constraint);
-		switch ($this->getGhosting())
+		if(($constraint=$this->getConstraint())!==TDraggableConstraint::None) $options['constraint']=strtolower($constraint);
+		switch($this->getGhosting())
 		{
 			case TDraggableGhostingOptions::SuperGhosting:
 				$options['superghosting']=true;

framework/Web/UI/ActiveControls/TDropContainer.php

Doc Comments -1 removed lines

@@ -127,7 +127,6 @@
 	 * Raises the onDrop event.
 	 * The drop parameters are encapsulated into a {@link TDropContainerEventParameter}
 	 *
-	 * @param object $dropControlId
 	 */
 	public function onDrop ($dropParams)
 	{

Braces +1 added lines, -2 removed lines

@@ -58,8 +58,7 @@
 		if ($this->sourcepath === NULL)
 		{
 			$this->sourcepath = $sourcepath;
-		}
-		else
+		} else
 		{
 			$this->sourcepath->append($sourcepath);
 		}

Spacing +12 added lines, -12 removed lines

@@ -137,9 +137,9 @@ 
 	 *
 	 * @param object $dropControlId
 	 */
-	public function onDrop ($dropParams)
+	public function onDrop($dropParams)
 	{
-		$this->raiseEvent('OnDrop', $this, new TDropContainerEventParameter ($dropParams));
+		$this->raiseEvent('OnDrop', $this, new TDropContainerEventParameter($dropParams));
 
 	}
 
@@ -161,11 +161,11 @@ 
 	 */
 	protected function getPostBackOptions()
 	{
-		$options['ID'] = $this->getClientID();
-		$options['EventTarget'] = $this->getUniqueID();
+		$options['ID']=$this->getClientID();
+		$options['EventTarget']=$this->getUniqueID();
 
-		$options['accept'] = $this->getAcceptCssClass();
-		$options['hoverclass'] = $this->getHoverCssClass();
+		$options['accept']=$this->getAcceptCssClass();
+		$options['hoverclass']=$this->getHoverCssClass();
 		return $options;
 	}
 
@@ -197,7 +197,7 @@ 
 	protected function addAttributesToRender($writer)
 	{
 		parent::addAttributesToRender($writer);
-		$writer->addAttribute('id',$this->getClientID());
+		$writer->addAttribute('id', $this->getClientID());
 
 		$this->getPage()->getClientScript()->registerPradoScript('dragdrop');
 		$this->getActiveControl()->registerCallbackClientScript(
@@ -210,9 +210,9 @@ 
 	 * child controls. This container will be a TActivePanel, in order to allow user
 	 * to update its content on callback.
 	 */
-	public function createChildControls ()
+	public function createChildControls()
 	{
-		if ($this->_container===null)
+		if($this->_container===null)
 		{
 			$this->_container=Prado::CreateComponent('System.Web.UI.ActiveControls.TActivePanel');
 			$this->_container->setId($this->getId(false).'_content');
@@ -238,17 +238,17 @@ 
 	 * is defered until OnPreRender event is raised.
 	 * @param THtmlWriter html writer
 	 */
-	public function render ($writer)
+	public function render($writer)
 	{
 		if($this->getHasPreRendered())
 		{
 			parent::render($writer);
 			if($this->getActiveControl()->canUpdateClientSide())
-				$this->getPage()->getCallbackClient()->replaceContent($this->_container,$writer);
+				$this->getPage()->getCallbackClient()->replaceContent($this->_container, $writer);
 		}
 		else
 		{
-			$this->getPage()->getAdapter()->registerControlToRender($this->_container,$writer);
+			$this->getPage()->getAdapter()->registerControlToRender($this->_container, $writer);
 		}
 	}
 }

framework/Web/UI/ActiveControls/TInPlaceTextBox.php

Doc Comments +3 added lines

@@ -92,6 +92,8 @@ 
 	 * Calls the client-side static method for this control class.
 	 * @param string static method name
 	 * @param mixed method parmaeter
+	 * @param string $func
+	 * @param boolean $value
 	 */
 	protected function callClientFunction($func,$value)
 	{
@@ -239,6 +241,7 @@ 
 	 * Raised when editing the content is requsted to be loaded from the
 	 * server side.
 	 * @param TCallbackEventParameter event parameter to be passed to the event handlers
+	 * @param TCallbackEventParameter $param
 	 */
 	public function onLoadingText($param)
 	{

Braces +1 added lines, -2 removed lines

@@ -58,8 +58,7 @@
 		if ($this->sourcepath === NULL)
 		{
 			$this->sourcepath = $sourcepath;
-		}
-		else
+		} else
 		{
 			$this->sourcepath->append($sourcepath);
 		}

Spacing +31 added lines, -31 removed lines

@@ -74,10 +74,10 @@ 
 	 */
 	public function setDisplayTextBox($value)
 	{
-		$value = TPropertyValue::ensureBoolean($value);
-		$this->setViewState('DisplayTextBox', $value,false);
+		$value=TPropertyValue::ensureBoolean($value);
+		$this->setViewState('DisplayTextBox', $value, false);
 		if($this->getActiveControl()->canUpdateClientSide())
-			$this->callClientFunction('setDisplayTextBox',$value);
+			$this->callClientFunction('setDisplayTextBox', $value);
 	}
 
 	/**
@@ -93,11 +93,11 @@ 
 	 * @param string static method name
 	 * @param mixed method parmaeter
 	 */
-	protected function callClientFunction($func,$value)
+	protected function callClientFunction($func, $value)
 	{
-		$client = $this->getPage()->getCallbackClient();
-		$code = $this->getClientClassName().'.'.$func;
-		$client->callClientFunction($code,array($this,$value));
+		$client=$this->getPage()->getCallbackClient();
+		$code=$this->getClientClassName().'.'.$func;
+		$client->callClientFunction($code, array($this, $value));
 	}
 
 	/**
@@ -121,9 +121,9 @@ 
 	 */
 	protected function getExternalControlID()
 	{
-		$extID = $this->getEditTriggerControlID();
+		$extID=$this->getEditTriggerControlID();
 		if($extID===null) return '';
-		if(($control = $this->findControl($extID))!==null)
+		if(($control=$this->findControl($extID))!==null)
 			return $control->getClientID();
 		return $extID;
 	}
@@ -135,13 +135,13 @@ 
 	 */
 	public function setText($value)
 	{
-		if(TTextBox::getText() === $value)
+		if(TTextBox::getText()===$value)
 			return;
 
 		TTextBox::setText($value);
 		if($this->getActiveControl()->canUpdateClientSide())
 		{
-			$client = $this->getPage()->getCallbackClient();
+			$client=$this->getPage()->getCallbackClient();
 			$client->update($this->getLabelClientID(), $value);
 			$client->setValue($this, $value);
 		}
@@ -152,14 +152,14 @@ 
 	 * @param boolean value
 	 * @since 3.1.2
 	 */
-	public function setReadOnly ($value)
+	public function setReadOnly($value)
 	{
 		$value=TPropertyValue::ensureBoolean($value);
-		if(TTextBox::getReadOnly() === $value)
+		if(TTextBox::getReadOnly()===$value)
 			return;
 
 		TTextBox::setReadOnly($value);
-		if ($this->getActiveControl()->canUpdateClientSide())
+		if($this->getActiveControl()->canUpdateClientSide())
 		{
 			$this->callClientFunction('setReadOnly', $value);
 		}
@@ -202,10 +202,10 @@ 
 	 */
 	public function onCallback($param)
 	{
-		$action = $param->getCallbackParameter();
-		if(is_array($action) && $action[0] === '__InlineEditor_loadExternalText__')
+		$action=$param->getCallbackParameter();
+		if(is_array($action) && $action[0]==='__InlineEditor_loadExternalText__')
 		{
-			$parameter = new TCallbackEventParameter($this->getResponse(), $action[1]);
+			$parameter=new TCallbackEventParameter($this->getResponse(), $action[1]);
 			$this->onLoadingText($parameter);
 		}
 		$this->raiseEvent('OnCallback', $this, $param);
@@ -216,26 +216,26 @@ 
 	 */
 	protected function getPostBackOptions()
 	{
-		$options = parent::getPostBackOptions();
-		$options['ID'] = $this->getLabelClientID();
-		$options['TextBoxID'] = $this->getClientID();
-		$options['ExternalControl'] = $this->getExternalControlID();
-		$options['AutoHide'] = $this->getAutoHideTextBox() == false ? '' : true;
-		$options['AutoPostBack'] = $this->getAutoPostBack() == false ? '' : true;
-		$options['Columns'] = $this->getColumns();
+		$options=parent::getPostBackOptions();
+		$options['ID']=$this->getLabelClientID();
+		$options['TextBoxID']=$this->getClientID();
+		$options['ExternalControl']=$this->getExternalControlID();
+		$options['AutoHide']=$this->getAutoHideTextBox()==false ? '' : true;
+		$options['AutoPostBack']=$this->getAutoPostBack()==false ? '' : true;
+		$options['Columns']=$this->getColumns();
 		if($this->getTextMode()==='MultiLine')
 		{
-			$options['Rows'] = $this->getRows();
-			$options['Wrap'] = $this->getWrap()== false ? '' : true;
+			$options['Rows']=$this->getRows();
+			$options['Wrap']=$this->getWrap()==false ? '' : true;
 		}
 		else
 		{
-			$length = $this->getMaxLength();
-			$options['MaxLength'] = $length > 0 ? $length : '';
+			$length=$this->getMaxLength();
+			$options['MaxLength']=$length > 0 ? $length : '';
 		}
 
 		if($this->hasEventHandler('OnLoadingText'))
-			$options['LoadTextOnEdit'] = true;
+			$options['LoadTextOnEdit']=true;
 
 		$options['ReadOnly']=$this->getReadOnly();
 		return $options;
@@ -248,7 +248,7 @@ 
 	 */
 	public function onLoadingText($param)
 	{
-		$this->raiseEvent('OnLoadingText',$this,$param);
+		$this->raiseEvent('OnLoadingText', $this, $param);
 	}
 
 	/**
@@ -267,7 +267,7 @@ 
 	{
 		//calls the TWebControl to avoid rendering other attribute normally render for a textbox.
 		TWebControl::addAttributesToRender($writer);
-		$writer->addAttribute('id',$this->getLabelClientID());
+		$writer->addAttribute('id', $this->getLabelClientID());
 		$this->getActiveControl()->registerCallbackClientScript(
 			$this->getClientClassName(), $this->getPostBackOptions());
 	}

framework/Web/UI/ActiveControls/TTriggeredCallback.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 	}
 
 	/**
-	 * @return array list of trigger callback options.
+	 * @return string list of trigger callback options.
 	 */
 	protected function getTriggerOptions()
 	{

Spacing +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
 	 */
 	protected function getTargetControl()
 	{
-		$id = $this->getControlID();
+		$id=$this->getControlID();
 		if(($control=$this->findControl($id)) instanceof TControl)
 			return $control->getClientID();
 		if($id==='')
@@ -60,9 +60,9 @@ 
 	 */
 	protected function getTriggerOptions()
 	{
-		$options['ID'] = $this->getClientID();
-		$options['EventTarget'] = $this->getUniqueID();
-		$options['ControlID'] = $this->getTargetControl();
+		$options['ID']=$this->getClientID();
+		$options['EventTarget']=$this->getUniqueID();
+		$options['ControlID']=$this->getTargetControl();
 		return $options;
 	}
 }

framework/Web/UI/JuiControls/TJuiDialog.php

Doc Comments +3 added lines

@@ -158,6 +158,9 @@
 		$this->triggerClientMethod('close');
 	}
 
+	/**
+	 * @param string $method
+	 */
 	private function triggerClientMethod($method)
 	{
 		$cs = $this->getPage()->getClientScript();

Braces +1 added lines, -2 removed lines

@@ -58,8 +58,7 @@
 		if ($this->sourcepath === NULL)
 		{
 			$this->sourcepath = $sourcepath;
-		}
-		else
+		} else
 		{
 			$this->sourcepath->append($sourcepath);
 		}

Spacing +13 added lines, -13 removed lines

@@ -68,7 +68,7 @@ 
 	 */
 	public function getOptions()
 	{
-		if (($options=$this->getViewState('JuiOptions'))===null)
+		if(($options=$this->getViewState('JuiOptions'))===null)
 		{
 		  $options=new TJuiControlOptions($this);
 		  $this->setViewState('JuiOptions', $options);
@@ -99,14 +99,14 @@ 
 	 */
 	protected function getPostBackOptions()
 	{
-		$options = $this->getOptions()->toArray();
+		$options=$this->getOptions()->toArray();
 		// always make the dialog a child of the form, or its inner inputs won't be collected
 		if(!isset($options['appendTo']))
-			$options['appendTo'] = 'form:first';
+			$options['appendTo']='form:first';
 
 		foreach($this->getControls() as $control)
 			if($control instanceof TJuiDialogButton)
-				$options['buttons'][] = $control->getPostBackOptions();
+				$options['buttons'][]=$control->getPostBackOptions();
 
 		return $options;
 	}
@@ -119,7 +119,7 @@ 
 	{
 		parent::addAttributesToRender($writer);
 
-		$writer->addAttribute('id',$this->getClientID());
+		$writer->addAttribute('id', $this->getClientID());
 		$options=TJavascript::encode($this->getPostBackOptions());
 		$cs=$this->getPage()->getClientScript();
 		$code="jQuery('#".$this->getWidgetID()."').".$this->getWidget()."(".$options.");";
@@ -140,7 +140,7 @@ 
 	 * Raises the OnCreate event
 	 * @param object $params event parameters
 	 */
-	public function onOpen ($params)
+	public function onOpen($params)
 	{
 		$this->raiseEvent('OnOpen', $this, $params);
 	}
@@ -163,8 +163,8 @@ 
 
 	private function triggerClientMethod($method)
 	{
-		$cs = $this->getPage()->getClientScript();
-		$code = "jQuery(document).ready(function() { jQuery('#".$this->getClientId()."').dialog('".$method."'); })";
+		$cs=$this->getPage()->getClientScript();
+		$code="jQuery(document).ready(function() { jQuery('#".$this->getClientId()."').dialog('".$method."'); })";
 		$cs->registerEndScript(sprintf('%08X', crc32($code)), $code);
 	}
 
@@ -244,7 +244,7 @@ 
 		return array(
 			'text' => $this->getText(),
 			'click' => new TJavaScriptLiteral("function(){new Prado.Callback('".$this->getUniqueID()."', 'onClick');}"
-			)) ;
+			));
 	}
 
 	/**
@@ -252,7 +252,7 @@ 
 	 */
 	public function getText()
 	{
-		return $this->getViewState('Text','');
+		return $this->getViewState('Text', '');
 	}
 
 	/**
@@ -260,14 +260,14 @@ 
 	 */
 	public function setText($value)
 	{
-		$this->setViewState('Text',$value,'');
+		$this->setViewState('Text', $value, '');
 	}
 
 	/**
 	 * Raises the OnClick event
 	 * @param object $params event parameters
 	 */
-	public function onClick ($params)
+	public function onClick($params)
 	{
 		$this->raiseEvent('OnClick', $this, $params);
 	}
@@ -279,7 +279,7 @@ 
 	 */
 	public function raiseCallbackEvent($param)
 	{
-		if($param->CallbackParameter === 'onClick')
+		if($param->CallbackParameter==='onClick')
 			$this->onClick($param);
 	}
 

framework/Web/UI/TTemplateControlInheritable.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	/**
 	 * This method creates the template object for the given class
 	 *
-	 * @param string $p_class The class to create the template from
+	 * @param string $parentClass
 	 * @return void
 	 * @throws TConfigurationException if a template control directive is invalid
 	 */

Spacing +5 added lines, -5 removed lines

@@ -43,7 +43,7 @@ 
 	 */	
 	public function createChildControls()
 	{
-		if(null === ($_template = $this->getTemplate())) {
+		if(null===($_template=$this->getTemplate())) {
 			return $this->doCreateChildControlsFor(get_class($this));
 		}
 
@@ -66,7 +66,7 @@ 
 	 */
 	public function doCreateChildControlsFor($parentClass)
 	{
-		if(false !== ($_parentClass = get_parent_class($parentClass)) && 'TTemplateControl' != $_parentClass) {
+		if(false!==($_parentClass=get_parent_class($parentClass)) && 'TTemplateControl'!=$_parentClass) {
 			$this->doCreateChildControlsFor($_parentClass);
 		}
 
@@ -82,7 +82,7 @@ 
 	 */
 	public function doTemplateForClass($parentClass)
 	{
-		if(null !== ($_template = $this->getService()->getTemplateManager()->getTemplateByClassName($parentClass))) {
+		if(null!==($_template=$this->getService()->getTemplateManager()->getTemplateByClassName($parentClass))) {
 			foreach($_template->getDirective() as $_name => $_value) {
 				if(!is_string($_value)) {
 					throw new TConfigurationException('templatecontrol_directive_invalid', get_class(this), $_name);
@@ -105,11 +105,11 @@ 
 	 */
 	public function getIsSourceTemplateControl()
 	{
-		if(null !== ($_template = $this->getTemplate())) {
+		if(null!==($_template=$this->getTemplate())) {
 			return $_template->getIsSourceTemplate();
 		}
 
-		return ($_template = $this->getService()->getTemplateManager()->getTemplateByClassName(get_parent_class($this)))
+		return ($_template=$this->getService()->getTemplateManager()->getTemplateByClassName(get_parent_class($this)))
 			? $_template->getIsSourceTemplate()
 			: false;
 	}

framework/Web/UI/WebControls/TBaseDataList.php

Doc Comments +1 added lines

@@ -166,6 +166,7 @@
 	 * Otherwise, an exception will be raised.
 	 * @param mixed data item
 	 * @param mixed field name
+	 * @param string $field
 	 * @return mixed data value at the specified field
 	 * @throws TInvalidDataValueException if the data is invalid
 	 */

Spacing +7 added lines, -7 removed lines

@@ -134,7 +134,7 @@ 
 	 */
 	public function getDataKeyField()
 	{
-		return $this->getViewState('DataKeyField','');
+		return $this->getViewState('DataKeyField', '');
 	}
 
 	/**
@@ -142,7 +142,7 @@ 
 	 */
 	public function setDataKeyField($value)
 	{
-		$this->setViewState('DataKeyField',$value,'');
+		$this->setViewState('DataKeyField', $value, '');
 	}
 
 	/**
@@ -150,10 +150,10 @@ 
 	 */
 	public function getDataKeys()
 	{
-		if(($dataKeys=$this->getViewState('DataKeys',null))===null)
+		if(($dataKeys=$this->getViewState('DataKeys', null))===null)
 		{
 			$dataKeys=new TList;
-			$this->setViewState('DataKeys',$dataKeys,null);
+			$this->setViewState('DataKeys', $dataKeys, null);
 		}
 		return $dataKeys;
 	}
@@ -169,9 +169,9 @@ 
 	 * @return mixed data value at the specified field
 	 * @throws TInvalidDataValueException if the data is invalid
 	 */
-	protected function getDataFieldValue($data,$field)
+	protected function getDataFieldValue($data, $field)
 	{
-		return TDataFieldAccessor::getDataFieldValue($data,$field);
+		return TDataFieldAccessor::getDataFieldValue($data, $field);
 	}
 
 	/**
@@ -182,7 +182,7 @@ 
 	 */
 	public function onSelectedIndexChanged($param)
 	{
-		$this->raiseEvent('OnSelectedIndexChanged',$this,$param);
+		$this->raiseEvent('OnSelectedIndexChanged', $this, $param);
 	}
 }
 

framework/Web/UI/WebControls/TCaptcha.php

Doc Comments +8 added lines

@@ -267,6 +267,7 @@ 
 
 	/**
 	 * @param string the public key used for generating the token. A random one will be generated if this is not set.
+	 * @param string $value
 	 */
 	public function setPublicKey($value)
 	{
@@ -322,6 +323,7 @@ 
 	/**
 	 * Validates a user input with the token.
 	 * @param string user input
+	 * @param string $input
 	 * @return boolean if the user input is not the same as the token.
 	 */
 	public function validate($input)
@@ -447,6 +449,11 @@ 
 	 * @param string private key
 	 * @param integer the length of the token
 	 * @param boolean whether the token is case sensitive
+	 * @param string $publicKey
+	 * @param string $privateKey
+	 * @param string $alphabet
+	 * @param integer $tokenLength
+	 * @param boolean $caseSensitive
 	 * @return string the token generated.
 	 */
 	protected function generateToken($publicKey,$privateKey,$alphabet,$tokenLength,$caseSensitive)
@@ -459,6 +466,7 @@ 
 	 * Converts a hash string into a string with characters consisting of alphanumeric characters.
 	 * @param string the hexadecimal representation of the hash string
 	 * @param string the alphabet used to represent the converted string. If empty, it means '234578adefhijmnrtwyABDEFGHIJLMNQRTWY', which excludes those confusing characters.
+	 * @param string $hex
 	 * @return string the converted string
 	 */
 	protected function hash2string($hex,$alphabet='')

Spacing +60 added lines, -60 removed lines

@@ -71,7 +71,7 @@ 
 	 */
 	public function getTokenImageTheme()
 	{
-		return $this->getViewState('TokenImageTheme',0);
+		return $this->getViewState('TokenImageTheme', 0);
 	}
 
 	/**
@@ -90,10 +90,10 @@ 
 	public function setTokenImageTheme($value)
 	{
 		$value=TPropertyValue::ensureInteger($value);
-		if($value>=0 && $value<=63)
-			$this->setViewState('TokenImageTheme',$value,0);
+		if($value >= 0 && $value <= 63)
+			$this->setViewState('TokenImageTheme', $value, 0);
 		else
-			throw new TConfigurationException('captcha_tokenimagetheme_invalid',0,63);
+			throw new TConfigurationException('captcha_tokenimagetheme_invalid', 0, 63);
 	}
 
 	/**
@@ -101,7 +101,7 @@ 
 	 */
 	public function getTokenFontSize()
 	{
-		return $this->getViewState('TokenFontSize',30);
+		return $this->getViewState('TokenFontSize', 30);
 	}
 
 	/**
@@ -113,10 +113,10 @@ 
 	public function setTokenFontSize($value)
 	{
 		$value=TPropertyValue::ensureInteger($value);
-		if($value>=20 && $value<=100)
-			$this->setViewState('TokenFontSize',$value,30);
+		if($value >= 20 && $value <= 100)
+			$this->setViewState('TokenFontSize', $value, 30);
 		else
-			throw new TConfigurationException('captcha_tokenfontsize_invalid',20,100);
+			throw new TConfigurationException('captcha_tokenfontsize_invalid', 20, 100);
 	}
 
 	/**
@@ -124,7 +124,7 @@ 
 	 */
 	public function getMinTokenLength()
 	{
-		return $this->getViewState('MinTokenLength',4);
+		return $this->getViewState('MinTokenLength', 4);
 	}
 
 	/**
@@ -133,10 +133,10 @@ 
 	public function setMinTokenLength($value)
 	{
 		$length=TPropertyValue::ensureInteger($value);
-		if($length>=self::MIN_TOKEN_LENGTH && $length<=self::MAX_TOKEN_LENGTH)
-			$this->setViewState('MinTokenLength',$length,4);
+		if($length >= self::MIN_TOKEN_LENGTH && $length <= self::MAX_TOKEN_LENGTH)
+			$this->setViewState('MinTokenLength', $length, 4);
 		else
-			throw new TConfigurationException('captcha_mintokenlength_invalid',self::MIN_TOKEN_LENGTH,self::MAX_TOKEN_LENGTH);
+			throw new TConfigurationException('captcha_mintokenlength_invalid', self::MIN_TOKEN_LENGTH, self::MAX_TOKEN_LENGTH);
 	}
 
 	/**
@@ -144,7 +144,7 @@ 
 	 */
 	public function getMaxTokenLength()
 	{
-		return $this->getViewState('MaxTokenLength',6);
+		return $this->getViewState('MaxTokenLength', 6);
 	}
 
 	/**
@@ -153,10 +153,10 @@ 
 	public function setMaxTokenLength($value)
 	{
 		$length=TPropertyValue::ensureInteger($value);
-		if($length>=self::MIN_TOKEN_LENGTH && $length<=self::MAX_TOKEN_LENGTH)
-			$this->setViewState('MaxTokenLength',$length,6);
+		if($length >= self::MIN_TOKEN_LENGTH && $length <= self::MAX_TOKEN_LENGTH)
+			$this->setViewState('MaxTokenLength', $length, 6);
 		else
-			throw new TConfigurationException('captcha_maxtokenlength_invalid',self::MIN_TOKEN_LENGTH,self::MAX_TOKEN_LENGTH);
+			throw new TConfigurationException('captcha_maxtokenlength_invalid', self::MIN_TOKEN_LENGTH, self::MAX_TOKEN_LENGTH);
 	}
 
 	/**
@@ -164,7 +164,7 @@ 
 	 */
 	public function getCaseSensitive()
 	{
-		return $this->getViewState('CaseSensitive',true);
+		return $this->getViewState('CaseSensitive', true);
 	}
 
 	/**
@@ -172,7 +172,7 @@ 
 	 */
 	public function setCaseSensitive($value)
 	{
-		$this->setViewState('CaseSensitive',TPropertyValue::ensureBoolean($value),true);
+		$this->setViewState('CaseSensitive', TPropertyValue::ensureBoolean($value), true);
 	}
 
 	/**
@@ -180,7 +180,7 @@ 
 	 */
 	public function getTokenAlphabet()
 	{
-		return $this->getViewState('TokenAlphabet','234578adefhijmnrtABDEFGHJLMNRT');
+		return $this->getViewState('TokenAlphabet', '234578adefhijmnrtABDEFGHJLMNRT');
 	}
 
 	/**
@@ -188,9 +188,9 @@ 
 	 */
 	public function setTokenAlphabet($value)
 	{
-		if(strlen($value)<2)
+		if(strlen($value) < 2)
 			throw new TConfigurationException('captcha_tokenalphabet_invalid');
-		$this->setViewState('TokenAlphabet',$value,'234578adefhijmnrtABDEFGHJLMNRT');
+		$this->setViewState('TokenAlphabet', $value, '234578adefhijmnrtABDEFGHJLMNRT');
 	}
 
 	/**
@@ -198,7 +198,7 @@ 
 	 */
 	public function getTokenExpiry()
 	{
-		return $this->getViewState('TokenExpiry',600);
+		return $this->getViewState('TokenExpiry', 600);
 	}
 
 	/**
@@ -206,7 +206,7 @@ 
 	 */
 	public function setTokenExpiry($value)
 	{
-		$this->setViewState('TokenExpiry',TPropertyValue::ensureInteger($value),600);
+		$this->setViewState('TokenExpiry', TPropertyValue::ensureInteger($value), 600);
 	}
 
 	/**
@@ -214,7 +214,7 @@ 
 	 */
 	public function getChangingTokenBackground()
 	{
-		return $this->getViewState('ChangingTokenBackground',false);
+		return $this->getViewState('ChangingTokenBackground', false);
 	}
 
 	/**
@@ -222,7 +222,7 @@ 
 	 */
 	public function setChangingTokenBackground($value)
 	{
-		$this->setViewState('ChangingTokenBackground',TPropertyValue::ensureBoolean($value),false);
+		$this->setViewState('ChangingTokenBackground', TPropertyValue::ensureBoolean($value), false);
 	}
 
 	/**
@@ -230,7 +230,7 @@ 
 	 */
 	public function getTestLimit()
 	{
-		return $this->getViewState('TestLimit',5);
+		return $this->getViewState('TestLimit', 5);
 	}
 
 	/**
@@ -238,7 +238,7 @@ 
 	 */
 	public function setTestLimit($value)
 	{
-		$this->setViewState('TestLimit',TPropertyValue::ensureInteger($value),5);
+		$this->setViewState('TestLimit', TPropertyValue::ensureInteger($value), 5);
 	}
 
 	/**
@@ -246,8 +246,8 @@ 
 	 */
 	public function getIsTokenExpired()
 	{
-		if(($expiry=$this->getTokenExpiry())>0 && ($start=$this->getViewState('TokenGenerated',0))>0)
-			return $expiry+$start<time();
+		if(($expiry=$this->getTokenExpiry()) > 0 && ($start=$this->getViewState('TokenGenerated', 0)) > 0)
+			return $expiry + $start < time();
 		else
 			return false;
 	}
@@ -257,7 +257,7 @@ 
 	 */
 	public function getPublicKey()
 	{
-		if(($publicKey=$this->getViewState('PublicKey',''))==='')
+		if(($publicKey=$this->getViewState('PublicKey', ''))==='')
 		{
 			$publicKey=$this->generateRandomKey();
 			$this->setPublicKey($publicKey);
@@ -270,7 +270,7 @@ 
 	 */
 	public function setPublicKey($value)
 	{
-		$this->setViewState('PublicKey',$value,'');
+		$this->setViewState('PublicKey', $value, '');
 	}
 
 	/**
@@ -278,7 +278,7 @@ 
 	 */
 	public function getToken()
 	{
-		return $this->generateToken($this->getPublicKey(),$this->getPrivateKey(),$this->getTokenAlphabet(),$this->getTokenLength(),$this->getCaseSensitive());
+		return $this->generateToken($this->getPublicKey(), $this->getPrivateKey(), $this->getTokenAlphabet(), $this->getTokenLength(), $this->getCaseSensitive());
 	}
 
 	/**
@@ -290,13 +290,13 @@ 
 		{
 			$minLength=$this->getMinTokenLength();
 			$maxLength=$this->getMaxTokenLength();
-			if($minLength>$maxLength)
-				$tokenLength=rand($maxLength,$minLength);
-			else if($minLength<$maxLength)
-				$tokenLength=rand($minLength,$maxLength);
+			if($minLength > $maxLength)
+				$tokenLength=rand($maxLength, $minLength);
+			else if($minLength < $maxLength)
+				$tokenLength=rand($minLength, $maxLength);
 			else
 				$tokenLength=$minLength;
-			$this->setViewState('TokenLength',$tokenLength);
+			$this->setViewState('TokenLength', $tokenLength);
 		}
 		return $tokenLength;
 	}
@@ -311,7 +311,7 @@ 
 			$fileName=$this->generatePrivateKeyFile();
 			$content=file_get_contents($fileName);
 			$matches=array();
-			if(preg_match("/privateKey='(.*?)'/ms",$content,$matches)>0)
+			if(preg_match("/privateKey='(.*?)'/ms", $content, $matches) > 0)
 				$this->_privateKey=$matches[1];
 			else
 				throw new TConfigurationException('captcha_privatekey_unknown');
@@ -326,18 +326,18 @@ 
 	 */
 	public function validate($input)
 	{
-		$number=$this->getViewState('TestNumber',0);
+		$number=$this->getViewState('TestNumber', 0);
 		if(!$this->_validated)
 		{
-			$this->setViewState('TestNumber',++$number);
+			$this->setViewState('TestNumber', ++$number);
 			$this->_validated=true;
 		}
-		if($this->getIsTokenExpired() || (($limit=$this->getTestLimit())>0 && $number>$limit))
+		if($this->getIsTokenExpired() || (($limit=$this->getTestLimit()) > 0 && $number > $limit))
 		{
 			$this->regenerateToken();
 			return false;
 		}
-		return ($this->getToken()===($this->getCaseSensitive()?$input:strtoupper($input)));
+		return ($this->getToken()===($this->getCaseSensitive() ? $input : strtoupper($input)));
 	}
 
 	/**
@@ -351,7 +351,7 @@ 
 		$this->setPublicKey('');
 		$this->clearViewState('TokenGenerated');
 		$this->clearViewState('RandomSeed');
-		$this->clearViewState('TestNumber',0);
+		$this->clearViewState('TestNumber', 0);
 	}
 
 	/**
@@ -363,7 +363,7 @@ 
 		parent::onPreRender($param);
 		if(!self::checkRequirements())
 			throw new TConfigurationException('captcha_imagettftext_required');
-		if(!$this->getViewState('TokenGenerated',0))
+		if(!$this->getViewState('TokenGenerated', 0))
 		{
 			$manager=$this->getApplication()->getAssetManager();
 			$manager->publishFilePath($this->getFontFile());
@@ -371,7 +371,7 @@ 
 			$url.='?options='.urlencode($this->getTokenImageOptions());
 			$this->setImageUrl($url);
 
-			$this->setViewState('TokenGenerated',time());
+			$this->setViewState('TokenGenerated', time());
 		}
 	}
 
@@ -380,7 +380,7 @@ 
 	 */
 	protected function getTokenImageOptions()
 	{
-		$privateKey=$this->getPrivateKey();  // call this method to ensure private key is generated
+		$privateKey=$this->getPrivateKey(); // call this method to ensure private key is generated
 		$token=$this->getToken();
 		$options=array();
 		$options['publicKey']=$this->getPublicKey();
@@ -389,12 +389,12 @@ 
 		$options['alphabet']=$this->getTokenAlphabet();
 		$options['fontSize']=$this->getTokenFontSize();
 		$options['theme']=$this->getTokenImageTheme();
-		if(($randomSeed=$this->getViewState('RandomSeed',0))===0)
+		if(($randomSeed=$this->getViewState('RandomSeed', 0))===0)
 		{
-			$randomSeed=(int)(microtime()*1000000);
-			$this->setViewState('RandomSeed',$randomSeed);
+			$randomSeed=(int) (microtime() * 1000000);
+			$this->setViewState('RandomSeed', $randomSeed);
 		}
-		$options['randomSeed']=$this->getChangingTokenBackground()?0:$randomSeed;
+		$options['randomSeed']=$this->getChangingTokenBackground() ? 0 : $randomSeed;
 		$str=serialize($options);
 		return base64_encode(md5($privateKey.$str).$str);
 	}
@@ -428,7 +428,7 @@ 
 			$content="<?php
 \$privateKey='$key';
 ?>";
-			file_put_contents($fileName,$content);
+			file_put_contents($fileName, $content);
 		}
 		return $fileName;
 	}
@@ -449,10 +449,10 @@ 
 	 * @param boolean whether the token is case sensitive
 	 * @return string the token generated.
 	 */
-	protected function generateToken($publicKey,$privateKey,$alphabet,$tokenLength,$caseSensitive)
+	protected function generateToken($publicKey, $privateKey, $alphabet, $tokenLength, $caseSensitive)
 	{
-		$token=substr($this->hash2string(md5($publicKey.$privateKey),$alphabet).$this->hash2string(md5($privateKey.$publicKey),$alphabet),0,$tokenLength);
-		return $caseSensitive?$token:strtoupper($token);
+		$token=substr($this->hash2string(md5($publicKey.$privateKey), $alphabet).$this->hash2string(md5($privateKey.$publicKey), $alphabet), 0, $tokenLength);
+		return $caseSensitive ? $token : strtoupper($token);
 	}
 
 	/**
@@ -461,20 +461,20 @@ 
 	 * @param string the alphabet used to represent the converted string. If empty, it means '234578adefhijmnrtwyABDEFGHIJLMNQRTWY', which excludes those confusing characters.
 	 * @return string the converted string
 	 */
-	protected function hash2string($hex,$alphabet='')
+	protected function hash2string($hex, $alphabet='')
 	{
-		if(strlen($alphabet)<2)
+		if(strlen($alphabet) < 2)
 			$alphabet='234578adefhijmnrtABDEFGHJLMNQRT';
 		$hexLength=strlen($hex);
 		$base=strlen($alphabet);
 		$result='';
-		for($i=0;$i<$hexLength;$i+=6)
+		for($i=0; $i < $hexLength; $i+=6)
 		{
-			$number=hexdec(substr($hex,$i,6));
+			$number=hexdec(substr($hex, $i, 6));
 			while($number)
 			{
-				$result.=$alphabet[$number%$base];
-				$number=floor($number/$base);
+				$result.=$alphabet[$number % $base];
+				$number=floor($number / $base);
 			}
 		}
 		return $result;

framework/Web/UI/WebControls/TCaptchaValidator.php

Doc Comments +4 added lines, -1 removed lines

@@ -79,7 +79,7 @@ 
 	}
 
 	/**
-	 * @return TCaptchaControl the CAPTCHA control to be validated against
+	 * @return TCaptcha the CAPTCHA control to be validated against
 	 * @throws TConfigurationException if the CAPTCHA cannot be found according to {@link setCaptchaControl CaptchaControl}
 	 */
 	protected function findCaptchaControl()
@@ -115,6 +115,9 @@ 
 		return $options;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	private function generateTokenHash($token)
 	{
 		for($h=0,$i=strlen($token)-1;$i>=0;--$i)

Spacing +5 added lines, -5 removed lines

@@ -50,7 +50,7 @@ 
 	 */
 	public function getCaptchaControl()
 	{
-		return $this->getViewState('CaptchaControl','');
+		return $this->getViewState('CaptchaControl', '');
 	}
 
 	/**
@@ -61,7 +61,7 @@ 
 	 */
 	public function setCaptchaControl($value)
 	{
-		$this->setViewState('CaptchaControl',TPropertyValue::ensureString($value),'');
+		$this->setViewState('CaptchaControl', TPropertyValue::ensureString($value), '');
 	}
 
 	/**
@@ -87,9 +87,9 @@ 
 		if(($id=$this->getCaptchaControl())==='')
 			throw new TConfigurationException('captchavalidator_captchacontrol_required');
 		else if(($control=$this->findControl($id))===null)
-			throw new TConfigurationException('captchavalidator_captchacontrol_inexistent',$id);
+			throw new TConfigurationException('captchavalidator_captchacontrol_inexistent', $id);
 		else if(!($control instanceof TCaptcha))
-			throw new TConfigurationException('captchavalidator_captchacontrol_invalid',$id);
+			throw new TConfigurationException('captchavalidator_captchacontrol_invalid', $id);
 		else
 			return $control;
 	}
@@ -117,7 +117,7 @@ 
 
 	private function generateTokenHash($token)
 	{
-		for($h=0,$i=strlen($token)-1;$i>=0;--$i)
+		for($h=0, $i=strlen($token) - 1; $i >= 0; --$i)
 			$h+=ord($token[$i]);
 		return $h;
 	}

Braces +1 added lines, -2 removed lines

@@ -58,8 +58,7 @@
 		if ($this->sourcepath === NULL)
 		{
 			$this->sourcepath = $sourcepath;
-		}
-		else
+		} else
 		{
 			$this->sourcepath->append($sourcepath);
 		}