jon48 / webtrees-lib

src/Webtrees/Functions/Functions.php

Doc Comments +7 added lines, -7 removed lines

@@ -51,8 +51,8 @@ 
 	 * 
 	 * @param integer $num Numerator
 	 * @param integer $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Result of the safe division
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Result of the safe division
 	 */
 	public static function safeDivision($num, $denom, $default = 0) {
 		if($denom && $denom!=0){
@@ -66,8 +66,8 @@ 
 	 *
 	 * @param int $num Numerator
 	 * @param int $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Percentage
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Percentage
 	 */
 	public static function getPercentage($num, $denom, $default = 0){
 		return 100 * self::safeDivision($num, $denom, $default);
@@ -78,7 +78,7 @@ 
 	 *
 	 * @param string $file The image to resize
 	 * @param int $target	The final max width/height
-	 * @return array array of ($width, $height). One of them must be $target
+	 * @return integer[] array of ($width, $height). One of them must be $target
 	 */
 	static public function getResizedImageSize($file, $target=25){
 		list($width, $height, $type, $attr) = getimagesize($file);
@@ -233,7 +233,7 @@ 
 	 * Returns the generation associated with a Sosa number
 	 *
 	 * @param int $sosa Sosa number
-	 * @return number
+	 * @return integer
 	 */
 	public static function getGeneration($sosa){
 		return(int)log($sosa, 2)+1;
@@ -246,7 +246,7 @@ 
 	 * Returns whether the image type is supported by the system, and if so, return the standardised type
 	 *
 	 * @param string $reqtype Extension to test
-	 * @return boolean|string Is supported?
+	 * @return false|string Is supported?
 	 */
 	public static function isImageTypeSupported($reqtype) {
 	    $supportByGD = array('jpg'=>'jpeg', 'jpeg'=>'jpeg', 'gif'=>'gif', 'png'=>'png');

Braces +21 added lines, -13 removed lines

@@ -114,16 +114,18 @@ 
 		$len_chars = count($chars);
 		$token = '';
 		
-		for ($i = 0; $i < $length; $i++)
-			$token .= $chars[ mt_rand(0, $len_chars - 1) ];
+		for ($i = 0; $i < $length; $i++) {
+					$token .= $chars[ mt_rand(0, $len_chars - 1) ];
+		}
 		
 		# Number of 32 char chunks
 		$chunks = ceil( strlen($token) / 32 );
 		$md5token = '';
 		
 		# Run each chunk through md5
-		for ( $i=1; $i<=$chunks; $i++ )
-			$md5token .= md5( substr($token, $i * 32 - 32, 32) );
+		for ( $i=1; $i<=$chunks; $i++ ) {
+					$md5token .= md5( substr($token, $i * 32 - 32, 32) );
+		}
 		
 			# Trim the token
 		return substr($md5token, 0, $length);		
@@ -138,8 +140,9 @@ 
 	 */
 	public static function encryptToSafeBase64($data){
 		$key = 'STANDARDKEYIFNOSERVER';
-		if(Filter::server('SERVER_NAME') && Filter::server('SERVER_SOFTWARE'))
-			$key = md5(Filter::server('SERVER_NAME').Filter::server('SERVER_SOFTWARE'));
+		if(Filter::server('SERVER_NAME') && Filter::server('SERVER_SOFTWARE')) {
+					$key = md5(Filter::server('SERVER_NAME').Filter::server('SERVER_SOFTWARE'));
+		}
 		$iv = mcrypt_create_iv(self::ENCRYPTION_IV_SIZE, MCRYPT_RAND);
 		$id = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $data, MCRYPT_MODE_CBC,$iv);
 		$encrypted = base64_encode($iv.$id);
@@ -158,16 +161,19 @@ 
 	 */
 	public static function decryptFromSafeBase64($encrypted){
 		$key = 'STANDARDKEYIFNOSERVER';
-		if(Filter::server('SERVER_NAME') && Filter::server('SERVER_SOFTWARE'))
-			$key = md5(Filter::server('SERVER_NAME').Filter::server('SERVER_SOFTWARE'));
+		if(Filter::server('SERVER_NAME') && Filter::server('SERVER_SOFTWARE')) {
+					$key = md5(Filter::server('SERVER_NAME').Filter::server('SERVER_SOFTWARE'));
+		}
 		$encrypted = str_replace('-', '+', $encrypted);
 		$encrypted = str_replace('_', '/', $encrypted);
 		$encrypted = str_replace('*', '=', $encrypted);
 		$encrypted = base64_decode($encrypted);
-		if(!$encrypted)
-			throw new \InvalidArgumentException('The encrypted value is not in correct base64 format.');
-		if(strlen($encrypted) < self::ENCRYPTION_IV_SIZE) 
-			throw new \InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		if(!$encrypted) {
+					throw new \InvalidArgumentException('The encrypted value is not in correct base64 format.');
+		}
+		if(strlen($encrypted) < self::ENCRYPTION_IV_SIZE) {
+					throw new \InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		}
 		$iv_dec = substr($encrypted, 0, self::ENCRYPTION_IV_SIZE);
 		$encrypted = substr($encrypted, self::ENCRYPTION_IV_SIZE);
 		$decrypted = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key, $encrypted, MCRYPT_MODE_CBC, $iv_dec);
@@ -208,7 +214,9 @@ 
 	 * @return boolean True if path valid
 	 */
 	public static function isValidPath($filename, $acceptfolder = FALSE) {		
-		if(strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) return true;
+		if(strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) {
+			return true;
+		}
 		return false;
 	}