EGroupware / egroupware

api/src/Etemplate.php

Doc Comments +1 added lines, -2 removed lines

@@ -579,7 +579,7 @@ 
 	 *
 	 * @param string $name cell-name
 	 * @param string $attr attribute-name
-	 * @param mixed $val if not NULL sets attribute else returns it
+	 * @param boolean|string $val if not NULL sets attribute else returns it
 	 * @return reference to attribute
 	 * @deprecated use setElementAttribute($name, $attr, $val)
 	 */
@@ -638,7 +638,6 @@ 
 	/**
 	 * Deep copy array to make sure there are no references
 	 *
-	 * @param Array $array
 	 * @return Array
 	 */
 	public static function deep_copy($source)

Spacing +62 added lines, -63 removed lines

@@ -29,7 +29,7 @@ 
 	 *
 	 * @public boolean
 	 */
-	public $sitemgr=false;
+	public $sitemgr = false;
 
 	/**
 	 * Tell egw framework it's ok to call this
@@ -44,17 +44,17 @@ 
 	 * @param string $name of etemplate or array with name and other keys
 	 * @param string|array $load_via with keys of other etemplate to load in order to get $name
 	 */
-	function __construct($name='',$load_via='')
+	function __construct($name = '', $load_via = '')
 	{
 		// we do NOT call parent consturctor, as we only want to enherit it's (static) methods
-		if (false) parent::__construct ($name);	// satisfy IDE, as we dont call parent constructor
+		if (false) parent::__construct($name); // satisfy IDE, as we dont call parent constructor
 
 		$this->sitemgr = isset($GLOBALS['Common_BO']) && is_object($GLOBALS['Common_BO']);
 
-		if ($name) $this->read($name,$template='default','default',0,'',$load_via);
+		if ($name) $this->read($name, $template = 'default', 'default', 0, '', $load_via);
 
 		// generate new etemplate request object, if not already existing
-		if(!isset(self::$request)) self::$request = Etemplate\Request::read();
+		if (!isset(self::$request)) self::$request = Etemplate\Request::read();
 	}
 
 	/**
@@ -65,7 +65,7 @@ 
 	 *
 	 * @param string|array $params url or array with get-params incl. menuaction
 	 */
-	static function location($params='')
+	static function location($params = '')
 	{
 		Framework::redirect_link(is_array($params) ? '/index.php' : $params,
 			is_array($params) ? $params : '');
@@ -100,7 +100,7 @@ 
 	 * @param array $changes change made in the last call if looping, only used internaly by process_exec
 	 * @return string html for $output_mode == 1, else nothing
 	 */
-	function exec($method,array $content,array $sel_options=null,array $readonlys=null,array $preserv=null,$output_mode=0,$ignore_validation='',array $changes=null)
+	function exec($method, array $content, array $sel_options = null, array $readonlys = null, array $preserv = null, $output_mode = 0, $ignore_validation = '', array $changes = null)
 	{
 		$hook_data = Hooks::process(
 			array('hook_location'   => 'etemplate2_before_exec') +
@@ -109,11 +109,11 @@ 
 			$content
 		);
 
-		foreach($hook_data as $extras)
+		foreach ($hook_data as $extras)
 		{
 			if (!$extras) continue;
 
-			foreach(isset($extras[0]) ? $extras : array($extras) as $extra)
+			foreach (isset($extras[0]) ? $extras : array($extras) as $extra)
 			{
 				if ($extra['data'] && is_array($extra['data']))
 				{
@@ -148,7 +148,7 @@ 
 			$output_mode = 0;
 			self::$response = Json\Response::get();
 		}
-		self::$request->output_mode = $output_mode;	// let extensions "know" they are run eg. in a popup
+		self::$request->output_mode = $output_mode; // let extensions "know" they are run eg. in a popup
 		self::$request->content = self::$cont = $content;
 		self::$request->changes = $changes;
 		self::$request->sel_options = is_array($sel_options) ? self::fix_sel_options($sel_options) : array();
@@ -172,15 +172,15 @@ 
 
 		// compile required translations translations
 		$currentapp = $GLOBALS['egw_info']['flags']['currentapp'];
-		$langRequire = array('common' => array(), 'etemplate' => array());	// keep that order
-		foreach(Translation::$loaded_apps as $l_app => $lang)
+		$langRequire = array('common' => array(), 'etemplate' => array()); // keep that order
+		foreach (Translation::$loaded_apps as $l_app => $lang)
 		{
 			if (!in_array($l_app, array($currentapp, 'custom')))
 			{
 				$langRequire[$l_app] = array('app' => $l_app, 'lang' => $lang, 'etag' => Translation::etag($l_app, $lang));
 			}
 		}
-		foreach(array($currentapp, 'custom') as $l_app)
+		foreach (array($currentapp, 'custom') as $l_app)
 		{
 			if (isset(Translation::$loaded_apps[$l_app]))
 			{
@@ -200,7 +200,7 @@ 
 			'currentapp' => $currentapp,
 		);
 
-		if($data['content']['nm']['rows'] && is_array($data['content']['nm']['rows']))
+		if ($data['content']['nm']['rows'] && is_array($data['content']['nm']['rows']))
 		{
 			// Deep copy rows so we don't lose them when request is set to null
 			// (some content by reference)
@@ -208,7 +208,7 @@ 
 		}
 
 		// Info required to load the etemplate client-side
-		$dom_id = str_replace('.','-',$this->dom_id);
+		$dom_id = str_replace('.', '-', $this->dom_id);
 		$load_array = array(
 			'name' => $this->name,
 			'url' => self::rel2url($this->rel_path),
@@ -218,16 +218,16 @@ 
 		if (self::$response)	// call is within an ajax event / form submit
 		{
 			//error_log("Ajax " . __LINE__);
-			self::$response->generic('et2_load', $load_array+Framework::get_extra());
-			Framework::clear_extra();	// to not send/set it twice for multiple etemplates (eg. CRM view)
+			self::$response->generic('et2_load', $load_array + Framework::get_extra());
+			Framework::clear_extra(); // to not send/set it twice for multiple etemplates (eg. CRM view)
 		}
 		else	// first call
 		{
 			// check if application of template has a app.js file --> load it
-			list($app) = explode('.',$this->name);
+			list($app) = explode('.', $this->name);
 			if (file_exists(EGW_SERVER_ROOT.'/'.$app.'/js/app.js'))
 			{
-				Framework::includeJS('.','app',$app,true);
+				Framework::includeJS('.', 'app', $app, true);
 			}
 			// Category styles
 			Categories::css($app);
@@ -245,12 +245,12 @@ 
 				$content = '<form target="egw_iframe_autocomplete_helper" action="'.$form_action.'" id="'.$dom_id.'" class="et2_container"></form>'."\n".
 					'<iframe name="egw_iframe_autocomplete_helper" style="width:0;height:0;position: absolute;visibility:hidden;"></iframe>';
 				$GLOBALS['egw']->framework->response->generic("data", array($content));
-				$GLOBALS['egw']->framework->response->generic('et2_load',$load_array+Framework::get_extra());
-				Framework::clear_extra();	// to not send/set it twice for multiple etemplates (eg. CRM view)
+				$GLOBALS['egw']->framework->response->generic('et2_load', $load_array + Framework::get_extra());
+				Framework::clear_extra(); // to not send/set it twice for multiple etemplates (eg. CRM view)
 
 				// Really important to run this or weird things happen
 				// See https://help.egroupware.org/t/nextmatch-wert-im-header-ausgeben/73412/11
-				self::$request=null;
+				self::$request = null;
 				return;
 			}
 			// let framework know, if we are a popup or not ('popup' not true, which is allways used by index.php!)
@@ -268,7 +268,7 @@ 
 				echo '<div id="popupMainDiv" class="popupMainDiv">'."\n";
 			}
 			// Send any accumulated json responses - after flush to avoid sending the buffer as a response
-			if(Json\Response::isJSONResponse())
+			if (Json\Response::isJSONResponse())
 			{
 				$load_array['response'] = Json\Response::get()->returnResult();
 			}
@@ -297,10 +297,10 @@ 
 	 */
 	static protected function fix_sel_options(array $sel_options)
 	{
-		foreach($sel_options as &$options)
+		foreach ($sel_options as &$options)
 		{
-			if (!is_array($options)||empty($options)) continue;
-			foreach($options as $key => $value)
+			if (!is_array($options) || empty($options)) continue;
+			foreach ($options as $key => $value)
 			{
 				if (is_numeric($key) && (!is_array($value) || !isset($value['value'])))
 				{
@@ -339,9 +339,9 @@ 
 		$GLOBALS['egw']->session->set_action('Etemplate: '.self::$request->method);
 
 		// Set current app for validation
-		list($app) = explode('.',self::$request->method);
-		if(!$app) list($app) = explode('::',self::$request->method);
-		if($app)
+		list($app) = explode('.', self::$request->method);
+		if (!$app) list($app) = explode('::', self::$request->method);
+		if ($app)
 		{
 			Translation::add_app($app);
 			$GLOBALS['egw_info']['flags']['currentapp'] = $app;
@@ -350,7 +350,7 @@ 
 		$expand = array(
 			'cont' => &self::$request->content,
 		);
-		$template->run('validate', array('', $expand, $_content, &$validated), true);	// $respect_disabled=true: do NOT validate disabled widgets and children
+		$template->run('validate', array('', $expand, $_content, &$validated), true); // $respect_disabled=true: do NOT validate disabled widgets and children
 
 		if ($no_validation)
 		{
@@ -366,14 +366,14 @@ 
 		// tell request call to remove request, if it is not modified eg. by call to exec in callback
 		self::$request->remove_if_not_modified();
 
-		foreach(Hooks::process(array(
+		foreach (Hooks::process(array(
 			'hook_location'   => 'etemplate2_before_process',
 			'location_name'   => $template->id,
 		) + self::complete_array_merge(self::$request->preserv, $validated)) as $extras)
 		{
 			if (!$extras) continue;
 
-			foreach(isset($extras[0]) ? $extras : array($extras) as $extra)
+			foreach (isset($extras[0]) ? $extras : array($extras) as $extra)
 			{
 				if ($extra['data'] && is_array($extra['data']))
 				{
@@ -384,9 +384,9 @@ 
 
 		//error_log(__METHOD__."(,".array2string($content).')');
 		//error_log(' validated='.array2string($validated));
-		if(is_callable(self::$request->method))
+		if (is_callable(self::$request->method))
 		{
-			call_user_func(self::$request->method,self::complete_array_merge(self::$request->preserv, $validated));
+			call_user_func(self::$request->method, self::complete_array_merge(self::$request->preserv, $validated));
 		}
 		else
 		{
@@ -394,8 +394,7 @@ 
 			$content = ExecMethod(self::$request->method, self::complete_array_merge(self::$request->preserv, $validated));
 		}
 
-		$tcontent = is_array($content) ? $content :
-			self::complete_array_merge(self::$request->preserv, $validated);
+		$tcontent = is_array($content) ? $content : self::complete_array_merge(self::$request->preserv, $validated);
 
 		$hook_data = Hooks::process(
 			array(
@@ -407,11 +406,11 @@ 
 
 		if (is_array($content))
 		{
-			foreach($hook_data as $extras)
+			foreach ($hook_data as $extras)
 			{
 				if (!$extras) continue;
 
-				foreach(isset($extras[0]) ? $extras : array($extras) as $extra) {
+				foreach (isset($extras[0]) ? $extras : array($extras) as $extra) {
 					if ($extra['data'] && is_array($extra['data'])) {
 						$content = array_merge($content, $extra['data']);
 					}
@@ -423,7 +422,7 @@ 
 		if (isset($GLOBALS['egw_info']['flags']['java_script']))
 		{
 			// Strip out any script tags
-			$GLOBALS['egw_info']['flags']['java_script'] = preg_replace(array('/(<script[^>]*>)([^<]*)/is','/<\/script>/'),array('$2',''),$GLOBALS['egw_info']['flags']['java_script']);
+			$GLOBALS['egw_info']['flags']['java_script'] = preg_replace(array('/(<script[^>]*>)([^<]*)/is', '/<\/script>/'), array('$2', ''), $GLOBALS['egw_info']['flags']['java_script']);
 			self::$response->script($GLOBALS['egw_info']['flags']['java_script']);
 			//error_log($app .' added javascript to $GLOBALS[egw_info][flags][java_script] - use Json\Response->script() instead.');
 		}
@@ -452,7 +451,7 @@ 
 	static public function process_exec()
 	{
 		if (get_magic_quotes_gpc()) $_POST['value'] = stripslashes($_POST['value']);
-		$content = json_decode($_POST['value'],true);
+		$content = json_decode($_POST['value'], true);
 		//error_log(__METHOD__."(".array2string($content).")");
 
 		self::$request = Etemplate\Request::read($_POST['etemplate_exec_id']);
@@ -466,7 +465,7 @@ 
 		$expand = array(
 			'cont' => &self::$request->content,
 		);
-		$template->run('validate', array('', $expand, $content, &$validated), true);	// $respect_disabled=true: do NOT validate disabled widgets and children
+		$template->run('validate', array('', $expand, $content, &$validated), true); // $respect_disabled=true: do NOT validate disabled widgets and children
 		if (self::validation_errors(self::$request->ignore_validation))
 		{
 			error_log(__METHOD__."(,".array2string($content).') validation_errors='.array2string(self::$validation_errors));
@@ -502,7 +501,7 @@ 
 	 *
 	 * @ToDo supported customized templates stored in DB
 	 */
-	public function read($name,$template_set=null,$lang='default',$group=0,$version='',$load_via='')
+	public function read($name, $template_set = null, $lang = 'default', $group = 0, $version = '', $load_via = '')
 	{
 
 		// For mobile experience try to load custom mobile templates
@@ -511,9 +510,9 @@ 
 			$template_set = "mobile";
 		}
 
-		unset($lang); unset($group);	// not used, but in old signature
-		$this->rel_path = self::relPath($this->name=$name, $this->template_set=$template_set,
-			$this->version=$version, $this->laod_via = $load_via);
+		unset($lang); unset($group); // not used, but in old signature
+		$this->rel_path = self::relPath($this->name = $name, $this->template_set = $template_set,
+			$this->version = $version, $this->laod_via = $load_via);
 		//error_log(__METHOD__."('$name', '$template_set', '$lang', $group, '$version', '$load_via') rel_path=".array2string($this->rel_path));
 
 		$this->dom_id = $name;
@@ -568,7 +567,7 @@ 
 	 * @return mixed reference to attribute, usually NULL
 	 * @deprecated use getElementAttribute($name, $attr)
 	 */
-	public function &get_cell_attribute($name,$attr)
+	public function &get_cell_attribute($name, $attr)
 	{
 		return self::getElementAttribute($name, $attr);
 	}
@@ -582,7 +581,7 @@ 
 	 * @return reference to attribute
 	 * @deprecated use setElementAttribute($name, $attr, $val)
 	 */
-	public function &set_cell_attribute($name,$attr,$val)
+	public function &set_cell_attribute($name, $attr, $val)
 	{
 		return self::setElementAttribute($name, $attr, $val);
 	}
@@ -595,7 +594,7 @@ 
 	 * @return reference to attribute
 	 * @deprecated use disableElement($name, $disabled=true)
 	 */
-	public function disable_cells($name,$disabled=True)
+	public function disable_cells($name, $disabled = True)
 	{
 		return self::disableElement($name, $disabled);
 	}
@@ -611,23 +610,23 @@ 
 	 * @param array $new
 	 * @return array the merged array
 	 */
-	public static function complete_array_merge($old,$new)
+	public static function complete_array_merge($old, $new)
 	{
 		if (is_array($new))
 		{
-			if (!is_array($old)) $old = (array) $old;
+			if (!is_array($old)) $old = (array)$old;
 
-			foreach($new as $k => $v)
+			foreach ($new as $k => $v)
 			{
-				if (!is_array($v) || !isset($old[$k]) || 	// no array or a new array
-					isset($v[0]) && !is_array($v[0]) && isset($v[count($v)-1])	|| // or no associative array, eg. selecting multiple accounts
+				if (!is_array($v) || !isset($old[$k]) || // no array or a new array
+					isset($v[0]) && !is_array($v[0]) && isset($v[count($v) - 1]) || // or no associative array, eg. selecting multiple accounts
 					is_array($v) && count($v) == 0)			// Empty array replacing non-empty
 				{
 					$old[$k] = $v;
 				}
 				else
 				{
-					$old[$k] = self::complete_array_merge($old[$k],$v);
+					$old[$k] = self::complete_array_merge($old[$k], $v);
 				}
 			}
 		}
@@ -669,7 +668,7 @@ 
 	 *
 	 * @param array $content =null
 	 */
-	public function debug(array $content=null)
+	public function debug(array $content = null)
 	{
 		$GLOBALS['egw']->framework->render(print_r($content, true));
 	}
@@ -683,11 +682,11 @@ 
 	 * @param int &$max_upload=null on return max. upload size in byte
 	 * @return string
 	 */
-	static function max_upload_size_message(&$max_upload=null)
+	static function max_upload_size_message(&$max_upload = null)
 	{
 		$upload_max_filesize = ini_get('upload_max_filesize');
 		$post_max_size = ini_get('post_max_size');
-		$max_upload = min(self::km2int($upload_max_filesize),self::km2int($post_max_size)-2800);
+		$max_upload = min(self::km2int($upload_max_filesize), self::km2int($post_max_size) - 2800);
 
 		return lang('Maximum size for uploads').': '.Vfs::hsize($max_upload).
 			" (php.ini: upload_max_filesize=$upload_max_filesize, post_max_size=$post_max_size)";
@@ -701,9 +700,9 @@ 
 	 * @param boolean $readonly =true
 	 * @return string
 	 */
-	static public function number_format($number,$num_decimal_places=2,$readonly=true)
+	static public function number_format($number, $num_decimal_places = 2, $readonly = true)
 	{
-		static $dec_separator=null,$thousands_separator=null;
+		static $dec_separator = null, $thousands_separator = null;
 		if (is_null($dec_separator))
 		{
 			$dec_separator = $GLOBALS['egw_info']['user']['preferences']['common']['number_format'][0];
@@ -712,7 +711,7 @@ 
 		}
 		if ((string)$number === '') return '';
 
-		return number_format(str_replace(' ','',$number),$num_decimal_places,$dec_separator,$readonly ? $thousands_separator : '');
+		return number_format(str_replace(' ', '', $number), $num_decimal_places, $dec_separator, $readonly ? $thousands_separator : '');
 	}
 
 	/**
@@ -725,13 +724,13 @@ 
 	{
 		if (!is_numeric($size))
 		{
-			switch(strtolower(substr($size,-1)))
+			switch (strtolower(substr($size, -1)))
 			{
 				case 'm':
-					$size = 1024*1024*(int)$size;
+					$size = 1024 * 1024 * (int)$size;
 					break;
 				case 'k':
-					$size = 1024*(int)$size;
+					$size = 1024 * (int)$size;
 					break;
 			}
 		}