YetiForceCompany / YetiForceCRM

modules/Vtiger/models/Record.php

Doc Comments +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
 
 	/**
 	 * Function to get the Module to which the record belongs
-	 * @return Vtiger_Module_Model
+	 * @return boolean
 	 */
 	public function getModule()
 	{
@@ -219,7 +219,7 @@ 
 	/**
 	 * Function to retieve display value for a field
 	 * @param <String> $fieldName - field name for which values need to get
-	 * @return <String>
+	 * @return string
 	 */
 	public function getDisplayValue($fieldName, $recordId = false, $rawText = false)
 	{
@@ -325,7 +325,7 @@ 
 	/**
 	 * Static Function to get the instance of the Vtiger Record Model given the recordid and the module name
 	 * @param <Number> $recordId
-	 * @param <String> $moduleName
+	 * @param <String> $module
 	 * @return Vtiger_Record_Model or Module Specific Record Model instance
 	 */
 	public static function getInstanceById($recordId, $module = null)
@@ -493,7 +493,6 @@ 
 
 	/**
 	 * Function to get Display value for RelatedList
-	 * @param <String> $value
 	 * @return <String>
 	 */
 	public function getRelatedListDisplayValue($fieldName)
@@ -596,6 +595,7 @@ 
 	/**
 	 * Function to set record module field values
 	 * @param parent record model
+	 * @param Vtiger_Record_Model $parentRecordModel
 	 */
 	public function setRecordFieldValues($parentRecordModel)
 	{

modules/Vtiger/views/Detail.php

Doc Comments +3 added lines

@@ -302,6 +302,9 @@
 		return $viewer->view('DetailViewFullContents.tpl', $moduleName, true);
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	public function showModuleSummaryView($request)
 	{
 		$recordId = $request->get('record');

Braces +3 added lines, -2 removed lines

@@ -686,8 +686,9 @@
 			$sortImage = 'glyphicon glyphicon-chevron-up';
 		}
 		if (empty($orderBy) && empty($sortOrder)) {
-			if (is_numeric($relatedModuleName))
-				$relatedModuleName = vtlib\Functions::getModuleName($relatedModuleName);
+			if (is_numeric($relatedModuleName)) {
+							$relatedModuleName = vtlib\Functions::getModuleName($relatedModuleName);
+			}
 			$relatedInstance = CRMEntity::getInstance($relatedModuleName);
 			$orderBy = $relatedInstance->default_order_by;
 			$sortOrder = $relatedInstance->default_sort_order;

modules/WSAPP/SyncServer.php

Doc Comments +7 added lines, -1 removed lines

@@ -81,6 +81,9 @@ 
 		return $mapping;
 	}
 
+	/**
+	 * @param string $flag
+	 */
 	public function idmap_storeRecordsInQueue($syncServerId, $recordDetails, $flag, $appid)
 	{
 		if (!is_array($recordDetails))
@@ -182,7 +185,7 @@ 
 	 * @param <type> $appid
 	 * @param <type> $serverid
 	 * @param <type> $clientid
-	 * @param <type> $modifiedTime
+	 * @param <type> $clientModifiedTime
 	 * update the mapping of server and client id
 	 */
 	public function idmap_update($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId)
@@ -499,6 +502,9 @@ 
 		return $serverIds;
 	}
 
+	/**
+	 * @param string $flag
+	 */
 	public function convertToQueueRecordFormat($record, $flag)
 	{
 		if ($flag != $this->delete)

Braces +53 added lines, -40 removed lines

@@ -31,8 +31,9 @@ 
 	{
 		$db = PearDatabase::getInstance();
 		$appidresult = $db->pquery("SELECT appid FROM vtiger_wsapp WHERE appkey=?", array($key));
-		if ($db->num_rows($appidresult))
-			return $db->query_result($appidresult, 0, 'appid');
+		if ($db->num_rows($appidresult)) {
+					return $db->query_result($appidresult, 0, 'appid');
+		}
 		return false;
 	}
 
@@ -42,8 +43,9 @@ 
 	 */
 	public function idmap_get_clientmap($appid, $serverids)
 	{
-		if (!is_array($serverids))
-			$serverids = array($serverids);
+		if (!is_array($serverids)) {
+					$serverids = array($serverids);
+		}
 		$db = PearDatabase::getInstance();
 		;
 		$result = $db->pquery(sprintf(
@@ -65,8 +67,9 @@ 
 	 */
 	public function idmap_get_clientservermap($appid, $clientids)
 	{
-		if (!is_array($clientids))
-			$clientids = array($clientids);
+		if (!is_array($clientids)) {
+					$clientids = array($clientids);
+		}
 
 		$db = PearDatabase::getInstance();
 
@@ -83,8 +86,9 @@ 
 
 	public function idmap_storeRecordsInQueue($syncServerId, $recordDetails, $flag, $appid)
 	{
-		if (!is_array($recordDetails))
-			$recordDetails = array($recordDetails);
+		if (!is_array($recordDetails)) {
+					$recordDetails = array($recordDetails);
+		}
 		$db = PearDatabase::getInstance();
 		$params = array();
 		$params[] = $syncServerId;
@@ -99,8 +103,9 @@ 
 		$db = PearDatabase::getInstance();
 		$checkQuery = "SELECT syncserverid FROM vtiger_wsapp_queuerecords WHERE syncserverid=?";
 		$result = $db->pquery($checkQuery, array($syncServerId));
-		if ($db->num_rows($result) > 0)
-			return true;
+		if ($db->num_rows($result) > 0) {
+					return true;
+		}
 		return false;
 	}
 
@@ -148,19 +153,20 @@ 
 	public function idmap_put($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId, $mode = "save")
 	{
 		$db = PearDatabase::getInstance();
-		if ($mode == $this->create)
-			$this->idmap_create($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
-		else if ($mode == $this->update)
-			$this->idmap_update($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
-		else if ($mode == $this->save) {
+		if ($mode == $this->create) {
+					$this->idmap_create($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
+		} else if ($mode == $this->update) {
+					$this->idmap_update($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
+		} else if ($mode == $this->save) {
 			$result = $db->pquery("SELECT * FROM vtiger_wsapp_recordmapping WHERE appid=? and serverid=? and clientid=?", array($appid, $serverid, $clientid));
-			if ($db->num_rows($result) <= 0)
-				$this->idmap_create($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
-			else
-				$this->idmap_update($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
+			if ($db->num_rows($result) <= 0) {
+							$this->idmap_create($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
+			} else {
+							$this->idmap_update($appid, $serverid, $clientid, $clientModifiedTime, $serverModifiedTime, $serverAppId);
+			}
+		} else if ($mode == $this->delete) {
+					$this->idmap_delete($appid, $serverid, $clientid, $serverAppId);
 		}
-		else if ($mode == $this->delete)
-			$this->idmap_delete($appid, $serverid, $clientid, $serverAppId);
 	}
 
 	/**
@@ -229,11 +235,13 @@ 
 		if (empty($type)) {
 			throw new WebServiceException('WSAPP06', "No sync type specified");
 		}
-		if (is_array($name))
-			throw new WebServiceException("WSAPP07", "type is in the wrong format");
+		if (is_array($name)) {
+					throw new WebServiceException("WSAPP07", "type is in the wrong format");
+		}
 		$type = strtolower($type);
-		if (!in_array($type, $this->syncTypes))
-			throw new WebServiceException('WSAPP05', "Wrong sync type specified");
+		if (!in_array($type, $this->syncTypes)) {
+					throw new WebServiceException('WSAPP05', "Wrong sync type specified");
+		}
 		$db = PearDatabase::getInstance();
 		$uid = uniqid();
 		$db->pquery("INSERT INTO vtiger_wsapp (name, appkey,type) VALUES(?,?,?)", array($name, $uid, $type));
@@ -267,10 +275,11 @@ 
 			throw new WebServiceException('WSAPP04', "Access restricted to app");
 		}
 
-		if (!is_array($element))
-			$records = array($element);
-		else
-			$records = $element;
+		if (!is_array($element)) {
+					$records = array($element);
+		} else {
+					$records = $element;
+		}
 
 		//hardcoded since the destination handler will be vtigerCRM
 		$serverKey = wsapp_getAppKey("vtigerCRM");
@@ -293,13 +302,15 @@ 
 			$clientRecordId = $record['id'];
 
 			// Missing client record id?
-			if (empty($clientRecordId))
-				continue;
+			if (empty($clientRecordId)) {
+							continue;
+			}
 
 			$lookupRecordId = false;
 			$lookupResult = $db->pquery("SELECT serverid,clientmodifiedtime FROM vtiger_wsapp_recordmapping WHERE appid=? && clientid=?", array($appid, $clientRecordId));
-			if ($db->num_rows($lookupResult))
-				$lookupRecordId = $db->query_result($lookupResult, 0, 'serverid');
+			if ($db->num_rows($lookupResult)) {
+							$lookupRecordId = $db->query_result($lookupResult, 0, 'serverid');
+			}
 			if (empty($lookupRecordId) && $record['mode'] != "delete") {
 				$createRecords[$clientRecordId] = $record['values'];
 				$createRecords[$clientRecordId]['module'] = $record['module'];
@@ -309,8 +320,9 @@ 
 					$deleteRecords[$clientRecordId] = $lookupRecordId;
 				} else if (!(empty($lookupRecordId))) {
 					$clientLastModifiedTime = $db->query_result($lookupResult, 0, 'clientmodifiedtime');
-					if ($clientLastModifiedTime >= $record['values']['modifiedtime'])
-						continue;
+					if ($clientLastModifiedTime >= $record['values']['modifiedtime']) {
+											continue;
+					}
 					$record['values']['id'] = $lookupRecordId;
 					$updateRecords[$clientRecordId] = $record['values'];
 					$updateRecords[$clientRecordId]['module'] = $record['module'];
@@ -446,8 +458,9 @@ 
 	 */
 	public function map($key, $element, $user)
 	{
-		if (empty($element))
-			return;
+		if (empty($element)) {
+					return;
+		}
 		$db = PearDatabase::getInstance();
 		$appid = $this->appid_with_key($key);
 		$createDetails = $element["create"];
@@ -501,9 +514,9 @@ 
 
 	public function convertToQueueRecordFormat($record, $flag)
 	{
-		if ($flag != $this->delete)
-			return $record;
-		else {
+		if ($flag != $this->delete) {
+					return $record;
+		} else {
 			$recordFormat = array();
 			$recordFormat['id'] = $record['id'];
 			return $recordFormat;

vtlib/tools/console.php

Doc Comments +13 added lines

@@ -32,6 +32,9 @@ 
 		
 	}
 
+	/**
+	 * @param boolean $interactive
+	 */
 	public function setArguments($args, $interactive)
 	{
 		$this->arguments = $args;
@@ -156,11 +159,18 @@ 
 		} while (true);
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function toAlphaNumeric($value)
 	{
 		return preg_replace("/[^a-zA-Z0-9_]/", "", $value);
 	}
 
+	/**
+	 * @param string $dir
+	 * @param string $file_pattern
+	 */
 	protected function findFiles($dir, $file_pattern, &$files)
 	{
 		$items = glob($dir . '/*', GLOB_NOSORT);
@@ -257,6 +267,9 @@ 
 		echo "DONE.\n";
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function find($name)
 	{
 		return vtlib\Module::getInstance($name);

Spacing +1 added lines, -1 removed lines

@@ -401,7 +401,7 @@
 					if (!file_exists($tplpath . $tplname)) {
 						$initialContent = "{* License Text *}\n";
 						// Enable debug to make it easy to implement.
-						$initialContent.= "{debug}{* REMOVE THIS LINE AFTER IMPLEMENTATION *}\n\n";
+						$initialContent .= "{debug}{* REMOVE THIS LINE AFTER IMPLEMENTATION *}\n\n";
 						file_put_contents($tplpath . $tplname, $initialContent);
 					}
 					file_put_contents($tplpath . $tplname, "{* $file *}\n", FILE_APPEND);

Braces +6 added lines, -4 removed lines

@@ -116,8 +116,9 @@ 
 	protected function prompt($msg = '', $type = self::PROMPT_ANY)
 	{
 		do {
-			if ($msg)
-				echo $msg;
+			if ($msg) {
+							echo $msg;
+			}
 			$value = trim(fgets(STDIN));
 
 			if (!$value && $type == self::PROMPT_OPTIONAL) {
@@ -463,8 +464,9 @@ 
 			$filename = basename($file, true);
 			$dir = substr($file, 0, strpos($file, $filename));
 			$dir = str_replace('languages/' . self::BASE_LANG_PREFIX, 'languages/' . $languageInformation['prefix'], $dir);
-			if (!file_exists($dir))
-				mkdir($dir);
+			if (!file_exists($dir)) {
+							mkdir($dir);
+			}
 
 			if (isset($languageInformation['prefix_value'])) {
 				$contents = file_get_contents($file);

vtlib/Vtiger/Access.php

Doc Comments +5 added lines

@@ -53,6 +53,7 @@ 
 	 * Enable or Disable sharing access control to module
 	 * @param Module Instance of the module to use
 	 * @param Boolean true to enable sharing access, false disable sharing access
+	 * @param ModuleBasic $moduleInstance
 	 * @access private
 	 */
 	static function allowSharing($moduleInstance, $enable = true)
@@ -66,6 +67,7 @@ 
 	/**
 	 * Initialize sharing access.
 	 * @param Module Instance of the module to use
+	 * @param ModuleBasic $moduleInstance
 	 * @access private
 	 * @internal This method is called from Module during creation.
 	 */
@@ -139,6 +141,8 @@ 
 	 * @param String Tool (action name) like Import, Export, Merge
 	 * @param Boolean true to enable tool, false to disable
 	 * @param Integer (optional) profile id to use, false applies to all profile.
+	 * @param ModuleBasic $moduleInstance
+	 * @param boolean $flag
 	 * @access private
 	 */
 	static function updateTool($moduleInstance, $toolAction, $flag, $profileid = false)
@@ -179,6 +183,7 @@ 
 	/**
 	 * Delete tool (actions) of the module
 	 * @param Module Instance of module to use
+	 * @param ModuleBasic $moduleInstance
 	 */
 	static function deleteTools($moduleInstance)
 	{

Braces +12 added lines, -10 removed lines

@@ -108,16 +108,18 @@
 
 		$permission_text = strtolower($permission_text);
 
-		if ($permission_text == 'public_readonly')
-			$permission = 0;
-		else if ($permission_text == 'public_readwrite')
-			$permission = 1;
-		else if ($permission_text == 'public_readwritedelete')
-			$permission = 2;
-		else if ($permission_text == 'private')
-			$permission = 3;
-		else
-			$permission = 2; // public_readwritedelete is default
+		if ($permission_text == 'public_readonly') {
+					$permission = 0;
+		} else if ($permission_text == 'public_readwrite') {
+					$permission = 1;
+		} else if ($permission_text == 'public_readwritedelete') {
+					$permission = 2;
+		} else if ($permission_text == 'private') {
+					$permission = 3;
+		} else {
+					$permission = 2;
+		}
+		// public_readwritedelete is default
 
 		$editstatus = 0; // 0 or 1
 

vtlib/Vtiger/Block.php

Doc Comments +4 added lines, -1 removed lines

@@ -78,6 +78,7 @@ 
 	/**
 	 * Create vtiger CRM block
 	 * @access private
+	 * @param boolean $moduleInstance
 	 */
 	public function __create($moduleInstance)
 	{
@@ -150,7 +151,8 @@ 
 	/**
 	 * Add field to this block
 	 * @param Field Instance of field to add to this block.
-	 * @return Reference to this block instance
+	 * @param Field $fieldInstance
+	 * @return Block to this block instance
 	 */
 	public function addField($fieldInstance)
 	{
@@ -226,6 +228,7 @@ 
 	 * Delete all blocks associated with module
 	 * @param Module Instnace of module to use
 	 * @param Boolean true to delete associated fields, false otherwise
+	 * @param ModuleBasic $moduleInstance
 	 * @access private
 	 */
 	static function deleteForModule($moduleInstance, $recursive = true)

Braces +14 added lines, -10 removed lines

@@ -86,8 +86,9 @@ 
 		$this->module = $moduleInstance;
 
 		$this->id = $this->__getUniqueId();
-		if (!$this->sequence)
-			$this->sequence = $this->__getNextSequence();
+		if (!$this->sequence) {
+					$this->sequence = $this->__getNextSequence();
+		}
 		if ($this->display_status != 0) {
 			$this->display_status = 1;
 		}
@@ -126,10 +127,11 @@ 
 	 */
 	public function save($moduleInstance = false)
 	{
-		if ($this->id)
-			$this->__update();
-		else
-			$this->__create($moduleInstance);
+		if ($this->id) {
+					$this->__update();
+		} else {
+					$this->__create($moduleInstance);
+		}
 		return $this->id;
 	}
 
@@ -141,8 +143,9 @@ 
 	{
 		if ($recursive) {
 			$fields = Field::getAllForBlock($this);
-			foreach ($fields as $fieldInstance)
-				$fieldInstance->delete($recursive);
+			foreach ($fields as $fieldInstance) {
+							$fieldInstance->delete($recursive);
+			}
 		}
 		$this->__delete();
 	}
@@ -231,8 +234,9 @@ 
 	static function deleteForModule($moduleInstance, $recursive = true)
 	{
 		$adb = \PearDatabase::getInstance();
-		if ($recursive)
-			Field::deleteForModule($moduleInstance);
+		if ($recursive) {
+					Field::deleteForModule($moduleInstance);
+		}
 		$adb->delete('vtiger_module_dashboard_blocks', 'tabid = ?', [$moduleInstance->getId()]);
 		$adb->pquery('DELETE vtiger_blocks, vtiger_blocks_hide'
 			. ' FROM vtiger_blocks'

vtlib/Vtiger/Cron.php

Doc Comments +5 added lines, -1 removed lines

@@ -36,7 +36,8 @@ 
 
 	/**
 	 * set the value to the data
-	 * @param type $value,$key
+	 * @param string $key
+	 * @param integer $value
 	 */
 	public function set($key, $value)
 	{
@@ -179,6 +180,7 @@ 
 
 	/**
 	 * Helper function to check the status value.
+	 * @param integer $value
 	 */
 	public function statusEqual($value)
 	{
@@ -212,6 +214,7 @@ 
 
 	/**
 	 * Update status
+	 * @param integer $status
 	 */
 	public function updateStatus($status)
 	{
@@ -287,6 +290,7 @@ 
 
 	/**
 	 * Execute SQL query silently (even when table doesn't exist)
+	 * @param string $sql
 	 */
 	protected static function querySilent($sql, $params = false)
 	{

Spacing +4 added lines, -4 removed lines

@@ -162,7 +162,7 @@ 
 	{
 		return $this->data['description'];
 	}
-	public function getLockStatus(){
+	public function getLockStatus() {
 		return isset($this->data['lockStatus']) ? $this->data['lockStatus'] : false;
 	}
 	/**
@@ -253,12 +253,12 @@ 
 		$time = time();
 		$query = 'UPDATE vtiger_cron_task SET lastend = ?';
 		$params = [$time];
-		if(!$lock){
+		if (!$lock) {
 			$query .= ' ,status = ?';
-			$params []= self::$STATUS_ENABLED;
+			$params [] = self::$STATUS_ENABLED;
 		}
 		$query .= ' WHERE id = ?';
-		$params []= $this->getId();
+		$params [] = $this->getId();
 		self::querySilent($query, $params);
 		return $this->set('lastend', $time);
 	}

vtlib/Vtiger/Event.php

Doc Comments +1 added lines

@@ -80,6 +80,7 @@
 	 * Trigger event based on CRM Record
 	 * @param String Name of the Event to trigger
 	 * @param Integer CRM record id on which event needs to be triggered.
+	 * @param string $eventname
 	 */
 	static function trigger($eventname, $crmid)
 	{

Braces +3 added lines, -2 removed lines

@@ -83,8 +83,9 @@
 	 */
 	static function trigger($eventname, $crmid)
 	{
-		if (!self::hasSupport())
-			return;
+		if (!self::hasSupport()) {
+					return;
+		}
 
 		$adb = \PearDatabase::getInstance();
 		$checkres = $adb->pquery("SELECT setype, crmid, deleted FROM vtiger_crmentity WHERE crmid=?", Array($crmid));

vtlib/Vtiger/FieldBasic.php

Doc Comments +1 added lines

@@ -146,6 +146,7 @@
 	/**
 	 * Create this field instance
 	 * @param vtlib\Block Instance of the block to use
+	 * @param boolean $blockInstance
 	 * @access private
 	 */
 	public function __create($blockInstance)

Braces +17 added lines, -12 removed lines

@@ -173,16 +173,19 @@ 
 		}
 
 // Initialize other variables which are not done
-		if (!$this->table)
-			$this->table = $moduleInstance->basetable;
+		if (!$this->table) {
+					$this->table = $moduleInstance->basetable;
+		}
 		if (!$this->column) {
 			$this->column = strtolower($this->name);
-			if (!$this->columntype)
-				$this->columntype = 'VARCHAR(100)';
+			if (!$this->columntype) {
+							$this->columntype = 'VARCHAR(100)';
+			}
 		}
 
-		if (!$this->label)
-			$this->label = $this->name;
+		if (!$this->label) {
+					$this->label = $this->name;
+		}
 
 		$adb->pquery('INSERT INTO vtiger_field (tabid, fieldid, columnname, tablename, generatedtype,
 uitype, fieldname, fieldlabel, readonly, presence, defaultvalue, maximumlength, sequence,
@@ -199,8 +202,9 @@ 
 
 		if (!empty($this->columntype)) {
 			$columntype = $this->columntype;
-			if ($this->uitype == 10)
-				$columntype .= ', ADD INDEX (`' . $this->column . '`)';
+			if ($this->uitype == 10) {
+							$columntype .= ', ADD INDEX (`' . $this->column . '`)';
+			}
 			Utils::AddColumn($this->table, $this->column, $columntype);
 		}
 
@@ -275,10 +279,11 @@ 
 	 */
 	public function save($blockInstance = false)
 	{
-		if ($this->id)
-			$this->__update();
-		else
-			$this->__create($blockInstance);
+		if ($this->id) {
+					$this->__update();
+		} else {
+					$this->__create($blockInstance);
+		}
 		return $this->id;
 	}