EGroupware / egroupware

api/src/Etemplate/Widget/Checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

Spacing +11 added lines, -11 removed lines

@@ -44,7 +44,7 @@ 
 	 * @param array &$validated=array() validated content
 	 * @return boolean true if no validation error, false otherwise
 	 */
-	public function validate($cname, array $expand, array $content, &$validated=array())
+	public function validate($cname, array $expand, array $content, &$validated = array())
 	{
 		$form_name = self::form_name($cname, $this->id, $expand);
 
@@ -56,28 +56,28 @@ 
 		if (!$this->is_readonly($cname, $form_name))
 		{
 			$value = self::get_array($content, $form_name);
-			if (!isset($value))	return;	// value not transmitted --> nothing to validate
-			$valid =& self::get_array($validated, $form_name, true);
+			if (!isset($value))	return; // value not transmitted --> nothing to validate
+			$valid = & self::get_array($validated, $form_name, true);
 
 			if (!$value && $this->attrs['needed'])
 			{
-				self::set_validation_error($form_name,lang('Field must not be empty !!!'),'');
+				self::set_validation_error($form_name, lang('Field must not be empty !!!'), '');
 			}
 			$type = $this->type ? $this->type : $this->attrs['type'];
 			$value_attr = $type == 'radio' ? 'set_value' : 'selected_value';
 			// defaults for set and unset values
 			$selected_value = true;
 			$unselected_value = false;
-			if (array_key_exists($value_attr, $this->attrs) || array_key_exists('unselected_value',$this->attrs))
+			if (array_key_exists($value_attr, $this->attrs) || array_key_exists('unselected_value', $this->attrs))
 			{
-				if(array_key_exists($value_attr, $this->attrs))
+				if (array_key_exists($value_attr, $this->attrs))
 				{
 					// Expand any content stuff
-					$selected_value = self::expand_name($this->attrs[$value_attr], $expand['c'], $expand['row'], $expand['c_'], $expand['row_'],$expand['cont']);
+					$selected_value = self::expand_name($this->attrs[$value_attr], $expand['c'], $expand['row'], $expand['c_'], $expand['row_'], $expand['cont']);
 				}
-				if(array_key_exists('unselected_value',$this->attrs))
+				if (array_key_exists('unselected_value', $this->attrs))
 				{
-					$unselected_value = self::expand_name($this->attrs['unselected_value'], $expand['c'], $expand['row'], $expand['c_'], $expand['row_'],$expand['cont']);
+					$unselected_value = self::expand_name($this->attrs['unselected_value'], $expand['c'], $expand['row'], $expand['c_'], $expand['row_'], $expand['cont']);
 				}
 			}
 			if ($type == 'radio')
@@ -87,14 +87,14 @@ 
 				{
 					$valid = $value;
 				}
-				elseif ( !$options && $selected_value && $value == $selected_value)
+				elseif (!$options && $selected_value && $value == $selected_value)
 				{
 					// Options set in template, not in sel_options
 					$valid = $selected_value;
 				}
 				elseif (!isset($valid))
 				{
-					$valid = '';	// do not overwrite value of an other radio-button of the same group (identical name)!
+					$valid = ''; // do not overwrite value of an other radio-button of the same group (identical name)!
 				}
 			}
 			elseif (in_array((string)$selected_value, (array)$value))

Braces +13 added lines, -3 removed lines

@@ -56,7 +56,11 @@ 
 		if (!$this->is_readonly($cname, $form_name))
 		{
 			$value = self::get_array($content, $form_name);
-			if (!isset($value))	return;	// value not transmitted --> nothing to validate
+			if (!isset($value))
+			{
+				return;
+			}
+			// value not transmitted --> nothing to validate
 			$valid =& self::get_array($validated, $form_name, true);
 
 			if (!$value && $this->attrs['needed'])
@@ -101,7 +105,10 @@ 
 			{
 				if ($multiple)
 				{
-					if (!isset($valid)) $valid = array();
+					if (!isset($valid))
+					{
+						$valid = array();
+					}
 					$valid[] = $selected_value;
 				}
 				else
@@ -113,7 +120,10 @@ 
 			{
 				if ($multiple)
 				{
-					if (!isset($valid)) $valid = array();
+					if (!isset($valid))
+					{
+						$valid = array();
+					}
 				}
 				elseif ($value === 'true')
 				{

api/src/Etemplate/Widget/Date.php

Doc Comments +1 added lines, -2 removed lines

@@ -101,7 +101,6 @@ 
 	/**
 	 * Put date in the proper format for sending to client
 	 * @param string|int $value
-	 * @param string $format
 	 */
 	public function format_date($value)
 	{
@@ -139,7 +138,7 @@ 
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * @param array $data Row data
 	 * @return type
 	 */
-	public function set_row_value($cname, Array $expand, Array &$data)
+	public function set_row_value($cname, array $expand, array &$data)
 	{
 		if($this->type == 'date-duration') return;
 

Braces +21 added lines, -5 removed lines

@@ -90,12 +90,18 @@ 
 	 */
 	public function set_row_value($cname, Array $expand, Array &$data)
 	{
-		if($this->type == 'date-duration') return;
+		if($this->type == 'date-duration')
+		{
+			return;
+		}
 
 		$form_name = self::form_name($cname, $this->id, $expand);
 		$value =& $this->get_array($data, $form_name, true);
 
-		if (true) $value = $this->format_date($value);
+		if (true)
+		{
+			$value = $this->format_date($value);
+		}
 	}
 
 	/**
@@ -105,7 +111,11 @@ 
 	 */
 	public function format_date($value)
 	{
-		if (!$value) return $value;	// otherwise we will get current date or 1970-01-01 instead of an empty value
+		if (!$value)
+		{
+			return $value;
+		}
+		// otherwise we will get current date or 1970-01-01 instead of an empty value
 
 		if ($this->attrs['dataformat'])
 		{
@@ -145,9 +155,12 @@ 
 	{
 		$form_name = self::form_name($cname, $this->id, $expand);
 
-		if (!$this->is_readonly($cname, $form_name) && $this->type != 'date-since')	// date-since is always readonly
+		if (!$this->is_readonly($cname, $form_name) && $this->type != 'date-since')
+		{
+			// date-since is always readonly
 		{
 			$value = self::get_array($content, $form_name);
+		}
 			$valid =& self::get_array($validated, $form_name, true);
 
 			if($value)
@@ -232,10 +245,13 @@ 
 				// Not null, blank
 				$value = '';
 			}
-			elseif ($date && empty($this->attrs['dataformat']))	// integer timestamp
+			elseif ($date && empty($this->attrs['dataformat']))
+			{
+				// integer timestamp
 			{
 				$valid = $date->format('ts');
 			}
+			}
 			// string with formatting letters like for php's date() method
 			elseif ($date && ($valid = $date->format($this->attrs['dataformat'])))
 			{

Spacing +31 added lines, -31 removed lines

@@ -60,17 +60,17 @@ 
 	 * @param string $cname
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
-	public function beforeSendToClient($cname, array $expand=null)
+	public function beforeSendToClient($cname, array $expand = null)
 	{
-		if($this->type == 'date-houronly')
+		if ($this->type == 'date-houronly')
 		{
 			return parent::beforeSendToClient($cname, $expand);
 		}
 
 		$form_name = self::form_name($cname, $this->id, $expand);
-		$value =& self::get_array(self::$request->content, $form_name, false, true);
+		$value = & self::get_array(self::$request->content, $form_name, false, true);
 
-		if($this->type != 'date-duration' && $value)
+		if ($this->type != 'date-duration' && $value)
 		{
 			$value = $this->format_date($value);
 		}
@@ -90,10 +90,10 @@ 
 	 */
 	public function set_row_value($cname, Array $expand, Array &$data)
 	{
-		if($this->type == 'date-duration') return;
+		if ($this->type == 'date-duration') return;
 
 		$form_name = self::form_name($cname, $this->id, $expand);
-		$value =& $this->get_array($data, $form_name, true);
+		$value = & $this->get_array($data, $form_name, true);
 
 		if (true) $value = $this->format_date($value);
 	}
@@ -105,7 +105,7 @@ 
 	 */
 	public function format_date($value)
 	{
-		if (!$value) return $value;	// otherwise we will get current date or 1970-01-01 instead of an empty value
+		if (!$value) return $value; // otherwise we will get current date or 1970-01-01 instead of an empty value
 
 		if ($this->attrs['dataformat'])
 		{
@@ -115,11 +115,11 @@ 
 		{
 			$date = new Api\DateTime($value);
 		}
-		if($this->type == 'date-timeonly' && $date)
+		if ($this->type == 'date-timeonly' && $date)
 		{
 			$date->setDate(1970, 1, 1);
 		}
-		if($date)
+		if ($date)
 		{
 			// postfix date-string with "Z" so javascript doesn't add/subtract anything
 			$value = $date->format('Y-m-d\TH:i:s\Z');
@@ -141,34 +141,34 @@ 
 	 * @param array &$validated=array() validated content
 	 * @return boolean true if no validation error, false otherwise
 	 */
-	public function validate($cname, array $expand, array $content, &$validated=array())
+	public function validate($cname, array $expand, array $content, &$validated = array())
 	{
 		$form_name = self::form_name($cname, $this->id, $expand);
 
 		if (!$this->is_readonly($cname, $form_name) && $this->type != 'date-since')	// date-since is always readonly
 		{
 			$value = self::get_array($content, $form_name);
-			$valid =& self::get_array($validated, $form_name, true);
+			$valid = & self::get_array($validated, $form_name, true);
 
-			if($value)
+			if ($value)
 			{
 				try
 				{
 					$date = new Api\DateTime($value);
 				}
-				catch(\Exception $e)
+				catch (\Exception $e)
 				{
 					unset($e);
 					$date = null;
 					$value = '';
 					// this is not really a user error, but one of the clientside engine
-					self::set_validation_error($form_name,lang("'%1' is not a valid date !!!", $value).' '.$this->dataformat);
+					self::set_validation_error($form_name, lang("'%1' is not a valid date !!!", $value).' '.$this->dataformat);
 				}
 			}
 
 			if ((string)$value === '' && $this->attrs['needed'])
 			{
-				self::set_validation_error($form_name,lang('Field must not be empty !!!'));
+				self::set_validation_error($form_name, lang('Field must not be empty !!!'));
 			}
 			elseif (is_null($value))
 			{
@@ -181,53 +181,53 @@ 
 
 			if (!empty($this->attrs['min']))
 			{
-				if(is_numeric($this->attrs['min']))
+				if (is_numeric($this->attrs['min']))
 				{
-					$min = new Api\DateTime(strtotime( $this->attrs['min'] . 'days'));
+					$min = new Api\DateTime(strtotime($this->attrs['min'].'days'));
 				}
-				elseif (preg_match('/[+-][[:digit:]]+[ymwd]/',$this->attrs['min']))
+				elseif (preg_match('/[+-][[:digit:]]+[ymwd]/', $this->attrs['min']))
 				{
 					// Relative date with periods
-					$min = new Api\DateTime(strtotime(str_replace(array('y','m','w','d'), array('years','months','weeks','days'), $this->attrs['min'])));
+					$min = new Api\DateTime(strtotime(str_replace(array('y', 'm', 'w', 'd'), array('years', 'months', 'weeks', 'days'), $this->attrs['min'])));
 				}
 				else
 				{
 					$min = new Api\DateTime(strtotime($this->attrs['min']));
 				}
-				if($date < $min)
+				if ($date < $min)
 				{
-					self::set_validation_error($form_name,lang(
+					self::set_validation_error($form_name, lang(
 						"Value has to be at least '%1' !!!",
 						$min->format($this->type != 'date')
-					),'');
+					), '');
 					$value = $min;
 				}
 			}
 			if (!empty($this->attrs['max']))
 			{
-				if(is_numeric($this->attrs['max']))
+				if (is_numeric($this->attrs['max']))
 				{
-					$max = new Api\DateTime(strtotime( $this->attrs['max'] . 'days'));
+					$max = new Api\DateTime(strtotime($this->attrs['max'].'days'));
 				}
-				elseif (preg_match('/[+-][[:digit:]]+[ymwd]/',$this->attrs['max']))
+				elseif (preg_match('/[+-][[:digit:]]+[ymwd]/', $this->attrs['max']))
 				{
 					// Relative date with periods
-					$max = new Api\DateTime(strtotime(str_replace(array('y','m','w','d'), array('years','months','weeks','days'), $this->attrs['max'])));
+					$max = new Api\DateTime(strtotime(str_replace(array('y', 'm', 'w', 'd'), array('years', 'months', 'weeks', 'days'), $this->attrs['max'])));
 				}
 				else
 				{
 					$max = new Api\DateTime(strtotime($this->attrs['max']));
 				}
-				if($date > $max)
+				if ($date > $max)
 				{
-					self::set_validation_error($form_name,lang(
+					self::set_validation_error($form_name, lang(
 						"Value has to be at maximum '%1' !!!",
 						$max->format($this->type != 'date')
-					),'');
+					), '');
 					$value = $max;
 				}
 			}
-			if(!$value)
+			if (!$value)
 			{
 				// Not null, blank
 				$value = '';
@@ -244,7 +244,7 @@ 
 			else
 			{
 				// this is not really a user error, but one of the clientside engine
-				self::set_validation_error($form_name,lang("'%1' is not a valid date !!!", $value).' '.$this->dataformat);
+				self::set_validation_error($form_name, lang("'%1' is not a valid date !!!", $value).' '.$this->dataformat);
 			}
 			//error_log("$this : ($valid)" . Api\DateTime::to($valid));
 		}

api/src/Etemplate/Widget/Tabbox.php

Doc Comments -1 removed lines

@@ -102,7 +102,6 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @param array $expand=array values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

Braces +8 added lines, -2 removed lines

@@ -65,7 +65,10 @@ 
 			foreach($tabs as &$tab)
 			{
 				$template= clone Template::instance($tab['template']);
-				if($tab['id']) $template->attrs['content'] = $tab['id'];
+				if($tab['id'])
+				{
+					$template->attrs['content'] = $tab['id'];
+				}
 				$this->children[1]->children[] = $template;
 				$tab['url'] = Template::rel2url($template->rel_path);
 				//$this->tabs[] = $tab;
@@ -112,7 +115,10 @@ 
 		{
 			$value = self::get_array($content, $form_name);
 			$valid =& self::get_array($validated, $form_name, true);
-			if (true) $valid = $value;
+			if (true)
+			{
+				$valid = $value;
+			}
 		}
 	}
 }

Spacing +16 added lines, -16 removed lines

@@ -42,30 +42,30 @@ 
 	 * @param array $params =array('') parameter(s) first parameter has to be the cname, second $expand!
 	 * @param boolean $respect_disabled =false false (default): ignore disabled, true: method is NOT run for disabled widgets AND their children
 	 */
-	public function run($method_name, $params=array(''), $respect_disabled=false)
+	public function run($method_name, $params = array(''), $respect_disabled = false)
 	{
 		$form_name = self::form_name($params[0], $this->id, $params[1]);
 
 		// Make sure additional tabs are processed for any method
-		if (!($tabs =& self::getElementAttribute($form_name, 'tabs')))
+		if (!($tabs = & self::getElementAttribute($form_name, 'tabs')))
 		{
 			$tabs = $this->attrs['tabs'];
 		}
-		if($tabs && !$this->tabs_attr_evaluated)
+		if ($tabs && !$this->tabs_attr_evaluated)
 		{
-			$this->tabs_attr_evaluated = true;	// we must not evaluate tabs attribte more then once!
+			$this->tabs_attr_evaluated = true; // we must not evaluate tabs attribte more then once!
 
 			// add_tabs toggles replacing or adding to existing tabs
-			if(!$this->attrs['add_tabs'])
+			if (!$this->attrs['add_tabs'])
 			{
 				$this->children[1]->children = array();
 			}
 
 			//$this->tabs = array();
-			foreach($tabs as &$tab)
+			foreach ($tabs as &$tab)
 			{
-				$template= clone Template::instance($tab['template']);
-				if($tab['id']) $template->attrs['content'] = $tab['id'];
+				$template = clone Template::instance($tab['template']);
+				if ($tab['id']) $template->attrs['content'] = $tab['id'];
 				$this->children[1]->children[] = $template;
 				$tab['url'] = Template::rel2url($template->rel_path);
 				//$this->tabs[] = $tab;
@@ -83,22 +83,22 @@ 
 		// to avoid checking for server side validation
 		if ($form_name == 'tabs' && is_array($readonlys))
 		{
-			foreach($this->children[1]->children as $tab)
+			foreach ($this->children[1]->children as $tab)
 			{
-				if($readonlys[$tab->id])
+				if ($readonlys[$tab->id])
 				{
 					$tab->attrs['disabled'] = $readonlys[$tab->id];
 				}
 			}
 		}
 		
-		if($respect_disabled && $readonlys)
+		if ($respect_disabled && $readonlys)
 		{
-			foreach($this->children[1]->children as $tab)
+			foreach ($this->children[1]->children as $tab)
 			{
-				$parts = explode('.',$tab->template ? $tab->template : $tab->id);
+				$parts = explode('.', $tab->template ? $tab->template : $tab->id);
 				$ro_id = array_pop($parts);
-				if($readonlys[$ro_id])
+				if ($readonlys[$ro_id])
 				{
 					$tab->attrs['disabled'] = $readonlys[$ro_id];
 				}
@@ -118,14 +118,14 @@ 
 	 * @param array &$validated=array() validated content
 	 * @param array $expand=array values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
-	public function validate($cname, array $expand, array $content, &$validated=array())
+	public function validate($cname, array $expand, array $content, &$validated = array())
 	{
 		$form_name = self::form_name($cname, $this->id, $expand);
 
 		if (!empty($form_name))
 		{
 			$value = self::get_array($content, $form_name);
-			$valid =& self::get_array($validated, $form_name, true);
+			$valid = & self::get_array($validated, $form_name, true);
 			if (true) $valid = $value;
 		}
 	}

api/src/Etemplate/Widget/Textbox.php

Doc Comments +1 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 *
 	 * @param string|XMLReader $xml
 	 * @param boolean $cloned =true true: object does NOT need to be cloned, false: to set attribute, set them in cloned object
-	 * @return Template current object or clone, if any attribute was set
+	 * @return Textbox current object or clone, if any attribute was set
 	 */
 	public function set_attrs($xml, $cloned=true)
 	{
@@ -110,7 +110,6 @@ 
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @param array $expand=array values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

Braces +14 added lines, -4 removed lines

@@ -41,7 +41,10 @@ 
 		// normalize types
 		if ($this->type !== 'textbox')
 		{
-			if ($this->type == 'int') $this->type = 'integer';
+			if ($this->type == 'int')
+			{
+				$this->type = 'integer';
+			}
 
 			$this->attrs['type'] = $this->type;
 			$this->type = 'textbox';
@@ -90,7 +93,10 @@ 
 			if (!empty($value))
 			{
 				$preserv =& self::get_array(self::$request->preserv, $form_name, true);
-				if (true) $preserv = (string)$value;
+				if (true)
+				{
+					$preserv = (string)$value;
+				}
 				$value = str_repeat('*', strlen($preserv));
 			}
 		}
@@ -171,11 +177,15 @@ 
 						break;
 				}
 			}
-			elseif ($this->attrs['type'] == 'integer' || $this->attrs['type'] == 'float')	// cast int and float and check range
+			elseif ($this->attrs['type'] == 'integer' || $this->attrs['type'] == 'float')
+			{
+				// cast int and float and check range
 			{
 				if ((string)$value !== '' || $this->attrs['needed'])	// empty values are Ok if needed is not set
 				{
-					$value = $this->attrs['type'] == 'integer' ? (int) $value : (float) str_replace(',','.',$value);	// allow for german (and maybe other) format
+					$value = $this->attrs['type'] == 'integer' ? (int) $value : (float) str_replace(',','.',$value);
+			}
+			// allow for german (and maybe other) format
 
 					if (!(empty($this->attrs['min']) && $this->attrs['min'] !== 0) && $value < $this->attrs['min'])
 					{

Spacing +22 added lines, -22 removed lines

@@ -57,7 +57,7 @@ 
 	 * @param boolean $cloned =true true: object does NOT need to be cloned, false: to set attribute, set them in cloned object
 	 * @return Template current object or clone, if any attribute was set
 	 */
-	public function set_attrs($xml, $cloned=true)
+	public function set_attrs($xml, $cloned = true)
 	{
 		parent::set_attrs($xml, $cloned);
 
@@ -69,7 +69,7 @@ 
 			$this->setElementAttribute($this->id, 'size', abs($this->attrs['size']));
 			self::$request->readonlys[$this->id] = false;
 			$this->setElementAttribute($this->id, 'readonly', true);
-			trigger_error("Using a negative size to set textbox readonly. " .$this, E_USER_DEPRECATED);
+			trigger_error("Using a negative size to set textbox readonly. ".$this, E_USER_DEPRECATED);
 		}
 		return $this;
 	}
@@ -80,16 +80,16 @@ 
 	 * @param string $cname
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
-	public function beforeSendToClient($cname, array $expand=null)
+	public function beforeSendToClient($cname, array $expand = null)
 	{
 		// to NOT transmit passwords back to client, we need to store (non-empty) value in preserv
 		if ($this->attrs['type'] == 'passwd' || $this->type == 'passwd')
 		{
 			$form_name = self::form_name($cname, $this->id, $expand);
-			$value =& self::get_array(self::$request->content, $form_name);
+			$value = & self::get_array(self::$request->content, $form_name);
 			if (!empty($value))
 			{
-				$preserv =& self::get_array(self::$request->preserv, $form_name, true);
+				$preserv = & self::get_array(self::$request->preserv, $form_name, true);
 				if (true) $preserv = (string)$value;
 				$value = str_repeat('*', strlen($preserv));
 			}
@@ -112,7 +112,7 @@ 
 	 * @param array &$validated=array() validated content
 	 * @param array $expand=array values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
-	public function validate($cname, array $expand, array $content, &$validated=array())
+	public function validate($cname, array $expand, array $content, &$validated = array())
 	{
 		$form_name = self::form_name($cname, $this->id, $expand);
 
@@ -120,7 +120,7 @@ 
 		{
 			if (!isset($this->attrs['validator']))
 			{
-				switch($this->attrs['type'])
+				switch ($this->attrs['type'])
 				{
 					case 'int':
 					case 'integer':
@@ -150,26 +150,26 @@ 
 
 			if ((string)$value === '' && $this->attrs['needed'])
 			{
-				self::set_validation_error($form_name,lang('Field must not be empty !!!'),'');
+				self::set_validation_error($form_name, lang('Field must not be empty !!!'), '');
 			}
-			if ((int) $this->attrs['maxlength'] > 0 && mb_strlen($value) > (int) $this->attrs['maxlength'])
+			if ((int)$this->attrs['maxlength'] > 0 && mb_strlen($value) > (int)$this->attrs['maxlength'])
 			{
-				$value = mb_substr($value,0,(int) $this->attrs['maxlength']);
+				$value = mb_substr($value, 0, (int)$this->attrs['maxlength']);
 			}
 			// PHP xml parser reads backslashes literal from attributes, while JavaScript ones need them escaped (eg. like PHP strings)
 			// --> replace \\ with \ to get following XML working: validator="/^\\d+$" (server- AND client-side!)
-			if ($this->attrs['validator'] && !preg_match(str_replace('\\\\','\\', $this->attrs['validator']), $value))
+			if ($this->attrs['validator'] && !preg_match(str_replace('\\\\', '\\', $this->attrs['validator']), $value))
 			{
-				switch($this->attrs['type'])
+				switch ($this->attrs['type'])
 				{
 					case 'integer':
-						self::set_validation_error($form_name,lang("'%1' is not a valid integer !!!",$value),'');
+						self::set_validation_error($form_name, lang("'%1' is not a valid integer !!!", $value), '');
 						break;
 					case 'float':
-						self::set_validation_error($form_name,lang("'%1' is not a valid floatingpoint number !!!",$value),'');
+						self::set_validation_error($form_name, lang("'%1' is not a valid floatingpoint number !!!", $value), '');
 						break;
 					default:
-						self::set_validation_error($form_name,lang("'%1' has an invalid format !!!",$value)/*." !preg_match('$this->attrs[validator]', '$value')"*/,'');
+						self::set_validation_error($form_name, lang("'%1' has an invalid format !!!", $value)/*." !preg_match('$this->attrs[validator]', '$value')"*/, '');
 						break;
 				}
 			}
@@ -177,17 +177,17 @@ 
 			{
 				if ((string)$value !== '' || $this->attrs['needed'])	// empty values are Ok if needed is not set
 				{
-					$value = $this->attrs['type'] == 'integer' ? (int) $value : (float) str_replace(',','.',$value);	// allow for german (and maybe other) format
+					$value = $this->attrs['type'] == 'integer' ? (int)$value : (float)str_replace(',', '.', $value); // allow for german (and maybe other) format
 
 					if (!(empty($this->attrs['min']) && $this->attrs['min'] !== 0) && $value < $this->attrs['min'])
 					{
-						self::set_validation_error($form_name,lang("Value has to be at least '%1' !!!",$this->attrs['min']),'');
-						$value = $this->attrs['type'] == 'integer' ? (int) $this->attrs['min'] : (float) $this->attrs['min'];
+						self::set_validation_error($form_name, lang("Value has to be at least '%1' !!!", $this->attrs['min']), '');
+						$value = $this->attrs['type'] == 'integer' ? (int)$this->attrs['min'] : (float)$this->attrs['min'];
 					}
-					if (!(empty($this->attrs['max'])&& $this->attrs['max'] !== 0) && $value > $this->attrs['max'])
+					if (!(empty($this->attrs['max']) && $this->attrs['max'] !== 0) && $value > $this->attrs['max'])
 					{
-						self::set_validation_error($form_name,lang("Value has to be at maximum '%1' !!!",$this->attrs['max']),'');
-						$value = $this->attrs['type'] == 'integer' ? (int) $this->attrs['max'] : (float) $this->attrs['max'];
+						self::set_validation_error($form_name, lang("Value has to be at maximum '%1' !!!", $this->attrs['max']), '');
+						$value = $this->attrs['type'] == 'integer' ? (int)$this->attrs['max'] : (float)$this->attrs['max'];
 					}
 				}
 			}
@@ -199,4 +199,4 @@ 
 		}
 	}
 }
-Etemplate\Widget::registerWidget(__NAMESPACE__.'\\Textbox', array('textbox','text','int','integer','float','passwd','hidden','colorpicker','hidden'));
+Etemplate\Widget::registerWidget(__NAMESPACE__.'\\Textbox', array('textbox', 'text', 'int', 'integer', 'float', 'passwd', 'hidden', 'colorpicker', 'hidden'));

api/src/Exception/NoPermission/Admin.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
  */
 class Admin extends App
 {
+	/**
+	 * @param string $msg
+	 */
 	function __construct($msg=null,$code=102)
 	{
 		if (is_null($msg)) $msg = 'admin';

Spacing +2 added lines, -2 removed lines

@@ -19,10 +19,10 @@
  */
 class Admin extends App
 {
-	function __construct($msg=null,$code=102)
+	function __construct($msg = null, $code = 102)
 	{
 		if (is_null($msg)) $msg = 'admin';
 
-		parent::__construct($msg,$code);
+		parent::__construct($msg, $code);
 	}
 }

Braces +4 added lines, -1 removed lines

@@ -21,7 +21,10 @@
 {
 	function __construct($msg=null,$code=102)
 	{
-		if (is_null($msg)) $msg = 'admin';
+		if (is_null($msg))
+		{
+			$msg = 'admin';
+		}
 
 		parent::__construct($msg,$code);
 	}

api/src/Framework/Ajax.php

Doc Comments -5 removed lines

@@ -356,11 +356,6 @@
 	/**
 	* Add menu items to the topmenu template class to be displayed
 	*
-	* @param array $app application data
-	* @param mixed $alt_label string with alternative menu item label default value = null
-	* @param string $urlextra string with alternate additional code inside <a>-tag
-	* @access protected
-	* @return void
 	*/
 	function _add_topmenu_item(array $app_data,$alt_label=null)
 	{

Indentation +18 added lines, -18 removed lines

@@ -337,16 +337,16 @@ 
 	}
 
 	/**
-	* called by hooks to add an icon in the topmenu info location
-	*
-	* @param string $id unique element id
-	* @param string $icon_src src of the icon image. Make sure this nog height then 18pixels
-	* @param string $iconlink where the icon links to
-	* @param booleon $blink set true to make the icon blink
-	* @param mixed $tooltip string containing the tooltip Api\Html, or null of no tooltip
-	* @todo implement in a reasonable way for jdots
-	* @return void
-	*/
+	 * called by hooks to add an icon in the topmenu info location
+	 *
+	 * @param string $id unique element id
+	 * @param string $icon_src src of the icon image. Make sure this nog height then 18pixels
+	 * @param string $iconlink where the icon links to
+	 * @param booleon $blink set true to make the icon blink
+	 * @param mixed $tooltip string containing the tooltip Api\Html, or null of no tooltip
+	 * @todo implement in a reasonable way for jdots
+	 * @return void
+	 */
 	function topmenu_info_icon($id,$icon_src,$iconlink,$blink=false,$tooltip=null)
 	{
 		unset($id,$icon_src,$iconlink,$blink,$tooltip);	// not used
@@ -354,14 +354,14 @@ 
 	}
 
 	/**
-	* Add menu items to the topmenu template class to be displayed
-	*
-	* @param array $app application data
-	* @param mixed $alt_label string with alternative menu item label default value = null
-	* @param string $urlextra string with alternate additional code inside <a>-tag
-	* @access protected
-	* @return void
-	*/
+	 * Add menu items to the topmenu template class to be displayed
+	 *
+	 * @param array $app application data
+	 * @param mixed $alt_label string with alternative menu item label default value = null
+	 * @param string $urlextra string with alternate additional code inside <a>-tag
+	 * @access protected
+	 * @return void
+	 */
 	function _add_topmenu_item(array $app_data,$alt_label=null)
 	{
 		switch($app_data['name'])

Braces +52 added lines, -13 removed lines

@@ -104,7 +104,9 @@ 
 
 		//Width may not be smaller than MIN_SIDEBAR_WIDTH
 		if ($width < self::MIN_SIDEBAR_WIDTH)
-			$width = self::MIN_SIDEBAR_WIDTH;
+		{
+					$width = self::MIN_SIDEBAR_WIDTH;
+		}
 
 		return $width;
 	}
@@ -156,7 +158,10 @@ 
 	 */
 	static function link($url = '', $extravars = '', $link_app=null)
 	{
-		if (is_null($link_app)) $link_app = self::$link_app;
+		if (is_null($link_app))
+		{
+			$link_app = self::$link_app;
+		}
 		$link = parent::link($url, $extravars);
 
 		// $link_app === true --> detect application, otherwise use given application
@@ -182,7 +187,10 @@ 
 	function header(array $extra=array())
 	{
 		// make sure header is output only once
-		if (self::$header_done) return '';
+		if (self::$header_done)
+		{
+			return '';
+		}
 		self::$header_done = true;
 
 		$this->send_headers();
@@ -249,7 +257,10 @@ 
 			// for remote manual never check/create framework
 			if (!in_array($GLOBALS['egw_info']['flags']['currentapp'], array('manual', 'login', 'logout', 'sitemgr')))
 			{
-				if (empty($GLOBALS['egw_info']['flags']['java_script'])) $GLOBALS['egw_info']['flags']['java_script']='';
+				if (empty($GLOBALS['egw_info']['flags']['java_script']))
+				{
+					$GLOBALS['egw_info']['flags']['java_script']='';
+				}
 				$extra['check-framework'] = $_GET['cd'] !== 'no';
 			}
 		}
@@ -522,7 +533,10 @@ 
 	 */
 	public function sidebox($appname,$menu_title,$file,$type=null)
 	{
-		if (!isset($file['menuOpened'])) $file['menuOpened'] = (boolean)$this->sidebox_menu_opened;
+		if (!isset($file['menuOpened']))
+		{
+			$file['menuOpened'] = (boolean)$this->sidebox_menu_opened;
+		}
 		//error_log(__METHOD__."('$appname', '$menu_title', file[menuOpened]=$file[menuOpened], ...) this->sidebox_menu_opened=$this->sidebox_menu_opened");
 		$this->sidebox_menu_opened = false;
 
@@ -663,7 +677,10 @@ 
 		foreach($tablist as $data)
 		{
 			$tabs[] = $data['appName'];
-			if ($data['active']) $active = $data['appName'];
+			if ($data['active'])
+			{
+				$active = $data['appName'];
+			}
 		}
 		// send app a notification, that it's tab got closed
 		// used eg. in phpFreeChat to leave the chat
@@ -790,10 +807,22 @@ 
 		}
 
 		unset($apps['logout']);	// never display it
-		if (isset($apps['about'])) $apps['about']['noNavbar'] = true;
-		if (isset($apps['preferences'])) $apps['preferences']['noNavbar'] = true;
-		if (isset($apps['manual'])) $apps['manual']['noNavbar'] = true;
-		if (isset($apps['home'])) $apps['home']['noNavbar'] = true;
+		if (isset($apps['about']))
+		{
+			$apps['about']['noNavbar'] = true;
+		}
+		if (isset($apps['preferences']))
+		{
+			$apps['preferences']['noNavbar'] = true;
+		}
+		if (isset($apps['manual']))
+		{
+			$apps['manual']['noNavbar'] = true;
+		}
+		if (isset($apps['home']))
+		{
+			$apps['home']['noNavbar'] = true;
+		}
 
 		// no need for website icon, if we have sitemgr
 		if (isset($apps['sitemgr']) && isset($apps['sitemgr-link']))
@@ -855,7 +884,10 @@ 
 		else
 		{
 			$active_tab = $GLOBALS['egw_info']['user']['preferences']['common']['active_tab'];
-			if (!$active_tab) $active_tab = $default_app;
+			if (!$active_tab)
+			{
+				$active_tab = $default_app;
+			}
 		}
 
 		//self::app_from_url might return an application the user has no rights
@@ -898,9 +930,12 @@ 
 		// Restore Tabs
 		foreach($open_tabs as $n => $app)
 		{
-			if (isset($apps[$app]))		// user might no longer have app rights
+			if (isset($apps[$app]))
+			{
+				// user might no longer have app rights
 			{
 				$apps[$app]['opened'] = $n;
+			}
 				if ($app == $active_tab)
 				{
 					$apps[$app]['active'] = true;
@@ -926,7 +961,11 @@ 
 	function footer($no_framework=true)
 	{
 		//error_log(__METHOD__."($no_framework) footer_done=".array2string(self::$footer_done).' '.function_backtrace());
-		if (self::$footer_done) return;	// prevent (multiple) footers
+		if (self::$footer_done)
+		{
+			return;
+		}
+		// prevent (multiple) footers
 		self::$footer_done = true;
 
 		if (!isset($GLOBALS['egw_info']['flags']['nofooter']) || !$GLOBALS['egw_info']['flags']['nofooter'])

Spacing +78 added lines, -78 removed lines

@@ -57,11 +57,11 @@ 
 	 *
 	 * @param string $template = '' name of the template
 	 */
-	function __construct($template=self::APP)
+	function __construct($template = self::APP)
 	{
-		parent::__construct($template);		// call the constructor of the extended class
+		parent::__construct($template); // call the constructor of the extended class
 
-		$this->template_dir = '/'.$template;		// we are packaged as an application
+		$this->template_dir = '/'.$template; // we are packaged as an application
 	}
 
 	/**
@@ -129,16 +129,16 @@ 
 	public static function app_from_url($url)
 	{
 		$matches = null;
-		if (preg_match('/menuaction=([a-z0-9_-]+)\./i',$url,$matches))
+		if (preg_match('/menuaction=([a-z0-9_-]+)\./i', $url, $matches))
 		{
 			return $matches[1];
 		}
 		if ($GLOBALS['egw_info']['server']['webserver_url'] &&
-			($webserver_path = parse_url($GLOBALS['egw_info']['server']['webserver_url'],PHP_URL_PATH)))
+			($webserver_path = parse_url($GLOBALS['egw_info']['server']['webserver_url'], PHP_URL_PATH)))
 		{
-			list(,$url) = explode($webserver_path, parse_url($url,PHP_URL_PATH),2);
+			list(,$url) = explode($webserver_path, parse_url($url, PHP_URL_PATH), 2);
 		}
-		if (preg_match('/\/([^\/]+)\/([^\/]+\.php)?(\?|\/|$)/',$url,$matches))
+		if (preg_match('/\/([^\/]+)\/([^\/]+\.php)?(\?|\/|$)/', $url, $matches))
 		{
 			return $matches[1];
 		}
@@ -154,7 +154,7 @@ 
 	 * @param string $link_app = null if appname or true, some templates generate a special link-handler url
 	 * @return string	The full url after processing
 	 */
-	static function link($url = '', $extravars = '', $link_app=null)
+	static function link($url = '', $extravars = '', $link_app = null)
 	{
 		if (is_null($link_app)) $link_app = self::$link_app;
 		$link = parent::link($url, $extravars);
@@ -165,7 +165,7 @@ 
 			// Link gets handled in JS, so quotes need slashes as well as url-encoded
 			// encoded ampersands in get parameters (%26) need to be encoded twise,
 			// so they are still encoded when assigned to window.location
-			$link_with_slashes = str_replace(array('%27','%26'), array('\%27','%2526'), $link);
+			$link_with_slashes = str_replace(array('%27', '%26'), array('\%27', '%2526'), $link);
 
 			//$link = "javascript:window.egw_link_handler?egw_link_handler('$link','$link_app'):parent.egw_link_handler('$link','$link_app');";
 			$link = "javascript:egw_link_handler('$link_with_slashes','$link_app')";
@@ -179,7 +179,7 @@ 
 	 * @param array $extra = array() extra attributes passed as data-attribute to egw.js
 	 * @return string with Api\Html
 	 */
-	function header(array $extra=array())
+	function header(array $extra = array())
 	{
 		// make sure header is output only once
 		if (self::$header_done) return '';
@@ -204,8 +204,8 @@ 
 		{
 			$this->tpl->set_file(array('_head' => 'head.tpl'));
 		}
-		$this->tpl->set_block('_head','head');
-		$this->tpl->set_block('_head','framework');
+		$this->tpl->set_block('_head', 'head');
+		$this->tpl->set_block('_head', 'framework');
 
 		// should we draw the framework, or just a header
 		$do_framework = isset($_GET['cd']) && $_GET['cd'] === 'yes';
@@ -230,7 +230,7 @@ 
 			{
 				self::includeJS('.', 'fw_'.static::APP, static::JS_INCLUDE_APP);
 			}
-			Api\Cache::unsetSession(__CLASS__,'sidebox_md5');	// sideboxes need to be send again
+			Api\Cache::unsetSession(__CLASS__, 'sidebox_md5'); // sideboxes need to be send again
 
 			$extra['navbar-apps'] = $this->get_navbar_apps($_SERVER['REQUEST_URI']);
 		}
@@ -239,7 +239,7 @@ 
 		// - if not we need to check if we have an opener (are a popup window)
 		// - as popups can open further popups, we need to decend all the way down until we find a framework
 		// - only if we cant find a framework in all openers, we redirect to create a new framework
-		if(!$do_framework)
+		if (!$do_framework)
 		{
 			// fetch sidebox from application and set it in extra data, if we are no popup
 			if (!$GLOBALS['egw_info']['flags']['nonavbar'])
@@ -249,7 +249,7 @@ 
 			// for remote manual never check/create framework
 			if (!in_array($GLOBALS['egw_info']['flags']['currentapp'], array('manual', 'login', 'logout', 'sitemgr')))
 			{
-				if (empty($GLOBALS['egw_info']['flags']['java_script'])) $GLOBALS['egw_info']['flags']['java_script']='';
+				if (empty($GLOBALS['egw_info']['flags']['java_script'])) $GLOBALS['egw_info']['flags']['java_script'] = '';
 				$extra['check-framework'] = $_GET['cd'] !== 'no';
 			}
 		}
@@ -260,7 +260,7 @@ 
 		));
 		
 		$this->tpl->set_var($this->_get_header($extra));
-		$content = $this->tpl->fp('out','head').$content;
+		$content = $this->tpl->fp('out', 'head').$content;
 
 		if (!$do_framework)
 		{
@@ -269,10 +269,10 @@ 
 
 		// topmenu
 		$vars = $this->_get_navbar($apps = $this->_get_navbar_apps());
-		$this->tpl->set_var($this->topmenu($vars,$apps));
+		$this->tpl->set_var($this->topmenu($vars, $apps));
 
 		// hook after_navbar (eg. notifications)
-		$this->tpl->set_var('hook_after_navbar',$this->_get_after_navbar());
+		$this->tpl->set_var('hook_after_navbar', $this->_get_after_navbar());
 
 		//Global sidebar width
 		$this->tpl->set_var('sidebox_width', self::get_global_sidebar_width());
@@ -289,7 +289,7 @@ 
 
 		// add framework div's
 		$this->tpl->set_var($this->_get_footer());
-		$content .= $this->tpl->fp('out','framework');
+		$content .= $this->tpl->fp('out', 'framework');
 		$content .= self::footer(false);
 
 		echo $content;
@@ -308,14 +308,14 @@ 
 	 * @param array $apps
 	 * @return array
 	 */
-	function topmenu(array $vars,array $apps)
+	function topmenu(array $vars, array $apps)
 	{
 		$this->topmenu_items = $this->topmenu_info_items = array();
 
-		parent::topmenu($vars,$apps);
-		$vars['topmenu_items'] = "<ul>\n<li>".implode("</li>\n<li>",$this->topmenu_items)."</li>\n</ul>";
+		parent::topmenu($vars, $apps);
+		$vars['topmenu_items'] = "<ul>\n<li>".implode("</li>\n<li>", $this->topmenu_items)."</li>\n</ul>";
 		$vars['topmenu_info_items'] = '';
-		foreach($this->topmenu_info_items as $id => $item)
+		foreach ($this->topmenu_info_items as $id => $item)
 		{
 			$vars['topmenu_info_items'] .= '<div class="topmenu_info_item"'.
 				(is_numeric($id) ? '' : ' id="topmenu_info_'.$id.'"').'>'.$item."</div>\n";
@@ -336,9 +336,9 @@ 
 	* @todo implement in a reasonable way for jdots
 	* @return void
 	*/
-	function topmenu_info_icon($id,$icon_src,$iconlink,$blink=false,$tooltip=null)
+	function topmenu_info_icon($id, $icon_src, $iconlink, $blink = false, $tooltip = null)
 	{
-		unset($id,$icon_src,$iconlink,$blink,$tooltip);	// not used
+		unset($id, $icon_src, $iconlink, $blink, $tooltip); // not used
 		// not yet implemented, only used in admin/inc/hook_topmenu_info.inc.php to notify about pending updates
 	}
 
@@ -351,9 +351,9 @@ 
 	* @access protected
 	* @return void
 	*/
-	function _add_topmenu_item(array $app_data,$alt_label=null)
+	function _add_topmenu_item(array $app_data, $alt_label = null)
 	{
-		switch($app_data['name'])
+		switch ($app_data['name'])
 		{
 			case 'logout':
 				if (Api\Header\UserAgent::mobile() || $GLOBALS['egw_info']['user']['preferences']['common']['theme'] == 'mobile')
@@ -362,7 +362,7 @@ 
 				}
 				else
 				{
-					return;	// no need for logout in topmenu on jdots
+					return; // no need for logout in topmenu on jdots
 				}
 				break;
 
@@ -371,7 +371,7 @@ 
 				break;
 
 			default:
-				if (strpos($app_data['url'],'logout.php') === false && substr($app_data['url'], 0, 11) != 'javascript:')
+				if (strpos($app_data['url'], 'logout.php') === false && substr($app_data['url'], 0, 11) != 'javascript:')
 				{
 					$app_data['url'] = "javascript:egw_link_handler('".$app_data['url']."','".
 						(isset($GLOBALS['egw_info']['user']['apps'][$app_data['name']]) ?
@@ -379,8 +379,8 @@ 
 				}
 		}
 		$id = $app_data['id'] ? $app_data['id'] : ($app_data['name'] ? $app_data['name'] : $app_data['title']);
-		$title =  htmlspecialchars($alt_label ? $alt_label : $app_data['title']);
-		$this->topmenu_items[] = '<a id="topmenu_' . $id . '" href="'.htmlspecialchars($app_data['url']).'" title="'.$app_data['title'].'">'.$title.'</a>';
+		$title = htmlspecialchars($alt_label ? $alt_label : $app_data['title']);
+		$this->topmenu_items[] = '<a id="topmenu_'.$id.'" href="'.htmlspecialchars($app_data['url']).'" title="'.$app_data['title'].'">'.$title.'</a>';
 	}
 
 	/**
@@ -391,11 +391,11 @@ 
 	 * @access protected
 	 * @return void
 	 */
-	function _add_topmenu_info_item($content, $id=null)
+	function _add_topmenu_info_item($content, $id = null)
 	{
-		if(strpos($content,'menuaction=admin.admin_accesslog.sessions') !== false)
+		if (strpos($content, 'menuaction=admin.admin_accesslog.sessions') !== false)
 		{
-			$content = preg_replace('/href="([^"]+)"/',"href=\"javascript:egw_link_handler('\\1','admin')\"",$content);
+			$content = preg_replace('/href="([^"]+)"/', "href=\"javascript:egw_link_handler('\\1','admin')\"", $content);
 		}
 		if ($id)
 		{
@@ -414,10 +414,10 @@ 
 	 */
 	static function ajax_tz_selection($tz)
 	{
-		Api\DateTime::setUserPrefs($tz);	// throws exception, if tz is invalid
+		Api\DateTime::setUserPrefs($tz); // throws exception, if tz is invalid
 
 		$GLOBALS['egw']->preferences->read_repository();
-		$GLOBALS['egw']->preferences->add('common','tz',$tz);
+		$GLOBALS['egw']->preferences->add('common', 'tz', $tz);
 		$GLOBALS['egw']->preferences->save_repository();
 	}
 
@@ -469,13 +469,13 @@ 
 		// only send admin sidebox, for admin index url (when clicked on admin),
 		// not for other admin pages, called eg. from sidebox menu of other apps
 		// --> that way we always stay in the app, and NOT open admin sidebox for an app tab!!!
-		if ($app == 'admin' && substr($_SERVER['PHP_SELF'],-16) != '/admin/index.php' &&
+		if ($app == 'admin' && substr($_SERVER['PHP_SELF'], -16) != '/admin/index.php' &&
 			$_GET['menuaction'] != 'admin.admin_ui.index')
 		{
 			//error_log(__METHOD__."() app=$app, menuaction=$_GET[menuaction], PHP_SELF=$_SERVER[PHP_SELF] --> sidebox request ignored");
 			return;
 		}
-		$md5_session =& Api\Cache::getSession(__CLASS__,'sidebox_md5');
+		$md5_session = & Api\Cache::getSession(__CLASS__, 'sidebox_md5');
 
 		//Set the sidebox content
 		$sidebox = $this->get_sidebox($app);
@@ -484,7 +484,7 @@ 
 		if ($md5_session[$app] !== $md5)
 		{
 			//error_log(__METHOD__."() header changed md5_session[$app]!=='$md5' --> setting it on self::\$extra[setSidebox]");
-			$md5_session[$app] = $md5;	// update md5 in session
+			$md5_session[$app] = $md5; // update md5 in session
 			self::$extra['setSidebox'] = array($app, $sidebox, $md5);
 		}
 		//else error_log(__METHOD__."() md5_session[$app]==='$md5' --> nothing to do");
@@ -498,9 +498,9 @@ 
 	 * @return boolean $consider_navbar_not_yet_called_as_true=true ignored by jdots, we only care for cd=yes GET param
 	 * @return boolean
 	 */
-	public function isTop($consider_navbar_not_yet_called_as_true=true)
+	public function isTop($consider_navbar_not_yet_called_as_true = true)
 	{
-		unset($consider_navbar_not_yet_called_as_true);	// not used
+		unset($consider_navbar_not_yet_called_as_true); // not used
 		return isset($_GET['cd']) && $_GET['cd'] === 'yes';
 	}
 
@@ -526,7 +526,7 @@ 
 	 * @param array $file
 	 * @param string $type = null 'admin', 'preferences', 'favorites', ...
 	 */
-	public function sidebox($appname,$menu_title,$file,$type=null)
+	public function sidebox($appname, $menu_title, $file, $type = null)
 	{
 		if (!isset($file['menuOpened'])) $file['menuOpened'] = (boolean)$this->sidebox_menu_opened;
 		//error_log(__METHOD__."('$appname', '$menu_title', file[menuOpened]=$file[menuOpened], ...) this->sidebox_menu_opened=$this->sidebox_menu_opened");
@@ -535,11 +535,11 @@ 
 		// fix app admin menus to use admin.admin_ui.index loader
 		if (($type == 'admin' || $menu_title == lang('Admin')) && $appname != 'admin')
 		{
-			foreach($file as &$link)
+			foreach ($file as &$link)
 			{
 				preg_match('/ajax=(true|false)/', $link, $ajax);
 				$link = preg_replace("/^(javascript:egw_link_handler\(')(.*)menuaction=([^&]+)(.*)(','[^']+'\))$/",
-					'$1$2menuaction=admin.admin_ui.index&load=$3$4&ajax=' . ($ajax[1] ? $ajax[1] : 'true') .'\',\'admin\')', $file_was=$link);
+					'$1$2menuaction=admin.admin_ui.index&load=$3$4&ajax='.($ajax[1] ? $ajax[1] : 'true').'\',\'admin\')', $file_was = $link);
 			}
 
 		}
@@ -576,15 +576,15 @@ 
 			self::$link_app = $appname;
 			// allow other apps to hook into sidebox menu of an app, hook-name: sidebox_$appname
 			$this->sidebox_menu_opened = true;
-			Api\Hooks::process('sidebox_'.$appname,array($appname),true);	// true = call independent of app-permissions
+			Api\Hooks::process('sidebox_'.$appname, array($appname), true); // true = call independent of app-permissions
 
 			// calling the old hook
 			$this->sidebox_menu_opened = true;
-			Api\Hooks::single('sidebox_menu',$appname);
+			Api\Hooks::single('sidebox_menu', $appname);
 			self::$link_app = null;
 
 			// allow other apps to hook into sidebox menu of every app: sidebox_all
-			Api\Hooks::process('sidebox_all',array($GLOBALS['egw_info']['flags']['currentapp']),true);
+			Api\Hooks::process('sidebox_all', array($GLOBALS['egw_info']['flags']['currentapp']), true);
 		}
 		//If there still is no sidebox content, return null here
 		if (!isset($this->sideboxes[$appname]))
@@ -594,17 +594,17 @@ 
 
 		$data = array();
 		$sendToBottom = array();
-		foreach($this->sideboxes[$appname] as $menu_name => &$file)
+		foreach ($this->sideboxes[$appname] as $menu_name => &$file)
 		{
 			$current_menu = array(
-				'menu_name' => md5($menu_name),	// can contain Api\Html tags and javascript!
+				'menu_name' => md5($menu_name), // can contain Api\Html tags and javascript!
 				'title' => $menu_name,
 				'entries' => array(),
 				'opened' => (boolean)$file['menuOpened'],
 			);
-			foreach($file as $item_text => $item_link)
+			foreach ($file as $item_text => $item_link)
 			{
-				if ($item_text === 'menuOpened' || $item_text === 'sendToBottom' ||// flag, not menu entry
+				if ($item_text === 'menuOpened' || $item_text === 'sendToBottom' || // flag, not menu entry
 					$item_text === '_NewLine_' || $item_link === '_NewLine_')
 				{
 					continue;
@@ -615,14 +615,14 @@ 
 				}
 
 				$var = array();
-				$var['icon_or_star'] = $GLOBALS['egw_info']['server']['webserver_url'] . $this->template_dir.'/images/bullet.png';
+				$var['icon_or_star'] = $GLOBALS['egw_info']['server']['webserver_url'].$this->template_dir.'/images/bullet.png';
 				$var['target'] = '';
-				if(is_array($item_link))
+				if (is_array($item_link))
 				{
-					if(isset($item_link['icon']))
+					if (isset($item_link['icon']))
 					{
 						$app = isset($item_link['app']) ? $item_link['app'] : $appname;
-						$var['icon_or_star'] = $item_link['icon'] ? Api\Image::find($app,$item_link['icon']) : False;
+						$var['icon_or_star'] = $item_link['icon'] ? Api\Image::find($app, $item_link['icon']) : False;
 					}
 					$var['lang_item'] = isset($item_link['no_lang']) && $item_link['no_lang'] ? $item_link['text'] : lang($item_link['text']);
 					$var['item_link'] = $item_link['link'];
@@ -666,7 +666,7 @@ 
 	public static function ajax_tab_changed_state($tablist)
 	{
 		$tabs = array();
-		foreach($tablist as $data)
+		foreach ($tablist as $data)
 		{
 			$tabs[] = $data['appName'];
 			if ($data['active']) $active = $data['appName'];
@@ -675,7 +675,7 @@ 
 		// used eg. in phpFreeChat to leave the chat
 		if (($old_tabs = Api\Cache::getSession(__CLASS__, 'open_tabs')))
 		{
-			foreach(array_diff(explode(',',$old_tabs),$tabs) as $app)
+			foreach (array_diff(explode(',', $old_tabs), $tabs) as $app)
 			{
 				//error_log("Tab '$app' closed, old_tabs=$old_tabs");
 				Api\Hooks::single(array(
@@ -684,7 +684,7 @@ 
 				), $app);
 			}
 		}
-		$open = implode(',',$tabs);
+		$open = implode(',', $tabs);
 
 		if ($open != $GLOBALS['egw_info']['user']['preferences']['common']['open_tabs'] ||
 			$active != $GLOBALS['egw_info']['user']['preferences']['common']['active_tab'])
@@ -754,7 +754,7 @@ 
 		$i = 0;
 
 		//Parse the "$apps" array for valid content (security)
-		foreach($apps as $app)
+		foreach ($apps as $app)
 		{
 			//Check whether the app really exists and add it to the $app_arr var
 			if ($GLOBALS['egw_info']['user']['apps'][$app])
@@ -785,17 +785,17 @@ 
 	 */
 	public function navbar_apps()
 	{
-		$apps = parent::_get_navbar_apps(Api\Image::svg_usable());	// use svg if usable in browser
+		$apps = parent::_get_navbar_apps(Api\Image::svg_usable()); // use svg if usable in browser
 
 		//Add its sidebox width to each app
 		foreach ($apps as $app => &$data)
 		{
 			$data['sideboxwidth'] = self::get_sidebar_width($app);
 			// overwrite icon with svg, if supported by browser
-			unset($data['icon_hover']);	// not used in jdots
+			unset($data['icon_hover']); // not used in jdots
 		}
 
-		unset($apps['logout']);	// never display it
+		unset($apps['logout']); // never display it
 		if (isset($apps['about'])) $apps['about']['noNavbar'] = true;
 		if (isset($apps['preferences'])) $apps['preferences']['noNavbar'] = true;
 		if (isset($apps['manual'])) $apps['manual']['noNavbar'] = true;
@@ -845,7 +845,7 @@ 
 		}
 
 		// check if user called a specific url --> open it as active tab
-		$last_direct_url =& Api\Cache::getSession(__CLASS__, 'last_direct_url');
+		$last_direct_url = & Api\Cache::getSession(__CLASS__, 'last_direct_url');
 		if ($last_direct_url)
 		{
 			$url = $last_direct_url;
@@ -855,7 +855,7 @@ 
 		{
 			// Coming in with a specific URL, save it and redirect to index.php
 			// so reloads work nicely, but strip cd=yes or we'll get the framework again
-			$last_direct_url = preg_replace('/[&?]cd=yes/','',$url);
+			$last_direct_url = preg_replace('/[&?]cd=yes/', '', $url);
 			Api\Framework::redirect_link('/index.php?cd=yes');
 		}
 		else
@@ -870,11 +870,11 @@ 
 		if ($active_tab && array_key_exists($active_tab, $apps))
 		{
 			// Do not remove cd=yes if it's an ajax=true app
-			if (strpos( $apps[$active_tab]['url'],'ajax=true') !== False)
+			if (strpos($apps[$active_tab]['url'], 'ajax=true') !== False)
 			{
-				$url = preg_replace('/[&?]cd=yes/','',$url);
+				$url = preg_replace('/[&?]cd=yes/', '', $url);
 			}
-			if($last_direct_url)
+			if ($last_direct_url)
 			{
 				$apps[$active_tab]['openOnce'] = $url;
 			}
@@ -886,8 +886,8 @@ 
 		{
 			$open_tabs = $GLOBALS['egw_info']['user']['preferences']['common']['open_tabs'];
 		}
-		$open_tabs = $open_tabs ? explode(',',$open_tabs) : array();
-		if ($active_tab && !in_array($active_tab,$open_tabs))
+		$open_tabs = $open_tabs ? explode(',', $open_tabs) : array();
+		if ($active_tab && !in_array($active_tab, $open_tabs))
 		{
 			$open_tabs[] = $active_tab;
 			$store_prefs = true;
@@ -895,14 +895,14 @@ 
 		if ($store_prefs)
 		{
 			$GLOBALS['egw']->preferences->read_repository();
-			$GLOBALS['egw']->preferences->add('common', 'open_tabs', implode(',',$open_tabs));
+			$GLOBALS['egw']->preferences->add('common', 'open_tabs', implode(',', $open_tabs));
 			$GLOBALS['egw']->preferences->add('common', 'active_tab', $active_tab);
 			$GLOBALS['egw']->preferences->save_repository(true);
 		}
 
 		//error_log(__METHOD__."('$url') url_tab='$url_tab', active_tab=$active_tab, open_tabs=".array2string($open_tabs));
 		// Restore Tabs
-		foreach($open_tabs as $n => $app)
+		foreach ($open_tabs as $n => $app)
 		{
 			if (isset($apps[$app]))		// user might no longer have app rights
 			{
@@ -929,10 +929,10 @@ 
 	 * @param boolean $no_framework = true
 	 * @return string
 	 */
-	function footer($no_framework=true)
+	function footer($no_framework = true)
 	{
 		//error_log(__METHOD__."($no_framework) footer_done=".array2string(self::$footer_done).' '.function_backtrace());
-		if (self::$footer_done) return;	// prevent (multiple) footers
+		if (self::$footer_done) return; // prevent (multiple) footers
 		self::$footer_done = true;
 
 		if (!isset($GLOBALS['egw_info']['flags']['nofooter']) || !$GLOBALS['egw_info']['flags']['nofooter'])
@@ -944,7 +944,7 @@ 
 			}
 		}
 		return $footer.
-			$GLOBALS['egw_info']['flags']['need_footer']."\n".	// eg. javascript, which need to be at the end of the page
+			$GLOBALS['egw_info']['flags']['need_footer']."\n".// eg. javascript, which need to be at the end of the page
 			"</body>\n</html>\n";
 	}
 
@@ -982,8 +982,8 @@ 
 		if ($parts['query'])
 		{
 			$_SERVER['REQUEST_URI'] = '?'.$parts['query'];
-			parse_str($parts['query'],$_GET);
-			$_REQUEST = $_GET;	// some apps use $_REQUEST to check $_GET or $_POST
+			parse_str($parts['query'], $_GET);
+			$_REQUEST = $_GET; // some apps use $_REQUEST to check $_GET or $_POST
 		}
 
 		if (!isset($_GET['menuaction']))
@@ -993,7 +993,7 @@ 
 		// set session action
 		$GLOBALS['egw']->session->set_action('Ajax: '.$_GET['menuaction']);
 
-		list($app,$class,$method) = explode('.',$_GET['menuaction']);
+		list($app, $class, $method) = explode('.', $_GET['menuaction']);
 
 		if (!isset($GLOBALS['egw_info']['user']['apps'][$app]))
 		{
@@ -1005,7 +1005,7 @@ 
 
 		$GLOBALS[$class] = $obj = CreateObject($app.'.'.$class);
 
-		if(!is_array($obj->public_functions) || !$obj->public_functions[$method])
+		if (!is_array($obj->public_functions) || !$obj->public_functions[$method])
 		{
 			throw new Api\Exception\NoPermission("Bad menuaction {$_GET['menuaction']}, not listed in public_functions!");
 		}

api/src/Framework/CssIncludes.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
 	 * Parse beginning of given CSS file for /*@import url("...") statements
 	 *
 	 * @param string $path EGroupware relative path eg. /phpgwapi/templates/default/some.css
-	 * @return array parsed pathes (EGroupware relative) including $path itself
+	 * @return string[] parsed pathes (EGroupware relative) including $path itself
 	 */
 	protected static function resolve_css_includes($path, &$pathes=array())
 	{

Braces +8 added lines, -2 removed lines

@@ -107,14 +107,20 @@
 		$max_modified = 0;
 		//no more dynamic minifying: $debug_minify = $GLOBALS['egw_info']['server']['debug_minify'] === 'True';
 		$base_path = $GLOBALS['egw_info']['server']['webserver_url'];
-		if ($base_path[0] != '/') $base_path = parse_url($base_path, PHP_URL_PATH);
+		if ($base_path[0] != '/')
+		{
+			$base_path = parse_url($base_path, PHP_URL_PATH);
+		}
 		$css_files = '';
 		foreach(self::$files as $path)
 		{
 			foreach(self::resolve_css_includes($path) as $path)
 			{
 				list($file,$query) = explode('?',$path,2);
-				if (($mod = filemtime(EGW_SERVER_ROOT.$file)) > $max_modified) $max_modified = $mod;
+				if (($mod = filemtime(EGW_SERVER_ROOT.$file)) > $max_modified)
+				{
+					$max_modified = $mod;
+				}
 
 				// do NOT include app.css or categories.php, as it changes from app to app
 				//no more dynamic minifying: if ($debug_minify || substr($path, -8) == '/app.css' || substr($file,-14) == 'categories.php')

Spacing +15 added lines, -15 removed lines

@@ -34,7 +34,7 @@ 
 	 * @param boolean $clear_includes =false true: clear all previous includes
 	 * @return boolean false: css file not found, true: file found
 	 */
-	public static function add($app, $name=null, $append=true, $clear_includes=false)
+	public static function add($app, $name = null, $append = true, $clear_includes = false)
 	{
 		if ($clear_includes)
 		{
@@ -43,7 +43,7 @@ 
 
 		if (!is_null($name))
 		{
-			foreach($GLOBALS['egw']->framework->template_dirs as $dir)
+			foreach ($GLOBALS['egw']->framework->template_dirs as $dir)
 			{
 				if (file_exists(EGW_SERVER_ROOT.($path = '/'.$app.'/templates/'.$dir.'/'.$name.'.css')))
 				{
@@ -55,12 +55,12 @@ 
 		{
 			$path = $app;
 		}
-		if (!file_exists(EGW_SERVER_ROOT.$path) && !file_exists(EGW_SERVER_ROOT . parse_url($path,PHP_URL_PATH)))
+		if (!file_exists(EGW_SERVER_ROOT.$path) && !file_exists(EGW_SERVER_ROOT.parse_url($path, PHP_URL_PATH)))
 		{
 			//error_log(__METHOD__."($app,$name) $path NOT found!");
 			return false;
 		}
-		if (!in_array($path,self::$files))
+		if (!in_array($path, self::$files))
 		{
 			if ($append)
 			{
@@ -79,16 +79,16 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get($resolve=false)
+	public static function get($resolve = false)
 	{
 		if (!$resolve)
 		{
 			return self::$files;
 		}
 		$files = array();
-		foreach(self::$files as $path)
+		foreach (self::$files as $path)
 		{
-			foreach(self::resolve_css_includes($path) as $path)
+			foreach (self::resolve_css_includes($path) as $path)
 			{
 				$files[] = $path;
 			}
@@ -109,11 +109,11 @@ 
 		$base_path = $GLOBALS['egw_info']['server']['webserver_url'];
 		if ($base_path[0] != '/') $base_path = parse_url($base_path, PHP_URL_PATH);
 		$css_files = '';
-		foreach(self::$files as $path)
+		foreach (self::$files as $path)
 		{
-			foreach(self::resolve_css_includes($path) as $path)
+			foreach (self::resolve_css_includes($path) as $path)
 			{
-				list($file,$query) = explode('?',$path,2);
+				list($file, $query) = explode('?', $path, 2);
 				if (($mod = filemtime(EGW_SERVER_ROOT.$file)) > $max_modified) $max_modified = $mod;
 
 				// do NOT include app.css or categories.php, as it changes from app to app
@@ -147,20 +147,20 @@ 
 	 * @param string $path EGroupware relative path eg. /phpgwapi/templates/default/some.css
 	 * @return array parsed pathes (EGroupware relative) including $path itself
 	 */
-	protected static function resolve_css_includes($path, &$pathes=array())
+	protected static function resolve_css_includes($path, &$pathes = array())
 	{
 		$matches = null;
 
-		list($file) = explode('?',$path,2);
-		if (($to_check = file_get_contents (EGW_SERVER_ROOT.$file, false, null, 0, 1024)) &&
+		list($file) = explode('?', $path, 2);
+		if (($to_check = file_get_contents(EGW_SERVER_ROOT.$file, false, null, 0, 1024)) &&
 			stripos($to_check, '/*@import') !== false && preg_match_all('|/\*@import url\("([^"]+)"|i', $to_check, $matches))
 		{
-			foreach($matches[1] as $import_path)
+			foreach ($matches[1] as $import_path)
 			{
 				if ($import_path[0] != '/')
 				{
 					$dir = dirname($path);
-					while(substr($import_path,0,3) == '../')
+					while (substr($import_path, 0, 3) == '../')
 					{
 						$dir = dirname($dir);
 						$import_path = substr($import_path, 3);

api/src/Framework/Favorites.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
 	 * @param string $action "add" or "delete"
 	 * @param boolean|int|String $group ID of the group to create the favorite for, or 'all' for all users
 	 * @param array $filters key => value pairs for the filter
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function set_favorite($app, $_name, $action, $group, $filters = array())
 	{

Braces +5 added lines, -1 removed lines

@@ -161,7 +161,11 @@
 		{
 			if(strpos($pref_name, $pref_prefix) === 0)
 			{
-				if(!is_array($pref)) continue;	// old favorite
+				if(!is_array($pref))
+				{
+					continue;
+				}
+				// old favorite
 
 				$favorites[(string)substr($pref_name,strlen($pref_prefix))] = $pref;
 			}

Spacing +25 added lines, -26 removed lines

@@ -42,7 +42,7 @@ 
 	 *
 	 * @return array with a single sidebox menu item (array) containing html for favorites
 	 */
-	public static function list_favorites($app, $default=null)
+	public static function list_favorites($app, $default = null)
 	{
 		if (!$app)
 		{
@@ -58,7 +58,7 @@ 
 		$target = 'favorite_sidebox_'.$app;
 
 		/* @var $filters array an array of favorites*/
-		$filters =  self::get_favorites($app);
+		$filters = self::get_favorites($app);
 		$is_admin = $GLOBALS['egw_info']['user']['apps']['admin'];
 		$html = "<span id='$target' class='ui-helper-clearfix sidebox-favorites'><ul class='ui-menu ui-widget-content ui-corner-all favorites' role='listbox'>\n";
 
@@ -69,25 +69,24 @@ 
 		}
 
 		// Get link for if there is no nextmatch - this is the fallback
-		$registry = Api\Link::get_registry($app,'list');
+		$registry = Api\Link::get_registry($app, 'list');
 		if (!$registry)
 		{
 			$registry = Api\Link::get_registry($app, 'index');
 		}
-		foreach($filters as $name => $filter)
+		foreach ($filters as $name => $filter)
 		{
 			//filter must not be empty if there's one, ignore it at the moment but it need to be checked how it got there in database
 			if (!$filter)
 			{
-				error_log(__METHOD__.'Favorite filter "'.$name.'" is not supposed to be empty, it should be an array.  Skipping, more investigation needed. filter = '. array2string($filters[$name]));
+				error_log(__METHOD__.'Favorite filter "'.$name.'" is not supposed to be empty, it should be an array.  Skipping, more investigation needed. filter = '.array2string($filters[$name]));
 				continue;
 			}
 			$li = "<li data-id='$name' data-group='{$filter['group']}' class='ui-menu-item' role='menuitem'>\n";
 			$li .= '<a href="#" class="ui-corner-all" tabindex="-1">';
-			$li .= "<div class='" . ((string)$name === (string)$default_filter ? 'ui-icon ui-icon-heart' : 'sideboxstar') . "'></div>".
+			$li .= "<div class='".((string)$name === (string)$default_filter ? 'ui-icon ui-icon-heart' : 'sideboxstar')."'></div>".
 				$filter['name'];
-			$li .= ($filter['group'] != false && !$is_admin || $name === 'blank' ? "" :
-				"<div class='ui-icon ui-icon-trash' title='" . lang('Delete') . "'></div>");
+			$li .= ($filter['group'] != false && !$is_admin || $name === 'blank' ? "" : "<div class='ui-icon ui-icon-trash' title='".lang('Delete')."'></div>");
 			$li .= "</a></li>\n";
 			//error_log(__METHOD__."() $name, filter=".array2string($filter)." --> ".$li);
 			$html .= $li;
@@ -95,7 +94,7 @@ 
 
 		// If were're here, the app supports favorites, so add a 'Add' link too
 		$html .= "<li data-id='add' class='ui-menu-item' role='menuitem'><a href='javascript:app.$app.add_favorite()' class='ui-corner-all'>";
-		$html .= Api\Html::image($app, 'new') . lang('Add current'). '</a></li>';
+		$html .= Api\Html::image($app, 'new').lang('Add current').'</a></li>';
 
 		$html .= '</ul></span>';
 
@@ -117,7 +116,7 @@ 
 	 * @return (array|boolean) An array of sorted favorites or False if there's no preferenced sorted list
 	 *
 	 */
-	public static function get_fav_sort_pref ($app)
+	public static function get_fav_sort_pref($app)
 	{
 		$fav_sorted_list = array();
 
@@ -157,13 +156,13 @@ 
 		$fav_sort_pref = self::get_fav_sort_pref($app);
 
 		// Look through all preferences & pull out favorites
-		foreach((array)$GLOBALS['egw_info']['user']['preferences'][$app] as $pref_name => $pref)
+		foreach ((array)$GLOBALS['egw_info']['user']['preferences'][$app] as $pref_name => $pref)
 		{
-			if(strpos($pref_name, $pref_prefix) === 0)
+			if (strpos($pref_name, $pref_prefix) === 0)
 			{
-				if(!is_array($pref)) continue;	// old favorite
+				if (!is_array($pref)) continue; // old favorite
 
-				$favorites[(string)substr($pref_name,strlen($pref_prefix))] = $pref;
+				$favorites[(string)substr($pref_name, strlen($pref_prefix))] = $pref;
 			}
 		}
 		if (is_array($fav_sort_pref))
@@ -172,7 +171,7 @@ 
 			{
 				$sorted_list[$key] = $favorites[$key];
 			}
-			$favorites = array_merge($sorted_list,$favorites);
+			$favorites = array_merge($sorted_list, $favorites);
 		}
 		return $favorites;
 	}
@@ -204,7 +203,7 @@ 
 			}
 			else
 			{
-				foreach($GLOBALS['egw']->accounts->memberships($GLOBALS['egw_info']['user']['account_id'], true) as $gid)
+				foreach ($GLOBALS['egw']->accounts->memberships($GLOBALS['egw_info']['user']['account_id'], true) as $gid)
 				{
 					$prefs = new Api\Preferences($gid);
 					$prefs->read_repository();
@@ -216,7 +215,7 @@ 
 				}
 			}
 		}
-		if($group && $GLOBALS['egw_info']['apps']['admin'] && $group !== 'all')
+		if ($group && $GLOBALS['egw_info']['apps']['admin'] && $group !== 'all')
 		{
 			$prefs = new Api\Preferences(is_numeric($group) ? $group : $GLOBALS['egw_info']['user']['account_id']);
 		}
@@ -227,7 +226,7 @@ 
 		$prefs->read_repository();
 		$type = $group === "all" ? "default" : "user";
 		//error_log(__METHOD__."('$app', '$name', '$action', ".array2string($group).", ...) pref_name=$pref_name, type=$type");
-		if($action == "add")
+		if ($action == "add")
 		{
 			$filters = array(
 				// This is the name as user entered it, minus tags
@@ -235,9 +234,9 @@ 
 				'group' => $group ? $group : false,
 				'state' => $filters
 			);
-			$pref_name = "favorite_".preg_replace('/[^A-Za-z0-9-_]/u','_',$name);
-			$result = $prefs->add($app,$pref_name,$filters,$type);
-			$pref = $prefs->save_repository(false,$type);
+			$pref_name = "favorite_".preg_replace('/[^A-Za-z0-9-_]/u', '_', $name);
+			$result = $prefs->add($app, $pref_name, $filters, $type);
+			$pref = $prefs->save_repository(false, $type);
 
 			// Update preferences client side, or it could disappear
 			Api\Json\Response::get()->call('egw.set_preferences', (array)$pref[$app], $app);
@@ -247,8 +246,8 @@ 
 		}
 		else if ($action == "delete")
 		{
-			$result = $prefs->delete($app,$pref_name, $type);
-			$pref = $prefs->save_repository(false,$type);
+			$result = $prefs->delete($app, $pref_name, $type);
+			$pref = $prefs->save_repository(false, $type);
 
 			// Update preferences client side, or it could come back
 			Api\Json\Response::get()->call('egw.set_preferences', (array)$pref[$app], $app);
@@ -291,7 +290,7 @@ 
 			{
 				$value = is_array($old_value) ? $old_value : php_safe_unserialize($old_value);
 
-				switch($attr)
+				switch ($attr)
 				{
 					case 'index_state':
 						$changes += self::change_account_id($value, self::$app_favorite_attributes[$app], $ids2change);
@@ -337,7 +336,7 @@ 
 			if (!empty($value[$attrs_to_change]))
 			{
 				$vals = !is_array($value[$attrs_to_change]) ? explode(',', $value[$attrs_to_change]) : $value[$attrs_to_change];
-				foreach($vals as &$v)
+				foreach ($vals as &$v)
 				{
 					if (isset($ids2change[$v]))
 					{
@@ -350,7 +349,7 @@ 
 		}
 		else
 		{
-			foreach($attrs_to_change as $key => $names)
+			foreach ($attrs_to_change as $key => $names)
 			{
 				if (is_int($key))
 				{

api/src/Header/Authenticate.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
 	 * @param string $realm
 	 * @param string $username
 	 * @param string &$password=null password to use or if null, on return stored password
-	 * @return string|boolean false if $password not given and can NOT be read
+	 * @return false|string false if $password not given and can NOT be read
 	 */
 	static private function get_digest_A1($realm,$username,&$password=null)
 	{

Indentation +12 added lines, -12 removed lines

@@ -255,20 +255,20 @@
 	 */
 	static public function parse_digest($txt)
 	{
-	    // protect against missing data
-	    $needed_parts = array('nonce'=>1, 'nc'=>1, 'cnonce'=>1, 'qop'=>1, 'username'=>1, 'uri'=>1, 'response'=>1);
-	    $data = array();
-	    $keys = implode('|', array_keys($needed_parts));
+		// protect against missing data
+		$needed_parts = array('nonce'=>1, 'nc'=>1, 'cnonce'=>1, 'qop'=>1, 'username'=>1, 'uri'=>1, 'response'=>1);
+		$data = array();
+		$keys = implode('|', array_keys($needed_parts));
 
 		$matches = null;
-	    preg_match_all('@(' . $keys . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
+		preg_match_all('@(' . $keys . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
 
-	    foreach ($matches as $m)
-	    {
-	        $data[$m[1]] = $m[3] ? $m[3] : $m[4];
-	        unset($needed_parts[$m[1]]);
-	    }
-	    //error_log(__METHOD__."('$txt') returning ".array2string($needed_parts ? false : $data));
-	    return $needed_parts ? false : $data;
+		foreach ($matches as $m)
+		{
+			$data[$m[1]] = $m[3] ? $m[3] : $m[4];
+			unset($needed_parts[$m[1]]);
+		}
+		//error_log(__METHOD__."('$txt') returning ".array2string($needed_parts ? false : $data));
+		return $needed_parts ? false : $data;
 	}
 }

Braces +38 added lines, -10 removed lines

@@ -82,7 +82,10 @@ 
 			error_log(__METHOD__.'() PHP_AUTH_USER='.array2string($_SERVER['PHP_AUTH_USER']).', PHP_AUTH_PW='.array2string($pw).', PHP_AUTH_DIGEST='.array2string($_SERVER['PHP_AUTH_DIGEST']));
 		}
 		$realm = $GLOBALS['egw_info']['flags']['auth_realm'];
-		if (empty($realm)) $realm = 'EGroupware';
+		if (empty($realm))
+		{
+			$realm = 'EGroupware';
+		}
 
 		$username = $_SERVER['PHP_AUTH_USER']; $password = $_SERVER['PHP_AUTH_PW'];
 		// Support for basic auth when using PHP CGI (what about digest auth?)
@@ -139,7 +142,8 @@ 
 			// replace \x encoded non-ascii chars in password, as they are used eg. by Thunderbird for German umlauts
 			if (strpos($password, '\\x') !== false)
 			{
-				$password = preg_replace_callback('/\\\\x([0-9A-F]{2})/i', function($matches){
+				$password = preg_replace_callback('/\\\\x([0-9A-F]{2})/i', function($matches)
+				{
 					return chr(hexdec($matches[1]));
 				}, $password);
 			}
@@ -167,7 +171,10 @@ 
 		if (!($GLOBALS['egw_info']['server']['auth_type'] == 'sql' && $GLOBALS['egw_info']['server']['sql_encryption_type'] == 'plain') ||
 			  $GLOBALS['egw_info']['server']['auth_type'] == 'ldap' && $GLOBALS['egw_info']['server']['ldap_encryption_type'] == 'plain')
 		{
-			if (self::ERROR_LOG) error_log(__METHOD__."('$username') return false (no plaintext passwords used)");
+			if (self::ERROR_LOG)
+			{
+				error_log(__METHOD__."('$username') return false (no plaintext passwords used)");
+			}
 			return false;	// no plain-text passwords used
 		}
 		// check for specific user, if given
@@ -175,10 +182,16 @@ 
 			$GLOBALS['egw_info']['server']['auth_type'] == 'sql' && substr($user_pw,0,7) != '{PLAIN}'))
 		{
 			unset($user_pw);
-			if (self::ERROR_LOG) error_log(__METHOD__."('$realm','$username') return false (unknown user or NO plaintext password for user)");
+			if (self::ERROR_LOG)
+			{
+				error_log(__METHOD__."('$realm','$username') return false (unknown user or NO plaintext password for user)");
+			}
 			return false;	// user does NOT exist, or has no plaintext passwords (ldap server requires real root_dn or special ACL!)
 		}
-		if (substr($user_pw,0,7) == '{PLAIN}') $user_pw = substr($user_pw,7);
+		if (substr($user_pw,0,7) == '{PLAIN}')
+		{
+			$user_pw = substr($user_pw,7);
+		}
 
 		if (self::ERROR_LOG)
 		{
@@ -200,7 +213,10 @@ 
 		{
 			$nonce = uniqid();
    			header('WWW-Authenticate: Digest realm="'.$realm.'",qop="auth",nonce="'.$nonce.'",opaque="'.md5($realm).'"');
-			if (self::ERROR_LOG) error_log(__METHOD__."() offering digest auth for realm '$realm' using nonce='$nonce'");
+			if (self::ERROR_LOG)
+			{
+				error_log(__METHOD__."() offering digest auth for realm '$realm' using nonce='$nonce'");
+			}
 		}
 	}
 
@@ -215,7 +231,10 @@ 
 	 */
 	static public function is_valid($realm,$auth_digest=null,&$username=null,&$password=null)
 	{
-		if (is_null($auth_digest)) $auth_digest = $_SERVER['PHP_AUTH_DIGEST'];
+		if (is_null($auth_digest))
+		{
+			$auth_digest = $_SERVER['PHP_AUTH_DIGEST'];
+		}
 
 		$data = self::parse_digest($auth_digest);
 
@@ -228,7 +247,10 @@ 
 
 		$valid_response = md5($A1.':'.$data['nonce'].':'.$data['nc'].':'.$data['cnonce'].':'.$data['qop'].':'.$A2);
 
-		if (self::ERROR_LOG) error_log(__METHOD__."('$realm','$auth_digest','$username') response='$data[response]', valid_response='$valid_response' returning ".array2string($data['response'] === $valid_response));
+		if (self::ERROR_LOG)
+		{
+			error_log(__METHOD__."('$realm','$auth_digest','$username') response='$data[response]', valid_response='$valid_response' returning ".array2string($data['response'] === $valid_response));
+		}
 		return $data['response'] === $valid_response;
 	}
 
@@ -247,10 +269,16 @@ 
 		{
 			return false;
 		}
-		if (is_null($password)) $password = $user_pw;
+		if (is_null($password))
+		{
+			$password = $user_pw;
+		}
 
 		$A1 = md5($username . ':' . $realm . ':' . $password);
-		if (self::ERROR_LOG > 1) error_log(__METHOD__."('$realm','$username','$password') returning ".array2string($A1));
+		if (self::ERROR_LOG > 1)
+		{
+			error_log(__METHOD__."('$realm','$username','$password') returning ".array2string($A1));
+		}
 		return $A1;
 	}
 

Spacing +19 added lines, -19 removed lines

@@ -75,7 +75,7 @@ 
 	 */
 	static public function autocreate_session_callback(&$account)
 	{
-		unset($account);	// not used, but required by function signature
+		unset($account); // not used, but required by function signature
 		if (self::ERROR_LOG)
 		{
 			$pw = self::ERROR_LOG > 1 ? $_SERVER['PHP_AUTH_PW'] : '**********';
@@ -86,15 +86,15 @@ 
 
 		$username = $_SERVER['PHP_AUTH_USER']; $password = $_SERVER['PHP_AUTH_PW'];
 		// Support for basic auth when using PHP CGI (what about digest auth?)
-		if (!isset($username) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && strpos($_SERVER['REDIRECT_HTTP_AUTHORIZATION'],'Basic ') === 0)
+		if (!isset($username) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && strpos($_SERVER['REDIRECT_HTTP_AUTHORIZATION'], 'Basic ') === 0)
 		{
-			$hash = base64_decode(substr($_SERVER['REDIRECT_HTTP_AUTHORIZATION'],6));
+			$hash = base64_decode(substr($_SERVER['REDIRECT_HTTP_AUTHORIZATION'], 6));
 			if (strpos($hash, ':') !== false)
 			{
 				list($username, $password) = explode(':', $hash, 2);
 			}
 		}
-		elseif (isset($_SERVER['PHP_AUTH_DIGEST']) && !self::is_valid($realm,$_SERVER['PHP_AUTH_DIGEST'],$username,$password))
+		elseif (isset($_SERVER['PHP_AUTH_DIGEST']) && !self::is_valid($realm, $_SERVER['PHP_AUTH_DIGEST'], $username, $password))
 		{
 			unset($password);
 		}
@@ -115,7 +115,7 @@ 
 			{
 				$realm .= ': '.$GLOBALS['egw']->session->reason;
 			}
-			header('WWW-Authenticate: Basic realm="'.$realm.'"');// draft-reschke-basicauth-enc-06 adds, accept-charset="'.translation::charset().'"');
+			header('WWW-Authenticate: Basic realm="'.$realm.'"'); // draft-reschke-basicauth-enc-06 adds, accept-charset="'.translation::charset().'"');
 			self::digest_header($realm);
 			header('HTTP/1.1 401 Unauthorized');
 			header('X-WebDAV-Status: 401 Unauthorized', true);
@@ -139,7 +139,7 @@ 
 			// replace \x encoded non-ascii chars in password, as they are used eg. by Thunderbird for German umlauts
 			if (strpos($password, '\\x') !== false)
 			{
-				$password = preg_replace_callback('/\\\\x([0-9A-F]{2})/i', function($matches){
+				$password = preg_replace_callback('/\\\\x([0-9A-F]{2})/i', function($matches) {
 					return chr(hexdec($matches[1]));
 				}, $password);
 			}
@@ -161,24 +161,24 @@ 
 	 * @param string &$user_pw =null stored cleartext password, if $username given AND function returns true
 	 * @return boolean true if digest auth is available, false otherwise
 	 */
-	static public function digest_auth_available($realm,$username=null,&$user_pw=null)
+	static public function digest_auth_available($realm, $username = null, &$user_pw = null)
 	{
 		// we currently require plaintext passwords!
 		if (!($GLOBALS['egw_info']['server']['auth_type'] == 'sql' && $GLOBALS['egw_info']['server']['sql_encryption_type'] == 'plain') ||
 			  $GLOBALS['egw_info']['server']['auth_type'] == 'ldap' && $GLOBALS['egw_info']['server']['ldap_encryption_type'] == 'plain')
 		{
 			if (self::ERROR_LOG) error_log(__METHOD__."('$username') return false (no plaintext passwords used)");
-			return false;	// no plain-text passwords used
+			return false; // no plain-text passwords used
 		}
 		// check for specific user, if given
-		if (!is_null($username) && !(($user_pw = $GLOBALS['egw']->accounts->id2name($username,'account_pwd','u')) ||
-			$GLOBALS['egw_info']['server']['auth_type'] == 'sql' && substr($user_pw,0,7) != '{PLAIN}'))
+		if (!is_null($username) && !(($user_pw = $GLOBALS['egw']->accounts->id2name($username, 'account_pwd', 'u')) ||
+			$GLOBALS['egw_info']['server']['auth_type'] == 'sql' && substr($user_pw, 0, 7) != '{PLAIN}'))
 		{
 			unset($user_pw);
 			if (self::ERROR_LOG) error_log(__METHOD__."('$realm','$username') return false (unknown user or NO plaintext password for user)");
-			return false;	// user does NOT exist, or has no plaintext passwords (ldap server requires real root_dn or special ACL!)
+			return false; // user does NOT exist, or has no plaintext passwords (ldap server requires real root_dn or special ACL!)
 		}
-		if (substr($user_pw,0,7) == '{PLAIN}') $user_pw = substr($user_pw,7);
+		if (substr($user_pw, 0, 7) == '{PLAIN}') $user_pw = substr($user_pw, 7);
 
 		if (self::ERROR_LOG)
 		{
@@ -194,7 +194,7 @@ 
 	 * @param string $realm
 	 * @param string &$nonce=null on return
 	 */
-	static public function digest_header($realm,&$nonce=null)
+	static public function digest_header($realm, &$nonce = null)
 	{
 		if (self::digest_auth_available($realm))
 		{
@@ -213,13 +213,13 @@ 
 	 * @param string &$password on return cleartext password
 	 * @return boolean true if digest is correct, false otherwise
 	 */
-	static public function is_valid($realm,$auth_digest=null,&$username=null,&$password=null)
+	static public function is_valid($realm, $auth_digest = null, &$username = null, &$password = null)
 	{
 		if (is_null($auth_digest)) $auth_digest = $_SERVER['PHP_AUTH_DIGEST'];
 
 		$data = self::parse_digest($auth_digest);
 
-		if (!$data || !($A1 = self::get_digest_A1($realm,$username=$data['username'],$password=null)))
+		if (!$data || !($A1 = self::get_digest_A1($realm, $username = $data['username'], $password = null)))
 		{
 			error_log(__METHOD__."('$realm','$auth_digest','$username') returning FALSE");
 			return false;
@@ -240,16 +240,16 @@ 
 	 * @param string &$password=null password to use or if null, on return stored password
 	 * @return string|boolean false if $password not given and can NOT be read
 	 */
-	static private function get_digest_A1($realm,$username,&$password=null)
+	static private function get_digest_A1($realm, $username, &$password = null)
 	{
 		$user_pw = null;
-		if (empty($username) || empty($realm) || !self::digest_auth_available($realm,$username,$user_pw))
+		if (empty($username) || empty($realm) || !self::digest_auth_available($realm, $username, $user_pw))
 		{
 			return false;
 		}
 		if (is_null($password)) $password = $user_pw;
 
-		$A1 = md5($username . ':' . $realm . ':' . $password);
+		$A1 = md5($username.':'.$realm.':'.$password);
 		if (self::ERROR_LOG > 1) error_log(__METHOD__."('$realm','$username','$password') returning ".array2string($A1));
 		return $A1;
 	}
@@ -265,7 +265,7 @@ 
 	    $keys = implode('|', array_keys($needed_parts));
 
 		$matches = null;
-	    preg_match_all('@(' . $keys . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
+	    preg_match_all('@('.$keys.')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
 
 	    foreach ($matches as $m)
 	    {