jon48 / webtrees-lib

src/Webtrees/Family.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * Find the spouse of a person, using the Xref comparison.
 	 *
-	 * @param Individual $person
+	 * @param fw\Individual $person
 	 *
 	 * @return Individual|null
 	 */

Braces +3 added lines, -1 removed lines

@@ -45,7 +45,9 @@
 	* @return int Level of sources
 	* */
 	function isMarriageSourced(){
-		if($this->is_marriage_sourced !== null) return $this->is_marriage_sourced;
+		if($this->is_marriage_sourced !== null) {
+			return $this->is_marriage_sourced;
+		}
 		$this->is_marriage_sourced = $this->isFactSourced(WT_EVENTS_MARR.'|MARC');
 		return $this->is_marriage_sourced;
 	}

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 +27 added lines, -17 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);		
@@ -146,12 +148,14 @@ 
 	 * @return string Encrypted and encoded text
 	 */
 	public static function encryptToSafeBase64($data){
-	    if(!self::isEncryptionCompatible())
-	        throw new \Exception('MCrypt PHP extension is required to use encryption.');
+	    if(!self::isEncryptionCompatible()) {
+	    	        throw new \Exception('MCrypt PHP extension is required to use encryption.');
+	    }
 	    
 		$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);
@@ -169,20 +173,24 @@ 
 	 * @return string Decrypted text
 	 */
 	public static function decryptFromSafeBase64($encrypted){
-	    if(!self::isEncryptionCompatible())
-	        throw new \Exception('MCrypt PHP extension is required to use encryption.');
+	    if(!self::isEncryptionCompatible()) {
+	    	        throw new \Exception('MCrypt PHP extension is required to use encryption.');
+	    }
 	    
 		$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);
@@ -223,7 +231,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;
 	}
 	

src/Webtrees/Functions/FunctionsPrint.php

Doc Comments +1 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
 	 * 
 	 * @param \Fisharebest\Webtrees\Place $place
 	 * @param string $icon_path
-	 * @param number $size
+	 * @param integer $size
 	 * @return string HTML code of the inserted flag
 	 */
 	public static function htmlPlaceIcon(\Fisharebest\Webtrees\Place $place, $icon_path , $size = 50) {
@@ -184,7 +184,6 @@ 
 	/**
 	 * Format date to display short (just years)
 	 *
-	 * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date
 	 * @param boolean $anchor option to print a link to calendar
 	 * @return string HTML code for short date
 	 */
@@ -212,7 +211,6 @@ 
 	/**
 	 * Format fact place to display short
 	 *
-	 * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date
 	 * @param string $format Format of the place
 	 * @param boolean $anchor option to print a link to placelist
 	 * @return string HTML code for short place

Braces +11 added lines, -7 removed lines

@@ -160,7 +160,9 @@ 
 	public static function htmlIndividualForList(\Fisharebest\Webtrees\Individual $individual, $isStrong = true){
 		$html = '';
 		$tag = 'em';
-		if($isStrong) $tag = 'strong';
+		if($isStrong) {
+			$tag = 'strong';
+		}
 		if($individual && $individual->canShow()){
 			$dindi = new Individual($individual);
 			$html = $individual->getSexImage();
@@ -174,8 +176,7 @@ 
 			$html .= '&nbsp;<span><small><em>'.$dindi->format_first_major_fact(WT_EVENTS_BIRT, 10).'</em></small></span>';
 			$html .= '&nbsp;<span><small><em>'.$dindi->format_first_major_fact(WT_EVENTS_DEAT, 10).'</em></small></span>';
 			$html .= '</a>';
-		}
-		else {
+		} else {
 			$html .= '<span class=\"list_item\"><'.$tag.'>' . I18N::translate('Private') . '</'.$tag.'></span>';
 		}
 		return $html;
@@ -195,8 +196,7 @@ 
 		$date = $fact->getDate();
 		if($date->isOK()){
 			$html.=' '.$date->Display($anchor && !$SEARCH_SPIDER, '%Y');
-		}
-		else{
+		} else{
 			// 1 DEAT Y with no DATE => print YES
 			// 1 BIRT 2 SOUR @S1@ => print YES
 			// 1 DEAT N is not allowed
@@ -220,7 +220,9 @@ 
 	public static function formatFactPlaceShort(\Fisharebest\Webtrees\Fact $fact, $format, $anchor=false){
 		$html='';
 		
-		if ($fact === null) return $html;
+		if ($fact === null) {
+			return $html;
+		}
 		$place = $fact->getPlace();
 		if($place){
 			$dplace = new Place($place);
@@ -339,7 +341,9 @@ 
 					default:
 						break;
 				}
-				if($image && $title) $html = '<i class="icon-maj-sourced-'.$size.'_'.$image.'" title="'.$title.'"></i>';
+				if($image && $title) {
+					$html = '<i class="icon-maj-sourced-'.$size.'_'.$image.'" title="'.$title.'"></i>';
+				}
 				break;
 			default:
 				break;

src/Webtrees/Individual.php

Doc Comments +1 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
 	 * Returns an estimated birth place based on statistics on the base
 	 *
 	 * @param boolean $perc Should the coefficient of reliability be returned
-	 * @return string|array Estimated birth place if found, null otherwise
+	 * @return string Estimated birth place if found, null otherwise
 	 */
 	public function getEstimatedBirthPlace($perc=false){
 		if($bplace = $this->gedcomrecord->getBirthPlace()){
@@ -110,7 +110,6 @@ 
 	/**
 	 * Returns a significant place for the individual
 	 *
-	 * @param boolean $perc Should the coefficient of reliability be returned
 	 * @return string|array Estimated birth place if found, null otherwise
 	 */
 	public function getSignificantPlace(){

Braces +8 added lines, -6 removed lines

@@ -65,8 +65,7 @@ 
 				$ct2 = preg_match_all($pattern, $titlefact->getValue(), $match2);
 				if($ct2>0){
 					$this->titles[$match2[1][0]][]= trim($match2[2][0]);
-				}
-				else{
+				} else{
 					$this->titles[$titlefact->getValue()][]='';
 				}
 			}
@@ -98,8 +97,7 @@ 
 		if($bplace = $this->gedcomrecord->getBirthPlace()){
 			if($perc){
 				return array ($bplace, 1);
-			}
-			else{
+			} else{
 				return $bplace;
 			}
 		}
@@ -168,7 +166,9 @@ 
 	 * @return int Level of sources
 	 * */
 	public function isBirthSourced(){
-		if($this->is_birth_sourced !== null) return $this->is_birth_sourced;
+		if($this->is_birth_sourced !== null) {
+			return $this->is_birth_sourced;
+		}
 		$this->is_birth_sourced = $this->isFactSourced(WT_EVENTS_BIRT);
 		return $this->is_birth_sourced;
 	}
@@ -179,7 +179,9 @@ 
 	* @return int Level of sources
 	* */
 	public function isDeathSourced(){
-		if($this->is_death_sourced !== null) return $this->is_death_sourced;
+		if($this->is_death_sourced !== null) {
+			return $this->is_death_sourced;
+		}
 		$this->is_death_sourced = $this->isFactSourced(WT_EVENTS_DEAT);
 		return $this->is_death_sourced;
 	}

src/Webtrees/Module/AdminTasks/Model/AbstractTask.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
      * Set parameters of the Task
      *
      * @param bool $is_enabled Status of the task
-     * @param \DateTime $lastupdated Time of the last task run
+     * @param \DateTime $last_updated Time of the last task run
      * @param bool $last_result Result of the last run, true for success, false for failure
      * @param int $frequency Frequency of execution in minutes
      * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited

Braces +9 added lines, -4 removed lines

@@ -236,7 +236,9 @@ 
 	 * @return bool
 	 */
 	public function save() {
-	    if(!$this->provider) throw new \Exception('The task has not been initialised with a provider.');
+	    if(!$this->provider) {
+	    	throw new \Exception('The task has not been initialised with a provider.');
+	    }
 		return $this->provider->updateTask($this);
 	}
 	
@@ -246,8 +248,9 @@ 
      */
     public function execute(){
     
-        if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
-            $this->is_running = false;
+        if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime()) {
+                    $this->is_running = false;
+        }
     
         if(!$this->is_running){  //TODO put in place a time_out for running...
             //TODO Log the executions in the logs
@@ -261,7 +264,9 @@ 
                 $this->last_updated = new \DateTime();
                 if($this->nb_occurrences > 0){
                     $this->nb_occurrences--;
-                    if($this->nb_occurrences == 0) $this->is_enabled = false;
+                    if($this->nb_occurrences == 0) {
+                    	$this->is_enabled = false;
+                    }
                 }
             }
             $this->is_running = false;

src/Webtrees/Module/AdminTasks/Model/TaskProviderInterface.php

Doc Comments +3 added lines, -2 removed lines

@@ -32,8 +32,8 @@ 
 	 * Set the status of a specific admin task.
 	 * The status can be enabled (true), or disabled (false).
 	 *
-	 * @param AbstractTask $ga
 	 * @param bool $status
+	 * @return void
 	 */
 	public function setTaskStatus(AbstractTask $task, $status);
 		
@@ -49,6 +49,7 @@ 
      * Delete the task from the database, in a transactional manner.
      *
      * @param string $task_name Task to delete
+     * @return boolean
      */
     public function deleteTask($task_name);
     
@@ -75,7 +76,7 @@ 
      * Returns the list of tasks that are currently meant to run.
      * Tasks to run can be forced, or can be limited to only one.
      * 
-     * @param string|null $force Force the enabled tasks to run.
+     * @param boolean $force Force the enabled tasks to run.
      * @param string|null $task_name Name of the specific task to run
      */
 	function getTasksToRun($force = false, $task_name = null);

src/Webtrees/Module/Certificates/Model/Certificate.php

Doc Comments +2 added lines, -1 removed lines

@@ -109,6 +109,7 @@ 
 	/**
 	 * {@inhericDoc}
 	 * @see \Fisharebest\Webtrees\GedcomRecord::getInstance()
+	 * @param string $xref
 	 */	
 	static public function getInstance($xref, Tree $tree, $gedcom = null, CertificateProviderInterface $provider = null) {
 		try{
@@ -150,7 +151,7 @@ 
 	/**
 	 * Define a source associated with the certificate
 	 *
-	 * @param string|Source $xref
+	 * @param string|null $xref
 	 */
 	public function setSource($xref){
 		if($xref instanceof Source){

Braces +11 added lines, -7 removed lines

@@ -118,8 +118,7 @@ 
 			if(Functions::isValidPath($certfile, true)) {
 				return new Certificate($certfile, $tree, $provider);
 			}
-		}
-		catch (\Exception $ex) { 
+		} catch (\Exception $ex) { 
 			Log::addErrorLog('Certificate module error : > '.$ex->getMessage().' < with data > '.$xref.' <');
 		}	
 
@@ -202,7 +201,9 @@ 
 	 */
 	public function getCity(){
 		$chunks = explode('/', $this->getFilename(), 2);
-		if(count($chunks) > 1) return $chunks[0];
+		if(count($chunks) > 1) {
+			return $chunks[0];
+		}
 		return null;
 	}
 	
@@ -246,8 +247,7 @@ 
     	
     		if($sid){
     			$this->source = Source::getInstance($sid, $this->tree);
-    		}
-    		else{
+    		} else{
     			$this->fetchALinkedSource();  // the method already attach the source to the Certificate object;
     		}
     		
@@ -256,7 +256,9 @@ 
     			$repofact = $this->source->getFirstFact('REPO');
     			if($repofact) {
     				$repo = $repofact->getTarget();
-    				if($repo && $repo instanceof Repository)  $wmtext .= ' '.$repo->getFullName().' - ';
+    				if($repo && $repo instanceof Repository) {
+    					$wmtext .= ' '.$repo->getFullName().' - ';
+    				}
     			}
     			$wmtext .= $this->source->getFullName();			
     		}	
@@ -426,7 +428,9 @@ 
 			}
 		}
 		
-		if($sid) $this->source = Source::getInstance($sid, $this->tree);
+		if($sid) {
+			$this->source = Source::getInstance($sid, $this->tree);
+		}
 		
 		return $this->source;	
 	}

src/Webtrees/Module/CertificatesModule.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
     /**
      * Return the HTML code for custom simple tag _ACT
      *
-     * @param Certificate $certificatePath Certificate (as per the GEDCOM)
+     * @param Certificate $certificate Certificate (as per the GEDCOM)
      * @param string|null $sid Linked Source ID, if it exists
      */
     protected function getDisplay_ACT(Certificate $certificate, $sid = null){    

Braces +15 added lines, -6 removed lines

@@ -105,7 +105,9 @@ 
         $sid=null;
         
         if($this->getSetting('MAJ_SHOW_CERT', Auth::PRIV_HIDE) >= Auth::accessLevel($WT_TREE)){
-            if (!$srec || strlen($srec) == 0) return $html;
+            if (!$srec || strlen($srec) == 0) {
+            	return $html;
+            }
             	
             $certificate = null;
             $subrecords = explode("\n", $srec);
@@ -118,11 +120,14 @@ 
                 $level = substr($subrecords[$i], 0, 1);
                 $tag = substr($subrecords[$i], 2, 4);
                 $text = substr($subrecords[$i], 7);
-                if($tag == '_ACT') $certificate= new Certificate($text, $WT_TREE, $this->getProvider());
+                if($tag == '_ACT') {
+                	$certificate= new Certificate($text, $WT_TREE, $this->getProvider());
+                }
             }
             	
-            if($certificate && $certificate->canShow())
-                $html = $this->getDisplay_ACT($certificate, $sid);
+            if($certificate && $certificate->canShow()) {
+                            $html = $this->getDisplay_ACT($certificate, $sid);
+            }
                 	
         }
         return $html;
@@ -150,7 +155,9 @@ 
         $html = '';
         switch($tag){
             case '_ACT':
-                if($context == 'SOUR') $html = $this->getDisplay_ACT($value, $contextid);
+                if($context == 'SOUR') {
+                	$html = $this->getDisplay_ACT($value, $contextid);
+                }
                 break;
         }
         return $html;
@@ -180,7 +187,9 @@ 
 				$html .= '<select id="certifCity'.$element_id.'" class="_CITY">';
 				foreach ($tabCities as $cities){
 					$selectedCity='';
-					if($certificate && $cities== $certificate->getCity()) $selectedCity='selected="true"';
+					if($certificate && $cities== $certificate->getCity()) {
+						$selectedCity='selected="true"';
+					}
 					$html .= '<option value="'.$cities.'" '.$selectedCity.' />'.$cities.'</option>';
 				}
 				$html .= '</select>';

src/Webtrees/Module/GeoDispersion/Model/GeoAnalysisProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
     /**
      * Returns the number of geographical analysis (active and inactive). 
      * 
-     * @return int
+     * @return string
      */
     public function getGeoAnalysisCount() {
         return Database::prepare(

Braces +3 added lines, -6 removed lines

@@ -167,8 +167,7 @@ 
 			$ga = $this->getGeoAnalysis($id, false);
 			
 			$id = Database::commit();
-		}
-		catch(\Exception $ex) {
+		} catch(\Exception $ex) {
 			Database::rollback();
 			$ga = null;
 			Log::addErrorLog('A new Geo Analysis failed to be created. Transaction rollbacked. Parameters ['.$description.', '.$analysis_level.','.$map_file.','.$map_top_level.','.$use_flags.', '.$gen_details.']. Exception: '.$ex->getMessage());
@@ -210,8 +209,7 @@ 
 			$ga = $this->getGeoAnalysis($ga->getId(), false);
 			
 			$id = Database::commit();
-		}
-		catch(\Exception $ex) {		    
+		} catch(\Exception $ex) {		    
 			Database::rollback();
 			Log::addErrorLog('The Geo Analysis ID “' . $ga->getId() . '” failed to be updated. Transaction rollbacked. Exception: '.$ex->getMessage());
 			$ga = null;
@@ -350,8 +348,7 @@ 
         if(!$this->place_hierarchy) {
             if($place_structure = $this->getPlacesHierarchyFromHeader()) {
                 $this->place_hierarchy = array('type' => 'header', 'hierarchy' => $place_structure);
-            }
-            else {
+            } else {
                 $this->place_hierarchy = array('type' => 'data', 'hierarchy' => $this->getPlacesHierarchyFromData());
             }            
         }