Commit 7216390c authored by Carsten  Rose's avatar Carsten Rose
Browse files

Support.php: added some phpdoc

parent e3da2abe
......@@ -63,8 +63,8 @@ class Support {
/**
* Extract Tag from $tag (eg: <input class="form-control">, might contain further attributes) and wrap it around $value. If $flagOmitEmpty==true && $value=='': return ''.
*
* @param $tag
* @param $value
* @param string $tag
* @param string $value
* @param bool|false $omitIfValueEmpty
* @return string
*/
......@@ -84,8 +84,8 @@ class Support {
/**
* Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
*
* @param $type
* @param $value
* @param string $type
* @param string $value
* @param bool $flagOmitEmpty
* @return string
*/
......@@ -101,8 +101,8 @@ class Support {
*
* Based on: http://www.w3schools.com/howto/howto_css_tooltip.asp
*
* @param $before
* @param $tooltipText
* @param string $before
* @param string $tooltipText
* @return string
*/
public static function appendTooltip($before, $tooltipText) {
......@@ -118,8 +118,8 @@ class Support {
*
* Returns the false if not found or index of found place. Be carefull: use unary operator to compare for 'false'
*
* @param $needle
* @param $haystack
* @param string $needle
* @param string $haystack
* @return boolean true if found, else false
*/
public static function findInSet($needle, $haystack) {
......@@ -135,7 +135,7 @@ class Support {
* 01.02.13 3:24 > 1979-02-01 03:24:00
* 1.2.1979 14:21:5 > 1979-02-01 14:21:05
*
* @param $dateTimeString
* @param string $dateTimeString
* @return string
* @throws UserFormException
*/
......@@ -222,7 +222,7 @@ class Support {
/**
* @param string $type date | datetime | time
* @param string $format FORMAT_DATE_INTERNATIONAL | FORMAT_DATE_GERMAN
* @param $showSeconds
* @param string $showSeconds
* @return string
* @throws UserFormException
*/
......@@ -262,10 +262,10 @@ class Support {
* Returned value will be 'date only', 'datetime' oder 'time only', depending on the input value.
*
* @param string $dateTimeString
* @param $dateFormat
* @param $showZero
* @param $showTime
* @param $showSeconds
* @param string $dateFormat
* @param string $showZero
* @param string $showTime
* @param string $showSeconds
* @return string
* @throws UserFormException
*/
......@@ -383,7 +383,7 @@ class Support {
/**
* Split date FORMAT_DATE_GERMAN | FORMAT_DATE_INTERNATIONAL to array with arr[0]=yyyy, arr[1]=mm, arr[2]=dd.
*
* @param $dateString
* @param string $dateString
* @return array
* @throws UserFormException
*/
......@@ -446,7 +446,7 @@ class Support {
/**
* Encrypt curly braces by an uncommon string. Helps preventing unwished action on curly braces.
*
* @param $text
* @param string $text
* @return mixed
*/
public
......@@ -460,7 +460,7 @@ class Support {
/**
* Decrypt curly braces by an uncommon string. Helps preventing unwished action on curly braces
*
* @param $text
* @param string $text
* @return mixed
*/
public static function decryptDoubleCurlyBraces($text) {
......@@ -485,8 +485,8 @@ class Support {
}
/**
* @param $url
* @param $param
* @param string $url
* @param string $param
* @return string
*/
public static function concatUrlParam($url, $param) {
......@@ -516,19 +516,19 @@ class Support {
}
/**
* @param $arr
* @param $index
* @param array $arr
* @param string $index
* @param string $value
*/
public static function setIfNotSet(&$arr, $index, $value = '') {
public static function setIfNotSet(array &$arr, $index, $value = '') {
if (!isset($arr[$index]))
$arr[$index] = $value;
}
/**
* @param $filename
* @param $extend
* @param string $filename
* @param string $extend
* @return string
*/
public static function extendFilename($filename, $extend) {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment