jon48 / webtrees-lib

src/Webtrees/ImageBuilder.php

Indentation +299 added lines, -299 removed lines

@@ -22,61 +22,61 @@ 
  */
 class ImageBuilder {
     
-    /**
-     * Reference media
-     * @var Media $media
-     */
-    protected $media;
+	/**
+	 * Reference media
+	 * @var Media $media
+	 */
+	protected $media;
     
-    /**
-     * Use TTF font
-     * @var bool $use_ttf
-     */
-    protected $use_ttf;
+	/**
+	 * Use TTF font
+	 * @var bool $use_ttf
+	 */
+	protected $use_ttf;
     
-    /**
-     * Expiration offset. Default is one day.
-     * @var int $expire_offset
-     */
-    protected $expire_offset;
+	/**
+	 * Expiration offset. Default is one day.
+	 * @var int $expire_offset
+	 */
+	protected $expire_offset;
    
-    /**
-     * Should the certificate display a watermark
-     * @var bool $show_watermark
-     */
-    protected $show_watermark;
+	/**
+	 * Should the certificate display a watermark
+	 * @var bool $show_watermark
+	 */
+	protected $show_watermark;
         
-    /**
-     * Maximum watermark font size. Default is 18.
-     * @var int $font_max_size
-     */
-    protected $font_max_size;
+	/**
+	 * Maximum watermark font size. Default is 18.
+	 * @var int $font_max_size
+	 */
+	protected $font_max_size;
     
-    /**
-     * Watermark font color, in hexadecimal. Default is #4D6DF3.
-     * @var string $font_color
-     */
-    protected $font_color;
+	/**
+	 * Watermark font color, in hexadecimal. Default is #4D6DF3.
+	 * @var string $font_color
+	 */
+	protected $font_color;
     
-    /**
-     * Should the image be rendered as attachment (vs inline)     * 
-     * @var bool $as_attachment
-     */
-    protected $as_attachment;
+	/**
+	 * Should the image be rendered as attachment (vs inline)     * 
+	 * @var bool $as_attachment
+	 */
+	protected $as_attachment;
     
 	/**
-	* Contructor for ImageBuilder
-	*
-	* @param Media|null $media Reference media object
-	*/
+	 * Contructor for ImageBuilder
+	 *
+	 * @param Media|null $media Reference media object
+	 */
 	public function __construct(Media $media = null){
-	    $this->media = $media;
-	    $this->use_ttf = function_exists('imagettftext');
-	    $this->expire_offset = 3600 * 24;
-	    $this->show_watermark = true;
-	    $this->font_max_size = 18;
-	    $this->font_color = '#4D6DF3';
-	    $this->as_attachment = false;
+		$this->media = $media;
+		$this->use_ttf = function_exists('imagettftext');
+		$this->expire_offset = 3600 * 24;
+		$this->show_watermark = true;
+		$this->font_max_size = 18;
+		$this->font_color = '#4D6DF3';
+		$this->as_attachment = false;
 	}
 	
 	/**
@@ -85,7 +85,7 @@ 
 	 * @return int
 	 */
 	public function getExpireOffset() {
-	    return $this->expire_offset;
+		return $this->expire_offset;
 	}
 	
 	/**
@@ -95,8 +95,8 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setExpireOffset($expireOffset) {
-	    if($expireOffset) $this->expire_offset = $expireOffset;
-	    return $this;
+		if($expireOffset) $this->expire_offset = $expireOffset;
+		return $this;
 	}
 	
 	/**
@@ -105,7 +105,7 @@ 
 	 * @return bool
 	 */
 	public function isShowWatermark() {
-	    return $this->show_watermark;
+		return $this->show_watermark;
 	}
 	
 	/**
@@ -115,8 +115,8 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setShowWatermark($show_watermark) {
-	    if(!is_null($show_watermark)) $this->show_watermark = $show_watermark;
-	    return $this;
+		if(!is_null($show_watermark)) $this->show_watermark = $show_watermark;
+		return $this;
 	}
 	
 	/**
@@ -126,8 +126,8 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontMaxSize($font_max_size) {
-	    if($font_max_size) $this->font_max_size = $font_max_size;
-	    return $this;
+		if($font_max_size) $this->font_max_size = $font_max_size;
+		return $this;
 	}
 	
 	/**
@@ -137,8 +137,8 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontColor($font_color) {
-	    if($font_color) $this->font_color = $font_color;
-	    return $this;
+		if($font_color) $this->font_color = $font_color;
+		return $this;
 	}
 	
 	/**
@@ -148,8 +148,8 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setAsAttachment($is_attachement) {
-	    if(is_bool($is_attachement)) $this->as_attachment = $is_attachement;
-	    return $this;
+		if(is_bool($is_attachement)) $this->as_attachment = $is_attachement;
+		return $this;
 	}
 	
 	/**
@@ -157,135 +157,135 @@ 
 	 */
 	public function render(){
 	    
-	    if (!$this->media || !$this->media->canShow()) {
-	        Log::addMediaLog('Image Builder error: >' . I18N::translate('Missing or private media object.'));
-	        $this->renderError();
-	    }
+		if (!$this->media || !$this->media->canShow()) {
+			Log::addMediaLog('Image Builder error: >' . I18N::translate('Missing or private media object.'));
+			$this->renderError();
+		}
 	    
-	    $serverFilename = $this->media->getServerFilename();
+		$serverFilename = $this->media->getServerFilename();
 	    
-	    if (!file_exists($serverFilename)) {
-	        Log::addMediaLog('Image Builder error: >'. I18N::translate('The media object does not exist.').'< for path >'.$serverFilename.'<');
-	        $this->renderError();
-	    }
+		if (!file_exists($serverFilename)) {
+			Log::addMediaLog('Image Builder error: >'. I18N::translate('The media object does not exist.').'< for path >'.$serverFilename.'<');
+			$this->renderError();
+		}
 	    
-	    $mimetype = $this->media->mimeType();
-	    $imgsize = $this->media->getImageAttributes();
-	    $filetime = $this->media->getFiletime();
-	    $filetimeHeader = gmdate('D, d M Y H:i:s', $filetime) . ' GMT';	    
-	    $expireHeader = gmdate('D, d M Y H:i:s', WT_TIMESTAMP + $this->getExpireOffset()) . ' GMT';
+		$mimetype = $this->media->mimeType();
+		$imgsize = $this->media->getImageAttributes();
+		$filetime = $this->media->getFiletime();
+		$filetimeHeader = gmdate('D, d M Y H:i:s', $filetime) . ' GMT';	    
+		$expireHeader = gmdate('D, d M Y H:i:s', WT_TIMESTAMP + $this->getExpireOffset()) . ' GMT';
 	    
-	    $type = Functions::isImageTypeSupported($imgsize['ext']);
-	    $usewatermark = false;
-	    // if this image supports watermarks and the watermark module is intalled...
-	    if ($type) {
-	        $usewatermark = $this->isShowWatermark();
-	    }
+		$type = Functions::isImageTypeSupported($imgsize['ext']);
+		$usewatermark = false;
+		// if this image supports watermarks and the watermark module is intalled...
+		if ($type) {
+			$usewatermark = $this->isShowWatermark();
+		}
 	    
-	    // determine whether we have enough memory to watermark this image
-	    if ($usewatermark) {
-	        if (!FunctionsMedia::hasMemoryForImage($serverFilename)) {
-	            // not enough memory to watermark this file
-	            $usewatermark = false;
-	        }
-	    }
+		// determine whether we have enough memory to watermark this image
+		if ($usewatermark) {
+			if (!FunctionsMedia::hasMemoryForImage($serverFilename)) {
+				// not enough memory to watermark this file
+				$usewatermark = false;
+			}
+		}
 	    
-	    $etag = $this->media->getEtag();
+		$etag = $this->media->getEtag();
 	    
-	    // parse IF_MODIFIED_SINCE header from client
-	    $if_modified_since = 'x';
-	    if (!empty(Filter::server('HTTP_IF_MODIFIED_SINCE'))) {
-	        $if_modified_since = preg_replace('/;.*$/', '', Filter::server('HTTP_IF_MODIFIED_SINCE'));
-	    }
+		// parse IF_MODIFIED_SINCE header from client
+		$if_modified_since = 'x';
+		if (!empty(Filter::server('HTTP_IF_MODIFIED_SINCE'))) {
+			$if_modified_since = preg_replace('/;.*$/', '', Filter::server('HTTP_IF_MODIFIED_SINCE'));
+		}
 	    
-	    // parse IF_NONE_MATCH header from client
-	    $if_none_match = 'x';
-	    if (!empty(Filter::server('HTTP_IF_NONE_MATCH'))) {
-	        $if_none_match = str_replace('"', '', Filter::server('HTTP_IF_NONE_MATCH'));
-	    }
+		// parse IF_NONE_MATCH header from client
+		$if_none_match = 'x';
+		if (!empty(Filter::server('HTTP_IF_NONE_MATCH'))) {
+			$if_none_match = str_replace('"', '', Filter::server('HTTP_IF_NONE_MATCH'));
+		}
 	    
-	    // add caching headers.  allow browser to cache file, but not proxy
-	    header('Last-Modified: ' . $filetimeHeader);
-	    header('ETag: "' . $etag . '"');
-	    header('Expires: ' . $expireHeader);
-	    header('Cache-Control: max-age=' . $this->getExpireOffset() . ', s-maxage=0, proxy-revalidate');
+		// add caching headers.  allow browser to cache file, but not proxy
+		header('Last-Modified: ' . $filetimeHeader);
+		header('ETag: "' . $etag . '"');
+		header('Expires: ' . $expireHeader);
+		header('Cache-Control: max-age=' . $this->getExpireOffset() . ', s-maxage=0, proxy-revalidate');
 	    
-	    // if this file is already in the user’s cache, don’t resend it
-	    // first check if the if_modified_since param matches
-	    if ($if_modified_since === $filetimeHeader) {
-	        // then check if the etag matches
-	        if ($if_none_match === $etag) {
-	            http_response_code(304);
+		// if this file is already in the user’s cache, don’t resend it
+		// first check if the if_modified_since param matches
+		if ($if_modified_since === $filetimeHeader) {
+			// then check if the etag matches
+			if ($if_none_match === $etag) {
+				http_response_code(304);
 	    
-	            return;
-	        }
-	    }	    
+				return;
+			}
+		}	    
 
-	    // send headers for the image
-	    $disposition = $this->as_attachment ? 'attachment' : 'inline';
-	    header('Content-Type: ' . $mimetype);
-	    header('Content-Disposition: ' . $disposition . '; filename="' . addslashes(basename($this->media->getFilename())) . '"');
+		// send headers for the image
+		$disposition = $this->as_attachment ? 'attachment' : 'inline';
+		header('Content-Type: ' . $mimetype);
+		header('Content-Disposition: ' . $disposition . '; filename="' . addslashes(basename($this->media->getFilename())) . '"');
 	     
-	    if ($usewatermark) {
-	        // generate the watermarked image
-	        $imCreateFunc = 'imagecreatefrom' . $type;
-	        $imSendFunc   = 'image' . $type;
+		if ($usewatermark) {
+			// generate the watermarked image
+			$imCreateFunc = 'imagecreatefrom' . $type;
+			$imSendFunc   = 'image' . $type;
 	    
-	        if (function_exists($imCreateFunc) && function_exists($imSendFunc)) {
-	            $im = $imCreateFunc($serverFilename);
-	            $im = $this->applyWatermark($im);
+			if (function_exists($imCreateFunc) && function_exists($imSendFunc)) {
+				$im = $imCreateFunc($serverFilename);
+				$im = $this->applyWatermark($im);
 	    	    
-	            // send the image
-	            $imSendFunc($im);
-	            imagedestroy($im);
+				// send the image
+				$imSendFunc($im);
+				imagedestroy($im);
 	    
-	            return;
-	        } else {
-	            // this image is defective.  log it
-	            Log::addMediaLog('Image Builder error: >' . I18N::translate('This media file is broken and cannot be watermarked.') . '< in file >' . $serverFilename . '< memory used: ' . memory_get_usage());
-	        }
-	    }
+				return;
+			} else {
+				// this image is defective.  log it
+				Log::addMediaLog('Image Builder error: >' . I18N::translate('This media file is broken and cannot be watermarked.') . '< in file >' . $serverFilename . '< memory used: ' . memory_get_usage());
+			}
+		}
 	    
-	    // determine filesize of image (could be original or watermarked version)
-	    $filesize = filesize($serverFilename);
+		// determine filesize of image (could be original or watermarked version)
+		$filesize = filesize($serverFilename);
 	    
-	    // set content-length header, send file
-	    header('Content-Length: ' . $filesize);
+		// set content-length header, send file
+		header('Content-Length: ' . $filesize);
 	    
-	    // Some servers disable fpassthru() and readfile()
-	    if (function_exists('readfile')) {
-	        readfile($serverFilename);
-	    } else {
-	        $fp = fopen($serverFilename, 'rb');
-	        if (function_exists('fpassthru')) {
-	            fpassthru($fp);
-	        } else {
-	            while (!feof($fp)) {
-	                echo fread($fp, 65536);
-	            }
-	        }
-	        fclose($fp);
-	    }	    
+		// Some servers disable fpassthru() and readfile()
+		if (function_exists('readfile')) {
+			readfile($serverFilename);
+		} else {
+			$fp = fopen($serverFilename, 'rb');
+			if (function_exists('fpassthru')) {
+				fpassthru($fp);
+			} else {
+				while (!feof($fp)) {
+					echo fread($fp, 65536);
+				}
+			}
+			fclose($fp);
+		}	    
 	}
 	
 	/**
 	 * Render an error as an image.
 	 */
 	protected function renderError() {	
-	    $error = I18N::translate('The media file was not found in this family tree.');
+		$error = I18N::translate('The media file was not found in this family tree.');
 
-    	$width  = (mb_strlen($error) * 6.5 + 50) * 1.15;
-    	$height = 60;
-    	$im     = imagecreatetruecolor($width, $height); /* Create a black image */
-    	$bgc    = imagecolorallocate($im, 255, 255, 255); /* set background color */
-    	imagefilledrectangle($im, 2, 2, $width - 4, $height - 4, $bgc); /* create a rectangle, leaving 2 px border */
+		$width  = (mb_strlen($error) * 6.5 + 50) * 1.15;
+		$height = 60;
+		$im     = imagecreatetruecolor($width, $height); /* Create a black image */
+		$bgc    = imagecolorallocate($im, 255, 255, 255); /* set background color */
+		imagefilledrectangle($im, 2, 2, $width - 4, $height - 4, $bgc); /* create a rectangle, leaving 2 px border */
     
-    	$this->embedText($im, $error, 100, '255, 0, 0', WT_ROOT . Config::FONT_DEJAVU_SANS_TTF, 'top', 'left');
+		$this->embedText($im, $error, 100, '255, 0, 0', WT_ROOT . Config::FONT_DEJAVU_SANS_TTF, 'top', 'left');
     
-    	http_response_code(404);
-    	header('Content-Type: image/png');
-    	imagepng($im);
-    	imagedestroy($im);
+		http_response_code(404);
+		header('Content-Type: image/png');
+		imagepng($im);
+		imagedestroy($im);
 	}
 	
 	/**
@@ -297,25 +297,25 @@ 
 	 */
 	protected function applyWatermark($im) {
 	    
-	    // text to watermark with	    
-	    if(method_exists($this->media, 'getWatermarkText')) {
-	       $word1_text = $this->media->getWatermarkText();
-	    }
-	    else {
-	        $word1_text = $this->media->getTitle();
-	    }
+		// text to watermark with	    
+		if(method_exists($this->media, 'getWatermarkText')) {
+		   $word1_text = $this->media->getWatermarkText();
+		}
+		else {
+			$word1_text = $this->media->getTitle();
+		}
 	
-	    $this->embedText(
-	        $im, 
-	        $word1_text, 
-	        $this->font_max_size,
-	        $this->font_color,
-	        WT_ROOT . Config::FONT_DEJAVU_SANS_TTF,
-	        'top', 
-	        'left'
-	     );
+		$this->embedText(
+			$im, 
+			$word1_text, 
+			$this->font_max_size,
+			$this->font_color,
+			WT_ROOT . Config::FONT_DEJAVU_SANS_TTF,
+			'top', 
+			'left'
+		 );
 	
-	    return ($im);
+		return ($im);
 	}
 	
 	/**
@@ -332,94 +332,94 @@ 
 	 */
 	protected function embedText($im, $text, $maxsize, $color, $font, $vpos, $hpos) {
 	    
-	    // there are two ways to embed text with PHP
-	    // (preferred) using GD and FreeType you can embed text using any True Type font
-	    // (fall back) if that is not available, you can insert basic monospaced text
+		// there are two ways to embed text with PHP
+		// (preferred) using GD and FreeType you can embed text using any True Type font
+		// (fall back) if that is not available, you can insert basic monospaced text
 	    
-	    $col = $this->hexrgb($color);
-	    $textcolor = imagecolorallocate($im, $col['red'], $col['green'], $col['blue']);
+		$col = $this->hexrgb($color);
+		$textcolor = imagecolorallocate($im, $col['red'], $col['green'], $col['blue']);
 	    
-	    // make adjustments to settings that imagestring and imagestringup can’t handle
-	    if (!$this->use_ttf) {
-	        // imagestringup only writes up, can’t use top2bottom
-	        if ($hpos === 'top2bottom') {
-	            $hpos = 'bottom2top';
-	        }
-	    }
+		// make adjustments to settings that imagestring and imagestringup can’t handle
+		if (!$this->use_ttf) {
+			// imagestringup only writes up, can’t use top2bottom
+			if ($hpos === 'top2bottom') {
+				$hpos = 'bottom2top';
+			}
+		}
 	    
-	    $text       = I18N::reverseText($text);
-	    $height     = imagesy($im);
-	    $width      = imagesx($im);
-	    $calc_angle = rad2deg(atan($height / $width));
-	    $hypoth     = $height / sin(deg2rad($calc_angle));
+		$text       = I18N::reverseText($text);
+		$height     = imagesy($im);
+		$width      = imagesx($im);
+		$calc_angle = rad2deg(atan($height / $width));
+		$hypoth     = $height / sin(deg2rad($calc_angle));
 	    
-	    // vertical and horizontal position of the text
-	    switch ($vpos) {
-	        default:
-	        case 'top':
-	            $taille   = $this->textLength($maxsize, $width, $text);
-	            $pos_y    = $height * 0.15 + $taille;
-	            $pos_x    = $width * 0.15;
-	            $rotation = 0;
-	            break;
-	        case 'middle':
-	            $taille   = $this->textLength($maxsize, $width, $text);
-	            $pos_y    = ($height + $taille) / 2;
-	            $pos_x    = $width * 0.15;
-	            $rotation = 0;
-	            break;
-	        case 'bottom':
-	            $taille   = $this->textLength($maxsize, $width, $text);
-	            $pos_y    = ($height * .85 - $taille);
-	            $pos_x    = $width * 0.15;
-	            $rotation = 0;
-	            break;
-	        case 'across':
-	            switch ($hpos) {
-	                default:
-	                case 'left':
-	                    $taille   = $this->textLength($maxsize, $hypoth, $text);
-	                    $pos_y    = ($height * .85 - $taille);
-	                    $pos_x    = $width * 0.15;
-	                    $rotation = $calc_angle;
-	                    break;
-	                case 'right':
-	                    $taille   = $this->textLength($maxsize, $hypoth, $text);
-	                    $pos_y    = ($height * .15 - $taille);
-	                    $pos_x    = $width * 0.85;
-	                    $rotation = $calc_angle + 180;
-	                    break;
-	                case 'top2bottom':
-	                    $taille   = $this->textLength($maxsize, $height, $text);
-	                    $pos_y    = ($height * .15 - $taille);
-	                    $pos_x    = ($width * .90 - $taille);
-	                    $rotation = -90;
-	                    break;
-	                case 'bottom2top':
-	                    $taille   = $this->textLength($maxsize, $height, $text);
-	                    $pos_y    = $height * 0.85;
-	                    $pos_x    = $width * 0.15;
-	                    $rotation = 90;
-	                    break;
-	            }
-	            break;
-	    }
+		// vertical and horizontal position of the text
+		switch ($vpos) {
+			default:
+			case 'top':
+				$taille   = $this->textLength($maxsize, $width, $text);
+				$pos_y    = $height * 0.15 + $taille;
+				$pos_x    = $width * 0.15;
+				$rotation = 0;
+				break;
+			case 'middle':
+				$taille   = $this->textLength($maxsize, $width, $text);
+				$pos_y    = ($height + $taille) / 2;
+				$pos_x    = $width * 0.15;
+				$rotation = 0;
+				break;
+			case 'bottom':
+				$taille   = $this->textLength($maxsize, $width, $text);
+				$pos_y    = ($height * .85 - $taille);
+				$pos_x    = $width * 0.15;
+				$rotation = 0;
+				break;
+			case 'across':
+				switch ($hpos) {
+					default:
+					case 'left':
+						$taille   = $this->textLength($maxsize, $hypoth, $text);
+						$pos_y    = ($height * .85 - $taille);
+						$pos_x    = $width * 0.15;
+						$rotation = $calc_angle;
+						break;
+					case 'right':
+						$taille   = $this->textLength($maxsize, $hypoth, $text);
+						$pos_y    = ($height * .15 - $taille);
+						$pos_x    = $width * 0.85;
+						$rotation = $calc_angle + 180;
+						break;
+					case 'top2bottom':
+						$taille   = $this->textLength($maxsize, $height, $text);
+						$pos_y    = ($height * .15 - $taille);
+						$pos_x    = ($width * .90 - $taille);
+						$rotation = -90;
+						break;
+					case 'bottom2top':
+						$taille   = $this->textLength($maxsize, $height, $text);
+						$pos_y    = $height * 0.85;
+						$pos_x    = $width * 0.15;
+						$rotation = 90;
+						break;
+				}
+				break;
+		}
 	    
-	    // apply the text
-	    if ($this->use_ttf) {
-	        // if imagettftext throws errors, catch them with a custom error handler
-	        set_error_handler(array($this, 'imageTtfTextErrorHandler'));
-	        imagettftext($im, $taille, $rotation, $pos_x, $pos_y, $textcolor, $font, $text);
-	        restore_error_handler();
-	    }
-	    // Don’t use an ‘else’ here since imagettftextErrorHandler may have changed the value of $useTTF from true to false
-	    if (!$this->use_ttf) {
-	        if ($rotation !== 90) {
-	            imagestring($im, 5, $pos_x, $pos_y, $text, $textcolor);
-	        } else {
-	            imagestringup($im, 5, $pos_x, $pos_y, $text, $textcolor);
-	        }
-	    }
+		// apply the text
+		if ($this->use_ttf) {
+			// if imagettftext throws errors, catch them with a custom error handler
+			set_error_handler(array($this, 'imageTtfTextErrorHandler'));
+			imagettftext($im, $taille, $rotation, $pos_x, $pos_y, $textcolor, $font, $text);
+			restore_error_handler();
+		}
+		// Don’t use an ‘else’ here since imagettftextErrorHandler may have changed the value of $useTTF from true to false
+		if (!$this->use_ttf) {
+			if ($rotation !== 90) {
+				imagestring($im, 5, $pos_x, $pos_y, $text, $textcolor);
+			} else {
+				imagestringup($im, 5, $pos_x, $pos_y, $text, $textcolor);
+			}
+		}
 	
 	}
 	
@@ -431,53 +431,53 @@ 
 	 */
 	protected function hexrgb ($hexstr)
 	{
-	    $int = hexdec($hexstr);
+		$int = hexdec($hexstr);
 	
-	    return array('red' => 0xFF & ($int >> 0x10),
-	        'green' => 0xFF & ($int >> 0x8),
-	        'blue' => 0xFF & $int);
+		return array('red' => 0xFF & ($int >> 0x10),
+			'green' => 0xFF & ($int >> 0x8),
+			'blue' => 0xFF & $int);
 	}
 	
-    /**
-     * Generate an approximate length of text, in pixels.
-     *
-     * @param int    $t
-     * @param int    $mxl
-     * @param string $text
-     *
-     * @return int
-     */
-    function textLength($t, $mxl, $text) {
-    	$taille_c = $t;
-    	$len      = mb_strlen($text);
-    	while (($taille_c - 2) * $len > $mxl) {
-    		$taille_c--;
-    		if ($taille_c == 2) {
-    			break;
-    		}
-    	}
+	/**
+	 * Generate an approximate length of text, in pixels.
+	 *
+	 * @param int    $t
+	 * @param int    $mxl
+	 * @param string $text
+	 *
+	 * @return int
+	 */
+	function textLength($t, $mxl, $text) {
+		$taille_c = $t;
+		$len      = mb_strlen($text);
+		while (($taille_c - 2) * $len > $mxl) {
+			$taille_c--;
+			if ($taille_c == 2) {
+				break;
+			}
+		}
     
-    	return $taille_c;
-    }
+		return $taille_c;
+	}
     
-    /**
-     * imagettftext is the function that is most likely to throw an error
-     * use this custom error handler to catch and log it
-     *
-     * @param int    $errno
-     * @param string $errstr
-     *
-     * @return bool
-     */
-    function imageTtfTextErrorHandler($errno, $errstr) {
-        // log the error
-        Log::addErrorLog('Image Builder error: >' . $errno . '/' . $errstr . '< while processing file >' . $this->media->getServerFilename() . '<');
+	/**
+	 * imagettftext is the function that is most likely to throw an error
+	 * use this custom error handler to catch and log it
+	 *
+	 * @param int    $errno
+	 * @param string $errstr
+	 *
+	 * @return bool
+	 */
+	function imageTtfTextErrorHandler($errno, $errstr) {
+		// log the error
+		Log::addErrorLog('Image Builder error: >' . $errno . '/' . $errstr . '< while processing file >' . $this->media->getServerFilename() . '<');
     
-        // change value of useTTF to false so the fallback watermarking can be used.
-        $this->use_ttf = false;
+		// change value of useTTF to false so the fallback watermarking can be used.
+		$this->use_ttf = false;
     
-        return true;
-    }
+		return true;
+	}
 		
 }
 

Spacing +26 added lines, -26 removed lines

@@ -69,7 +69,7 @@ 
 	*
 	* @param Media|null $media Reference media object
 	*/
-	public function __construct(Media $media = null){
+	public function __construct(Media $media = null) {
 	    $this->media = $media;
 	    $this->use_ttf = function_exists('imagettftext');
 	    $this->expire_offset = 3600 * 24;
@@ -95,7 +95,7 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setExpireOffset($expireOffset) {
-	    if($expireOffset) $this->expire_offset = $expireOffset;
+	    if ($expireOffset) $this->expire_offset = $expireOffset;
 	    return $this;
 	}
 	
@@ -115,7 +115,7 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setShowWatermark($show_watermark) {
-	    if(!is_null($show_watermark)) $this->show_watermark = $show_watermark;
+	    if (!is_null($show_watermark)) $this->show_watermark = $show_watermark;
 	    return $this;
 	}
 	
@@ -126,7 +126,7 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontMaxSize($font_max_size) {
-	    if($font_max_size) $this->font_max_size = $font_max_size;
+	    if ($font_max_size) $this->font_max_size = $font_max_size;
 	    return $this;
 	}
 	
@@ -137,7 +137,7 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontColor($font_color) {
-	    if($font_color) $this->font_color = $font_color;
+	    if ($font_color) $this->font_color = $font_color;
 	    return $this;
 	}
 	
@@ -148,32 +148,32 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setAsAttachment($is_attachement) {
-	    if(is_bool($is_attachement)) $this->as_attachment = $is_attachement;
+	    if (is_bool($is_attachement)) $this->as_attachment = $is_attachement;
 	    return $this;
 	}
 	
 	/**
 	 * Render the image to the output.
 	 */
-	public function render(){
+	public function render() {
 	    
 	    if (!$this->media || !$this->media->canShow()) {
-	        Log::addMediaLog('Image Builder error: >' . I18N::translate('Missing or private media object.'));
+	        Log::addMediaLog('Image Builder error: >'.I18N::translate('Missing or private media object.'));
 	        $this->renderError();
 	    }
 	    
 	    $serverFilename = $this->media->getServerFilename();
 	    
 	    if (!file_exists($serverFilename)) {
-	        Log::addMediaLog('Image Builder error: >'. I18N::translate('The media object does not exist.').'< for path >'.$serverFilename.'<');
+	        Log::addMediaLog('Image Builder error: >'.I18N::translate('The media object does not exist.').'< for path >'.$serverFilename.'<');
 	        $this->renderError();
 	    }
 	    
 	    $mimetype = $this->media->mimeType();
 	    $imgsize = $this->media->getImageAttributes();
 	    $filetime = $this->media->getFiletime();
-	    $filetimeHeader = gmdate('D, d M Y H:i:s', $filetime) . ' GMT';	    
-	    $expireHeader = gmdate('D, d M Y H:i:s', WT_TIMESTAMP + $this->getExpireOffset()) . ' GMT';
+	    $filetimeHeader = gmdate('D, d M Y H:i:s', $filetime).' GMT';	    
+	    $expireHeader = gmdate('D, d M Y H:i:s', WT_TIMESTAMP + $this->getExpireOffset()).' GMT';
 	    
 	    $type = Functions::isImageTypeSupported($imgsize['ext']);
 	    $usewatermark = false;
@@ -205,10 +205,10 @@ 
 	    }
 	    
 	    // add caching headers.  allow browser to cache file, but not proxy
-	    header('Last-Modified: ' . $filetimeHeader);
-	    header('ETag: "' . $etag . '"');
-	    header('Expires: ' . $expireHeader);
-	    header('Cache-Control: max-age=' . $this->getExpireOffset() . ', s-maxage=0, proxy-revalidate');
+	    header('Last-Modified: '.$filetimeHeader);
+	    header('ETag: "'.$etag.'"');
+	    header('Expires: '.$expireHeader);
+	    header('Cache-Control: max-age='.$this->getExpireOffset().', s-maxage=0, proxy-revalidate');
 	    
 	    // if this file is already in the user’s cache, don’t resend it
 	    // first check if the if_modified_since param matches
@@ -223,13 +223,13 @@ 
 
 	    // send headers for the image
 	    $disposition = $this->as_attachment ? 'attachment' : 'inline';
-	    header('Content-Type: ' . $mimetype);
-	    header('Content-Disposition: ' . $disposition . '; filename="' . addslashes(basename($this->media->getFilename())) . '"');
+	    header('Content-Type: '.$mimetype);
+	    header('Content-Disposition: '.$disposition.'; filename="'.addslashes(basename($this->media->getFilename())).'"');
 	     
 	    if ($usewatermark) {
 	        // generate the watermarked image
-	        $imCreateFunc = 'imagecreatefrom' . $type;
-	        $imSendFunc   = 'image' . $type;
+	        $imCreateFunc = 'imagecreatefrom'.$type;
+	        $imSendFunc   = 'image'.$type;
 	    
 	        if (function_exists($imCreateFunc) && function_exists($imSendFunc)) {
 	            $im = $imCreateFunc($serverFilename);
@@ -242,7 +242,7 @@ 
 	            return;
 	        } else {
 	            // this image is defective.  log it
-	            Log::addMediaLog('Image Builder error: >' . I18N::translate('This media file is broken and cannot be watermarked.') . '< in file >' . $serverFilename . '< memory used: ' . memory_get_usage());
+	            Log::addMediaLog('Image Builder error: >'.I18N::translate('This media file is broken and cannot be watermarked.').'< in file >'.$serverFilename.'< memory used: '.memory_get_usage());
 	        }
 	    }
 	    
@@ -250,7 +250,7 @@ 
 	    $filesize = filesize($serverFilename);
 	    
 	    // set content-length header, send file
-	    header('Content-Length: ' . $filesize);
+	    header('Content-Length: '.$filesize);
 	    
 	    // Some servers disable fpassthru() and readfile()
 	    if (function_exists('readfile')) {
@@ -280,7 +280,7 @@ 
     	$bgc    = imagecolorallocate($im, 255, 255, 255); /* set background color */
     	imagefilledrectangle($im, 2, 2, $width - 4, $height - 4, $bgc); /* create a rectangle, leaving 2 px border */
     
-    	$this->embedText($im, $error, 100, '255, 0, 0', WT_ROOT . Config::FONT_DEJAVU_SANS_TTF, 'top', 'left');
+    	$this->embedText($im, $error, 100, '255, 0, 0', WT_ROOT.Config::FONT_DEJAVU_SANS_TTF, 'top', 'left');
     
     	http_response_code(404);
     	header('Content-Type: image/png');
@@ -298,7 +298,7 @@ 
 	protected function applyWatermark($im) {
 	    
 	    // text to watermark with	    
-	    if(method_exists($this->media, 'getWatermarkText')) {
+	    if (method_exists($this->media, 'getWatermarkText')) {
 	       $word1_text = $this->media->getWatermarkText();
 	    }
 	    else {
@@ -310,7 +310,7 @@ 
 	        $word1_text, 
 	        $this->font_max_size,
 	        $this->font_color,
-	        WT_ROOT . Config::FONT_DEJAVU_SANS_TTF,
+	        WT_ROOT.Config::FONT_DEJAVU_SANS_TTF,
 	        'top', 
 	        'left'
 	     );
@@ -429,7 +429,7 @@ 
 	 * @param string $hexstr
 	 * @return int[]
 	 */
-	protected function hexrgb ($hexstr)
+	protected function hexrgb($hexstr)
 	{
 	    $int = hexdec($hexstr);
 	
@@ -471,7 +471,7 @@ 
      */
     function imageTtfTextErrorHandler($errno, $errstr) {
         // log the error
-        Log::addErrorLog('Image Builder error: >' . $errno . '/' . $errstr . '< while processing file >' . $this->media->getServerFilename() . '<');
+        Log::addErrorLog('Image Builder error: >'.$errno.'/'.$errstr.'< while processing file >'.$this->media->getServerFilename().'<');
     
         // change value of useTTF to false so the fallback watermarking can be used.
         $this->use_ttf = false;

Braces +16 added lines, -7 removed lines

@@ -95,7 +95,9 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setExpireOffset($expireOffset) {
-	    if($expireOffset) $this->expire_offset = $expireOffset;
+	    if($expireOffset) {
+	    	$this->expire_offset = $expireOffset;
+	    }
 	    return $this;
 	}
 	
@@ -115,7 +117,9 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setShowWatermark($show_watermark) {
-	    if(!is_null($show_watermark)) $this->show_watermark = $show_watermark;
+	    if(!is_null($show_watermark)) {
+	    	$this->show_watermark = $show_watermark;
+	    }
 	    return $this;
 	}
 	
@@ -126,7 +130,9 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontMaxSize($font_max_size) {
-	    if($font_max_size) $this->font_max_size = $font_max_size;
+	    if($font_max_size) {
+	    	$this->font_max_size = $font_max_size;
+	    }
 	    return $this;
 	}
 	
@@ -137,7 +143,9 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setFontColor($font_color) {
-	    if($font_color) $this->font_color = $font_color;
+	    if($font_color) {
+	    	$this->font_color = $font_color;
+	    }
 	    return $this;
 	}
 	
@@ -148,7 +156,9 @@ 
 	 * @return ImageBuilder
 	 */
 	public function setAsAttachment($is_attachement) {
-	    if(is_bool($is_attachement)) $this->as_attachment = $is_attachement;
+	    if(is_bool($is_attachement)) {
+	    	$this->as_attachment = $is_attachement;
+	    }
 	    return $this;
 	}
 	
@@ -300,8 +310,7 @@ 
 	    // text to watermark with	    
 	    if(method_exists($this->media, 'getWatermarkText')) {
 	       $word1_text = $this->media->getWatermarkText();
-	    }
-	    else {
+	    } else {
 	        $word1_text = $this->media->getTitle();
 	    }
 	

src/Webtrees/Module/Sosa/Model/SosaProvider.php

Braces +80 added lines, -31 removed lines

@@ -84,21 +84,25 @@ 
      * @param User $user
      */
     public function __construct(Tree $tree, User $user = null) {
-        if(self::$default_user === null) 
-            self::$default_user = User::find(-1);
+        if(self::$default_user === null) {
+                    self::$default_user = User::find(-1);
+        }
         
         $this->tree = $tree;
         $this->user = $user;
         $this->is_setup = true;
-        if($this->user === null) $this->user = Auth::user();
-        if(strlen($this->user->getUserId()) == 0) $this->user = self::$default_user;
+        if($this->user === null) {
+        	$this->user = Auth::user();
+        }
+        if(strlen($this->user->getUserId()) == 0) {
+        	$this->user = self::$default_user;
+        }
         
         // Check if the user, or the default user, has a root already setup;
         if(empty($this->getRootIndiId())) {
             if($this->user == self::$default_user) {  // If the default user is not setup
                 $this->is_setup = false;
-            }
-            else {
+            } else {
                 $this->user = self::$default_user;
                 $this->is_setup = $this->getRootIndiId() === null;
             }            
@@ -159,7 +163,9 @@ 
      * Remove all Sosa entries related to the gedcom file and user
      */
     public function deleteAll() {
-        if(!$this->is_setup) return;
+        if(!$this->is_setup) {
+        	return;
+        }
         Database::prepare(
             'DELETE FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id= :tree_id and majs_user_id = :user_id ')
@@ -175,7 +181,9 @@ 
      * @param int $sosa
      */
     public function deleteAncestors($sosa) {
-        if(!$this->is_setup) return;
+        if(!$this->is_setup) {
+        	return;
+        }
         $gen = Functions::getGeneration($sosa);
         Database::prepare(
             'DELETE FROM `##maj_sosa`'.
@@ -195,7 +203,9 @@ 
      * @param array $sosa_records
      */
     public function insertOrUpdate($sosa_records) {
-        if(!$this->is_setup) return;
+        if(!$this->is_setup) {
+        	return;
+        }
         
         $treeid = $this->tree->getTreeId();
         $userid = $this->user->getUserId();
@@ -244,7 +254,9 @@ 
      * @return array Array of sosa numbers
      */
     public function getSosaNumbers(Individual $indi) {
-        if(!$this->is_setup) return array();
+        if(!$this->is_setup) {
+        	return array();
+        }
         return Database::prepare(
                 'SELECT majs_sosa, majs_gen FROM `##maj_sosa`'.
                 ' WHERE majs_i_id=:indi_id AND majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
@@ -261,7 +273,9 @@ 
      * @return number Last generation if found, 1 otherwise
      */
     public function getLastGeneration() {
-        if(!$this->is_setup) return;
+        if(!$this->is_setup) {
+        	return;
+        }
         return Database::prepare(
                 'SELECT MAX(majs_gen) FROM `##maj_sosa`'.
                 ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
@@ -281,7 +295,9 @@ 
      * @return array Associative array of Sosa ancestors, with their generation, comma separated
      */
     public function getAllSosaWithGenerations(){
-        if(!$this->is_setup) return array();
+        if(!$this->is_setup) {
+        	return array();
+        }
         return Database::prepare(
             'SELECT majs_i_id AS indi,' .
             ' GROUP_CONCAT(DISTINCT majs_gen ORDER BY majs_gen ASC SEPARATOR ",") AS generations' .
@@ -301,9 +317,12 @@ 
      * @return array Array of Sosa individuals
      */
     public function getSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_list_by_gen)
-            $this->sosa_list_by_gen = array();
+        if(!$this->is_setup) {
+        	return array();
+        }
+        if(!$this->sosa_list_by_gen) {
+                    $this->sosa_list_by_gen = array();
+        }
         
         if($gen){
             if(!isset($this->sosa_list_by_gen[$gen])){
@@ -332,9 +351,12 @@ 
      * @return array Array of Sosa families
      */
     public function getFamilySosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_fam_list_by_gen)
-            $this->sosa_fam_list_by_gen = array();
+        if(!$this->is_setup) {
+        	return array();
+        }
+        if(!$this->sosa_fam_list_by_gen) {
+                    $this->sosa_fam_list_by_gen = array();
+        }
         
         if($gen){
             if(!isset($this->sosa_fam_list_by_gen[$gen])){
@@ -368,7 +390,9 @@ 
      * @return array Array of Sosa individuals
      */
     public function getMissingSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();    
+        if(!$this->is_setup) {
+        	return array();
+        }
         if($gen){
             return $this->sosa_list_by_gen[$gen] = Database::prepare(
                 'SELECT schild.majs_sosa sosa, schild.majs_i_id indi, sfat.majs_sosa IS NOT NULL has_father, smot.majs_sosa IS NOT NULL has_mother'.
@@ -408,7 +432,9 @@ 
      * @return array Statistics array
      */
     public function getStatisticsByGeneration() {
-        if(!$this->is_setup) return array();
+        if(!$this->is_setup) {
+        	return array();
+        }
         if(!$this->statistics_tab) {
             $this->statistics_tab = array();
             if($maxGeneration = $this->getLastGeneration()) {
@@ -436,7 +462,9 @@ 
 	 * @return int
 	 */
 	public function getTotalIndividuals() {
-	    if(!$this->is_setup) return 0;
+	    if(!$this->is_setup) {
+	    	return 0;
+	    }
 	    return Database::prepare(
 	        'SELECT COUNT(*) FROM `##individuals`' .
 	        ' WHERE i_file = :tree_id')
@@ -450,7 +478,9 @@ 
      * @return number Number of Sosas
      */
     public function getSosaCount(){
-        if(!$this->is_setup) return 0;
+        if(!$this->is_setup) {
+        	return 0;
+        }
         return Database::prepare(
             'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
@@ -467,7 +497,9 @@ 
      * @return number Number of Sosas in generation
      */
     public function getSosaCountAtGeneration($gen){
-        if(!$this->is_setup) return 0;
+        if(!$this->is_setup) {
+        	return 0;
+        }
         return Database::prepare(
             'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
@@ -486,7 +518,9 @@ 
      * @return number Total number of Sosas up to generation
      */
     public function getSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
+        if(!$this->is_setup) {
+        	return 0;
+        }
         return Database::prepare(
             'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
@@ -504,7 +538,9 @@ 
      * @return number Total number of distinct individual
      */
     public function getDifferentSosaCount(){
-        if(!$this->is_setup) return 0;
+        if(!$this->is_setup) {
+        	return 0;
+        }
         return Database::prepare(
             'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
@@ -521,7 +557,9 @@ 
      * @return number Number of distinct Sosa individuals up to generation
      */
     public function getDifferentSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
+        if(!$this->is_setup) {
+        	return 0;
+        }
         return Database::prepare(
             'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
@@ -546,7 +584,9 @@ 
      * @return array Birth statistics array
      */
     public function getStatsBirthYearInGeneration($gen){
-        if(!$this->is_setup) return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
+        if(!$this->is_setup) {
+        	return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
+        }
         return Database::prepare(
             'SELECT'.
             ' MIN(majs_birth_year) AS first, MIN(majs_birth_year_est) AS first_est,'.
@@ -568,7 +608,9 @@ 
      * @return number|NULL Mean generation time
      */
     public function getMeanGenerationTime(){
-        if(!$this->is_setup) return;
+        if(!$this->is_setup) {
+        	return;
+        }
         if(!$this->statistics_tab){
             $this->getStatisticsByGeneration();
         }
@@ -610,7 +652,9 @@ 
      * @return array
      */
     public function getGenerationDepthStatsAtGen($gen) {
-        if(!$this->is_setup) return array();
+        if(!$this->is_setup) {
+        	return array();
+        }
         $gen_depth_stats_raw = Database::prepare(
             'SELECT stats_by_gen.root_ancestor AS root_ancestor_sosa,'.
             '   sosa_list.majs_i_id as root_ancestor_id,'.
@@ -685,7 +729,10 @@ 
      * @return array
      */
     public function getAncestorDispersionForGen($gen) {
-        if(!$this->is_setup || $gen > 11) return array();  // Going further than 11 gen will be out of range in the query
+        if(!$this->is_setup || $gen > 11) {
+        	return array();
+        }
+        // Going further than 11 gen will be out of range in the query
         return Database::prepare(
             'SELECT branches, count(i_id)'.
             ' FROM ('.
@@ -725,7 +772,9 @@ 
      * @return array 
      */
     public function getTopMultiSosaAncestorsNoTies($limit) {
-        if(!$this->is_setup) return array();
+        if(!$this->is_setup) {
+        	return array();
+        }
         return Database::prepare(
             'SELECT sosa_i_id, sosa_count FROM ('.
             '   SELECT'.

Indentation +710 added lines, -710 removed lines

@@ -22,413 +22,413 @@ 
  */
 class SosaProvider {
     
-    /**
-     * Maximum number of generation the database is able to hold.
-     * @var int MAX_DB_GENERATIONS
-     */
-    const MAX_DB_GENERATIONS = 64;
-    
-    /**
-     * System's default user (ID -1 in the database
-     * @var User $default_user
-     */
-    protected static $default_user;
-    
-    /**
-     * Reference user
-     * @var User $user
-     */
-    protected $user;
-    
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    protected $tree;
-    
-    /**
-     * Cached list of Sosa Individuals by generation
-     * Format: key = generation, value = array ( sosa => Individual ID)
-     * @var array $sosa_list_by_gen
-     */
-    protected $sosa_list_by_gen;
-    
-    /**
-     * Cached list of Sosa Families by generation
-     * Format: key = generation, value = array ( sosa => Family ID)
-     * @var unknown $sosa_fam_list_by_gen
-     */
-    protected $sosa_fam_list_by_gen;
-    
-    /**
-     * Cached array of statistics by generation
-     * Format:  key = generation, 
-     *          value = array(
-     *              sosaCount, sosaTotalCount, diffSosaTotalCount, firstBirth, lastBirth, avgBirth
-     *           )
-     * @var array $statistics_tab
-     */
-    protected $statistics_tab;
-    
-    /**
-     * Has the provider's initialisation completed
-     * @var bool $is_setup
-     */
-    protected $is_setup;
-    
-    /**
-     * Constructor for Sosa Provider.
-     * A provider is defined in relation to a specific tree and reference user.
-     * 
-     * @param Tree $tree
-     * @param User $user
-     */
-    public function __construct(Tree $tree, User $user = null) {
-        if(self::$default_user === null) 
-            self::$default_user = User::find(-1);
+	/**
+	 * Maximum number of generation the database is able to hold.
+	 * @var int MAX_DB_GENERATIONS
+	 */
+	const MAX_DB_GENERATIONS = 64;
+    
+	/**
+	 * System's default user (ID -1 in the database
+	 * @var User $default_user
+	 */
+	protected static $default_user;
+    
+	/**
+	 * Reference user
+	 * @var User $user
+	 */
+	protected $user;
+    
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	protected $tree;
+    
+	/**
+	 * Cached list of Sosa Individuals by generation
+	 * Format: key = generation, value = array ( sosa => Individual ID)
+	 * @var array $sosa_list_by_gen
+	 */
+	protected $sosa_list_by_gen;
+    
+	/**
+	 * Cached list of Sosa Families by generation
+	 * Format: key = generation, value = array ( sosa => Family ID)
+	 * @var unknown $sosa_fam_list_by_gen
+	 */
+	protected $sosa_fam_list_by_gen;
+    
+	/**
+	 * Cached array of statistics by generation
+	 * Format:  key = generation, 
+	 *          value = array(
+	 *              sosaCount, sosaTotalCount, diffSosaTotalCount, firstBirth, lastBirth, avgBirth
+	 *           )
+	 * @var array $statistics_tab
+	 */
+	protected $statistics_tab;
+    
+	/**
+	 * Has the provider's initialisation completed
+	 * @var bool $is_setup
+	 */
+	protected $is_setup;
+    
+	/**
+	 * Constructor for Sosa Provider.
+	 * A provider is defined in relation to a specific tree and reference user.
+	 * 
+	 * @param Tree $tree
+	 * @param User $user
+	 */
+	public function __construct(Tree $tree, User $user = null) {
+		if(self::$default_user === null) 
+			self::$default_user = User::find(-1);
         
-        $this->tree = $tree;
-        $this->user = $user;
-        $this->is_setup = true;
-        if($this->user === null) $this->user = Auth::user();
-        if(strlen($this->user->getUserId()) == 0) $this->user = self::$default_user;
+		$this->tree = $tree;
+		$this->user = $user;
+		$this->is_setup = true;
+		if($this->user === null) $this->user = Auth::user();
+		if(strlen($this->user->getUserId()) == 0) $this->user = self::$default_user;
         
-        // Check if the user, or the default user, has a root already setup;
-        if(empty($this->getRootIndiId())) {
-            if($this->user == self::$default_user) {  // If the default user is not setup
-                $this->is_setup = false;
-            }
-            else {
-                $this->user = self::$default_user;
-                $this->is_setup = $this->getRootIndiId() === null;
-            }            
-        }
-    }
-    
-    /**
-     * Returns is the Provider has been successfully set up
-     * @return bool
-     */
-    public function isSetup() {
-        return $this->is_setup;
-    }
-    
-    /**
-     * Return the reference tree
-     * 
-     *  @return Tree Reference tree
-     */
-    public function getTree() {
-        return $this->tree;
-    }
-    
-    /**
-     * Return the reference user
-     * 
-     * @return User
-     */
-    public function getUser() {
-        return $this->user;
-    }
-    
-    /**
-     * Return the root individual ID for the reference tree and user.
-     * @return string Individual ID
-     */
-    public function getRootIndiId() {
-        return $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
-    }
-    
-    /**
-     * Return the root individual for the reference tree and user.
-     * @return Individual Individual
-     */
-    public function getRootIndi() {
-        $root_indi_id = $this->getRootIndiId();
-        if(!empty($root_indi_id)) {
-            return Individual::getInstance($root_indi_id, $this->tree);
-        }
-        return null;
-    }
+		// Check if the user, or the default user, has a root already setup;
+		if(empty($this->getRootIndiId())) {
+			if($this->user == self::$default_user) {  // If the default user is not setup
+				$this->is_setup = false;
+			}
+			else {
+				$this->user = self::$default_user;
+				$this->is_setup = $this->getRootIndiId() === null;
+			}            
+		}
+	}
+    
+	/**
+	 * Returns is the Provider has been successfully set up
+	 * @return bool
+	 */
+	public function isSetup() {
+		return $this->is_setup;
+	}
+    
+	/**
+	 * Return the reference tree
+	 * 
+	 *  @return Tree Reference tree
+	 */
+	public function getTree() {
+		return $this->tree;
+	}
+    
+	/**
+	 * Return the reference user
+	 * 
+	 * @return User
+	 */
+	public function getUser() {
+		return $this->user;
+	}
+    
+	/**
+	 * Return the root individual ID for the reference tree and user.
+	 * @return string Individual ID
+	 */
+	public function getRootIndiId() {
+		return $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
+	}
+    
+	/**
+	 * Return the root individual for the reference tree and user.
+	 * @return Individual Individual
+	 */
+	public function getRootIndi() {
+		$root_indi_id = $this->getRootIndiId();
+		if(!empty($root_indi_id)) {
+			return Individual::getInstance($root_indi_id, $this->tree);
+		}
+		return null;
+	}
        
-    /*****************
+	/*****************
      * DATA CRUD LAYER
      *****************/
     
-    /**
-     * Remove all Sosa entries related to the gedcom file and user
-     */
-    public function deleteAll() {
-        if(!$this->is_setup) return;
-        Database::prepare(
-            'DELETE FROM `##maj_sosa`'.
-            ' WHERE majs_gedcom_id= :tree_id and majs_user_id = :user_id ')
-            ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId()                
-            ));
-    }
-    
-    /**
-     * Remove all ancestors of a sosa number
-     * 
-     * @param int $sosa
-     */
-    public function deleteAncestors($sosa) {
-        if(!$this->is_setup) return;
-        $gen = Functions::getGeneration($sosa);
-        Database::prepare(
-            'DELETE FROM `##maj_sosa`'.
-            ' WHERE majs_gedcom_id=:tree_id and majs_user_id = :user_id' .
-            ' AND majs_gen >= :gen' .
-            ' AND FLOOR(majs_sosa / (POW(2, (majs_gen - :gen)))) = :sosa'
-        )->execute(array(
-            'tree_id' => $this->tree->getTreeId(), 
-            'user_id' => $this->user->getUserId(),
-            'gen' => $gen,
-            'sosa' => $sosa
-        ));
-    }    
-    
-    /**
-     * Insert (or update if already existing) a list of Sosa individuals
-     * @param array $sosa_records
-     */
-    public function insertOrUpdate($sosa_records) {
-        if(!$this->is_setup) return;
+	/**
+	 * Remove all Sosa entries related to the gedcom file and user
+	 */
+	public function deleteAll() {
+		if(!$this->is_setup) return;
+		Database::prepare(
+			'DELETE FROM `##maj_sosa`'.
+			' WHERE majs_gedcom_id= :tree_id and majs_user_id = :user_id ')
+			->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId()                
+			));
+	}
+    
+	/**
+	 * Remove all ancestors of a sosa number
+	 * 
+	 * @param int $sosa
+	 */
+	public function deleteAncestors($sosa) {
+		if(!$this->is_setup) return;
+		$gen = Functions::getGeneration($sosa);
+		Database::prepare(
+			'DELETE FROM `##maj_sosa`'.
+			' WHERE majs_gedcom_id=:tree_id and majs_user_id = :user_id' .
+			' AND majs_gen >= :gen' .
+			' AND FLOOR(majs_sosa / (POW(2, (majs_gen - :gen)))) = :sosa'
+		)->execute(array(
+			'tree_id' => $this->tree->getTreeId(), 
+			'user_id' => $this->user->getUserId(),
+			'gen' => $gen,
+			'sosa' => $sosa
+		));
+	}    
+    
+	/**
+	 * Insert (or update if already existing) a list of Sosa individuals
+	 * @param array $sosa_records
+	 */
+	public function insertOrUpdate($sosa_records) {
+		if(!$this->is_setup) return;
         
-        $treeid = $this->tree->getTreeId();
-        $userid = $this->user->getUserId();
-        $questionmarks_table = array();
-        $values_table = array();
+		$treeid = $this->tree->getTreeId();
+		$userid = $this->user->getUserId();
+		$questionmarks_table = array();
+		$values_table = array();
         
-        $i = 0;
-        foreach  ($sosa_records as $row) {
-            $gen = Functions::getGeneration($row['sosa']);
-            if($gen <= self::MAX_DB_GENERATIONS) {
-                $questionmarks_table[] = 
-                    '(:tree_id'.$i.', :user_id'.$i.', :sosa'.$i.', :indi_id'.$i.', :gen'.$i.', :byear'.$i.', :byearest'.$i.', :dyear'.$i.', :dyearest'.$i.')';
-                $values_table = array_merge(
-                    $values_table, 
-                    array(
-                        'tree_id'.$i => $treeid, 
-                        'user_id'.$i => $userid, 
-                        'sosa'.$i => $row['sosa'], 
-                        'indi_id'.$i => $row['indi'], 
-                        'gen'.$i => Functions::getGeneration($row['sosa']),
-                        'byear'.$i => $row['birth_year'],
-                        'byearest'.$i => $row['birth_year_est'],
-                        'dyear'.$i => $row['death_year'],
-                        'dyearest'.$i => $row['death_year_est']
-                    )
-                );
-            }
-            $i++;
-        }
+		$i = 0;
+		foreach  ($sosa_records as $row) {
+			$gen = Functions::getGeneration($row['sosa']);
+			if($gen <= self::MAX_DB_GENERATIONS) {
+				$questionmarks_table[] = 
+					'(:tree_id'.$i.', :user_id'.$i.', :sosa'.$i.', :indi_id'.$i.', :gen'.$i.', :byear'.$i.', :byearest'.$i.', :dyear'.$i.', :dyearest'.$i.')';
+				$values_table = array_merge(
+					$values_table, 
+					array(
+						'tree_id'.$i => $treeid, 
+						'user_id'.$i => $userid, 
+						'sosa'.$i => $row['sosa'], 
+						'indi_id'.$i => $row['indi'], 
+						'gen'.$i => Functions::getGeneration($row['sosa']),
+						'byear'.$i => $row['birth_year'],
+						'byearest'.$i => $row['birth_year_est'],
+						'dyear'.$i => $row['death_year'],
+						'dyearest'.$i => $row['death_year_est']
+					)
+				);
+			}
+			$i++;
+		}
         
-        $sql = 'REPLACE INTO `##maj_sosa`' .
-            ' (majs_gedcom_id, majs_user_id, majs_sosa, majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)' .
-            ' VALUES '. implode(',', $questionmarks_table);
-        Database::prepare($sql)->execute($values_table);
-    }
+		$sql = 'REPLACE INTO `##maj_sosa`' .
+			' (majs_gedcom_id, majs_user_id, majs_sosa, majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)' .
+			' VALUES '. implode(',', $questionmarks_table);
+		Database::prepare($sql)->execute($values_table);
+	}
     
-    /****************
+	/****************
      * SIMPLE QUERIES
      ****************/
     
-    /**
-     * Returns the list of Sosa numbers to which an individual is related.
-     * Format: key = sosa number, value = generation for the Sosa number
-     * 
-     * @param Individual $indi
-     * @return array Array of sosa numbers
-     */
-    public function getSosaNumbers(Individual $indi) {
-        if(!$this->is_setup) return array();
-        return Database::prepare(
-                'SELECT majs_sosa, majs_gen FROM `##maj_sosa`'.
-                ' WHERE majs_i_id=:indi_id AND majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
-            )->execute(array(
-                'indi_id' => $indi->getXref(), 
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId()
-            ))->fetchAssoc();
-    }
-    
-    /**
-     * Get the last generation of Sosa ancestors
-     *
-     * @return number Last generation if found, 1 otherwise
-     */
-    public function getLastGeneration() {
-        if(!$this->is_setup) return;
-        return Database::prepare(
-                'SELECT MAX(majs_gen) FROM `##maj_sosa`'.
-                ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
-            )->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId()                
-            ))->fetchOne() ?: 1;
-    }
-    
-    /*************
+	/**
+	 * Returns the list of Sosa numbers to which an individual is related.
+	 * Format: key = sosa number, value = generation for the Sosa number
+	 * 
+	 * @param Individual $indi
+	 * @return array Array of sosa numbers
+	 */
+	public function getSosaNumbers(Individual $indi) {
+		if(!$this->is_setup) return array();
+		return Database::prepare(
+				'SELECT majs_sosa, majs_gen FROM `##maj_sosa`'.
+				' WHERE majs_i_id=:indi_id AND majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
+			)->execute(array(
+				'indi_id' => $indi->getXref(), 
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId()
+			))->fetchAssoc();
+	}
+    
+	/**
+	 * Get the last generation of Sosa ancestors
+	 *
+	 * @return number Last generation if found, 1 otherwise
+	 */
+	public function getLastGeneration() {
+		if(!$this->is_setup) return;
+		return Database::prepare(
+				'SELECT MAX(majs_gen) FROM `##maj_sosa`'.
+				' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
+			)->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId()                
+			))->fetchOne() ?: 1;
+	}
+    
+	/*************
      * SOSA LISTS
      *************/
     
-    /**
-     * Return the list of all sosas, with the generations it belongs to
-     *
-     * @return array Associative array of Sosa ancestors, with their generation, comma separated
-     */
-    public function getAllSosaWithGenerations(){
-        if(!$this->is_setup) return array();
-        return Database::prepare(
-            'SELECT majs_i_id AS indi,' .
-            ' GROUP_CONCAT(DISTINCT majs_gen ORDER BY majs_gen ASC SEPARATOR ",") AS generations' .
-            ' FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id' .
-            ' GROUP BY majs_i_id'
-        )->execute(array(
-            'tree_id' => $this->tree->getTreeId(),
-            'user_id' => $this->user->getUserId()
-        ))->fetchAssoc();
-    }
-    
-    /**
-     * Get an associative array of Sosa individuals in generation G. Keys are Sosa numbers, values individuals.
-     *
-     * @param number $gen Generation
-     * @return array Array of Sosa individuals
-     */
-    public function getSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_list_by_gen)
-            $this->sosa_list_by_gen = array();
+	/**
+	 * Return the list of all sosas, with the generations it belongs to
+	 *
+	 * @return array Associative array of Sosa ancestors, with their generation, comma separated
+	 */
+	public function getAllSosaWithGenerations(){
+		if(!$this->is_setup) return array();
+		return Database::prepare(
+			'SELECT majs_i_id AS indi,' .
+			' GROUP_CONCAT(DISTINCT majs_gen ORDER BY majs_gen ASC SEPARATOR ",") AS generations' .
+			' FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id' .
+			' GROUP BY majs_i_id'
+		)->execute(array(
+			'tree_id' => $this->tree->getTreeId(),
+			'user_id' => $this->user->getUserId()
+		))->fetchAssoc();
+	}
+    
+	/**
+	 * Get an associative array of Sosa individuals in generation G. Keys are Sosa numbers, values individuals.
+	 *
+	 * @param number $gen Generation
+	 * @return array Array of Sosa individuals
+	 */
+	public function getSosaListAtGeneration($gen){
+		if(!$this->is_setup) return array();
+		if(!$this->sosa_list_by_gen)
+			$this->sosa_list_by_gen = array();
         
-        if($gen){
-            if(!isset($this->sosa_list_by_gen[$gen])){
-                $this->sosa_list_by_gen[$gen] = Database::prepare(
-                    'SELECT majs_sosa AS sosa, majs_i_id AS indi'.
-                    ' FROM `##maj_sosa`'.
-                    ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-                    ' AND majs_gen = :gen'.
-                    ' ORDER BY majs_sosa ASC')
-                ->execute(array(
-                    'tree_id' => $this->tree->getTreeId(),
-                    'user_id' => $this->user->getUserId(),
-                    'gen' => $gen
-                ))
-                ->fetchAssoc();
-            }
-            return $this->sosa_list_by_gen[$gen];
-        }
-        return array();
-    }
-    
-    /**
-     * Get an associative array of Sosa families in generation G. Keys are Sosa numbers for the husband, values families.
-     *
-     * @param number $gen Generation
-     * @return array Array of Sosa families
-     */
-    public function getFamilySosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_fam_list_by_gen)
-            $this->sosa_fam_list_by_gen = array();
+		if($gen){
+			if(!isset($this->sosa_list_by_gen[$gen])){
+				$this->sosa_list_by_gen[$gen] = Database::prepare(
+					'SELECT majs_sosa AS sosa, majs_i_id AS indi'.
+					' FROM `##maj_sosa`'.
+					' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+					' AND majs_gen = :gen'.
+					' ORDER BY majs_sosa ASC')
+				->execute(array(
+					'tree_id' => $this->tree->getTreeId(),
+					'user_id' => $this->user->getUserId(),
+					'gen' => $gen
+				))
+				->fetchAssoc();
+			}
+			return $this->sosa_list_by_gen[$gen];
+		}
+		return array();
+	}
+    
+	/**
+	 * Get an associative array of Sosa families in generation G. Keys are Sosa numbers for the husband, values families.
+	 *
+	 * @param number $gen Generation
+	 * @return array Array of Sosa families
+	 */
+	public function getFamilySosaListAtGeneration($gen){
+		if(!$this->is_setup) return array();
+		if(!$this->sosa_fam_list_by_gen)
+			$this->sosa_fam_list_by_gen = array();
         
-        if($gen){
-            if(!isset($this->sosa_fam_list_by_gen[$gen])){
-                $this->sosa_fam_list_by_gen[$gen] = Database::prepare(
-                    'SELECT s1.majs_sosa AS sosa, f_id AS fam'.
-                    ' FROM `##families`'.
-                    ' INNER JOIN `##maj_sosa` AS s1 ON (`##families`.f_husb = s1.majs_i_id AND `##families`.f_file = s1.majs_gedcom_id)'.
-                    ' INNER JOIN `##maj_sosa` AS s2 ON (`##families`.f_wife = s2.majs_i_id AND `##families`.f_file = s2.majs_gedcom_id)'.
-                    ' WHERE s1.majs_sosa + 1 = s2.majs_sosa'.
-                    ' AND s1.majs_gedcom_id= :tree_id AND s1.majs_user_id=:user_id'.
-                    ' AND s2.majs_gedcom_id= :tree_id AND s2.majs_user_id=:user_id'.
-                    ' AND s1.majs_gen = :gen'.
-                    ' ORDER BY s1.majs_sosa ASC'
-                    )
-                    ->execute(array(
-                        'tree_id' => $this->tree->getTreeId(),
-                        'user_id' => $this->user->getUserId(),
-                        'gen' => $gen
-                    ))
-                    ->fetchAssoc();
-            }
-            return $this->sosa_fam_list_by_gen[$gen];
-        }
-        return array();
-    }
-    
-    /**
-     * Get an associative array of Sosa individuals in generation G who are missing parents. Keys are Sosa numbers, values individuals.
-     *
-     * @param number $gen Generation
-     * @return array Array of Sosa individuals
-     */
-    public function getMissingSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();    
-        if($gen){
-            return $this->sosa_list_by_gen[$gen] = Database::prepare(
-                'SELECT schild.majs_sosa sosa, schild.majs_i_id indi, sfat.majs_sosa IS NOT NULL has_father, smot.majs_sosa IS NOT NULL has_mother'.
-                ' FROM `##maj_sosa` schild'.
-                ' LEFT JOIN `##maj_sosa` sfat ON ((schild.majs_sosa * 2) = sfat.majs_sosa AND schild.majs_gedcom_id = sfat.majs_gedcom_id AND schild.majs_user_id = sfat.majs_user_id)'.
-                ' LEFT JOIN `##maj_sosa` smot ON ((schild.majs_sosa * 2 + 1) = smot.majs_sosa AND schild.majs_gedcom_id = smot.majs_gedcom_id AND schild.majs_user_id = smot.majs_user_id)'.
-                ' WHERE schild.majs_gedcom_id = :tree_id AND schild.majs_user_id = :user_id'.
-                ' AND schild.majs_gen = :gen'.
-                ' AND (sfat.majs_sosa IS NULL OR smot.majs_sosa IS NULL)'.
-                ' ORDER BY schild.majs_sosa ASC')
-                ->execute(array(
-                    'tree_id' => $this->tree->getTreeId(),
-                    'user_id' => $this->user->getUserId(),
-                    'gen' => $gen - 1
-                ))->fetchAll(\PDO::FETCH_ASSOC);
-        }
-        return array();
-    }
-    
-    
-    
-    /*************
+		if($gen){
+			if(!isset($this->sosa_fam_list_by_gen[$gen])){
+				$this->sosa_fam_list_by_gen[$gen] = Database::prepare(
+					'SELECT s1.majs_sosa AS sosa, f_id AS fam'.
+					' FROM `##families`'.
+					' INNER JOIN `##maj_sosa` AS s1 ON (`##families`.f_husb = s1.majs_i_id AND `##families`.f_file = s1.majs_gedcom_id)'.
+					' INNER JOIN `##maj_sosa` AS s2 ON (`##families`.f_wife = s2.majs_i_id AND `##families`.f_file = s2.majs_gedcom_id)'.
+					' WHERE s1.majs_sosa + 1 = s2.majs_sosa'.
+					' AND s1.majs_gedcom_id= :tree_id AND s1.majs_user_id=:user_id'.
+					' AND s2.majs_gedcom_id= :tree_id AND s2.majs_user_id=:user_id'.
+					' AND s1.majs_gen = :gen'.
+					' ORDER BY s1.majs_sosa ASC'
+					)
+					->execute(array(
+						'tree_id' => $this->tree->getTreeId(),
+						'user_id' => $this->user->getUserId(),
+						'gen' => $gen
+					))
+					->fetchAssoc();
+			}
+			return $this->sosa_fam_list_by_gen[$gen];
+		}
+		return array();
+	}
+    
+	/**
+	 * Get an associative array of Sosa individuals in generation G who are missing parents. Keys are Sosa numbers, values individuals.
+	 *
+	 * @param number $gen Generation
+	 * @return array Array of Sosa individuals
+	 */
+	public function getMissingSosaListAtGeneration($gen){
+		if(!$this->is_setup) return array();    
+		if($gen){
+			return $this->sosa_list_by_gen[$gen] = Database::prepare(
+				'SELECT schild.majs_sosa sosa, schild.majs_i_id indi, sfat.majs_sosa IS NOT NULL has_father, smot.majs_sosa IS NOT NULL has_mother'.
+				' FROM `##maj_sosa` schild'.
+				' LEFT JOIN `##maj_sosa` sfat ON ((schild.majs_sosa * 2) = sfat.majs_sosa AND schild.majs_gedcom_id = sfat.majs_gedcom_id AND schild.majs_user_id = sfat.majs_user_id)'.
+				' LEFT JOIN `##maj_sosa` smot ON ((schild.majs_sosa * 2 + 1) = smot.majs_sosa AND schild.majs_gedcom_id = smot.majs_gedcom_id AND schild.majs_user_id = smot.majs_user_id)'.
+				' WHERE schild.majs_gedcom_id = :tree_id AND schild.majs_user_id = :user_id'.
+				' AND schild.majs_gen = :gen'.
+				' AND (sfat.majs_sosa IS NULL OR smot.majs_sosa IS NULL)'.
+				' ORDER BY schild.majs_sosa ASC')
+				->execute(array(
+					'tree_id' => $this->tree->getTreeId(),
+					'user_id' => $this->user->getUserId(),
+					'gen' => $gen - 1
+				))->fetchAll(\PDO::FETCH_ASSOC);
+		}
+		return array();
+	}
+    
+    
+    
+	/*************
      * STATISTICS
      *************/
-    /**
-     * Get the statistic array detailed by generation.
-     * Statistics for each generation are:
-     * 	- The number of Sosa in generation
-     * 	- The number of Sosa up to generation
-     *  - The number of distinct Sosa up to generation
-     *  - The year of the first birth in generation
-     *  - The year of the first estimated birth in generation
-     *  - The year of the last birth in generation
-     *  - The year of the last estimated birth in generation
-     *  - The average year of birth in generation
-     *
-     * @return array Statistics array
-     */
-    public function getStatisticsByGeneration() {
-        if(!$this->is_setup) return array();
-        if(!$this->statistics_tab) {
-            $this->statistics_tab = array();
-            if($maxGeneration = $this->getLastGeneration()) {
-                for ($gen = 1; $gen <= $maxGeneration; $gen++) {
-                    $birthStats = $this->getStatsBirthYearInGeneration($gen);
-                    $this->statistics_tab[$gen] = array(
-                        'sosaCount'				=>	$this->getSosaCountAtGeneration($gen),
-                        'sosaTotalCount'		=>	$this->getSosaCountUpToGeneration($gen),
-                        'diffSosaTotalCount'	=>	$this->getDifferentSosaCountUpToGeneration($gen),
-                        'firstBirth'			=>	$birthStats['first'],
-                        'firstEstimatedBirth'	=>	$birthStats['first_est'],
-                        'lastBirth'				=>	$birthStats['last'],
-                        'lastEstimatedBirth'	=>	$birthStats['last_est'],
-                        'avgBirth'				=>	$birthStats['avg']
-                    );
-                }
-            }
-        }
-        return $this->statistics_tab;        
-    }
+	/**
+	 * Get the statistic array detailed by generation.
+	 * Statistics for each generation are:
+	 * 	- The number of Sosa in generation
+	 * 	- The number of Sosa up to generation
+	 *  - The number of distinct Sosa up to generation
+	 *  - The year of the first birth in generation
+	 *  - The year of the first estimated birth in generation
+	 *  - The year of the last birth in generation
+	 *  - The year of the last estimated birth in generation
+	 *  - The average year of birth in generation
+	 *
+	 * @return array Statistics array
+	 */
+	public function getStatisticsByGeneration() {
+		if(!$this->is_setup) return array();
+		if(!$this->statistics_tab) {
+			$this->statistics_tab = array();
+			if($maxGeneration = $this->getLastGeneration()) {
+				for ($gen = 1; $gen <= $maxGeneration; $gen++) {
+					$birthStats = $this->getStatsBirthYearInGeneration($gen);
+					$this->statistics_tab[$gen] = array(
+						'sosaCount'				=>	$this->getSosaCountAtGeneration($gen),
+						'sosaTotalCount'		=>	$this->getSosaCountUpToGeneration($gen),
+						'diffSosaTotalCount'	=>	$this->getDifferentSosaCountUpToGeneration($gen),
+						'firstBirth'			=>	$birthStats['first'],
+						'firstEstimatedBirth'	=>	$birthStats['first_est'],
+						'lastBirth'				=>	$birthStats['last'],
+						'lastEstimatedBirth'	=>	$birthStats['last_est'],
+						'avgBirth'				=>	$birthStats['avg']
+					);
+				}
+			}
+		}
+		return $this->statistics_tab;        
+	}
     
 	/**
 	 * How many individuals exist in the tree.
@@ -436,332 +436,332 @@ 
 	 * @return int
 	 */
 	public function getTotalIndividuals() {
-	    if(!$this->is_setup) return 0;
-	    return Database::prepare(
-	        'SELECT COUNT(*) FROM `##individuals`' .
-	        ' WHERE i_file = :tree_id')
-	        ->execute(array('tree_id' => $this->tree->getTreeId()))
-	        ->fetchOne() ?: 0;
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(*) FROM `##individuals`' .
+			' WHERE i_file = :tree_id')
+			->execute(array('tree_id' => $this->tree->getTreeId()))
+			->fetchOne() ?: 0;
 	}
     
-    /**
-     * Get the total Sosa count for all generations
-     *
-     * @return number Number of Sosas
-     */
-    public function getSosaCount(){
-        if(!$this->is_setup) return 0;
-        return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
-            ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId() 
-            ))->fetchOne() ?: 0;
-    }
-    
-    /**
-     * Get the number of Sosa in a specific generation.
-     *
-     * @param number $gen Generation
-     * @return number Number of Sosas in generation
-     */
-    public function getSosaCountAtGeneration($gen){
-        if(!$this->is_setup) return 0;
-        return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-            ' AND majs_gen= :gen')
-        ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen            
-        ))->fetchOne() ?: 0;
-    }
-    
-    /**
-     * Get the total number of Sosa up to a specific generation.
-     *
-     * @param number $gen Generation
-     * @return number Total number of Sosas up to generation
-     */
-    public function getSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
-        return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-            ' AND majs_gen <= :gen')
-        ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen 
-        ))->fetchOne() ?: 0;
-    }
-    
-    /**
-     * Get the total number of distinct Sosa individual for all generations.
-     *
-     * @return number Total number of distinct individual
-     */
-    public function getDifferentSosaCount(){
-        if(!$this->is_setup) return 0;
-        return Database::prepare(
-            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
-        ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId()
-        ))->fetchOne() ?: 0;
-    }
-    
-    /**
-     * Get the number of distinct Sosa individual up to a specific generation.
-     *
-     * @param number $gen Generation
-     * @return number Number of distinct Sosa individuals up to generation
-     */
-    public function getDifferentSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
-        return Database::prepare(
-            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-            ' AND majs_gen <= :gen')
-        ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen 
-        ))->fetchOne() ?: 0;
-    }
-    
-    /**
-     * Get an array of birth statistics for a specific generation
-     * Statistics are :
-     * 	- first : First birth year in generation
-     *  - first_est: First estimated birth year in generation
-     *  - last : Last birth year in generation
-     *  - last_est : Last estimated birth year in generation
-     *  - avg : Average birth year (based on non-estimated birth date)
-     *
-     * @param number $gen Generation
-     * @return array Birth statistics array
-     */
-    public function getStatsBirthYearInGeneration($gen){
-        if(!$this->is_setup) return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
-        return Database::prepare(
-            'SELECT'.
-            ' MIN(majs_birth_year) AS first, MIN(majs_birth_year_est) AS first_est,'.
-            ' AVG(majs_birth_year) AS avg,'.
-            ' MAX(majs_birth_year) AS last, MAX(majs_birth_year_est) AS last_est'.
-            ' FROM `##maj_sosa`'.
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-            ' AND majs_gen=:gen')
-            ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen))
-            ->fetchOneRow(\PDO::FETCH_ASSOC) ?: array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
-    }
-    
-    /**
-     * Get the mean generation time, based on a linear regression of birth years and generations
-     *
-     * @return number|NULL Mean generation time
-     */
-    public function getMeanGenerationTime(){
-        if(!$this->is_setup) return;
-        if(!$this->statistics_tab){
-            $this->getStatisticsByGeneration();
-        }
-        //Linear regression on x=generation and y=birthdate
-        $sum_xy = $sum_x = $sum_y= $sum_x2 = $n = 0;
-        foreach($this->statistics_tab as $gen=>$stats){
-            if(!is_null($stats['avgBirth'])) {
-                $n++;
-                $sum_xy+=$gen*$stats['avgBirth'];
-                $sum_x+=$gen;
-                $sum_y+=$stats['avgBirth'];
-                $sum_x2+=$gen*$gen;
-            }
-        }
-        $denom=($n*$sum_x2)-($sum_x*$sum_x);
-        if($denom!=0){
-            return -(($n*$sum_xy)-($sum_x*$sum_y))/($denom);
-        }
-        return null;
-    }
-    
-    /**
-     * Return an array of the mean generation depth and standard deviation for all Sosa ancestors at a given generation.
-     * Sosa 1 is of generation 1.
-     * 
-     * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes,
-     * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140
-     * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0
-     * 
-     * Format: 
-     *  - key : sosa number of the ancestor
-     *  - values: array
-     *      - root_ancestor_id : ID of the ancestor
-     *      - mean_gen_depth : Mean generation depth
-     *      - stddev_gen_depth : Standard deviation of generation depth
-     *  
-     * @param number $gen Sosa generation
-     * @return array
-     */
-    public function getGenerationDepthStatsAtGen($gen) {
-        if(!$this->is_setup) return array();
-        $gen_depth_stats_raw = Database::prepare(
-            'SELECT stats_by_gen.root_ancestor AS root_ancestor_sosa,'.
-            '   sosa_list.majs_i_id as root_ancestor_id,'.
-            '   1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth,'.
-            '   SQRT('. 
-            '       SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm)))'.
-            '       - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))), 2)'.
-            '   ) AS stddev_gen_depth'.
-            ' FROM('.
-            '   SELECT'.
-            '       sosa.majs_gedcom_id,'.
-            '       sosa.majs_user_id,'.
-            '       sosa.majs_gen - :gen AS majs_gen_norm,'.
-            '       FLOOR(((sosa.majs_sosa / POW(2, sosa.majs_gen -1 )) - 1) * POWER(2, :gen - 1)) + POWER(2, :gen - 1) AS root_ancestor,'.
-            '       SUM(case when sosa_fat.majs_i_id IS NULL AND sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count,'.
-            '       SUM(case when sosa_fat.majs_i_id IS NULL AND sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count'.
-            '   FROM `##maj_sosa` AS sosa'.
-            '   LEFT JOIN `##maj_sosa` AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.
-            '       AND sosa_fat.majs_gedcom_id = sosa.majs_gedcom_id'.
-            '       AND sosa_fat.majs_user_id = sosa.majs_user_id'.
-            '   LEFT JOIN `##maj_sosa` AS sosa_mot ON sosa_mot.majs_sosa = 2 * sosa.majs_sosa + 1'.
-            '       AND sosa_mot.majs_gedcom_id = sosa.majs_gedcom_id'.
-            '       AND sosa_mot.majs_user_id = sosa.majs_user_id'.
-            '   WHERE sosa.majs_gedcom_id = :tree_id'.
-            '       AND sosa.majs_user_id = :user_id'.
-            '       AND sosa.majs_gen >=  :gen'.
-            '       AND (sosa_fat.majs_i_id IS NULL OR sosa_mot.majs_i_id IS NULL)'.
-            '   GROUP BY sosa.majs_gen, root_ancestor'.
-            ' ) AS stats_by_gen'.
-            ' INNER JOIN `##maj_sosa` sosa_list ON sosa_list.majs_gedcom_id = stats_by_gen.majs_gedcom_id'.
-            '   AND sosa_list.majs_user_id = stats_by_gen.majs_user_id'.
-            '   AND sosa_list.majs_sosa = stats_by_gen.root_ancestor'.
-            ' GROUP BY stats_by_gen.root_ancestor, sosa_list.majs_i_id'.
-            ' ORDER BY stats_by_gen.root_ancestor')
-        ->execute(array(
-            'tree_id' => $this->tree->getTreeId(),
-            'user_id' => $this->user->getUserId(),
-            'gen' => $gen
-        ))->fetchAll() ?: array();
+	/**
+	 * Get the total Sosa count for all generations
+	 *
+	 * @return number Number of Sosas
+	 */
+	public function getSosaCount(){
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
+			->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId() 
+			))->fetchOne() ?: 0;
+	}
+    
+	/**
+	 * Get the number of Sosa in a specific generation.
+	 *
+	 * @param number $gen Generation
+	 * @return number Number of Sosas in generation
+	 */
+	public function getSosaCountAtGeneration($gen){
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+			' AND majs_gen= :gen')
+		->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen            
+		))->fetchOne() ?: 0;
+	}
+    
+	/**
+	 * Get the total number of Sosa up to a specific generation.
+	 *
+	 * @param number $gen Generation
+	 * @return number Total number of Sosas up to generation
+	 */
+	public function getSosaCountUpToGeneration($gen){
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+			' AND majs_gen <= :gen')
+		->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen 
+		))->fetchOne() ?: 0;
+	}
+    
+	/**
+	 * Get the total number of distinct Sosa individual for all generations.
+	 *
+	 * @return number Total number of distinct individual
+	 */
+	public function getDifferentSosaCount(){
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
+		->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId()
+		))->fetchOne() ?: 0;
+	}
+    
+	/**
+	 * Get the number of distinct Sosa individual up to a specific generation.
+	 *
+	 * @param number $gen Generation
+	 * @return number Number of distinct Sosa individuals up to generation
+	 */
+	public function getDifferentSosaCountUpToGeneration($gen){
+		if(!$this->is_setup) return 0;
+		return Database::prepare(
+			'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+			' AND majs_gen <= :gen')
+		->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen 
+		))->fetchOne() ?: 0;
+	}
+    
+	/**
+	 * Get an array of birth statistics for a specific generation
+	 * Statistics are :
+	 * 	- first : First birth year in generation
+	 *  - first_est: First estimated birth year in generation
+	 *  - last : Last birth year in generation
+	 *  - last_est : Last estimated birth year in generation
+	 *  - avg : Average birth year (based on non-estimated birth date)
+	 *
+	 * @param number $gen Generation
+	 * @return array Birth statistics array
+	 */
+	public function getStatsBirthYearInGeneration($gen){
+		if(!$this->is_setup) return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
+		return Database::prepare(
+			'SELECT'.
+			' MIN(majs_birth_year) AS first, MIN(majs_birth_year_est) AS first_est,'.
+			' AVG(majs_birth_year) AS avg,'.
+			' MAX(majs_birth_year) AS last, MAX(majs_birth_year_est) AS last_est'.
+			' FROM `##maj_sosa`'.
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+			' AND majs_gen=:gen')
+			->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen))
+			->fetchOneRow(\PDO::FETCH_ASSOC) ?: array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
+	}
+    
+	/**
+	 * Get the mean generation time, based on a linear regression of birth years and generations
+	 *
+	 * @return number|NULL Mean generation time
+	 */
+	public function getMeanGenerationTime(){
+		if(!$this->is_setup) return;
+		if(!$this->statistics_tab){
+			$this->getStatisticsByGeneration();
+		}
+		//Linear regression on x=generation and y=birthdate
+		$sum_xy = $sum_x = $sum_y= $sum_x2 = $n = 0;
+		foreach($this->statistics_tab as $gen=>$stats){
+			if(!is_null($stats['avgBirth'])) {
+				$n++;
+				$sum_xy+=$gen*$stats['avgBirth'];
+				$sum_x+=$gen;
+				$sum_y+=$stats['avgBirth'];
+				$sum_x2+=$gen*$gen;
+			}
+		}
+		$denom=($n*$sum_x2)-($sum_x*$sum_x);
+		if($denom!=0){
+			return -(($n*$sum_xy)-($sum_x*$sum_y))/($denom);
+		}
+		return null;
+	}
+    
+	/**
+	 * Return an array of the mean generation depth and standard deviation for all Sosa ancestors at a given generation.
+	 * Sosa 1 is of generation 1.
+	 * 
+	 * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes,
+	 * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140
+	 * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0
+	 * 
+	 * Format: 
+	 *  - key : sosa number of the ancestor
+	 *  - values: array
+	 *      - root_ancestor_id : ID of the ancestor
+	 *      - mean_gen_depth : Mean generation depth
+	 *      - stddev_gen_depth : Standard deviation of generation depth
+	 *  
+	 * @param number $gen Sosa generation
+	 * @return array
+	 */
+	public function getGenerationDepthStatsAtGen($gen) {
+		if(!$this->is_setup) return array();
+		$gen_depth_stats_raw = Database::prepare(
+			'SELECT stats_by_gen.root_ancestor AS root_ancestor_sosa,'.
+			'   sosa_list.majs_i_id as root_ancestor_id,'.
+			'   1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth,'.
+			'   SQRT('. 
+			'       SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm)))'.
+			'       - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))), 2)'.
+			'   ) AS stddev_gen_depth'.
+			' FROM('.
+			'   SELECT'.
+			'       sosa.majs_gedcom_id,'.
+			'       sosa.majs_user_id,'.
+			'       sosa.majs_gen - :gen AS majs_gen_norm,'.
+			'       FLOOR(((sosa.majs_sosa / POW(2, sosa.majs_gen -1 )) - 1) * POWER(2, :gen - 1)) + POWER(2, :gen - 1) AS root_ancestor,'.
+			'       SUM(case when sosa_fat.majs_i_id IS NULL AND sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count,'.
+			'       SUM(case when sosa_fat.majs_i_id IS NULL AND sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count'.
+			'   FROM `##maj_sosa` AS sosa'.
+			'   LEFT JOIN `##maj_sosa` AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.
+			'       AND sosa_fat.majs_gedcom_id = sosa.majs_gedcom_id'.
+			'       AND sosa_fat.majs_user_id = sosa.majs_user_id'.
+			'   LEFT JOIN `##maj_sosa` AS sosa_mot ON sosa_mot.majs_sosa = 2 * sosa.majs_sosa + 1'.
+			'       AND sosa_mot.majs_gedcom_id = sosa.majs_gedcom_id'.
+			'       AND sosa_mot.majs_user_id = sosa.majs_user_id'.
+			'   WHERE sosa.majs_gedcom_id = :tree_id'.
+			'       AND sosa.majs_user_id = :user_id'.
+			'       AND sosa.majs_gen >=  :gen'.
+			'       AND (sosa_fat.majs_i_id IS NULL OR sosa_mot.majs_i_id IS NULL)'.
+			'   GROUP BY sosa.majs_gen, root_ancestor'.
+			' ) AS stats_by_gen'.
+			' INNER JOIN `##maj_sosa` sosa_list ON sosa_list.majs_gedcom_id = stats_by_gen.majs_gedcom_id'.
+			'   AND sosa_list.majs_user_id = stats_by_gen.majs_user_id'.
+			'   AND sosa_list.majs_sosa = stats_by_gen.root_ancestor'.
+			' GROUP BY stats_by_gen.root_ancestor, sosa_list.majs_i_id'.
+			' ORDER BY stats_by_gen.root_ancestor')
+		->execute(array(
+			'tree_id' => $this->tree->getTreeId(),
+			'user_id' => $this->user->getUserId(),
+			'gen' => $gen
+		))->fetchAll() ?: array();
         
-        $gen_depth_stats = array();
-        foreach ($gen_depth_stats_raw as $gen_depth_stat) {
-            $gen_depth_stats[$gen_depth_stat->root_ancestor_sosa] = array(
-                'root_ancestor_id' => $gen_depth_stat->root_ancestor_id,
-                'mean_gen_depth' => $gen_depth_stat->mean_gen_depth,
-                'stddev_gen_depth' => $gen_depth_stat->stddev_gen_depth
-            );
-        }
-        return $gen_depth_stats;
-    }
-    
-    /**
-     * Return a computed array of statistics about the dispersion of ancestors across the ancestors
-     * at a specified generation.
-     * This statistics cannot be used for generations above 11, as it would cause a out of range in MySQL
-     * 
-     * Format: 
-     *  - key : a base-2 representation of the ancestor at generation G for which exclusive ancestors have been found,
-     *          -1 is used for shared ancestors
-     *          For instance base2(0100) = base10(4) represent the maternal grand father
-     *  - values: number of ancestors exclusively in the ancestors of the ancestor in key
-     *  
-     *  For instance a result at generation 3 could be :
-     *      array (   -1        =>  12      -> 12 ancestors are shared by the grand-parents
-     *                base10(1) =>  32      -> 32 ancestors are exclusive to the paternal grand-father
-     *                base10(2) =>  25      -> 25 ancestors are exclusive to the paternal grand-mother
-     *                base10(4) =>  12      -> 12 ancestors are exclusive to the maternal grand-father
-     *                base10(8) =>  30      -> 30 ancestors are exclusive to the maternal grand-mother
-     *            )
-     *  
-     * @param int $gen Reference generation
-     * @return array
-     */
-    public function getAncestorDispersionForGen($gen) {
-        if(!$this->is_setup || $gen > 11) return array();  // Going further than 11 gen will be out of range in the query
-        return Database::prepare(
-            'SELECT branches, count(i_id)'.
-            ' FROM ('.
-            '   SELECT i_id,'.
-            '       CASE'.
-            '           WHEN CEIL(LOG2(SUM(branch))) = LOG2(SUM(branch)) THEN SUM(branch)'.
-            '           ELSE -1'.   // We put all ancestors shared between some branches in the same bucket
-            '       END branches'.
-            '   FROM ('.
-            '       SELECT DISTINCT majs_i_id i_id,'.
-            '           POW(2, FLOOR(majs_sosa / POW(2, (majs_gen - :gen))) - POW(2, :gen -1)) branch'.
-            '       FROM `##maj_sosa`'.
-            '       WHERE majs_gedcom_id = :tree_id AND majs_user_id = :user_id'.
-            '           AND majs_gen >= :gen'.
-            '   ) indistat'.
-            '   GROUP BY i_id'.
-            ') grouped'.
-            ' GROUP BY branches')
-            ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen
-            ))->fetchAssoc() ?: array();
-    }
-    
-    /**
-     * Return an array of the most duplicated root Sosa ancestors.
-     * The number of ancestors to return is limited by the parameter $limit.
-     * If several individuals are tied when reaching the limit, none of them are returned,
-     * which means that there can be less individuals returned than requested.
-     * 
-     * Format: 
-     *  - key : root Sosa individual
-     *  - value: number of duplications of the ancestor (e.g. 3 if it appears 3 times)
-     * 
-     * @param number $limit Maximum number of individuals to return
-     * @return array 
-     */
-    public function getTopMultiSosaAncestorsNoTies($limit) {
-        if(!$this->is_setup) return array();
-        return Database::prepare(
-            'SELECT sosa_i_id, sosa_count FROM ('.
-            '   SELECT'.
-            '       top_sosa.sosa_i_id, top_sosa.sosa_count, top_sosa.sosa_min,'.
-            '       @keep := IF(@prev_count = 0 OR sosa_count = @prev_count, @keep, 1) AS keep,'.
-            '       @prev_count := top_sosa.sosa_count AS prev_count'.
-            '   FROM ('.
-            '       SELECT'.
-            '           sosa.majs_i_id sosa_i_id,'.
-            '           COUNT(sosa.majs_sosa) sosa_count,'.
-            '           MIN(sosa.majs_sosa) sosa_min'.
-            '       FROM ##maj_sosa AS sosa'.
-            '       LEFT JOIN ##maj_sosa AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.   // Link to sosa's father
-            '           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
-            '           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
-            '       LEFT JOIN ##maj_sosa AS sosa_mot on sosa_mot.majs_sosa = (2 * sosa.majs_sosa + 1)'.  // Link to sosa's mother
-            '           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
-            '           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
-            '       WHERE sosa.majs_gedcom_id = :tree_id'.
-            '       AND sosa.majs_user_id = :user_id'.
-            '       AND sosa_fat.majs_sosa IS NULL'.    // We keep only root individuals, i.e. those with no father or mother
-            '       AND sosa_mot.majs_sosa IS NULL'. 
-            '       GROUP BY sosa.majs_i_id'.
-            '       HAVING COUNT(sosa.majs_sosa) > 1'.   // Limit to the duplicate sosas.
-            '       ORDER BY COUNT(sosa.majs_sosa) DESC'.
-            '       LIMIT ' . ($limit + 1) . // We want to select one more than required
-            '   ) AS top_sosa,'.
-            '   (SELECT @prev_count := 0, @keep := 0) x'.
-            '   ORDER BY top_sosa.sosa_count ASC'.
-            ' ) top_sosa_list'.
-            ' WHERE keep = 1'.
-            ' ORDER BY sosa_count DESC, sosa_min ASC'
-            )->execute(array(
-                'tree_id' => $this->tree->getTreeId(),
-                'user_id' => $this->user->getUserId()
-            ))->fetchAssoc() ?: array();
-    }
+		$gen_depth_stats = array();
+		foreach ($gen_depth_stats_raw as $gen_depth_stat) {
+			$gen_depth_stats[$gen_depth_stat->root_ancestor_sosa] = array(
+				'root_ancestor_id' => $gen_depth_stat->root_ancestor_id,
+				'mean_gen_depth' => $gen_depth_stat->mean_gen_depth,
+				'stddev_gen_depth' => $gen_depth_stat->stddev_gen_depth
+			);
+		}
+		return $gen_depth_stats;
+	}
+    
+	/**
+	 * Return a computed array of statistics about the dispersion of ancestors across the ancestors
+	 * at a specified generation.
+	 * This statistics cannot be used for generations above 11, as it would cause a out of range in MySQL
+	 * 
+	 * Format: 
+	 *  - key : a base-2 representation of the ancestor at generation G for which exclusive ancestors have been found,
+	 *          -1 is used for shared ancestors
+	 *          For instance base2(0100) = base10(4) represent the maternal grand father
+	 *  - values: number of ancestors exclusively in the ancestors of the ancestor in key
+	 *  
+	 *  For instance a result at generation 3 could be :
+	 *      array (   -1        =>  12      -> 12 ancestors are shared by the grand-parents
+	 *                base10(1) =>  32      -> 32 ancestors are exclusive to the paternal grand-father
+	 *                base10(2) =>  25      -> 25 ancestors are exclusive to the paternal grand-mother
+	 *                base10(4) =>  12      -> 12 ancestors are exclusive to the maternal grand-father
+	 *                base10(8) =>  30      -> 30 ancestors are exclusive to the maternal grand-mother
+	 *            )
+	 *  
+	 * @param int $gen Reference generation
+	 * @return array
+	 */
+	public function getAncestorDispersionForGen($gen) {
+		if(!$this->is_setup || $gen > 11) return array();  // Going further than 11 gen will be out of range in the query
+		return Database::prepare(
+			'SELECT branches, count(i_id)'.
+			' FROM ('.
+			'   SELECT i_id,'.
+			'       CASE'.
+			'           WHEN CEIL(LOG2(SUM(branch))) = LOG2(SUM(branch)) THEN SUM(branch)'.
+			'           ELSE -1'.   // We put all ancestors shared between some branches in the same bucket
+			'       END branches'.
+			'   FROM ('.
+			'       SELECT DISTINCT majs_i_id i_id,'.
+			'           POW(2, FLOOR(majs_sosa / POW(2, (majs_gen - :gen))) - POW(2, :gen -1)) branch'.
+			'       FROM `##maj_sosa`'.
+			'       WHERE majs_gedcom_id = :tree_id AND majs_user_id = :user_id'.
+			'           AND majs_gen >= :gen'.
+			'   ) indistat'.
+			'   GROUP BY i_id'.
+			') grouped'.
+			' GROUP BY branches')
+			->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen
+			))->fetchAssoc() ?: array();
+	}
+    
+	/**
+	 * Return an array of the most duplicated root Sosa ancestors.
+	 * The number of ancestors to return is limited by the parameter $limit.
+	 * If several individuals are tied when reaching the limit, none of them are returned,
+	 * which means that there can be less individuals returned than requested.
+	 * 
+	 * Format: 
+	 *  - key : root Sosa individual
+	 *  - value: number of duplications of the ancestor (e.g. 3 if it appears 3 times)
+	 * 
+	 * @param number $limit Maximum number of individuals to return
+	 * @return array 
+	 */
+	public function getTopMultiSosaAncestorsNoTies($limit) {
+		if(!$this->is_setup) return array();
+		return Database::prepare(
+			'SELECT sosa_i_id, sosa_count FROM ('.
+			'   SELECT'.
+			'       top_sosa.sosa_i_id, top_sosa.sosa_count, top_sosa.sosa_min,'.
+			'       @keep := IF(@prev_count = 0 OR sosa_count = @prev_count, @keep, 1) AS keep,'.
+			'       @prev_count := top_sosa.sosa_count AS prev_count'.
+			'   FROM ('.
+			'       SELECT'.
+			'           sosa.majs_i_id sosa_i_id,'.
+			'           COUNT(sosa.majs_sosa) sosa_count,'.
+			'           MIN(sosa.majs_sosa) sosa_min'.
+			'       FROM ##maj_sosa AS sosa'.
+			'       LEFT JOIN ##maj_sosa AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.   // Link to sosa's father
+			'           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
+			'           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
+			'       LEFT JOIN ##maj_sosa AS sosa_mot on sosa_mot.majs_sosa = (2 * sosa.majs_sosa + 1)'.  // Link to sosa's mother
+			'           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
+			'           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
+			'       WHERE sosa.majs_gedcom_id = :tree_id'.
+			'       AND sosa.majs_user_id = :user_id'.
+			'       AND sosa_fat.majs_sosa IS NULL'.    // We keep only root individuals, i.e. those with no father or mother
+			'       AND sosa_mot.majs_sosa IS NULL'. 
+			'       GROUP BY sosa.majs_i_id'.
+			'       HAVING COUNT(sosa.majs_sosa) > 1'.   // Limit to the duplicate sosas.
+			'       ORDER BY COUNT(sosa.majs_sosa) DESC'.
+			'       LIMIT ' . ($limit + 1) . // We want to select one more than required
+			'   ) AS top_sosa,'.
+			'   (SELECT @prev_count := 0, @keep := 0) x'.
+			'   ORDER BY top_sosa.sosa_count ASC'.
+			' ) top_sosa_list'.
+			' WHERE keep = 1'.
+			' ORDER BY sosa_count DESC, sosa_min ASC'
+			)->execute(array(
+				'tree_id' => $this->tree->getTreeId(),
+				'user_id' => $this->user->getUserId()
+			))->fetchAssoc() ?: array();
+	}
     
                
 }

Spacing +81 added lines, -81 removed lines

@@ -84,18 +84,18 @@ 
      * @param User $user
      */
     public function __construct(Tree $tree, User $user = null) {
-        if(self::$default_user === null) 
+        if (self::$default_user === null) 
             self::$default_user = User::find(-1);
         
         $this->tree = $tree;
         $this->user = $user;
         $this->is_setup = true;
-        if($this->user === null) $this->user = Auth::user();
-        if(strlen($this->user->getUserId()) == 0) $this->user = self::$default_user;
+        if ($this->user === null) $this->user = Auth::user();
+        if (strlen($this->user->getUserId()) == 0) $this->user = self::$default_user;
         
         // Check if the user, or the default user, has a root already setup;
-        if(empty($this->getRootIndiId())) {
-            if($this->user == self::$default_user) {  // If the default user is not setup
+        if (empty($this->getRootIndiId())) {
+            if ($this->user == self::$default_user) {  // If the default user is not setup
                 $this->is_setup = false;
             }
             else {
@@ -145,7 +145,7 @@ 
      */
     public function getRootIndi() {
         $root_indi_id = $this->getRootIndiId();
-        if(!empty($root_indi_id)) {
+        if (!empty($root_indi_id)) {
             return Individual::getInstance($root_indi_id, $this->tree);
         }
         return null;
@@ -159,7 +159,7 @@ 
      * Remove all Sosa entries related to the gedcom file and user
      */
     public function deleteAll() {
-        if(!$this->is_setup) return;
+        if (!$this->is_setup) return;
         Database::prepare(
             'DELETE FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id= :tree_id and majs_user_id = :user_id ')
@@ -175,12 +175,12 @@ 
      * @param int $sosa
      */
     public function deleteAncestors($sosa) {
-        if(!$this->is_setup) return;
+        if (!$this->is_setup) return;
         $gen = Functions::getGeneration($sosa);
         Database::prepare(
             'DELETE FROM `##maj_sosa`'.
-            ' WHERE majs_gedcom_id=:tree_id and majs_user_id = :user_id' .
-            ' AND majs_gen >= :gen' .
+            ' WHERE majs_gedcom_id=:tree_id and majs_user_id = :user_id'.
+            ' AND majs_gen >= :gen'.
             ' AND FLOOR(majs_sosa / (POW(2, (majs_gen - :gen)))) = :sosa'
         )->execute(array(
             'tree_id' => $this->tree->getTreeId(), 
@@ -195,7 +195,7 @@ 
      * @param array $sosa_records
      */
     public function insertOrUpdate($sosa_records) {
-        if(!$this->is_setup) return;
+        if (!$this->is_setup) return;
         
         $treeid = $this->tree->getTreeId();
         $userid = $this->user->getUserId();
@@ -203,9 +203,9 @@ 
         $values_table = array();
         
         $i = 0;
-        foreach  ($sosa_records as $row) {
+        foreach ($sosa_records as $row) {
             $gen = Functions::getGeneration($row['sosa']);
-            if($gen <= self::MAX_DB_GENERATIONS) {
+            if ($gen <= self::MAX_DB_GENERATIONS) {
                 $questionmarks_table[] = 
                     '(:tree_id'.$i.', :user_id'.$i.', :sosa'.$i.', :indi_id'.$i.', :gen'.$i.', :byear'.$i.', :byearest'.$i.', :dyear'.$i.', :dyearest'.$i.')';
                 $values_table = array_merge(
@@ -226,9 +226,9 @@ 
             $i++;
         }
         
-        $sql = 'REPLACE INTO `##maj_sosa`' .
-            ' (majs_gedcom_id, majs_user_id, majs_sosa, majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)' .
-            ' VALUES '. implode(',', $questionmarks_table);
+        $sql = 'REPLACE INTO `##maj_sosa`'.
+            ' (majs_gedcom_id, majs_user_id, majs_sosa, majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)'.
+            ' VALUES '.implode(',', $questionmarks_table);
         Database::prepare($sql)->execute($values_table);
     }
     
@@ -244,7 +244,7 @@ 
      * @return array Array of sosa numbers
      */
     public function getSosaNumbers(Individual $indi) {
-        if(!$this->is_setup) return array();
+        if (!$this->is_setup) return array();
         return Database::prepare(
                 'SELECT majs_sosa, majs_gen FROM `##maj_sosa`'.
                 ' WHERE majs_i_id=:indi_id AND majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
@@ -261,7 +261,7 @@ 
      * @return number Last generation if found, 1 otherwise
      */
     public function getLastGeneration() {
-        if(!$this->is_setup) return;
+        if (!$this->is_setup) return;
         return Database::prepare(
                 'SELECT MAX(majs_gen) FROM `##maj_sosa`'.
                 ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'
@@ -280,13 +280,13 @@ 
      *
      * @return array Associative array of Sosa ancestors, with their generation, comma separated
      */
-    public function getAllSosaWithGenerations(){
-        if(!$this->is_setup) return array();
+    public function getAllSosaWithGenerations() {
+        if (!$this->is_setup) return array();
         return Database::prepare(
-            'SELECT majs_i_id AS indi,' .
-            ' GROUP_CONCAT(DISTINCT majs_gen ORDER BY majs_gen ASC SEPARATOR ",") AS generations' .
-            ' FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id' .
+            'SELECT majs_i_id AS indi,'.
+            ' GROUP_CONCAT(DISTINCT majs_gen ORDER BY majs_gen ASC SEPARATOR ",") AS generations'.
+            ' FROM `##maj_sosa`'.
+            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
             ' GROUP BY majs_i_id'
         )->execute(array(
             'tree_id' => $this->tree->getTreeId(),
@@ -300,13 +300,13 @@ 
      * @param number $gen Generation
      * @return array Array of Sosa individuals
      */
-    public function getSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_list_by_gen)
+    public function getSosaListAtGeneration($gen) {
+        if (!$this->is_setup) return array();
+        if (!$this->sosa_list_by_gen)
             $this->sosa_list_by_gen = array();
         
-        if($gen){
-            if(!isset($this->sosa_list_by_gen[$gen])){
+        if ($gen) {
+            if (!isset($this->sosa_list_by_gen[$gen])) {
                 $this->sosa_list_by_gen[$gen] = Database::prepare(
                     'SELECT majs_sosa AS sosa, majs_i_id AS indi'.
                     ' FROM `##maj_sosa`'.
@@ -331,13 +331,13 @@ 
      * @param number $gen Generation
      * @return array Array of Sosa families
      */
-    public function getFamilySosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();
-        if(!$this->sosa_fam_list_by_gen)
+    public function getFamilySosaListAtGeneration($gen) {
+        if (!$this->is_setup) return array();
+        if (!$this->sosa_fam_list_by_gen)
             $this->sosa_fam_list_by_gen = array();
         
-        if($gen){
-            if(!isset($this->sosa_fam_list_by_gen[$gen])){
+        if ($gen) {
+            if (!isset($this->sosa_fam_list_by_gen[$gen])) {
                 $this->sosa_fam_list_by_gen[$gen] = Database::prepare(
                     'SELECT s1.majs_sosa AS sosa, f_id AS fam'.
                     ' FROM `##families`'.
@@ -367,9 +367,9 @@ 
      * @param number $gen Generation
      * @return array Array of Sosa individuals
      */
-    public function getMissingSosaListAtGeneration($gen){
-        if(!$this->is_setup) return array();    
-        if($gen){
+    public function getMissingSosaListAtGeneration($gen) {
+        if (!$this->is_setup) return array();    
+        if ($gen) {
             return $this->sosa_list_by_gen[$gen] = Database::prepare(
                 'SELECT schild.majs_sosa sosa, schild.majs_i_id indi, sfat.majs_sosa IS NOT NULL has_father, smot.majs_sosa IS NOT NULL has_mother'.
                 ' FROM `##maj_sosa` schild'.
@@ -408,10 +408,10 @@ 
      * @return array Statistics array
      */
     public function getStatisticsByGeneration() {
-        if(!$this->is_setup) return array();
-        if(!$this->statistics_tab) {
+        if (!$this->is_setup) return array();
+        if (!$this->statistics_tab) {
             $this->statistics_tab = array();
-            if($maxGeneration = $this->getLastGeneration()) {
+            if ($maxGeneration = $this->getLastGeneration()) {
                 for ($gen = 1; $gen <= $maxGeneration; $gen++) {
                     $birthStats = $this->getStatsBirthYearInGeneration($gen);
                     $this->statistics_tab[$gen] = array(
@@ -436,9 +436,9 @@ 
 	 * @return int
 	 */
 	public function getTotalIndividuals() {
-	    if(!$this->is_setup) return 0;
+	    if (!$this->is_setup) return 0;
 	    return Database::prepare(
-	        'SELECT COUNT(*) FROM `##individuals`' .
+	        'SELECT COUNT(*) FROM `##individuals`'.
 	        ' WHERE i_file = :tree_id')
 	        ->execute(array('tree_id' => $this->tree->getTreeId()))
 	        ->fetchOne() ?: 0;
@@ -449,10 +449,10 @@ 
      *
      * @return number Number of Sosas
      */
-    public function getSosaCount(){
-        if(!$this->is_setup) return 0;
+    public function getSosaCount() {
+        if (!$this->is_setup) return 0;
         return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
             ->execute(array(
                 'tree_id' => $this->tree->getTreeId(), 
@@ -466,10 +466,10 @@ 
      * @param number $gen Generation
      * @return number Number of Sosas in generation
      */
-    public function getSosaCountAtGeneration($gen){
-        if(!$this->is_setup) return 0;
+    public function getSosaCountAtGeneration($gen) {
+        if (!$this->is_setup) return 0;
         return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
             ' AND majs_gen= :gen')
         ->execute(array(
@@ -485,10 +485,10 @@ 
      * @param number $gen Generation
      * @return number Total number of Sosas up to generation
      */
-    public function getSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
+    public function getSosaCountUpToGeneration($gen) {
+        if (!$this->is_setup) return 0;
         return Database::prepare(
-            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`' .
+            'SELECT COUNT(majs_sosa) FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
             ' AND majs_gen <= :gen')
         ->execute(array(
@@ -503,10 +503,10 @@ 
      *
      * @return number Total number of distinct individual
      */
-    public function getDifferentSosaCount(){
-        if(!$this->is_setup) return 0;
+    public function getDifferentSosaCount() {
+        if (!$this->is_setup) return 0;
         return Database::prepare(
-            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
+            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id')
         ->execute(array(
                 'tree_id' => $this->tree->getTreeId(), 
@@ -520,10 +520,10 @@ 
      * @param number $gen Generation
      * @return number Number of distinct Sosa individuals up to generation
      */
-    public function getDifferentSosaCountUpToGeneration($gen){
-        if(!$this->is_setup) return 0;
+    public function getDifferentSosaCountUpToGeneration($gen) {
+        if (!$this->is_setup) return 0;
         return Database::prepare(
-            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`' .
+            'SELECT COUNT(DISTINCT majs_i_id) FROM `##maj_sosa`'.
             ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
             ' AND majs_gen <= :gen')
         ->execute(array(
@@ -545,8 +545,8 @@ 
      * @param number $gen Generation
      * @return array Birth statistics array
      */
-    public function getStatsBirthYearInGeneration($gen){
-        if(!$this->is_setup) return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
+    public function getStatsBirthYearInGeneration($gen) {
+        if (!$this->is_setup) return array('first' => 0, 'first_est' => 0, 'avg' => 0, 'last' => 0, 'last_est' => 0);
         return Database::prepare(
             'SELECT'.
             ' MIN(majs_birth_year) AS first, MIN(majs_birth_year_est) AS first_est,'.
@@ -567,25 +567,25 @@ 
      *
      * @return number|NULL Mean generation time
      */
-    public function getMeanGenerationTime(){
-        if(!$this->is_setup) return;
-        if(!$this->statistics_tab){
+    public function getMeanGenerationTime() {
+        if (!$this->is_setup) return;
+        if (!$this->statistics_tab) {
             $this->getStatisticsByGeneration();
         }
         //Linear regression on x=generation and y=birthdate
-        $sum_xy = $sum_x = $sum_y= $sum_x2 = $n = 0;
-        foreach($this->statistics_tab as $gen=>$stats){
-            if(!is_null($stats['avgBirth'])) {
+        $sum_xy = $sum_x = $sum_y = $sum_x2 = $n = 0;
+        foreach ($this->statistics_tab as $gen=>$stats) {
+            if (!is_null($stats['avgBirth'])) {
                 $n++;
-                $sum_xy+=$gen*$stats['avgBirth'];
-                $sum_x+=$gen;
-                $sum_y+=$stats['avgBirth'];
-                $sum_x2+=$gen*$gen;
+                $sum_xy += $gen * $stats['avgBirth'];
+                $sum_x += $gen;
+                $sum_y += $stats['avgBirth'];
+                $sum_x2 += $gen * $gen;
             }
         }
-        $denom=($n*$sum_x2)-($sum_x*$sum_x);
-        if($denom!=0){
-            return -(($n*$sum_xy)-($sum_x*$sum_y))/($denom);
+        $denom = ($n * $sum_x2) - ($sum_x * $sum_x);
+        if ($denom != 0) {
+            return -(($n * $sum_xy) - ($sum_x * $sum_y)) / ($denom);
         }
         return null;
     }
@@ -609,7 +609,7 @@ 
      * @return array
      */
     public function getGenerationDepthStatsAtGen($gen) {
-        if(!$this->is_setup) return array();
+        if (!$this->is_setup) return array();
         $gen_depth_stats_raw = Database::prepare(
             'SELECT stats_by_gen.root_ancestor AS root_ancestor_sosa,'.
             '   sosa_list.majs_i_id as root_ancestor_id,'.
@@ -684,14 +684,14 @@ 
      * @return array
      */
     public function getAncestorDispersionForGen($gen) {
-        if(!$this->is_setup || $gen > 11) return array();  // Going further than 11 gen will be out of range in the query
+        if (!$this->is_setup || $gen > 11) return array(); // Going further than 11 gen will be out of range in the query
         return Database::prepare(
             'SELECT branches, count(i_id)'.
             ' FROM ('.
             '   SELECT i_id,'.
             '       CASE'.
             '           WHEN CEIL(LOG2(SUM(branch))) = LOG2(SUM(branch)) THEN SUM(branch)'.
-            '           ELSE -1'.   // We put all ancestors shared between some branches in the same bucket
+            '           ELSE -1'.// We put all ancestors shared between some branches in the same bucket
             '       END branches'.
             '   FROM ('.
             '       SELECT DISTINCT majs_i_id i_id,'.
@@ -724,7 +724,7 @@ 
      * @return array 
      */
     public function getTopMultiSosaAncestorsNoTies($limit) {
-        if(!$this->is_setup) return array();
+        if (!$this->is_setup) return array();
         return Database::prepare(
             'SELECT sosa_i_id, sosa_count FROM ('.
             '   SELECT'.
@@ -737,20 +737,20 @@ 
             '           COUNT(sosa.majs_sosa) sosa_count,'.
             '           MIN(sosa.majs_sosa) sosa_min'.
             '       FROM ##maj_sosa AS sosa'.
-            '       LEFT JOIN ##maj_sosa AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.   // Link to sosa's father
+            '       LEFT JOIN ##maj_sosa AS sosa_fat ON sosa_fat.majs_sosa = 2 * sosa.majs_sosa'.// Link to sosa's father
             '           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
             '           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
-            '       LEFT JOIN ##maj_sosa AS sosa_mot on sosa_mot.majs_sosa = (2 * sosa.majs_sosa + 1)'.  // Link to sosa's mother
+            '       LEFT JOIN ##maj_sosa AS sosa_mot on sosa_mot.majs_sosa = (2 * sosa.majs_sosa + 1)'.// Link to sosa's mother
             '           AND sosa.majs_gedcom_id = sosa_fat.majs_gedcom_id'.
             '           AND sosa.majs_user_id = sosa_fat.majs_user_id'.
             '       WHERE sosa.majs_gedcom_id = :tree_id'.
             '       AND sosa.majs_user_id = :user_id'.
-            '       AND sosa_fat.majs_sosa IS NULL'.    // We keep only root individuals, i.e. those with no father or mother
+            '       AND sosa_fat.majs_sosa IS NULL'.// We keep only root individuals, i.e. those with no father or mother
             '       AND sosa_mot.majs_sosa IS NULL'. 
             '       GROUP BY sosa.majs_i_id'.
-            '       HAVING COUNT(sosa.majs_sosa) > 1'.   // Limit to the duplicate sosas.
+            '       HAVING COUNT(sosa.majs_sosa) > 1'.// Limit to the duplicate sosas.
             '       ORDER BY COUNT(sosa.majs_sosa) DESC'.
-            '       LIMIT ' . ($limit + 1) . // We want to select one more than required
+            '       LIMIT '.($limit + 1).// We want to select one more than required
             '   ) AS top_sosa,'.
             '   (SELECT @prev_count := 0, @keep := 0) x'.
             '   ORDER BY top_sosa.sosa_count ASC'.

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

Indentation +329 added lines, -329 removed lines

@@ -21,130 +21,130 @@ 
  */
 class GeoAnalysisProvider {
     
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    protected $tree;
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	protected $tree;
     
-    /**
-     * Cached hierarchy of places in the Gedcom file.
-     * 
-     * @var (array|null) $place_hierarchy
-     */
-    protected $place_hierarchy;
+	/**
+	 * Cached hierarchy of places in the Gedcom file.
+	 * 
+	 * @var (array|null) $place_hierarchy
+	 */
+	protected $place_hierarchy;
     
-    /**
-     * Constructor for GeoAnalysis Provider.
-     * A provider is defined in relation to a specific tree.
-     *
-     * @param Tree $tree
-     */
-    public function __construct(Tree $tree) {
-        $this->tree = $tree;
-        $this->place_hierarchy = null;
-    }
+	/**
+	 * Constructor for GeoAnalysis Provider.
+	 * A provider is defined in relation to a specific tree.
+	 *
+	 * @param Tree $tree
+	 */
+	public function __construct(Tree $tree) {
+		$this->tree = $tree;
+		$this->place_hierarchy = null;
+	}
     
-    /**
-     * Creates and returns a GeoAnalysis object from a data row.
-     * The row data is expected to be an array with the indexes:
-     *  - majgd_id: geodispersion analysis ID
-     *  - majgd_descr: geodispersion analysis description/title
-     *  - majgd_sublevel: Analysis level
-     *  - majgd_useflagsgen: Use flags in places display
-     *  - majgd_detailsgen: Number of top places
-     *  - majgd_map: file name of the map
-     *  - majgd_toplevel: parent level for the map
-     * 
-     * @param array $row
-     * @return GeoAnalysis
-     */
-    protected function loadGeoAnalysisFromRow($row) {
-        $options = new GeoDisplayOptions();
-        $options
-        ->setUsingFlags($row['majgd_useflagsgen'] == 'yes')
-        ->setMaxDetailsInGen($row['majgd_detailsgen']);
+	/**
+	 * Creates and returns a GeoAnalysis object from a data row.
+	 * The row data is expected to be an array with the indexes:
+	 *  - majgd_id: geodispersion analysis ID
+	 *  - majgd_descr: geodispersion analysis description/title
+	 *  - majgd_sublevel: Analysis level
+	 *  - majgd_useflagsgen: Use flags in places display
+	 *  - majgd_detailsgen: Number of top places
+	 *  - majgd_map: file name of the map
+	 *  - majgd_toplevel: parent level for the map
+	 * 
+	 * @param array $row
+	 * @return GeoAnalysis
+	 */
+	protected function loadGeoAnalysisFromRow($row) {
+		$options = new GeoDisplayOptions();
+		$options
+		->setUsingFlags($row['majgd_useflagsgen'] == 'yes')
+		->setMaxDetailsInGen($row['majgd_detailsgen']);
         
-        if($row['majgd_map']) {
-            $options
-            ->setMap(new OutlineMap($row['majgd_map']))
-            ->setMapLevel($row['majgd_toplevel']);
-        }
+		if($row['majgd_map']) {
+			$options
+			->setMap(new OutlineMap($row['majgd_map']))
+			->setMapLevel($row['majgd_toplevel']);
+		}
         
-        $enabled = true;
-        if(isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
-            $enabled = false;
-        }
+		$enabled = true;
+		if(isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
+			$enabled = false;
+		}
         
-        return new GeoAnalysis(
-            $this->tree,
-            $row['majgd_id'],
-            $row['majgd_descr'],
-            $row['majgd_sublevel'],
-            $options,
-            $enabled
-            );
-    }
+		return new GeoAnalysis(
+			$this->tree,
+			$row['majgd_id'],
+			$row['majgd_descr'],
+			$row['majgd_sublevel'],
+			$options,
+			$enabled
+			);
+	}
     
-    /**
-     * Returns the number of geographical analysis (active and inactive). 
-     * 
-     * @return int
-     */
-    public function getGeoAnalysisCount() {
-        return Database::prepare(
-            'SELECT COUNT(majgd_id)' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id'
-            )->execute(array(
-                'gedcom_id' => $this->tree->getTreeId()
-            ))->fetchOne();
-    }
+	/**
+	 * Returns the number of geographical analysis (active and inactive). 
+	 * 
+	 * @return int
+	 */
+	public function getGeoAnalysisCount() {
+		return Database::prepare(
+			'SELECT COUNT(majgd_id)' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id'
+			)->execute(array(
+				'gedcom_id' => $this->tree->getTreeId()
+			))->fetchOne();
+	}
     
-    /**
-     * Get a geographical analysis by its ID.
-     * The function can only search for only enabled analysis, or all.
-     * 
-     * @param int $id geodispersion analysis ID
-     * @param bool $only_enabled Search for only enabled geodispersion analysis
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis|NULL
-     */
-    public function getGeoAnalysis($id, $only_enabled = true) {
-        $args = array (
-            'gedcom_id' => $this->tree->getTreeId(),
-            'ga_id' => $id
-        );
+	/**
+	 * Get a geographical analysis by its ID.
+	 * The function can only search for only enabled analysis, or all.
+	 * 
+	 * @param int $id geodispersion analysis ID
+	 * @param bool $only_enabled Search for only enabled geodispersion analysis
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis|NULL
+	 */
+	public function getGeoAnalysis($id, $only_enabled = true) {
+		$args = array (
+			'gedcom_id' => $this->tree->getTreeId(),
+			'ga_id' => $id
+		);
         
-        $sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id';
-        if($only_enabled) {
-            $sql .= ' AND majgd_status = :status';
-            $args['status'] = 'enabled';
-        }
-        $sql .= ' ORDER BY majgd_descr';
+		$sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id';
+		if($only_enabled) {
+			$sql .= ' AND majgd_status = :status';
+			$args['status'] = 'enabled';
+		}
+		$sql .= ' ORDER BY majgd_descr';
         
-        $ga_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
+		$ga_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
         
-        if($ga_array) {
-            return $this->loadGeoAnalysisFromRow($ga_array);
-        }
+		if($ga_array) {
+			return $this->loadGeoAnalysisFromRow($ga_array);
+		}
         
-        return null;            
-    }
+		return null;            
+	}
     
-    /**
-     * Add a new geodispersion analysis in the database, in a transactional manner.
-     * When successful, eturns the newly created GeoAnalysis object.
-     * 
-     * @param string $description geodispersion analysis title
-     * @param int $analysis_level Analysis level
-     * @param string $map_file Filename of the map
-     * @param int $map_top_level Parent level of the map
-     * @param bool $use_flags Use flag in the place display
-     * @param int $gen_details Number of top places to display
-     * @return GeoAnalysis
-     */
+	/**
+	 * Add a new geodispersion analysis in the database, in a transactional manner.
+	 * When successful, eturns the newly created GeoAnalysis object.
+	 * 
+	 * @param string $description geodispersion analysis title
+	 * @param int $analysis_level Analysis level
+	 * @param string $map_file Filename of the map
+	 * @param int $map_top_level Parent level of the map
+	 * @param bool $use_flags Use flag in the place display
+	 * @param int $gen_details Number of top places to display
+	 * @return GeoAnalysis
+	 */
 	public function createGeoAnalysis($description, $analysis_level, $map_file, $map_top_level, $use_flags, $gen_details) {
 		try{
 			Database::beginTransaction();
@@ -174,17 +174,17 @@ 
 			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());
 		}
 		return $ga;
-    }
+	}
 	
-    /**
-     * Update a geodispersion analysis in the database, in transactional manner.
-     * When successful, returns the updated GeoAnalysis object
-     *  
-     * @param GeoAnalysis $ga
-     * @return GeoAnalysis
-     */
-    public function updateGeoAnalysis(GeoAnalysis $ga) {
-        try {
+	/**
+	 * Update a geodispersion analysis in the database, in transactional manner.
+	 * When successful, returns the updated GeoAnalysis object
+	 *  
+	 * @param GeoAnalysis $ga
+	 * @return GeoAnalysis
+	 */
+	public function updateGeoAnalysis(GeoAnalysis $ga) {
+		try {
 			Database::beginTransaction();
 		
 			Database::prepare(
@@ -217,239 +217,239 @@ 
 			$ga = null;
 		}
 		return $ga;
-    }
+	}
     
-    /**
-     * Set the status of a specific analysis.
-     * The status can be enabled (true), or disabled (false).
-     * 
-     * @param GeoAnalysis $ga
-     * @param bool $status
-     */
-    public function setGeoAnalysisStatus(GeoAnalysis $ga, $status) {
-        Database::prepare(
-            'UPDATE `##maj_geodispersion`'.
-            ' SET majgd_status = :status'.
-            ' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id'
-        )->execute(array(
-                'gedcom_id' => $this->tree->getTreeId(),
-                'status' => $status ? 'enabled' : 'disabled',
-                'ga_id' => $ga->getId()
-        ));
-    }
+	/**
+	 * Set the status of a specific analysis.
+	 * The status can be enabled (true), or disabled (false).
+	 * 
+	 * @param GeoAnalysis $ga
+	 * @param bool $status
+	 */
+	public function setGeoAnalysisStatus(GeoAnalysis $ga, $status) {
+		Database::prepare(
+			'UPDATE `##maj_geodispersion`'.
+			' SET majgd_status = :status'.
+			' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id'
+		)->execute(array(
+				'gedcom_id' => $this->tree->getTreeId(),
+				'status' => $status ? 'enabled' : 'disabled',
+				'ga_id' => $ga->getId()
+		));
+	}
     
-    /**
-     * Delete a geodispersion analysis from the database.
-     * 
-     * @param GeoAnalysis $ga
-     */
-    public function deleteGeoAnalysis(GeoAnalysis $ga) {
-        Database::prepare(
-            'DELETE FROM `##maj_geodispersion`'.
-            ' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id'
-            )->execute(array(
-                'gedcom_id' => $this->tree->getTreeId(),
-                'ga_id' => $ga->getId()
-            ));
-    }
+	/**
+	 * Delete a geodispersion analysis from the database.
+	 * 
+	 * @param GeoAnalysis $ga
+	 */
+	public function deleteGeoAnalysis(GeoAnalysis $ga) {
+		Database::prepare(
+			'DELETE FROM `##maj_geodispersion`'.
+			' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id'
+			)->execute(array(
+				'gedcom_id' => $this->tree->getTreeId(),
+				'ga_id' => $ga->getId()
+			));
+	}
         
-    /**
-     * Return the list of geodispersion analysis recorded and enabled for a specific GEDCOM
-     *
-     * @return array List of enabled maps
-     */
-    public function getGeoAnalysisList(){
-        $res = array();
+	/**
+	 * Return the list of geodispersion analysis recorded and enabled for a specific GEDCOM
+	 *
+	 * @return array List of enabled maps
+	 */
+	public function getGeoAnalysisList(){
+		$res = array();
         
-        $list = Database::prepare(
-            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id AND majgd_status = :status'.
-            ' ORDER BY majgd_descr'
-        )->execute(array(
-            'gedcom_id' => $this->tree->getTreeId(),
-            'status' => 'enabled'
-        ))->fetchAll(\PDO::FETCH_ASSOC);
+		$list = Database::prepare(
+			'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id AND majgd_status = :status'.
+			' ORDER BY majgd_descr'
+		)->execute(array(
+			'gedcom_id' => $this->tree->getTreeId(),
+			'status' => 'enabled'
+		))->fetchAll(\PDO::FETCH_ASSOC);
         
-        foreach($list as $ga) {
-           $res[] = $this->loadGeoAnalysisFromRow($ga);
-        }
+		foreach($list as $ga) {
+		   $res[] = $this->loadGeoAnalysisFromRow($ga);
+		}
         
-        return $res;
-    }
+		return $res;
+	}
     
-    /**
-     * Return the list of geodispersion analysis matching specified criterias.
-     * 
-     * @param string $search Search criteria in analysis description
-     * @param array $order_by Columns to order by
-     * @param int $start Offset to start with (for pagination)
-     * @param int|null $limit Max number of items to return (for pagination)
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis[]
-     */
-    public function getFilteredGeoAnalysisList($search = null, $order_by = null, $start = 0, $limit = null){
-        $res = array();
+	/**
+	 * Return the list of geodispersion analysis matching specified criterias.
+	 * 
+	 * @param string $search Search criteria in analysis description
+	 * @param array $order_by Columns to order by
+	 * @param int $start Offset to start with (for pagination)
+	 * @param int|null $limit Max number of items to return (for pagination)
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis[]
+	 */
+	public function getFilteredGeoAnalysisList($search = null, $order_by = null, $start = 0, $limit = null){
+		$res = array();
             
-        $sql = 
-            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id';
+		$sql = 
+			'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id';
         
-        $args = array('gedcom_id'=> $this->tree->getTreeId());
+		$args = array('gedcom_id'=> $this->tree->getTreeId());
         
-        if($search) {
-            $sql .= ' AND majgd_descr LIKE CONCAT(\'%\', :search, \'%\')';
-            $args['search'] = $search;
-        }
+		if($search) {
+			$sql .= ' AND majgd_descr LIKE CONCAT(\'%\', :search, \'%\')';
+			$args['search'] = $search;
+		}
         
-        if ($order_by) {
-            $sql .= ' ORDER BY ';
-            foreach ($order_by as $key => $value) {
-                if ($key > 0) {
-                    $sql .= ',';
-                }
+		if ($order_by) {
+			$sql .= ' ORDER BY ';
+			foreach ($order_by as $key => $value) {
+				if ($key > 0) {
+					$sql .= ',';
+				}
                 
-                switch ($value['dir']) {
-                    case 'asc':
-                        $sql .= $value['column'] . ' ASC ';
-                        break;
-                    case 'desc':
-                        $sql .= $value['column'] . ' DESC ';
-                        break;
-                }
-            }
-        } else {
-            $sql .= ' ORDER BY majgd_descr ASC';
-        }
+				switch ($value['dir']) {
+					case 'asc':
+						$sql .= $value['column'] . ' ASC ';
+						break;
+					case 'desc':
+						$sql .= $value['column'] . ' DESC ';
+						break;
+				}
+			}
+		} else {
+			$sql .= ' ORDER BY majgd_descr ASC';
+		}
         
-        if ($limit) {
-            $sql .= " LIMIT :limit OFFSET :offset";
-            $args['limit']  = $limit;
-            $args['offset'] = $start;
-        }
+		if ($limit) {
+			$sql .= " LIMIT :limit OFFSET :offset";
+			$args['limit']  = $limit;
+			$args['offset'] = $start;
+		}
             
-        $data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
+		$data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
 
-        foreach($data as $ga) {
-            $res[] = $this->loadGeoAnalysisFromRow($ga);
-        }
+		foreach($data as $ga) {
+			$res[] = $this->loadGeoAnalysisFromRow($ga);
+		}
         
-        return $res;
-    }
+		return $res;
+	}
             
-    /**
-     * Returns the infered place hierarchy, determined from the Gedcom data.
-     * Depending on the data, it can be based on the Gedcom Header description, or from a place example.
-     * This is returned as an associative array:
-     *      - type:    describe the source of the data (<em>header<em> / <em>data</em> / <em>none</em>)
-     *      - hierarchy: an array of the place hierarchy (in reverse order of the gedcom)
-     *      
-     * @return array
-     */
-    public function getPlacesHierarchy() {
-        if(!$this->place_hierarchy) {
-            if($place_structure = $this->getPlacesHierarchyFromHeader()) {
-                $this->place_hierarchy = array('type' => 'header', 'hierarchy' => $place_structure);
-            }
-            elseif ($place_structure = $this->getPlacesHierarchyFromData()){
-                $this->place_hierarchy = array('type' => 'data', 'hierarchy' => $place_structure);
-            }
-            else {
-                $this->place_hierarchy = array('type' => 'none', 'hierarchy' => null);
-            }
-        }
-        return $this->place_hierarchy;        
-    }
+	/**
+	 * Returns the infered place hierarchy, determined from the Gedcom data.
+	 * Depending on the data, it can be based on the Gedcom Header description, or from a place example.
+	 * This is returned as an associative array:
+	 *      - type:    describe the source of the data (<em>header<em> / <em>data</em> / <em>none</em>)
+	 *      - hierarchy: an array of the place hierarchy (in reverse order of the gedcom)
+	 *      
+	 * @return array
+	 */
+	public function getPlacesHierarchy() {
+		if(!$this->place_hierarchy) {
+			if($place_structure = $this->getPlacesHierarchyFromHeader()) {
+				$this->place_hierarchy = array('type' => 'header', 'hierarchy' => $place_structure);
+			}
+			elseif ($place_structure = $this->getPlacesHierarchyFromData()){
+				$this->place_hierarchy = array('type' => 'data', 'hierarchy' => $place_structure);
+			}
+			else {
+				$this->place_hierarchy = array('type' => 'none', 'hierarchy' => null);
+			}
+		}
+		return $this->place_hierarchy;        
+	}
     
-    /**
-     * Returns an array of the place hierarchy, as defined in the GEDCOM header.
-     * The places are reversed compared to normal GEDCOM structure.
-     * 
-     * @return array|null
-     */
-    protected function getPlacesHierarchyFromHeader() {
-        $head = GedcomRecord::getInstance('HEAD', $this->tree);
-        $head_place = $head->getFirstFact('PLAC');
-        if($head_place && $head_place_value = $head_place->getAttribute('FORM')){
-            return array_reverse(array_map('trim',explode(',', $head_place_value)));
-        }
-        return null;
-    }
+	/**
+	 * Returns an array of the place hierarchy, as defined in the GEDCOM header.
+	 * The places are reversed compared to normal GEDCOM structure.
+	 * 
+	 * @return array|null
+	 */
+	protected function getPlacesHierarchyFromHeader() {
+		$head = GedcomRecord::getInstance('HEAD', $this->tree);
+		$head_place = $head->getFirstFact('PLAC');
+		if($head_place && $head_place_value = $head_place->getAttribute('FORM')){
+			return array_reverse(array_map('trim',explode(',', $head_place_value)));
+		}
+		return null;
+	}
     
-    /**
-     * Returns an array of the place hierarchy, based on a random example of place within the GEDCOM.
-     * It will look for the longest hierarchy in the tree.
-     * The places are reversed compared to normal GEDCOM structure.
-     * 
-     * @return array
-     */
-    protected function getPlacesHierarchyFromData() {
-        $nb_levels = 0;
+	/**
+	 * Returns an array of the place hierarchy, based on a random example of place within the GEDCOM.
+	 * It will look for the longest hierarchy in the tree.
+	 * The places are reversed compared to normal GEDCOM structure.
+	 * 
+	 * @return array
+	 */
+	protected function getPlacesHierarchyFromData() {
+		$nb_levels = 0;
         
-        //Select all '2 PLAC ' tags in the file and create array
-        $places_list=array();
-        $ged_data = Database::prepare(
-            'SELECT i_gedcom AS gedcom'.
-            ' FROM `##individuals`'.
-            ' WHERE i_gedcom LIKE :gedcom AND i_file = :gedcom_id'.
-            ' UNION ALL'.
-            ' SELECT f_gedcom AS gedcom'.
-            ' FROM `##families`'.
-            ' WHERE f_gedcom LIKE :gedcom AND f_file = :gedcom_id'
-        )->execute(array(
-            'gedcom' => '%2 PLAC %',
-            'gedcom_id' => $this->tree->getTreeId()
-        ))->fetchOneColumn();
-        foreach ($ged_data as $ged_datum) {
-            $matches = null;
-            preg_match_all('/\n2 PLAC (.+)/', $ged_datum, $matches);
-            foreach ($matches[1] as $match) {
-                $places_list[$match]=true;
-            }
-        }
+		//Select all '2 PLAC ' tags in the file and create array
+		$places_list=array();
+		$ged_data = Database::prepare(
+			'SELECT i_gedcom AS gedcom'.
+			' FROM `##individuals`'.
+			' WHERE i_gedcom LIKE :gedcom AND i_file = :gedcom_id'.
+			' UNION ALL'.
+			' SELECT f_gedcom AS gedcom'.
+			' FROM `##families`'.
+			' WHERE f_gedcom LIKE :gedcom AND f_file = :gedcom_id'
+		)->execute(array(
+			'gedcom' => '%2 PLAC %',
+			'gedcom_id' => $this->tree->getTreeId()
+		))->fetchOneColumn();
+		foreach ($ged_data as $ged_datum) {
+			$matches = null;
+			preg_match_all('/\n2 PLAC (.+)/', $ged_datum, $matches);
+			foreach ($matches[1] as $match) {
+				$places_list[$match]=true;
+			}
+		}
         
-        // Get the places with higest numbers of levels
-        $places_with_high_level = array();
-        $max_level = 0;
+		// Get the places with higest numbers of levels
+		$places_with_high_level = array();
+		$max_level = 0;
         
-        foreach ($places_list as $place => $value) {
-            $levels = array_filter(array_map('trim', explode(",", $place)));
-            $parts = count($levels);
-            if($parts > $max_level) {
-                $max_level = $parts;
-                $places_with_high_level = array($place);
-            }
-            else if ($parts == $max_level) {
-                $places_with_high_level[] = $place;
-            }
-        }
+		foreach ($places_list as $place => $value) {
+			$levels = array_filter(array_map('trim', explode(",", $place)));
+			$parts = count($levels);
+			if($parts > $max_level) {
+				$max_level = $parts;
+				$places_with_high_level = array($place);
+			}
+			else if ($parts == $max_level) {
+				$places_with_high_level[] = $place;
+			}
+		}
         
-        // If empty array, then return null
-        if($max_level == 0) return null;
+		// If empty array, then return null
+		if($max_level == 0) return null;
                 
-        // Else, return the first alphabetical element -- cannot return random to ensure always the same example if used
-        usort($places_with_high_level, array('Fisharebest\\Webtrees\\I18N', 'strcasecmp'));        
-        return array_reverse(array_map('trim',explode(',', $places_with_high_level[0])));
+		// Else, return the first alphabetical element -- cannot return random to ensure always the same example if used
+		usort($places_with_high_level, array('Fisharebest\\Webtrees\\I18N', 'strcasecmp'));        
+		return array_reverse(array_map('trim',explode(',', $places_with_high_level[0])));
         
-    }
+	}
     
-    /**
-     * Returns the list of geodispersion maps available within the maps folder.
-     * 
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\OutlineMap[]
-     */
-    public function getOutlineMapsList() {
-        $res = array();
-        $root_path = WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/';
-        if(is_dir($root_path)){
-            $dir = opendir($root_path);
-            while (($file=readdir($dir))!== false) {
-                if (preg_match('/^[a-zA-Z0-9_]+.xml$/', $file)) {
-                    $res[base64_encode($file)] = new OutlineMap($file, true);
-                }
-            }
-        }
-        return $res;
-    }
+	/**
+	 * Returns the list of geodispersion maps available within the maps folder.
+	 * 
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\OutlineMap[]
+	 */
+	public function getOutlineMapsList() {
+		$res = array();
+		$root_path = WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/';
+		if(is_dir($root_path)){
+			$dir = opendir($root_path);
+			while (($file=readdir($dir))!== false) {
+				if (preg_match('/^[a-zA-Z0-9_]+.xml$/', $file)) {
+					$res[base64_encode($file)] = new OutlineMap($file, true);
+				}
+			}
+		}
+		return $res;
+	}
 }
  
\ No newline at end of file

Spacing +36 added lines, -36 removed lines

@@ -65,14 +65,14 @@ 
         ->setUsingFlags($row['majgd_useflagsgen'] == 'yes')
         ->setMaxDetailsInGen($row['majgd_detailsgen']);
         
-        if($row['majgd_map']) {
+        if ($row['majgd_map']) {
             $options
             ->setMap(new OutlineMap($row['majgd_map']))
             ->setMapLevel($row['majgd_toplevel']);
         }
         
         $enabled = true;
-        if(isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
+        if (isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
             $enabled = false;
         }
         
@@ -93,8 +93,8 @@ 
      */
     public function getGeoAnalysisCount() {
         return Database::prepare(
-            'SELECT COUNT(majgd_id)' .
-            ' FROM `##maj_geodispersion`' .
+            'SELECT COUNT(majgd_id)'.
+            ' FROM `##maj_geodispersion`'.
             ' WHERE majgd_file = :gedcom_id'
             )->execute(array(
                 'gedcom_id' => $this->tree->getTreeId()
@@ -110,15 +110,15 @@ 
      * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis|NULL
      */
     public function getGeoAnalysis($id, $only_enabled = true) {
-        $args = array (
+        $args = array(
             'gedcom_id' => $this->tree->getTreeId(),
             'ga_id' => $id
         );
         
-        $sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
-            ' FROM `##maj_geodispersion`' .
+        $sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status'.
+            ' FROM `##maj_geodispersion`'.
             ' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id';
-        if($only_enabled) {
+        if ($only_enabled) {
             $sql .= ' AND majgd_status = :status';
             $args['status'] = 'enabled';
         }
@@ -126,7 +126,7 @@ 
         
         $ga_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
         
-        if($ga_array) {
+        if ($ga_array) {
             return $this->loadGeoAnalysisFromRow($ga_array);
         }
         
@@ -146,7 +146,7 @@ 
      * @return GeoAnalysis
      */
 	public function createGeoAnalysis($description, $analysis_level, $map_file, $map_top_level, $use_flags, $gen_details) {
-		try{
+		try {
 			Database::beginTransaction();
 		
 			Database::prepare(
@@ -168,7 +168,7 @@ 
 			
 			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());
@@ -211,9 +211,9 @@ 
 			
 			 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());
+			Log::addErrorLog('The Geo Analysis ID “'.$ga->getId().'” failed to be updated. Transaction rollbacked. Exception: '.$ex->getMessage());
 			$ga = null;
 		}
 		return $ga;
@@ -258,12 +258,12 @@ 
      *
      * @return array List of enabled maps
      */
-    public function getGeoAnalysisList(){
+    public function getGeoAnalysisList() {
         $res = array();
         
         $list = Database::prepare(
-            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen' .
-            ' FROM `##maj_geodispersion`' .
+            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen'.
+            ' FROM `##maj_geodispersion`'.
             ' WHERE majgd_file = :gedcom_id AND majgd_status = :status'.
             ' ORDER BY majgd_descr'
         )->execute(array(
@@ -271,7 +271,7 @@ 
             'status' => 'enabled'
         ))->fetchAll(\PDO::FETCH_ASSOC);
         
-        foreach($list as $ga) {
+        foreach ($list as $ga) {
            $res[] = $this->loadGeoAnalysisFromRow($ga);
         }
         
@@ -287,17 +287,17 @@ 
      * @param int|null $limit Max number of items to return (for pagination)
      * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis[]
      */
-    public function getFilteredGeoAnalysisList($search = null, $order_by = null, $start = 0, $limit = null){
+    public function getFilteredGeoAnalysisList($search = null, $order_by = null, $start = 0, $limit = null) {
         $res = array();
             
         $sql = 
-            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
-            ' FROM `##maj_geodispersion`' .
+            'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status'.
+            ' FROM `##maj_geodispersion`'.
             ' WHERE majgd_file = :gedcom_id';
         
         $args = array('gedcom_id'=> $this->tree->getTreeId());
         
-        if($search) {
+        if ($search) {
             $sql .= ' AND majgd_descr LIKE CONCAT(\'%\', :search, \'%\')';
             $args['search'] = $search;
         }
@@ -311,10 +311,10 @@ 
                 
                 switch ($value['dir']) {
                     case 'asc':
-                        $sql .= $value['column'] . ' ASC ';
+                        $sql .= $value['column'].' ASC ';
                         break;
                     case 'desc':
-                        $sql .= $value['column'] . ' DESC ';
+                        $sql .= $value['column'].' DESC ';
                         break;
                 }
             }
@@ -330,7 +330,7 @@ 
             
         $data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
 
-        foreach($data as $ga) {
+        foreach ($data as $ga) {
             $res[] = $this->loadGeoAnalysisFromRow($ga);
         }
         
@@ -347,11 +347,11 @@ 
      * @return array
      */
     public function getPlacesHierarchy() {
-        if(!$this->place_hierarchy) {
-            if($place_structure = $this->getPlacesHierarchyFromHeader()) {
+        if (!$this->place_hierarchy) {
+            if ($place_structure = $this->getPlacesHierarchyFromHeader()) {
                 $this->place_hierarchy = array('type' => 'header', 'hierarchy' => $place_structure);
             }
-            elseif ($place_structure = $this->getPlacesHierarchyFromData()){
+            elseif ($place_structure = $this->getPlacesHierarchyFromData()) {
                 $this->place_hierarchy = array('type' => 'data', 'hierarchy' => $place_structure);
             }
             else {
@@ -370,8 +370,8 @@ 
     protected function getPlacesHierarchyFromHeader() {
         $head = GedcomRecord::getInstance('HEAD', $this->tree);
         $head_place = $head->getFirstFact('PLAC');
-        if($head_place && $head_place_value = $head_place->getAttribute('FORM')){
-            return array_reverse(array_map('trim',explode(',', $head_place_value)));
+        if ($head_place && $head_place_value = $head_place->getAttribute('FORM')) {
+            return array_reverse(array_map('trim', explode(',', $head_place_value)));
         }
         return null;
     }
@@ -387,7 +387,7 @@ 
         $nb_levels = 0;
         
         //Select all '2 PLAC ' tags in the file and create array
-        $places_list=array();
+        $places_list = array();
         $ged_data = Database::prepare(
             'SELECT i_gedcom AS gedcom'.
             ' FROM `##individuals`'.
@@ -404,7 +404,7 @@ 
             $matches = null;
             preg_match_all('/\n2 PLAC (.+)/', $ged_datum, $matches);
             foreach ($matches[1] as $match) {
-                $places_list[$match]=true;
+                $places_list[$match] = true;
             }
         }
         
@@ -415,7 +415,7 @@ 
         foreach ($places_list as $place => $value) {
             $levels = array_filter(array_map('trim', explode(",", $place)));
             $parts = count($levels);
-            if($parts > $max_level) {
+            if ($parts > $max_level) {
                 $max_level = $parts;
                 $places_with_high_level = array($place);
             }
@@ -425,11 +425,11 @@ 
         }
         
         // If empty array, then return null
-        if($max_level == 0) return null;
+        if ($max_level == 0) return null;
                 
         // Else, return the first alphabetical element -- cannot return random to ensure always the same example if used
         usort($places_with_high_level, array('Fisharebest\\Webtrees\\I18N', 'strcasecmp'));        
-        return array_reverse(array_map('trim',explode(',', $places_with_high_level[0])));
+        return array_reverse(array_map('trim', explode(',', $places_with_high_level[0])));
         
     }
     
@@ -441,9 +441,9 @@ 
     public function getOutlineMapsList() {
         $res = array();
         $root_path = WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/';
-        if(is_dir($root_path)){
+        if (is_dir($root_path)) {
             $dir = opendir($root_path);
-            while (($file=readdir($dir))!== false) {
+            while (($file = readdir($dir)) !== false) {
                 if (preg_match('/^[a-zA-Z0-9_]+.xml$/', $file)) {
                     $res[base64_encode($file)] = new OutlineMap($file, true);
                 }

Braces +8 added lines, -11 removed lines

@@ -167,8 +167,7 @@ 
 			$ga = $this->getGeoAnalysis($id, false);
 			
 			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);
 			
 			 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,11 +348,9 @@ 
         if(!$this->place_hierarchy) {
             if($place_structure = $this->getPlacesHierarchyFromHeader()) {
                 $this->place_hierarchy = array('type' => 'header', 'hierarchy' => $place_structure);
-            }
-            elseif ($place_structure = $this->getPlacesHierarchyFromData()){
+            } elseif ($place_structure = $this->getPlacesHierarchyFromData()){
                 $this->place_hierarchy = array('type' => 'data', 'hierarchy' => $place_structure);
-            }
-            else {
+            } else {
                 $this->place_hierarchy = array('type' => 'none', 'hierarchy' => null);
             }
         }
@@ -418,14 +414,15 @@ 
             if($parts > $max_level) {
                 $max_level = $parts;
                 $places_with_high_level = array($place);
-            }
-            else if ($parts == $max_level) {
+            } else if ($parts == $max_level) {
                 $places_with_high_level[] = $place;
             }
         }
         
         // If empty array, then return null
-        if($max_level == 0) return null;
+        if($max_level == 0) {
+        	return null;
+        }
                 
         // Else, return the first alphabetical element -- cannot return random to ensure always the same example if used
         usort($places_with_high_level, array('Fisharebest\\Webtrees\\I18N', 'strcasecmp'));        

src/Webtrees/Module/GeoDispersion/Views/AdminConfigView.php

Indentation +25 added lines, -25 removed lines

@@ -23,14 +23,14 @@ 
 	 * {@inhericDoc}
 	 * @see \MyArtJaub\Webtrees\Mvc\View\AbstractView::renderContent()
 	 */
-    protected function renderContent() {
+	protected function renderContent() {
         
-        /** @var Tree $tree  */
-        $tree = $this->data->get('tree');
-        $root_url = $this->data->get('root_url');
-        $other_trees = $this->data->get('other_trees');
-        $table_id = $this->data->get('table_id');
-        ?>        
+		/** @var Tree $tree  */
+		$tree = $this->data->get('tree');
+		$root_url = $this->data->get('root_url');
+		$other_trees = $this->data->get('other_trees');
+		$table_id = $this->data->get('table_id');
+		?>        
         <ol class="breadcrumb small">
         	<li><a href="admin.php"><?php echo I18N::translate('Control panel'); ?></a></li>
 			<li><a href="admin_modules.php"><?php echo I18N::translate('Module administration'); ?></a></li>
@@ -63,23 +63,23 @@ 
 		<p>
 		<?php $places_hierarchy = $this->data->get('places_hierarchy'); 
 		if($places_hierarchy && $places_hierarchy['type'] != 'none') {
-		    switch ($places_hierarchy['type']) {
-		        case 'header':
-		            echo I18N::translate('According to the GEDCOM header, the places within your file follows the structure: ');
-		            break;
-		        case 'data':
-		            echo I18N::translate('Your GEDCOM header does not contain any indication of place structure.').
-		            '<br/>'.
-		            I18N::translate('Here is an example of your place data: ');
-		            break;
-		        default:
-		            break;
-		    }
-		    $str_hierarchy = array();
-		    foreach($places_hierarchy['hierarchy'] as $key => $level) {
-		        $str_hierarchy[] = I18N::translate('(%d) %s', $key + 1, $level);
-		    }
-		    echo '<strong>' . implode(I18N::$list_separator, $str_hierarchy) . '</strong>';
+			switch ($places_hierarchy['type']) {
+				case 'header':
+					echo I18N::translate('According to the GEDCOM header, the places within your file follows the structure: ');
+					break;
+				case 'data':
+					echo I18N::translate('Your GEDCOM header does not contain any indication of place structure.').
+					'<br/>'.
+					I18N::translate('Here is an example of your place data: ');
+					break;
+				default:
+					break;
+			}
+			$str_hierarchy = array();
+			foreach($places_hierarchy['hierarchy'] as $key => $level) {
+				$str_hierarchy[] = I18N::translate('(%d) %s', $key + 1, $level);
+			}
+			echo '<strong>' . implode(I18N::$list_separator, $str_hierarchy) . '</strong>';
 		}
 		?>
 		</p>
@@ -109,7 +109,7 @@ 
         </a>
 		
 		<?php        
-    }
+	}
     
 }
  
\ No newline at end of file

Spacing +7 added lines, -7 removed lines

@@ -41,16 +41,16 @@ 
 		
 		<h2>
 			<?php echo $tree->getTitleHtml(); ?>
-			<?php if(count($other_trees) > 0) {?>
+			<?php if (count($other_trees) > 0) {?>
 			<div class="btn-group">
 				<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
 					<?php echo I18N::translate('Change tree'); ?>
 					<span class="caret"></span>
 				</button>
-				<?php foreach($other_trees as $other_tree) { ?>
+				<?php foreach ($other_trees as $other_tree) { ?>
 				<ul class="dropdown-menu" role="menu">
 					<li>
-						<a href="<?php echo $root_url . '&ged=' . $other_tree->getNameUrl(); ?>">
+						<a href="<?php echo $root_url.'&ged='.$other_tree->getNameUrl(); ?>">
 							<i class="fa fa-fw fa-tree"></i>&nbsp;<?php echo $other_tree->getTitleHtml(); ?>
 						</a>
 					</li>
@@ -62,7 +62,7 @@ 
 		
 		<p>
 		<?php $places_hierarchy = $this->data->get('places_hierarchy'); 
-		if($places_hierarchy && $places_hierarchy['type'] != 'none') {
+		if ($places_hierarchy && $places_hierarchy['type'] != 'none') {
 		    switch ($places_hierarchy['type']) {
 		        case 'header':
 		            echo I18N::translate('According to the GEDCOM header, the places within your file follows the structure: ');
@@ -76,10 +76,10 @@ 
 		            break;
 		    }
 		    $str_hierarchy = array();
-		    foreach($places_hierarchy['hierarchy'] as $key => $level) {
+		    foreach ($places_hierarchy['hierarchy'] as $key => $level) {
 		        $str_hierarchy[] = I18N::translate('(%d) %s', $key + 1, $level);
 		    }
-		    echo '<strong>' . implode(I18N::$list_separator, $str_hierarchy) . '</strong>';
+		    echo '<strong>'.implode(I18N::$list_separator, $str_hierarchy).'</strong>';
 		}
 		?>
 		</p>
@@ -103,7 +103,7 @@ 
     		</tbody>
     	</table>
     	
-        <a type="button" class="btn btn-primary" href="<?php echo $root_url . '@add&ged=' . $tree->getNameUrl(); ?>" title="<?php echo I18N::translate('Add'); ?>">
+        <a type="button" class="btn btn-primary" href="<?php echo $root_url.'@add&ged='.$tree->getNameUrl(); ?>" title="<?php echo I18N::translate('Add'); ?>">
         	<i class="fa fa-plus"></i>
         	<?php echo I18N::translate('Add'); ?>
         </a>

src/Webtrees/Module/GeoDispersion/AdminConfigController.php

Indentation +225 added lines, -225 removed lines

@@ -36,58 +36,58 @@ 
  */
 class AdminConfigController extends MvcController
 {    
-    /**
-     * GeoAnalysis Provider
-     * @var GeoAnalysisProvider $provider
-     */
-    protected $provider;    
+	/**
+	 * GeoAnalysis Provider
+	 * @var GeoAnalysisProvider $provider
+	 */
+	protected $provider;    
     
-    /**
-     * Constructor for Admin Config controller
-     * @param AbstractModule $module
-     */
-    public function __construct(AbstractModule $module) {
-        parent::__construct($module);
+	/**
+	 * Constructor for Admin Config controller
+	 * @param AbstractModule $module
+	 */
+	public function __construct(AbstractModule $module) {
+		parent::__construct($module);
         
-        $this->provider = $this->module->getProvider();
-    }    
+		$this->provider = $this->module->getProvider();
+	}    
     
-    /**
-     * Pages
-     */
+	/**
+	 * Pages
+	 */
         
-    /**
-     * AdminConfig@index
-     */
-    public function index() {
-        $wt_tree = Globals::getTree();
-        Theme::theme(new AdministrationTheme)->init($wt_tree);
-        $controller = new PageController();
-        $controller
-            ->restrictAccess(Auth::isManager($wt_tree))
-            ->setPageTitle($this->module->getTitle());
+	/**
+	 * AdminConfig@index
+	 */
+	public function index() {
+		$wt_tree = Globals::getTree();
+		Theme::theme(new AdministrationTheme)->init($wt_tree);
+		$controller = new PageController();
+		$controller
+			->restrictAccess(Auth::isManager($wt_tree))
+			->setPageTitle($this->module->getTitle());
         
-        $data = new ViewBag();
-        $data->set('title', $controller->getPageTitle());
-        $data->set('tree', $wt_tree);
+		$data = new ViewBag();
+		$data->set('title', $controller->getPageTitle());
+		$data->set('tree', $wt_tree);
         
-        $data->set('root_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig');
+		$data->set('root_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig');
                 
-        $table_id = 'table-geoanalysis-' . Uuid::uuid4();
-        $data->set('table_id', $table_id);
+		$table_id = 'table-geoanalysis-' . Uuid::uuid4();
+		$data->set('table_id', $table_id);
         
-        $other_trees = array();
-        foreach (Tree::getAll() as $tree) {
-            if($tree->getTreeId() != $wt_tree->getTreeId()) $other_trees[] = $tree;
-        }      
-        $data->set('other_trees', $other_trees);
+		$other_trees = array();
+		foreach (Tree::getAll() as $tree) {
+			if($tree->getTreeId() != $wt_tree->getTreeId()) $other_trees[] = $tree;
+		}      
+		$data->set('other_trees', $other_trees);
         
-        $data->set('places_hierarchy', $this->provider->getPlacesHierarchy());
+		$data->set('places_hierarchy', $this->provider->getPlacesHierarchy());
         
-        $controller
-            ->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL)
-            ->addExternalJavascript(WT_DATATABLES_BOOTSTRAP_JS_URL)
-            ->addInlineJavascript('
+		$controller
+			->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL)
+			->addExternalJavascript(WT_DATATABLES_BOOTSTRAP_JS_URL)
+			->addInlineJavascript('
 				jQuery.fn.dataTableExt.oSort["text-asc"] = textCompareAsc;
 				jQuery.fn.dataTableExt.oSort["text-desc"] = textCompareDesc;
                 
@@ -119,7 +119,7 @@ 
 				});
                 
                 ')
-                ->addInlineJavascript('				
+				->addInlineJavascript('				
                     function set_geoanalysis_status(ga_id, status, gedcom) {
                 		jQuery.ajax({
                             url: "module.php", 
@@ -163,54 +163,54 @@ 
                 ');
         
         
-        ViewFactory::make('AdminConfig', $this, $controller, $data)->render();
-    }
+		ViewFactory::make('AdminConfig', $this, $controller, $data)->render();
+	}
 
-    /**
-     * AdminConfig@jsonGeoAnalysisList
-     */
-    public function jsonGeoAnalysisList() {
-        $wt_tree = Globals::getTree();
-        $controller = new JsonController();
-        $controller
-            ->restrictAccess(Auth::isManager($wt_tree));
+	/**
+	 * AdminConfig@jsonGeoAnalysisList
+	 */
+	public function jsonGeoAnalysisList() {
+		$wt_tree = Globals::getTree();
+		$controller = new JsonController();
+		$controller
+			->restrictAccess(Auth::isManager($wt_tree));
         
-        // Generate an AJAX/JSON response for datatables to load a block of rows
-        $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
-        $start  = Filter::postInteger('start');
-        $length = Filter::postInteger('length');
-        $order  = Filter::postArray('order');
+		// Generate an AJAX/JSON response for datatables to load a block of rows
+		$search = Filter::postArray('search');
+		if($search) $search = $search['value'];
+		$start  = Filter::postInteger('start');
+		$length = Filter::postInteger('length');
+		$order  = Filter::postArray('order');
         
-        foreach($order as $key => &$value) {
-            switch($value['column']) {
-                case 3:
-                    $value['column'] = 'majgd_descr';
-                    break;
-                case 5;
-                    $value['column'] = 'majgd_sublevel';
-                    break;
-                default:
-                    unset($order[$key]);
-            }
-        }
+		foreach($order as $key => &$value) {
+			switch($value['column']) {
+				case 3:
+					$value['column'] = 'majgd_descr';
+					break;
+				case 5;
+					$value['column'] = 'majgd_sublevel';
+					break;
+				default:
+					unset($order[$key]);
+			}
+		}
         
-        /** @var GeoAnalysisProvider $provider */
-        $provider = $this->module->getProvider();
+		/** @var GeoAnalysisProvider $provider */
+		$provider = $this->module->getProvider();
         
-        $list = $provider->getFilteredGeoAnalysisList($search, $order, $start, $length);
-        $recordsFiltered = count($list);
-        $recordsTotal = $this->provider->getGeoAnalysisCount();
+		$list = $provider->getFilteredGeoAnalysisList($search, $order, $start, $length);
+		$recordsFiltered = count($list);
+		$recordsTotal = $this->provider->getGeoAnalysisCount();
         
-        $data = array();
-        $place_hierarchy = $this->provider->getPlacesHierarchy();
-        foreach($list as $ga) {
-            /** @var GeoAnalysis $ga */
+		$data = array();
+		$place_hierarchy = $this->provider->getPlacesHierarchy();
+		foreach($list as $ga) {
+			/** @var GeoAnalysis $ga */
             
-            $datum = array();
-            $options= $ga->getOptions();
+			$datum = array();
+			$options= $ga->getOptions();
             
-            $datum[0] = '
+			$datum[0] = '
                 <div class="btn-group">
                     <button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
                         <i class="fa fa-pencil"></i><span class="caret"></span>
@@ -234,116 +234,116 @@ 
                        </li>
                     </ul>
                 </div>';
-		    $datum[1] = $ga->getId();
-		    $datum[2] = $ga->isEnabled() ? 
+			$datum[1] = $ga->getId();
+			$datum[2] = $ga->isEnabled() ? 
 				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : 
 				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
-		    $datum[3] = $ga->getTitle();
-		    $analysis_level = $ga->getAnalysisLevel();
-		    if($place_hierarchy['type'] == 'header') {
-		        $datum[4] = $place_hierarchy['hierarchy'][$analysis_level - 1];
-		    } elseif ($place_hierarchy['type'] == 'data') {
-		        $datum[4] = $analysis_level . ' (' . $place_hierarchy['hierarchy'][$analysis_level - 1] . ')';
-		    } else {
-		        $datum[4] = $analysis_level;
-		    }
-		    $datum[5] = $ga->getAnalysisLevel();
-		    $datum[6] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
-		    $datum[7] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
-		    if($ga->hasMap()) {
-		        if($options->getMap()->isLoaded()) {
-    		        $datum[6] = $options->getMap()->getDescription();
-    		        $datum[7] = '<span data-toggle="tooltip" title="' . $options->getMap()->getTopLevelName() . '" />';
-    		        $top_level = $options->getMapLevel();
-    		        if($place_hierarchy['type'] == 'header') {
-    		            $datum[7] .= $place_hierarchy['hierarchy'][$top_level - 1];
-    		        } elseif ($place_hierarchy['type'] == 'data') {
-    		            $datum[7] .= $top_level . ' (' . $place_hierarchy['hierarchy'][$top_level - 1] . ')';
-    		        } else {
-    		            $datum[7] .= $top_level;
-    		        }
-    		        $datum[7] .= '</span>';
-		        }
-		        else {
-		            $datum[6] = I18N::translate('Error when loading map.');
-		        }
-		    }
-		    $datum[8] = $options->isUsingFlags() ? 
+			$datum[3] = $ga->getTitle();
+			$analysis_level = $ga->getAnalysisLevel();
+			if($place_hierarchy['type'] == 'header') {
+				$datum[4] = $place_hierarchy['hierarchy'][$analysis_level - 1];
+			} elseif ($place_hierarchy['type'] == 'data') {
+				$datum[4] = $analysis_level . ' (' . $place_hierarchy['hierarchy'][$analysis_level - 1] . ')';
+			} else {
+				$datum[4] = $analysis_level;
+			}
+			$datum[5] = $ga->getAnalysisLevel();
+			$datum[6] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
+			$datum[7] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
+			if($ga->hasMap()) {
+				if($options->getMap()->isLoaded()) {
+					$datum[6] = $options->getMap()->getDescription();
+					$datum[7] = '<span data-toggle="tooltip" title="' . $options->getMap()->getTopLevelName() . '" />';
+					$top_level = $options->getMapLevel();
+					if($place_hierarchy['type'] == 'header') {
+						$datum[7] .= $place_hierarchy['hierarchy'][$top_level - 1];
+					} elseif ($place_hierarchy['type'] == 'data') {
+						$datum[7] .= $top_level . ' (' . $place_hierarchy['hierarchy'][$top_level - 1] . ')';
+					} else {
+						$datum[7] .= $top_level;
+					}
+					$datum[7] .= '</span>';
+				}
+				else {
+					$datum[6] = I18N::translate('Error when loading map.');
+				}
+			}
+			$datum[8] = $options->isUsingFlags() ? 
 				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : 
 				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
-		    $datum[9] = $options->getMaxDetailsInGen() > 0 ? $options->getMaxDetailsInGen() : I18N::translate('All');
+			$datum[9] = $options->getMaxDetailsInGen() > 0 ? $options->getMaxDetailsInGen() : I18N::translate('All');
 		    
-		    $data[] = $datum;
-        }
+			$data[] = $datum;
+		}
         
-        $controller->pageHeader();
+		$controller->pageHeader();
         
-        $controller->encode(array(
-            'draw'            => Filter::getInteger('draw'),
-            'recordsTotal'    => $recordsTotal,
-            'recordsFiltered' => $recordsFiltered,
-            'data'            => $data
-        ));
+		$controller->encode(array(
+			'draw'            => Filter::getInteger('draw'),
+			'recordsTotal'    => $recordsTotal,
+			'recordsFiltered' => $recordsFiltered,
+			'data'            => $data
+		));
         
-    }
+	}
 
-    /**
-     * AdminConfig@edit
-     */
-    public function edit() {
-        $ga_id = Filter::getInteger('ga_id');
-        $ga = $this->provider->getGeoAnalysis($ga_id, false);
+	/**
+	 * AdminConfig@edit
+	 */
+	public function edit() {
+		$ga_id = Filter::getInteger('ga_id');
+		$ga = $this->provider->getGeoAnalysis($ga_id, false);
         
-        $this->renderEdit($ga);
-    }
+		$this->renderEdit($ga);
+	}
     
-    /**
-     * AdminConfig@add
-     */
-    public function add() {
-        $this->renderEdit(null);
-    }
+	/**
+	 * AdminConfig@add
+	 */
+	public function add() {
+		$this->renderEdit(null);
+	}
     
-    /**
-     * AdminConfig@save
-     */
-    public function save() {
-        $wt_tree = Globals::getTree();
-        $tmp_contrl = new PageController();
-        $tmp_contrl->restrictAccess(
-            Auth::isManager($wt_tree) 
-            && Filter::checkCsrf()
-         );
+	/**
+	 * AdminConfig@save
+	 */
+	public function save() {
+		$wt_tree = Globals::getTree();
+		$tmp_contrl = new PageController();
+		$tmp_contrl->restrictAccess(
+			Auth::isManager($wt_tree) 
+			&& Filter::checkCsrf()
+		 );
         
-        $ga_id          = Filter::postInteger('ga_id');
-        $description    = Filter::post('description');
-        $analysislevel  = Filter::postInteger('analysislevel');
-        $use_map        = Filter::postBool('use_map');
-        if($use_map) {
-            $map_file   = base64_decode(Filter::post('map_file'));
-            $map_top_level   = Filter::postInteger('map_top_level');
-        }
-        $use_flags      = Filter::postBool('use_flags');
-        $gen_details    = Filter::postInteger('gen_details');
+		$ga_id          = Filter::postInteger('ga_id');
+		$description    = Filter::post('description');
+		$analysislevel  = Filter::postInteger('analysislevel');
+		$use_map        = Filter::postBool('use_map');
+		if($use_map) {
+			$map_file   = base64_decode(Filter::post('map_file'));
+			$map_top_level   = Filter::postInteger('map_top_level');
+		}
+		$use_flags      = Filter::postBool('use_flags');
+		$gen_details    = Filter::postInteger('gen_details');
         
-        $success = false; 
-        if($ga_id) {
-            $ga = $this->provider->getGeoAnalysis($ga_id, false);
-            if($ga) {
-                $ga->setTitle($description);
-                $ga->setAnalysisLevel($analysislevel + 1);
-                $options = $ga->getOptions();
-                if($options) {
-                    $options->setUsingFlags($use_flags);
-                    $options->setMaxDetailsInGen($gen_details);
-                    if($use_map) {
-                        $options->setMap(new OutlineMap($map_file));
-                        $options->setMapLevel($map_top_level + 1);
-                    }
-                    else {
-                        $options->setMap(null);
-                    }
-                }
+		$success = false; 
+		if($ga_id) {
+			$ga = $this->provider->getGeoAnalysis($ga_id, false);
+			if($ga) {
+				$ga->setTitle($description);
+				$ga->setAnalysisLevel($analysislevel + 1);
+				$options = $ga->getOptions();
+				if($options) {
+					$options->setUsingFlags($use_flags);
+					$options->setMaxDetailsInGen($gen_details);
+					if($use_map) {
+						$options->setMap(new OutlineMap($map_file));
+						$options->setMapLevel($map_top_level + 1);
+					}
+					else {
+						$options->setMap(null);
+					}
+				}
 				
 				$res = $this->provider->updateGeoAnalysis($ga);
 				if($res) {
@@ -356,8 +356,8 @@ 
 					FlashMessages::addMessage(I18N::translate('An error occured while updating the geographical dispersion analysis “%s”', $ga->getTitle()), 'danger');
 					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'. $ga->getId() .'” could not be updated. See error log.');
 				}
-            }
-        } else {
+			}
+		} else {
 			$ga = $this->provider->createGeoAnalysis(
 				$description,
 				$analysislevel + 1,
@@ -375,33 +375,33 @@ 
 				FlashMessages::addMessage(I18N::translate('An error occured while adding the geographical dispersion analysis “%s”', $description), 'danger');
 				Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis “'.$description.'” could not be added. See error log.');
 			}
-        }
+		}
         
-        $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl();
-        if(!$success) {			
-            if($ga) {
-                $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@edit&ga_id='. $ga->getId() .'&ged=' . $wt_tree->getNameUrl();
-            }
-            else {
-                $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@add&ged=' . $wt_tree->getNameUrl();
-            }
-        }        
-        header('Location: ' . WT_BASE_URL . $redirection_url);
+		$redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl();
+		if(!$success) {			
+			if($ga) {
+				$redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@edit&ga_id='. $ga->getId() .'&ged=' . $wt_tree->getNameUrl();
+			}
+			else {
+				$redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@add&ged=' . $wt_tree->getNameUrl();
+			}
+		}        
+		header('Location: ' . WT_BASE_URL . $redirection_url);
         
-    }
+	}
      
 	/**
 	 * Renders the edit form, whether it is an edition of an existing GeoAnalysis, or the addition of a new one.
 	 * 
 	 * @param (GeoAnalysis!null) $ga GeoAnalysis to edit
 	 */
-    protected function renderEdit(GeoAnalysis $ga = null) {
-        $wt_tree = Globals::getTree();
-        Theme::theme(new AdministrationTheme)->init($wt_tree);
-        $controller = new PageController();        
-        $controller
-            ->restrictAccess(Auth::isManager($wt_tree))
-            ->addInlineJavascript('
+	protected function renderEdit(GeoAnalysis $ga = null) {
+		$wt_tree = Globals::getTree();
+		Theme::theme(new AdministrationTheme)->init($wt_tree);
+		$controller = new PageController();        
+		$controller
+			->restrictAccess(Auth::isManager($wt_tree))
+			->addInlineJavascript('
                 function toggleMapOptions() {
                     if($("input:radio[name=\'use_map\']:checked").val() == 1) {
                         $("#map_options").show();
@@ -415,34 +415,34 @@ 
                 toggleMapOptions();
             ');
         
-        $data = new ViewBag();
-        if($ga) {
-            $controller->setPageTitle(I18N::translate('Edit the geographical dispersion analysis'));
-            $data->set('geo_analysis', $ga);
-        } else {
-            $controller->setPageTitle(I18N::translate('Add a geographical dispersion analysis'));
-        }
+		$data = new ViewBag();
+		if($ga) {
+			$controller->setPageTitle(I18N::translate('Edit the geographical dispersion analysis'));
+			$data->set('geo_analysis', $ga);
+		} else {
+			$controller->setPageTitle(I18N::translate('Add a geographical dispersion analysis'));
+		}
         
-        $data->set('title', $controller->getPageTitle());
-        $data->set('admin_config_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl());
-        $data->set('module_title', $this->module->getTitle());
-        $data->set('save_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@save&ged=' . $wt_tree->getNameUrl());
-        $data->set('places_hierarchy', $this->provider->getPlacesHierarchy());
+		$data->set('title', $controller->getPageTitle());
+		$data->set('admin_config_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl());
+		$data->set('module_title', $this->module->getTitle());
+		$data->set('save_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@save&ged=' . $wt_tree->getNameUrl());
+		$data->set('places_hierarchy', $this->provider->getPlacesHierarchy());
     
-        $map_list = array_map(
-            function(OutlineMap $map) {
-                return $map->getDescription();
-            },
-            $this->provider->getOutlineMapsList()
-            );
-        asort($map_list);
-        $data->set('map_list', $map_list);
+		$map_list = array_map(
+			function(OutlineMap $map) {
+				return $map->getDescription();
+			},
+			$this->provider->getOutlineMapsList()
+			);
+		asort($map_list);
+		$data->set('map_list', $map_list);
     
-        $gen_details = array(0 => I18N::translate('All'));
-        for($i = 1; $i <= 10 ; $i++) $gen_details[$i] = $i;
-        $data->set('generation_details', $gen_details);
+		$gen_details = array(0 => I18N::translate('All'));
+		for($i = 1; $i <= 10 ; $i++) $gen_details[$i] = $i;
+		$data->set('generation_details', $gen_details);
     
-        ViewFactory::make('GeoAnalysisEdit', $this, $controller, $data)->render();
-    }
+		ViewFactory::make('GeoAnalysisEdit', $this, $controller, $data)->render();
+	}
     
 }
\ No newline at end of file

Spacing +44 added lines, -46 removed lines

@@ -71,14 +71,14 @@ 
         $data->set('title', $controller->getPageTitle());
         $data->set('tree', $wt_tree);
         
-        $data->set('root_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig');
+        $data->set('root_url', 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig');
                 
-        $table_id = 'table-geoanalysis-' . Uuid::uuid4();
+        $table_id = 'table-geoanalysis-'.Uuid::uuid4();
         $data->set('table_id', $table_id);
         
         $other_trees = array();
         foreach (Tree::getAll() as $tree) {
-            if($tree->getTreeId() != $wt_tree->getTreeId()) $other_trees[] = $tree;
+            if ($tree->getTreeId() != $wt_tree->getTreeId()) $other_trees[] = $tree;
         }      
         $data->set('other_trees', $other_trees);
         
@@ -101,7 +101,7 @@ 
                     processing: true,
                     serverSide : true,
 					ajax : {
-						url : "module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@jsonGeoAnalysisList&ged='. $wt_tree->getNameUrl().'",
+						url : "module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@jsonGeoAnalysisList&ged='.$wt_tree->getNameUrl().'",
                         type : "POST"
 					},
                     columns: [
@@ -125,7 +125,7 @@ 
                             url: "module.php", 
                             type: "GET",
                             data: {
-                			    mod: "' . $this->module->getName() .'",
+                			    mod: "' . $this->module->getName().'",
                                 mod_action:  "GeoAnalysis@setStatus",
                 			    ga_id: ga_id,
                 			    ged: typeof gedcom === "undefined" ? WT_GEDCOM : gedcom,
@@ -133,7 +133,7 @@ 
                             },
                             error: function(result, stat, error) {
                                 var err = typeof result.responseJSON === "undefined" ? error : result.responseJSON.error;
-                                alert("' . I18N::translate('An error occured while editing this analysis:') . '" + err);
+                                alert("' . I18N::translate('An error occured while editing this analysis:').'" + err);
                             },
                             complete: function(result, stat) {
                                 geoAnalysisTable.ajax.reload(null, false);
@@ -146,14 +146,14 @@ 
                             url: "module.php", 
                             type: "GET",
                             data: {
-                			    mod: "' . $this->module->getName() .'",
+                			    mod: "' . $this->module->getName().'",
                                 mod_action:  "GeoAnalysis@delete",
                 			    ga_id: ga_id,
                 			    ged: typeof gedcom === "undefined" ? WT_GEDCOM : gedcom
                             },
                             error: function(result, stat, error) {
                                 var err = typeof result.responseJSON === "undefined" ? error : result.responseJSON.error;
-                                alert("' . I18N::translate('An error occured while deleting this analysis:') . '" + err);
+                                alert("' . I18N::translate('An error occured while deleting this analysis:').'" + err);
                             },
                             complete: function(result, stat) {
                                 geoAnalysisTable.ajax.reload(null, false);
@@ -177,13 +177,13 @@ 
         
         // Generate an AJAX/JSON response for datatables to load a block of rows
         $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
+        if ($search) $search = $search['value'];
         $start  = Filter::postInteger('start');
         $length = Filter::postInteger('length');
         $order  = Filter::postArray('order');
         
-        foreach($order as $key => &$value) {
-            switch($value['column']) {
+        foreach ($order as $key => &$value) {
+            switch ($value['column']) {
                 case 3:
                     $value['column'] = 'majgd_descr';
                     break;
@@ -204,11 +204,11 @@ 
         
         $data = array();
         $place_hierarchy = $this->provider->getPlacesHierarchy();
-        foreach($list as $ga) {
+        foreach ($list as $ga) {
             /** @var GeoAnalysis $ga */
             
             $datum = array();
-            $options= $ga->getOptions();
+            $options = $ga->getOptions();
             
             $datum[0] = '
                 <div class="btn-group">
@@ -218,47 +218,46 @@ 
                     <ul class="dropdown-menu" role="menu">
                        <li>
                             <a href="#" onclick="return set_geoanalysis_status('. $ga->getId().', '.($ga->isEnabled() ? 'false' : 'true').', \''.Filter::escapeJs($wt_tree->getName()).'\');">
-                                <i class="fa fa-fw '.($ga->isEnabled() ? 'fa-times' : 'fa-check').'"></i> ' . ($ga->isEnabled() ? I18N::translate('Disable') : I18N::translate('Enable')) . '
+                                <i class="fa fa-fw '.($ga->isEnabled() ? 'fa-times' : 'fa-check').'"></i> '.($ga->isEnabled() ? I18N::translate('Disable') : I18N::translate('Enable')).'
                             </a>
                        </li>
                         <li>
                             <a href="module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@edit&ga_id='.$ga->getId().'&ged='.$wt_tree->getName().'">
-                                <i class="fa fa-fw fa-pencil"></i> ' . I18N::translate('Edit') . '
+                                <i class="fa fa-fw fa-pencil"></i> ' . I18N::translate('Edit').'
                             </a>
                        </li>
                        <li class="divider" />
                        <li>
                             <a href="#" onclick="return delete_geoanalysis('. $ga->getId().', \''.Filter::escapeJs($wt_tree->getName()).'\');">
-                                <i class="fa fa-fw fa-trash-o"></i> ' . I18N::translate('Delete') . '
+                                <i class="fa fa-fw fa-trash-o"></i> ' . I18N::translate('Delete').'
                             </a>
                        </li>
                     </ul>
                 </div>';
 		    $datum[1] = $ga->getId();
 		    $datum[2] = $ga->isEnabled() ? 
-				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : 
-				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
+				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
 		    $datum[3] = $ga->getTitle();
 		    $analysis_level = $ga->getAnalysisLevel();
-		    if($place_hierarchy['type'] == 'header') {
+		    if ($place_hierarchy['type'] == 'header') {
 		        $datum[4] = $place_hierarchy['hierarchy'][$analysis_level - 1];
 		    } elseif ($place_hierarchy['type'] == 'data') {
-		        $datum[4] = $analysis_level . ' (' . $place_hierarchy['hierarchy'][$analysis_level - 1] . ')';
+		        $datum[4] = $analysis_level.' ('.$place_hierarchy['hierarchy'][$analysis_level - 1].')';
 		    } else {
 		        $datum[4] = $analysis_level;
 		    }
 		    $datum[5] = $ga->getAnalysisLevel();
 		    $datum[6] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
 		    $datum[7] = '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('None').'</span>';
-		    if($ga->hasMap()) {
-		        if($options->getMap()->isLoaded()) {
+		    if ($ga->hasMap()) {
+		        if ($options->getMap()->isLoaded()) {
     		        $datum[6] = $options->getMap()->getDescription();
-    		        $datum[7] = '<span data-toggle="tooltip" title="' . $options->getMap()->getTopLevelName() . '" />';
+    		        $datum[7] = '<span data-toggle="tooltip" title="'.$options->getMap()->getTopLevelName().'" />';
     		        $top_level = $options->getMapLevel();
-    		        if($place_hierarchy['type'] == 'header') {
+    		        if ($place_hierarchy['type'] == 'header') {
     		            $datum[7] .= $place_hierarchy['hierarchy'][$top_level - 1];
     		        } elseif ($place_hierarchy['type'] == 'data') {
-    		            $datum[7] .= $top_level . ' (' . $place_hierarchy['hierarchy'][$top_level - 1] . ')';
+    		            $datum[7] .= $top_level.' ('.$place_hierarchy['hierarchy'][$top_level - 1].')';
     		        } else {
     		            $datum[7] .= $top_level;
     		        }
@@ -269,8 +268,7 @@ 
 		        }
 		    }
 		    $datum[8] = $options->isUsingFlags() ? 
-				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : 
-				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
+				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
 		    $datum[9] = $options->getMaxDetailsInGen() > 0 ? $options->getMaxDetailsInGen() : I18N::translate('All');
 		    
 		    $data[] = $datum;
@@ -319,24 +317,24 @@ 
         $description    = Filter::post('description');
         $analysislevel  = Filter::postInteger('analysislevel');
         $use_map        = Filter::postBool('use_map');
-        if($use_map) {
+        if ($use_map) {
             $map_file   = base64_decode(Filter::post('map_file'));
-            $map_top_level   = Filter::postInteger('map_top_level');
+            $map_top_level = Filter::postInteger('map_top_level');
         }
         $use_flags      = Filter::postBool('use_flags');
         $gen_details    = Filter::postInteger('gen_details');
         
         $success = false; 
-        if($ga_id) {
+        if ($ga_id) {
             $ga = $this->provider->getGeoAnalysis($ga_id, false);
-            if($ga) {
+            if ($ga) {
                 $ga->setTitle($description);
                 $ga->setAnalysisLevel($analysislevel + 1);
                 $options = $ga->getOptions();
-                if($options) {
+                if ($options) {
                     $options->setUsingFlags($use_flags);
                     $options->setMaxDetailsInGen($gen_details);
-                    if($use_map) {
+                    if ($use_map) {
                         $options->setMap(new OutlineMap($map_file));
                         $options->setMapLevel($map_top_level + 1);
                     }
@@ -346,7 +344,7 @@ 
                 }
 				
 				$res = $this->provider->updateGeoAnalysis($ga);
-				if($res) {
+				if ($res) {
 					FlashMessages::addMessage(I18N::translate('The geographical dispersion analysis “%s” has been successfully updated', $res->getTitle()), 'success');
 					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'.$res->getId().'” has been updated.');
 					$ga = $res;
@@ -354,7 +352,7 @@ 
 				}
 				else {
 					FlashMessages::addMessage(I18N::translate('An error occured while updating the geographical dispersion analysis “%s”', $ga->getTitle()), 'danger');
-					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'. $ga->getId() .'” could not be updated. See error log.');
+					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'.$ga->getId().'” could not be updated. See error log.');
 				}
             }
         } else {
@@ -366,7 +364,7 @@ 
 				$use_flags,
 				$gen_details
 			);
-			if($ga) {
+			if ($ga) {
 				FlashMessages::addMessage(I18N::translate('The geographical dispersion analysis “%s” has been successfully added.', $ga->getTitle()), 'success');
 				Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'.$ga->getId().'” has been added.');
 				$success = true;
@@ -377,16 +375,16 @@ 
 			}
         }
         
-        $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl();
-        if(!$success) {			
-            if($ga) {
-                $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@edit&ga_id='. $ga->getId() .'&ged=' . $wt_tree->getNameUrl();
+        $redirection_url = 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig&ged='.$wt_tree->getNameUrl();
+        if (!$success) {			
+            if ($ga) {
+                $redirection_url = 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@edit&ga_id='.$ga->getId().'&ged='.$wt_tree->getNameUrl();
             }
             else {
-                $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@add&ged=' . $wt_tree->getNameUrl();
+                $redirection_url = 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@add&ged='.$wt_tree->getNameUrl();
             }
         }        
-        header('Location: ' . WT_BASE_URL . $redirection_url);
+        header('Location: '.WT_BASE_URL.$redirection_url);
         
     }
      
@@ -416,7 +414,7 @@ 
             ');
         
         $data = new ViewBag();
-        if($ga) {
+        if ($ga) {
             $controller->setPageTitle(I18N::translate('Edit the geographical dispersion analysis'));
             $data->set('geo_analysis', $ga);
         } else {
@@ -424,9 +422,9 @@ 
         }
         
         $data->set('title', $controller->getPageTitle());
-        $data->set('admin_config_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $wt_tree->getNameUrl());
+        $data->set('admin_config_url', 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig&ged='.$wt_tree->getNameUrl());
         $data->set('module_title', $this->module->getTitle());
-        $data->set('save_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@save&ged=' . $wt_tree->getNameUrl());
+        $data->set('save_url', 'module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@save&ged='.$wt_tree->getNameUrl());
         $data->set('places_hierarchy', $this->provider->getPlacesHierarchy());
     
         $map_list = array_map(
@@ -439,7 +437,7 @@ 
         $data->set('map_list', $map_list);
     
         $gen_details = array(0 => I18N::translate('All'));
-        for($i = 1; $i <= 10 ; $i++) $gen_details[$i] = $i;
+        for ($i = 1; $i <= 10; $i++) $gen_details[$i] = $i;
         $data->set('generation_details', $gen_details);
     
         ViewFactory::make('GeoAnalysisEdit', $this, $controller, $data)->render();

Braces +14 added lines, -13 removed lines

@@ -78,7 +78,9 @@ 
         
         $other_trees = array();
         foreach (Tree::getAll() as $tree) {
-            if($tree->getTreeId() != $wt_tree->getTreeId()) $other_trees[] = $tree;
+            if($tree->getTreeId() != $wt_tree->getTreeId()) {
+            	$other_trees[] = $tree;
+            }
         }      
         $data->set('other_trees', $other_trees);
         
@@ -177,7 +179,9 @@ 
         
         // Generate an AJAX/JSON response for datatables to load a block of rows
         $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
+        if($search) {
+        	$search = $search['value'];
+        }
         $start  = Filter::postInteger('start');
         $length = Filter::postInteger('length');
         $order  = Filter::postArray('order');
@@ -263,8 +267,7 @@ 
     		            $datum[7] .= $top_level;
     		        }
     		        $datum[7] .= '</span>';
-		        }
-		        else {
+		        } else {
 		            $datum[6] = I18N::translate('Error when loading map.');
 		        }
 		    }
@@ -339,8 +342,7 @@ 
                     if($use_map) {
                         $options->setMap(new OutlineMap($map_file));
                         $options->setMapLevel($map_top_level + 1);
-                    }
-                    else {
+                    } else {
                         $options->setMap(null);
                     }
                 }
@@ -351,8 +353,7 @@ 
 					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'.$res->getId().'” has been updated.');
 					$ga = $res;
 					$success = true;
-				}
-				else {
+				} else {
 					FlashMessages::addMessage(I18N::translate('An error occured while updating the geographical dispersion analysis “%s”', $ga->getTitle()), 'danger');
 					Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'. $ga->getId() .'” could not be updated. See error log.');
 				}
@@ -370,8 +371,7 @@ 
 				FlashMessages::addMessage(I18N::translate('The geographical dispersion analysis “%s” has been successfully added.', $ga->getTitle()), 'success');
 				Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID “'.$ga->getId().'” has been added.');
 				$success = true;
-			}
-			else {
+			} else {
 				FlashMessages::addMessage(I18N::translate('An error occured while adding the geographical dispersion analysis “%s”', $description), 'danger');
 				Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis “'.$description.'” could not be added. See error log.');
 			}
@@ -381,8 +381,7 @@ 
         if(!$success) {			
             if($ga) {
                 $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@edit&ga_id='. $ga->getId() .'&ged=' . $wt_tree->getNameUrl();
-            }
-            else {
+            } else {
                 $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig@add&ged=' . $wt_tree->getNameUrl();
             }
         }        
@@ -439,7 +438,9 @@ 
         $data->set('map_list', $map_list);
     
         $gen_details = array(0 => I18N::translate('All'));
-        for($i = 1; $i <= 10 ; $i++) $gen_details[$i] = $i;
+        for($i = 1; $i <= 10 ; $i++) {
+        	$gen_details[$i] = $i;
+        }
         $data->set('generation_details', $gen_details);
     
         ViewFactory::make('GeoAnalysisEdit', $this, $controller, $data)->render();

src/Webtrees/Module/PatronymicLineage/Model/LineageRootNode.php

Indentation +58 added lines, -58 removed lines

@@ -24,68 +24,68 @@
 class LineageRootNode extends LineageNode
 {
     
-    /**
-     * @var Collection $places Places for the lineage node
-     */
-    private $places;
+	/**
+	 * @var Collection $places Places for the lineage node
+	 */
+	private $places;
    
-    /**
-     * @var int $nb_children Number of node childs
-     */
-    private $nb_children;
+	/**
+	 * @var int $nb_children Number of node childs
+	 */
+	private $nb_children;
   
-    /**
-     * Constructor for LineageRootNode
-     *
-     * @param Individual|null $node_indi
-     */
-    public function __construct(?Individual $node_indi = null)
-    {
-        parent::__construct($node_indi, $this);
-        $this->places = new Collection();
-        $this->nb_children = 0;
-    }
+	/**
+	 * Constructor for LineageRootNode
+	 *
+	 * @param Individual|null $node_indi
+	 */
+	public function __construct(?Individual $node_indi = null)
+	{
+		parent::__construct($node_indi, $this);
+		$this->places = new Collection();
+		$this->nb_children = 0;
+	}
    
-    /**
-     * Adds a place to the list of lineage's place
-     *
-     * @param Place $place
-     */
-    public function addPlace(Place $place): void
-    {
-        $place_name = $place->gedcomName();
-        if (mb_strlen($place_name) > 0) {
-            $this->places->put($place_name, $this->places->get($place_name, 0) + 1);
-        }
-    }
+	/**
+	 * Adds a place to the list of lineage's place
+	 *
+	 * @param Place $place
+	 */
+	public function addPlace(Place $place): void
+	{
+		$place_name = $place->gedcomName();
+		if (mb_strlen($place_name) > 0) {
+			$this->places->put($place_name, $this->places->get($place_name, 0) + 1);
+		}
+	}
     
-    /**
-     * Returns the number of child nodes.
-     * This number is more to be used as indication rather than an accurate one.
-     *
-     * @return int
-     */
-    public function numberChildNodes(): int
-    {
-        return $this->nb_children;
-    }
+	/**
+	 * Returns the number of child nodes.
+	 * This number is more to be used as indication rather than an accurate one.
+	 *
+	 * @return int
+	 */
+	public function numberChildNodes(): int
+	{
+		return $this->nb_children;
+	}
    
-    /**
-     * Increments the number of child nodes by one
-     *
-     */
-    public function incrementChildNodes(): void
-    {
-        $this->nb_children++;
-    }
+	/**
+	 * Increments the number of child nodes by one
+	 *
+	 */
+	public function incrementChildNodes(): void
+	{
+		$this->nb_children++;
+	}
    
-    /**
-     * Returns the list of place for the lineage
-     *
-     * @return Collection
-     */
-    public function places(): Collection
-    {
-        return $this->places;
-    }
+	/**
+	 * Returns the list of place for the lineage
+	 *
+	 * @return Collection
+	 */
+	public function places(): Collection
+	{
+		return $this->places;
+	}
 }

src/Webtrees/Module/PatronymicLineage/Model/LineageNode.php

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     public function addFamily(Family $fams): object
     {
         if (!$this->linked_fams->has($fams->xref())) {
-            $this->linked_fams->put($fams->xref(), (object) [
+            $this->linked_fams->put($fams->xref(), (object)[
                 'family'   =>  $fams,
                 'children' =>  new Collection()
             ]);
@@ -135,6 +135,6 @@ 
      */
     public function hasFollowUpSurname(): bool
     {
-        return mb_strlen($this->followUpSurname()) > 0 ;
+        return mb_strlen($this->followUpSurname()) > 0;
     }
 }

Indentation +113 added lines, -113 removed lines

@@ -25,117 +25,117 @@
 class LineageNode
 {
 
-    /**
-     * @var Collection $linked_fams Spouse families linked to the node
-     */
-    private $linked_fams;
-
-    /**
-     * @var ?Individual $node_indi Reference individual for the node
-     */
-    private $node_indi;
-
-    /**
-     * @var LineageRootNode $root_node Root node of the lineage
-     */
-    private $root_node;
-
-    /**
-     * @var ?string $alt_surname Linked surname, used to link to another lineage
-     */
-    private $alt_surname;
-
-    /**
-     * Constructor for Lineage node
-     *
-     * @param Individual $node_indi Main individual
-     * @param LineageRootNode $root_node Node of the lineage root
-     * @param null|string $alt_surname Follow-up surname
-     */
-    public function __construct(?Individual $node_indi = null, LineageRootNode $root_node, $alt_surname = null)
-    {
-        $this->node_indi = $node_indi;
-        $this->root_node = $root_node;
-        $this->alt_surname = $alt_surname;
-        $this->linked_fams = new Collection();
-    }
-
-    /**
-     * Add a spouse family to the node
-     *
-     * @param Family $fams
-     * @return stdClass
-     */
-    public function addFamily(Family $fams): object
-    {
-        if (!$this->linked_fams->has($fams->xref())) {
-            $this->linked_fams->put($fams->xref(), (object) [
-                'family'   =>  $fams,
-                'children' =>  new Collection()
-            ]);
-        }
-        return $this->linked_fams->get($fams->xref());
-    }
-
-    /**
-     * Add a child LineageNode to the node
-     *
-     * @param Family $fams
-     * @param LineageNode $child
-     */
-    public function addChild(Family $fams, LineageNode $child = null): void
-    {
-        $this->addFamily($fams)->children->push($child);
-        $this->root_node->incrementChildNodes();
-    }
-
-    /**
-     * Returns the node individual
-     *
-     * @return Individual|NULL
-     */
-    public function individual(): ?Individual
-    {
-        return $this->node_indi;
-    }
-
-    /**
-     * Returns the lineage root node individual
-     *
-     * @return LineageRootNode
-     */
-    public function rootNode(): LineageRootNode
-    {
-        return $this->root_node;
-    }
-
-    /**
-     * Returns the spouse families linked to the node
-     *
-     * @return Collection
-     */
-    public function families(): Collection
-    {
-        return $this->linked_fams;
-    }
-
-    /**
-     * Returns the follow-up surname
-     *
-     * @return string
-     */
-    public function followUpSurname(): string
-    {
-        return $this->alt_surname ?? '';
-    }
-
-    /**
-     * Indicates whether the node has a follow up surname
-     *
-     * @return boolean
-     */
-    public function hasFollowUpSurname(): bool
-    {
-        return mb_strlen($this->followUpSurname()) > 0 ;
-    }
+	/**
+	 * @var Collection $linked_fams Spouse families linked to the node
+	 */
+	private $linked_fams;
+
+	/**
+	 * @var ?Individual $node_indi Reference individual for the node
+	 */
+	private $node_indi;
+
+	/**
+	 * @var LineageRootNode $root_node Root node of the lineage
+	 */
+	private $root_node;
+
+	/**
+	 * @var ?string $alt_surname Linked surname, used to link to another lineage
+	 */
+	private $alt_surname;
+
+	/**
+	 * Constructor for Lineage node
+	 *
+	 * @param Individual $node_indi Main individual
+	 * @param LineageRootNode $root_node Node of the lineage root
+	 * @param null|string $alt_surname Follow-up surname
+	 */
+	public function __construct(?Individual $node_indi = null, LineageRootNode $root_node, $alt_surname = null)
+	{
+		$this->node_indi = $node_indi;
+		$this->root_node = $root_node;
+		$this->alt_surname = $alt_surname;
+		$this->linked_fams = new Collection();
+	}
+
+	/**
+	 * Add a spouse family to the node
+	 *
+	 * @param Family $fams
+	 * @return stdClass
+	 */
+	public function addFamily(Family $fams): object
+	{
+		if (!$this->linked_fams->has($fams->xref())) {
+			$this->linked_fams->put($fams->xref(), (object) [
+				'family'   =>  $fams,
+				'children' =>  new Collection()
+			]);
+		}
+		return $this->linked_fams->get($fams->xref());
+	}
+
+	/**
+	 * Add a child LineageNode to the node
+	 *
+	 * @param Family $fams
+	 * @param LineageNode $child
+	 */
+	public function addChild(Family $fams, LineageNode $child = null): void
+	{
+		$this->addFamily($fams)->children->push($child);
+		$this->root_node->incrementChildNodes();
+	}
+
+	/**
+	 * Returns the node individual
+	 *
+	 * @return Individual|NULL
+	 */
+	public function individual(): ?Individual
+	{
+		return $this->node_indi;
+	}
+
+	/**
+	 * Returns the lineage root node individual
+	 *
+	 * @return LineageRootNode
+	 */
+	public function rootNode(): LineageRootNode
+	{
+		return $this->root_node;
+	}
+
+	/**
+	 * Returns the spouse families linked to the node
+	 *
+	 * @return Collection
+	 */
+	public function families(): Collection
+	{
+		return $this->linked_fams;
+	}
+
+	/**
+	 * Returns the follow-up surname
+	 *
+	 * @return string
+	 */
+	public function followUpSurname(): string
+	{
+		return $this->alt_surname ?? '';
+	}
+
+	/**
+	 * Indicates whether the node has a follow up surname
+	 *
+	 * @return boolean
+	 */
+	public function hasFollowUpSurname(): bool
+	{
+		return mb_strlen($this->followUpSurname()) > 0 ;
+	}
 }

src/Webtrees/Module/PatronymicLineage/Model/LineageBuilder.php

Spacing +1 added lines, -1 removed lines

@@ -107,7 +107,7 @@
             }
         }
       
-        return $root_lineages->sort(function (LineageRootNode $a, LineageRootNode $b) {
+        return $root_lineages->sort(function(LineageRootNode $a, LineageRootNode $b) {
 
             if ($a->numberChildNodes() == $b->numberChildNodes()) {
                 return 0;

Indentation +216 added lines, -216 removed lines

@@ -29,220 +29,220 @@
 class LineageBuilder
 {
 
-    /**
-     * @var string $surname Reference surname
-     */
-    private $surname;
-
-    /**
-     * @var Tree $tree Reference tree
-     */
-    private $tree;
-
-    /**
-     * @var IndividualListModule $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * @var Collection $used_indis Individuals already processed
-     */
-    private $used_indis;
-
-    /**
-     * Constructor for Lineage Builder
-     *
-     * @param string $surname Reference surname
-     * @param Tree $tree Gedcom tree
-     */
-    public function __construct($surname, Tree $tree, IndividualListModule $indilist_module)
-    {
-        $this->surname = $surname;
-        $this->tree = $tree;
-        $this->indilist_module = $indilist_module;
-        $this->used_indis = new Collection();
-    }
-
-    /**
-     * Build all patronymic lineages for the reference surname.
-     *
-     * @return Collection|NULL List of root patronymic lineages
-     */
-    public function buildLineages(): ?Collection
-    {
-        if ($this->indilist_module === null) {
-            return null;
-        }
-
-        $indis = $this->indilist_module->individuals($this->tree, $this->surname, '', '', false, false, I18N::locale());
-        //Warning - the IndividualListModule returns a clone of individuals objects. Cannot be used for object equality
-        if (count($indis) == 0) {
-            return null;
-        }
-
-        $root_lineages = new Collection();
-
-        foreach ($indis as $indi) {
-            /** @var Individual $indi */
-            if ($this->used_indis->get($indi->xref(), false) === false) {
-                $indi_first = $this->getLineageRootIndividual($indi);
-                if ($indi_first !== null) {
-                    // The root lineage needs to be recreated from the Factory, to retrieve the proper object
-                    $indi_first = Registry::individualFactory()->make($indi_first->xref(), $this->tree);
-                }
-                if ($indi_first === null) {
-                    continue;
-                }
-                $this->used_indis->put($indi_first->xref(), true);
-                if ($indi_first->canShow()) {
-                    //Check if the root individual has brothers and sisters, without parents
-                    $indi_first_child_family = $indi_first->childFamilies()->first();
-                    if ($indi_first_child_family !== null) {
-                        $root_node = new LineageRootNode(null);
-                        $root_node->addFamily($indi_first_child_family);
-                    } else {
-                        $root_node = new LineageRootNode($indi_first);
-                    }
-                    $root_node = $this->buildLineage($root_node);
-                    $root_lineages->add($root_node);
-                }
-            }
-        }
-
-        return $root_lineages->sort(function (LineageRootNode $a, LineageRootNode $b) {
-
-            if ($a->numberChildNodes() == $b->numberChildNodes()) {
-                return 0;
-            }
-            return ($a->numberChildNodes() > $b->numberChildNodes()) ? -1 : 1;
-        });
-    }
-
-    /**
-     * Retrieve the root individual, from any individual, by recursion.
-     * The Root individual is the individual without a father, or without a mother holding the same name.
-     *
-     * @param Individual $indi
-     * @return Individual|NULL Root individual
-     */
-    private function getLineageRootIndividual(Individual $indi): ?Individual
-    {
-        $child_families = $indi->childFamilies();
-        if ($this->used_indis->get($indi->xref(), false) !== false) {
-            return null;
-        }
-
-        foreach ($child_families as $child_family) {
-            /** @var Family $child_family */
-            $child_family->husband();
-            if (($husb = $child_family->husband()) !== null) {
-                if ($husb->isPendingAddition() && $husb->privatizeGedcom(Auth::PRIV_HIDE) == '') {
-                    return $indi;
-                }
-                return $this->getLineageRootIndividual($husb);
-            } elseif (($wife = $child_family->wife()) !== null) {
-                if (!($wife->isPendingAddition() && $wife->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
-                    $indi_surname = $indi->getAllNames()[$indi->getPrimaryName()]['surname'];
-                    $wife_surname = $wife->getAllNames()[$wife->getPrimaryName()]['surname'];
-                    if (
-                        $indi->canShowName()
-                        && $wife->canShowName()
-                        && I18N::strcasecmp($indi_surname, $wife_surname) == 0
-                    ) {
-                            return $this->getLineageRootIndividual($wife);
-                    }
-                }
-                return $indi;
-            }
-        }
-        return $indi;
-    }
-
-    /**
-     * Computes descendent Lineage from a node.
-     * Uses recursion to build the lineage tree
-     *
-     * @param LineageNode $node
-     * @return LineageNode Computed lineage
-     */
-    private function buildLineage(LineageNode $node): LineageNode
-    {
-        $indi_surname = '';
-
-        $indi_node = $node->individual();
-        if ($indi_node !== null) {
-            if ($node->families()->count() == 0) {
-                foreach ($indi_node->spouseFamilies() as $spouse_family) {
-                    $node->addFamily($spouse_family);
-                }
-            }
-
-            $indi_surname = $indi_node->getAllNames()[$indi_node->getPrimaryName()]['surname'] ?? '';
-            $node->rootNode()->addPlace($indi_node->getBirthPlace());
-
-            //Tag the individual as used
-            $this->used_indis->put($indi_node->xref(), true);
-        }
-
-        foreach ($node->families() as $family_node) {
-            /** @var Family $spouse_family */
-            $spouse_family = $family_node->family;
-            $spouse_surname = '';
-            $spouse = null;
-            if (
-                $indi_node !== null &&
-                ($spouse = $spouse_family->spouse($indi_node)) !== null && $spouse->canShowName()
-            ) {
-                $spouse_surname = $spouse->getAllNames()[$spouse->getPrimaryName()]['surname'] ?? '';
-            }
-
-            $nb_children = $nb_natural = 0;
-
-            foreach ($spouse_family->children() as $child) {
-                if (!($child->isPendingAddition() && $child->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
-                    $child_surname = $child->getAllNames()[$child->getPrimaryName()]['surname'] ?? '';
-
-                    $nb_children++;
-                    if ($indi_node !== null && $indi_node->sex() == 'F') { //If the root individual is the mother
-                        //Print only lineages of children with the same surname as their mother
-                        //(supposing they are natural children)
-                        if (
-                            $spouse === null ||
-                            ($spouse_surname !== '' && I18N::strcasecmp($child_surname, $spouse_surname) != 0)
-                        ) {
-                            if (I18N::strcasecmp($child_surname, $indi_surname) == 0) {
-                                $nb_natural++;
-                                $node_child = new LineageNode($child, $node->rootNode());
-                                $node_child = $this->buildLineage($node_child);
-                                $node->addChild($spouse_family, $node_child);
-                            }
-                        }
-                    } else { //If the root individual is the father
-                        $nb_natural++;
-                        //Print if the children does not bear the same name as his mother
-                        //(and different from his father)
-                        if (
-                            mb_strlen($child_surname) == 0 ||
-                            mb_strlen($indi_surname) == 0 || mb_strlen($spouse_surname) == 0 ||
-                            I18N::strcasecmp($child_surname, $indi_surname) == 0 ||
-                            I18N::strcasecmp($child_surname, $spouse_surname) != 0
-                        ) {
-                            $node_child = new LineageNode($child, $node->rootNode());
-                            $node_child = $this->buildLineage($node_child);
-                        } else {
-                            $node_child = new LineageNode($child, $node->rootNode(), $child_surname);
-                        }
-                        $node->addChild($spouse_family, $node_child);
-                    }
-                }
-            }
-
-            //Do not print other children
-            if (($nb_children - $nb_natural) > 0) {
-                $node->addChild($spouse_family, null);
-            }
-        }
-
-        return $node;
-    }
+	/**
+	 * @var string $surname Reference surname
+	 */
+	private $surname;
+
+	/**
+	 * @var Tree $tree Reference tree
+	 */
+	private $tree;
+
+	/**
+	 * @var IndividualListModule $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * @var Collection $used_indis Individuals already processed
+	 */
+	private $used_indis;
+
+	/**
+	 * Constructor for Lineage Builder
+	 *
+	 * @param string $surname Reference surname
+	 * @param Tree $tree Gedcom tree
+	 */
+	public function __construct($surname, Tree $tree, IndividualListModule $indilist_module)
+	{
+		$this->surname = $surname;
+		$this->tree = $tree;
+		$this->indilist_module = $indilist_module;
+		$this->used_indis = new Collection();
+	}
+
+	/**
+	 * Build all patronymic lineages for the reference surname.
+	 *
+	 * @return Collection|NULL List of root patronymic lineages
+	 */
+	public function buildLineages(): ?Collection
+	{
+		if ($this->indilist_module === null) {
+			return null;
+		}
+
+		$indis = $this->indilist_module->individuals($this->tree, $this->surname, '', '', false, false, I18N::locale());
+		//Warning - the IndividualListModule returns a clone of individuals objects. Cannot be used for object equality
+		if (count($indis) == 0) {
+			return null;
+		}
+
+		$root_lineages = new Collection();
+
+		foreach ($indis as $indi) {
+			/** @var Individual $indi */
+			if ($this->used_indis->get($indi->xref(), false) === false) {
+				$indi_first = $this->getLineageRootIndividual($indi);
+				if ($indi_first !== null) {
+					// The root lineage needs to be recreated from the Factory, to retrieve the proper object
+					$indi_first = Registry::individualFactory()->make($indi_first->xref(), $this->tree);
+				}
+				if ($indi_first === null) {
+					continue;
+				}
+				$this->used_indis->put($indi_first->xref(), true);
+				if ($indi_first->canShow()) {
+					//Check if the root individual has brothers and sisters, without parents
+					$indi_first_child_family = $indi_first->childFamilies()->first();
+					if ($indi_first_child_family !== null) {
+						$root_node = new LineageRootNode(null);
+						$root_node->addFamily($indi_first_child_family);
+					} else {
+						$root_node = new LineageRootNode($indi_first);
+					}
+					$root_node = $this->buildLineage($root_node);
+					$root_lineages->add($root_node);
+				}
+			}
+		}
+
+		return $root_lineages->sort(function (LineageRootNode $a, LineageRootNode $b) {
+
+			if ($a->numberChildNodes() == $b->numberChildNodes()) {
+				return 0;
+			}
+			return ($a->numberChildNodes() > $b->numberChildNodes()) ? -1 : 1;
+		});
+	}
+
+	/**
+	 * Retrieve the root individual, from any individual, by recursion.
+	 * The Root individual is the individual without a father, or without a mother holding the same name.
+	 *
+	 * @param Individual $indi
+	 * @return Individual|NULL Root individual
+	 */
+	private function getLineageRootIndividual(Individual $indi): ?Individual
+	{
+		$child_families = $indi->childFamilies();
+		if ($this->used_indis->get($indi->xref(), false) !== false) {
+			return null;
+		}
+
+		foreach ($child_families as $child_family) {
+			/** @var Family $child_family */
+			$child_family->husband();
+			if (($husb = $child_family->husband()) !== null) {
+				if ($husb->isPendingAddition() && $husb->privatizeGedcom(Auth::PRIV_HIDE) == '') {
+					return $indi;
+				}
+				return $this->getLineageRootIndividual($husb);
+			} elseif (($wife = $child_family->wife()) !== null) {
+				if (!($wife->isPendingAddition() && $wife->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
+					$indi_surname = $indi->getAllNames()[$indi->getPrimaryName()]['surname'];
+					$wife_surname = $wife->getAllNames()[$wife->getPrimaryName()]['surname'];
+					if (
+						$indi->canShowName()
+						&& $wife->canShowName()
+						&& I18N::strcasecmp($indi_surname, $wife_surname) == 0
+					) {
+							return $this->getLineageRootIndividual($wife);
+					}
+				}
+				return $indi;
+			}
+		}
+		return $indi;
+	}
+
+	/**
+	 * Computes descendent Lineage from a node.
+	 * Uses recursion to build the lineage tree
+	 *
+	 * @param LineageNode $node
+	 * @return LineageNode Computed lineage
+	 */
+	private function buildLineage(LineageNode $node): LineageNode
+	{
+		$indi_surname = '';
+
+		$indi_node = $node->individual();
+		if ($indi_node !== null) {
+			if ($node->families()->count() == 0) {
+				foreach ($indi_node->spouseFamilies() as $spouse_family) {
+					$node->addFamily($spouse_family);
+				}
+			}
+
+			$indi_surname = $indi_node->getAllNames()[$indi_node->getPrimaryName()]['surname'] ?? '';
+			$node->rootNode()->addPlace($indi_node->getBirthPlace());
+
+			//Tag the individual as used
+			$this->used_indis->put($indi_node->xref(), true);
+		}
+
+		foreach ($node->families() as $family_node) {
+			/** @var Family $spouse_family */
+			$spouse_family = $family_node->family;
+			$spouse_surname = '';
+			$spouse = null;
+			if (
+				$indi_node !== null &&
+				($spouse = $spouse_family->spouse($indi_node)) !== null && $spouse->canShowName()
+			) {
+				$spouse_surname = $spouse->getAllNames()[$spouse->getPrimaryName()]['surname'] ?? '';
+			}
+
+			$nb_children = $nb_natural = 0;
+
+			foreach ($spouse_family->children() as $child) {
+				if (!($child->isPendingAddition() && $child->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
+					$child_surname = $child->getAllNames()[$child->getPrimaryName()]['surname'] ?? '';
+
+					$nb_children++;
+					if ($indi_node !== null && $indi_node->sex() == 'F') { //If the root individual is the mother
+						//Print only lineages of children with the same surname as their mother
+						//(supposing they are natural children)
+						if (
+							$spouse === null ||
+							($spouse_surname !== '' && I18N::strcasecmp($child_surname, $spouse_surname) != 0)
+						) {
+							if (I18N::strcasecmp($child_surname, $indi_surname) == 0) {
+								$nb_natural++;
+								$node_child = new LineageNode($child, $node->rootNode());
+								$node_child = $this->buildLineage($node_child);
+								$node->addChild($spouse_family, $node_child);
+							}
+						}
+					} else { //If the root individual is the father
+						$nb_natural++;
+						//Print if the children does not bear the same name as his mother
+						//(and different from his father)
+						if (
+							mb_strlen($child_surname) == 0 ||
+							mb_strlen($indi_surname) == 0 || mb_strlen($spouse_surname) == 0 ||
+							I18N::strcasecmp($child_surname, $indi_surname) == 0 ||
+							I18N::strcasecmp($child_surname, $spouse_surname) != 0
+						) {
+							$node_child = new LineageNode($child, $node->rootNode());
+							$node_child = $this->buildLineage($node_child);
+						} else {
+							$node_child = new LineageNode($child, $node->rootNode(), $child_surname);
+						}
+						$node->addChild($spouse_family, $node_child);
+					}
+				}
+			}
+
+			//Do not print other children
+			if (($nb_children - $nb_natural) > 0) {
+				$node->addChild($spouse_family, null);
+			}
+		}
+
+		return $node;
+	}
 }

src/Webtrees/Module/AbstractModuleMaj.php

Indentation +72 added lines, -72 removed lines

@@ -26,89 +26,89 @@
  */
 abstract class AbstractModuleMaj extends AbstractModule implements ModuleCustomInterface
 {    
-    use ModuleCustomTrait;
+	use ModuleCustomTrait;
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot() : void
-    {
-        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot() : void
+	{
+		View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
         
-        $this->loadRoutes(app(RouterContainer::class)->getMap());
-    }
+		$this->loadRoutes(app(RouterContainer::class)->getMap());
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
-     */
-    public function resourcesFolder(): string
-    {
-        return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
+	 */
+	public function resourcesFolder(): string
+	{
+		return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
-     */
-    public function customModuleAuthorName() : string
-    {
-        return 'Jonathan Jaubart';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
+	 */
+	public function customModuleAuthorName() : string
+	{
+		return 'Jonathan Jaubart';
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
-     */
-    public function customModuleSupportUrl() : string
-    {
-        return 'https://github.com/jon48/webtrees-lib';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
+	 */
+	public function customModuleSupportUrl() : string
+	{
+		return 'https://github.com/jon48/webtrees-lib';
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
-     */
-    public function customTranslations(string $language) : array
-    {
-        $translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
+	 */
+	public function customTranslations(string $language) : array
+	{
+		$translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
         
-        try {
-            $translation  = new Translation($translation_file);
-            return $translation->asArray();
-        } catch (\Exception $e) { }
+		try {
+			$translation  = new Translation($translation_file);
+			return $translation->asArray();
+		} catch (\Exception $e) { }
         
-        return array();
-    }
+		return array();
+	}
     
-    /**
-     * Add module routes to webtrees route loader
-     * 
-     * @param Map $router
-     */
-    public abstract function loadRoutes(Map $router) : void;
+	/**
+	 * Add module routes to webtrees route loader
+	 * 
+	 * @param Map $router
+	 */
+	public abstract function loadRoutes(Map $router) : void;
     
-    /**
-     * Returns the URL of the module specific stylesheets.
-     * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
-     * and fallback to default.min.css if none are found
-     * 
-     * @return string
-     */
-    public function moduleCssUrl() : string
-    {
-        /** @var ModuleThemeInterface $theme */
-        $theme = app(ModuleThemeInterface::class);
-        $css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
+	/**
+	 * Returns the URL of the module specific stylesheets.
+	 * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
+	 * and fallback to default.min.css if none are found
+	 * 
+	 * @return string
+	 */
+	public function moduleCssUrl() : string
+	{
+		/** @var ModuleThemeInterface $theme */
+		$theme = app(ModuleThemeInterface::class);
+		$css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
         
-        if(file_exists($css_file)) {
-            return $this->assetUrl('css/' . $theme->name() . '.min.css');
-        }
-        else {
-            return $this->assetUrl('css/default.min.css');
-        }
-    }
+		if(file_exists($css_file)) {
+			return $this->assetUrl('css/' . $theme->name() . '.min.css');
+		}
+		else {
+			return $this->assetUrl('css/default.min.css');
+		}
+	}
     
 }
  
\ No newline at end of file

Spacing +6 added lines, -6 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function boot() : void
     {
-        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
+        View::registerNamespace($this->name(), $this->resourcesFolder().'views/');
         
         $this->loadRoutes(app(RouterContainer::class)->getMap());
     }
@@ -45,7 +45,7 @@ 
      */
     public function resourcesFolder(): string
     {
-        return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
+        return Webtrees::MODULES_DIR.trim($this->name(), '_').'/resources/';
     }
     
     /**
@@ -72,7 +72,7 @@ 
      */
     public function customTranslations(string $language) : array
     {
-        $translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
+        $translation_file = $this->resourcesFolder().'lang/'.$language.'/messages.php';
         
         try {
             $translation  = new Translation($translation_file);
@@ -100,10 +100,10 @@ 
     {
         /** @var ModuleThemeInterface $theme */
         $theme = app(ModuleThemeInterface::class);
-        $css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
+        $css_file = $this->resourcesFolder().'css/'.$theme->name().'.min.css';
         
-        if(file_exists($css_file)) {
-            return $this->assetUrl('css/' . $theme->name() . '.min.css');
+        if (file_exists($css_file)) {
+            return $this->assetUrl('css/'.$theme->name().'.min.css');
         }
         else {
             return $this->assetUrl('css/default.min.css');

Braces +1 added lines, -2 removed lines

@@ -104,8 +104,7 @@
         
         if(file_exists($css_file)) {
             return $this->assetUrl('css/' . $theme->name() . '.min.css');
-        }
-        else {
+        } else {
             return $this->assetUrl('css/default.min.css');
         }
     }