YetiForceCompany / YetiForceCRM

vtlib/Vtiger/Functions.php

Doc Comments +7 added lines, -1 removed lines

@@ -229,7 +229,6 @@ 
 	/**
 	 * Function get module field infos.
 	 *
-	 * @param int|string $mixed
 	 * @param bool       $returnByColumn
 	 *
 	 * @return mixed[]
@@ -283,6 +282,10 @@ 
 	}
 
 	// Utility
+
+	/**
+	 * @return string
+	 */
 	public static function formatDecimal($value)
 	{
 		$fld_value = explode('.', $value);
@@ -733,6 +736,9 @@ 
 	 * @return <Date> - last working y
 	 */
 
+	/**
+	 * @param string $date
+	 */
 	public static function getLastWorkingDay($date)
 	{
 		if (empty($date)) {

vtlib/Vtiger/Module.php

Doc Comments +5 added lines

@@ -134,6 +134,9 @@ 
 	 *
 	 * NOTE: $url can have variables like $MODULE (module for which link is associated),
 	 * $RECORD (record on which link is dispalyed)
+	 * @param string $type
+	 * @param string $label
+	 * @param string $url
 	 */
 	public function addLink($type, $label, $url, $iconpath = '', $sequence = 0, $handlerInfo = null)
 	{
@@ -231,6 +234,7 @@ 
 	 * Get instance of the module class.
 	 *
 	 * @param string Module name
+	 * @param string $modulename
 	 */
 	public static function getClassInstance($modulename)
 	{
@@ -274,6 +278,7 @@ 
 
 	/**
 	 * Toggle the module (enable/disable).
+	 * @param boolean $enableDisable
 	 */
 	public static function toggleModuleAccess($moduleName, $enableDisable)
 	{

vtlib/Vtiger/Link.php

Spacing +1 added lines, -1 removed lines

@@ -183,7 +183,7 @@
 				if ($tabid === self::IGNORE_MODULE) {
 					$permittedTabIdList = \vtlib\Deprecated::getPermittedModuleIdList();
 					if (!empty($permittedTabIdList)) {
-						$permittedTabIdList[] = 0;  // Added to support one link for all modules
+						$permittedTabIdList[] = 0; // Added to support one link for all modules
 						foreach ($permittedTabIdList as $moduleId) {
 							foreach ($type as $typ) {
 								if (isset($rows[$moduleId][$typ])) {

Doc Comments +4 added lines

@@ -72,6 +72,7 @@ 
 	 * @param string HREF value or URL to use for the link
 	 * @param string ICON to use on the display
 	 * @param int Order or sequence of displaying the link
+	 * @param boolean $tabid
 	 */
 	public static function addLink($tabid, $type, $label, $url, $iconpath = '', $sequence = 0, $handlerInfo = null, $linkParams = null)
 	{
@@ -110,6 +111,7 @@ 
 	 * @param string Link Type (like DETAIL_VIEW_BASIC). Useful for grouping based on pages
 	 * @param string Display label
 	 * @param string URL of link to lookup while deleting
+	 * @param boolean $tabid
 	 */
 	public static function deleteLink($tabid, $type, $label, $url = false)
 	{
@@ -147,6 +149,7 @@ 
 	 * Get all the links related to module.
 	 *
 	 * @param int Module ID
+	 * @param boolean $tabid
 	 */
 	public static function getAll($tabid)
 	{
@@ -278,6 +281,7 @@ 
 
 	/**
 	 * Extract the links of module for export.
+	 * @param boolean $tabid
 	 */
 	public static function getAllForExport($tabid)
 	{

vtlib/Vtiger/PackageUpdate.php

Doc Comments +19 added lines

@@ -21,6 +21,7 @@ 
 
 	/**
 	 * Initialize Update.
+	 * @param boolean $overwrite
 	 */
 	public function initUpdate($moduleInstance, $zipfile, $overwrite)
 	{
@@ -167,6 +168,7 @@ 
 
 	/**
 	 * Handle migration of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function handleMigration($modulenode, $moduleInstance)
 	{
@@ -197,6 +199,7 @@ 
 
 	/**
 	 * Update Tables of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateTables($modulenode)
 	{
@@ -205,6 +208,7 @@ 
 
 	/**
 	 * Update Blocks of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateBlocks($modulenode, $moduleInstance)
 	{
@@ -234,6 +238,7 @@ 
 
 	/**
 	 * Update Block of the module.
+	 * @param Block $blockInstance
 	 */
 	public function updateBlock($modulenode, $moduleInstance, $blocknode, $blockInstance)
 	{
@@ -258,6 +263,7 @@ 
 
 	/**
 	 * Update Fields of the module.
+	 * @param Block $blockInstance
 	 */
 	public function updateFields($blocknode, $blockInstance, $moduleInstance)
 	{
@@ -286,6 +292,7 @@ 
 
 	/**
 	 * Update Field of the module.
+	 * @param Field $fieldInstance
 	 */
 	public function updateField($blocknode, $blockInstance, $moduleInstance, $fieldnode, $fieldInstance)
 	{
@@ -368,6 +375,7 @@ 
 
 	/**
 	 * Import Custom views of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateCustomViews($modulenode, $moduleInstance)
 	{
@@ -386,6 +394,7 @@ 
 
 	/**
 	 * Update Custom View of the module.
+	 * @param Filter $filterInstance
 	 */
 	public function updateCustomView($modulenode, $moduleInstance, $customviewnode, $filterInstance)
 	{
@@ -395,6 +404,7 @@ 
 
 	/**
 	 * Update Sharing Access of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateSharingAccess($modulenode, $moduleInstance)
 	{
@@ -405,6 +415,7 @@ 
 
 	/**
 	 * Update Events of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateEvents($modulenode, $moduleInstance)
 	{
@@ -420,6 +431,7 @@ 
 
 	/**
 	 * Update actions of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateActions($modulenode, $moduleInstance)
 	{
@@ -440,6 +452,7 @@ 
 
 	/**
 	 * Update related lists of the module.
+	 * @param \SimpleXMLElement $modulenode
 	 */
 	public function updateRelatedLists($modulenode, $moduleInstance)
 	{
@@ -497,6 +510,9 @@ 
 		return $inRelModuleInstance;
 	}
 
+	/**
+	 * @param \SimpleXMLElement $modulenode
+	 */
 	public function updateCustomLinks($modulenode, $moduleInstance)
 	{
 		if (empty($modulenode->customlinks) || empty($modulenode->customlinks->customlink)) {
@@ -506,6 +522,9 @@ 
 		$this->importCustomLinks($modulenode, $moduleInstance);
 	}
 
+	/**
+	 * @param \SimpleXMLElement $modulenode
+	 */
 	public function updateCronTasks($modulenode)
 	{
 		if (empty($modulenode->crons) || empty($modulenode->crons->cron)) {

vtlib/Vtiger/Utils.php

Doc Comments +3 added lines

@@ -133,6 +133,8 @@ 
 	 * @param string Optional suffix to add during table creation
 	 * <br />
 	 * will be appended to CREATE TABLE $tablename SQL
+	 * @param string $tablename
+	 * @param string $criteria
 	 */
 	public static function createTable($tablename, $criteria, $suffixTableMeta = false)
 	{
@@ -212,6 +214,7 @@ 
 	 * Check if the given SQL is a CREATE statement.
 	 *
 	 * @param string SQL String
+	 * @param string $sql
 	 */
 	public static function isCreateSql($sql)
 	{

vtlib/Vtiger/Utils/StringTemplate.php

Doc Comments +1 added lines

@@ -112,6 +112,7 @@
 
 	/**
 	 * Clean up the input to be used as a regex.
+	 * @param string $value
 	 */
 	public function __formatAsRegex($value)
 	{

api/webservice/Core/Auth.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
 {
 	protected static $realm = 'YetiForceApi';
 
+	/**
+	 * @param \Api\Controller $self
+	 */
 	public static function init($self)
 	{
 		$method = \AppConfig::api('AUTH_METHOD');

api/webservice/Core/BaseAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
 	 *
 	 * @throws \Api\Core\Exception
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function checkPermission()
 	{

api/webservice/Core/Exception.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
  */
 class Exception extends \Exception
 {
+	/**
+	 * @param string $message
+	 */
 	public function __construct($message, $code = 200, self $previous = null)
 	{
 		if (!empty($previous)) {