YetiForceCompany / YetiForceCRM

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)) {

api/webservice/Portal/BaseModule/Hierarchy.php

Doc Comments +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
 	 *
 	 * @throws \Api\Core\Exception
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function checkPermission()
 	{
@@ -84,7 +84,7 @@ 
 	 * @param int                 $parentId
 	 * @param string              $type
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function getRecords(\App\QueryGenerator $mainQueryGenerator, $parentId, $type = 'child')
 	{

api/webservice/Portal/Users/Logout.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	/**
 	 * Put method.
 	 *
-	 * @return array
+	 * @return boolean
 	 */
 	public function put()
 	{

include/fields/CurrencyField.php

Doc Comments +8 added lines, -5 removed lines

@@ -203,7 +203,7 @@ 
 	 * @param \App\User $user
 	 * @param bool      $skipConversion
 	 *
-	 * @return Formatted Currency
+	 * @return string Currency
 	 */
 	public function getDisplayValueWithSymbol($user = null, $skipConversion = false)
 	{
@@ -219,7 +219,7 @@ 
 	 * @param string $currencySymbol
 	 * @param string $currencySymbolPlacement
 	 *
-	 * @return Currency value appended with the currency symbol
+	 * @return string value appended with the currency symbol
 	 */
 	public static function appendCurrencySymbol($currencyValue, $currencySymbol, $currencySymbolPlacement = '')
 	{
@@ -241,7 +241,7 @@ 
 	 *
 	 * @param Number $value
 	 *
-	 * @return Formatted Currency
+	 * @return string Currency
 	 */
 	private function formatCurrencyValue($value)
 	{
@@ -438,7 +438,7 @@ 
 	 * @param \App\User $user
 	 * @param bool      $skipConversion
 	 *
-	 * @return Number
+	 * @return string
 	 */
 	public static function convertToDBFormat($value, $user = null, $skipConversion = false)
 	{
@@ -453,7 +453,7 @@ 
 	/**
 	 * Function to get the default CRM currency.
 	 *
-	 * @return int Default system currency id
+	 * @return string|null Default system currency id
 	 */
 	public static function getDBCurrencyId()
 	{
@@ -465,6 +465,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param double $amount
+	 */
 	public static function convertToDollar($amount, $conversionRate)
 	{
 		if ($conversionRate == 0) {

include/fields/DateTimeField.php

Doc Comments +3 added lines, -2 removed lines

@@ -61,7 +61,6 @@ 
 	}
 
 	/**
-	 * @param Users $user
 	 *
 	 * @return string
 	 */
@@ -156,7 +155,6 @@ 
 
 	/**
 	 * @param string $date
-	 * @param Users  $user
 	 *
 	 * @return string
 	 */
@@ -346,6 +344,9 @@ 
 		return $time;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private static function sanitizeDate($value, $user)
 	{
 		if (empty($user)) {