*
* @param name Name of the string
*
+ * @param int $maxLength
+ *
* @return string An equivalent variable name
*
* @access public
}
/**
- * given a string, replace all non alpha numeric characters and
+ * Given a string, replace all non alpha numeric characters and
* spaces with the replacement character
*
* @param string $name the name to be worked on
}
}
+ /**
+ * Convert possibly underscore separated words to camel case with special handling for 'UF'
+ * e.g
+ * membership_payment returns MembershipPayment
+ * @param string $string
+ *
+ * @return string string
+ */
+ static function convertStringToCamel($string) {
+ $fragments = explode('_', $string);
+ foreach ($fragments as & $fragment) {
+ $fragment = ucfirst($fragment);
+ }
+ // Special case: UFGroup, UFJoin, UFMatch, UFField
+ if ($fragments[0] === 'Uf') {
+ $fragments[0] = 'UF';
+ }
+ return implode('', $fragments);
+ }
+
/**
*
* Takes a variable name and munges it randomly into another variable name
}
/**
- * takes a string and returns the last tuple of the string.
+ * Takes a string and returns the last tuple of the string.
* useful while converting file names to class names etc
*
* @param string $string the input string
- * @param char $char the character used to demarcate the componets
+ * @param \char|string $char $char the character used to demarcate the componets
*
* @access public
*
}
/**
- * appends a name to a string and seperated by delimiter.
+ * Appends a name to a string and seperated by delimiter.
* does the right thing for an empty string
*
* @param string $str the string to be appended to
}
/**
- * determine if the string is composed only of ascii characters
+ * Determine if the string is composed only of ascii characters
*
* @param string $str input string
* @param boolean $utf8 attempt utf8 match on failure (default yes)
}
/**
- * determine the string replacements for redaction
+ * Determine the string replacements for redaction
* on the basis of the regular expressions
*
* @param string $str input string
return CRM_Core_DAO::$_nullArray;
}
+ /**
+ * @param $str
+ * @param $stringRules
+ *
+ * @return mixed
+ */
static function redaction($str, $stringRules) {
//redact the strings
if (!empty($stringRules)) {
}
/**
- * determine if two href's are equivalent (fuzzy match)
+ * Determine if two href's are equivalent (fuzzy match)
*
* @param string $url1 the first url to be matched
* @param string $url2 the second url to be matched against
}
/**
- * Function to extract variable values
+ * Extract variable values
*
* @param mix $query this is basically url
*
}
/**
- * translate a true/false/yes/no string to a 0 or 1 value
+ * Translate a true/false/yes/no string to a 0 or 1 value
*
* @param string $str the string to be translated
*
}
/**
- * returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false
+ * Returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false
*
* @param string $str the string to be translated
*
return $text;
}
+ /**
+ * @param $string
+ * @param array $params
+ */
static function extractName($string, &$params) {
$name = trim($string);
if (empty($name)) {
}
}
+ /**
+ * @param $string
+ *
+ * @return array
+ */
static function &makeArray($string) {
$string = trim($string);
}
/**
- * strip leading, trailing, double spaces from string
+ * Strip leading, trailing, double spaces from string
* used for postal/greeting/addressee
*
* @param string $string input string to be cleaned
*
* @param string $string
* @param int $maxLen
+ *
+ * @return string
*/
static function ellipsify($string, $maxLen) {
$len = strlen($string);
* "admin foo" => array(NULL,"admin foo")
* "cms:admin foo" => array("cms", "admin foo")
*
+ * @param $delim
* @param string $string e.g. "view all contacts". Syntax: "[prefix:]name"
+ * @param null $defaultPrefix
+ *
* @return array (0 => string|NULL $prefix, 1 => string $value)
*/
public static function parsePrefix($delim, $string, $defaultPrefix = NULL) {
}
/**
- * this function will mask part of the the user portion of an Email address (everything before the @)
+ * This function will mask part of the the user portion of an Email address (everything before the @)
*
* @param string $email the email address to be masked
* @param string $maskChar the character used for masking
}
/**
- * this function compares two strings
+ * This function compares two strings
*
* @param string $strOne string one
* @param string $strTwo string two
}
}
+ /**
+ * Many parts of the codebase have a convention of internally passing around
+ * HTML-encoded URLs. This effectively means that "&" is replaced by "&"
+ * (because most other odd characters are %-escaped in URLs; and %-escaped
+ * strings don't need any extra escaping in HTML).
+ *
+ * @param string $url URL with HTML entities
+ * @return string URL without HTML entities
+ */
+ public static function unstupifyUrl($htmlUrl) {
+ return str_replace('&', '&', $htmlUrl);
+ }
}
projects / civicrm-core.git / blobdiff