jon48 / webtrees-lib

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

Indentation +327 added lines, -327 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,236 +217,236 @@ 
 			$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>)
-     *      - 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);
-            }
-            else {
-                $this->place_hierarchy = array('type' => 'data', 'hierarchy' => $this->getPlacesHierarchyFromData());
-            }            
-        }
-        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>)
+	 *      - 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);
+			}
+			else {
+				$this->place_hierarchy = array('type' => 'data', 'hierarchy' => $this->getPlacesHierarchyFromData());
+			}            
+		}
+		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' => '%\n2 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' => '%\n2 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;
+			}
+		}
         
-        // Unique list of places
-        $places_list=array_keys($places_list);
+		// Unique list of places
+		$places_list=array_keys($places_list);
         
-        //sort the array, limit to unique values, and count them
-        usort($places_list, array('I18N', 'strcasecmp'));
+		//sort the array, limit to unique values, and count them
+		usort($places_list, array('I18N', 'strcasecmp'));
         
-        //calculate maximum no. of levels to display
-        $has_found_good_example = false;
-        foreach($places_list as $place){
-            $levels = explode(",", $place);
-            $parts = count($levels);
-            if ($parts >= $nb_levels){
-                $nb_levels = $parts;
-                if(!$has_found_good_example){
-                    $random_place = $place;
-                    if(min(array_map('strlen', $levels)) > 0){
-                        $has_found_good_example = true;
-                    }
-                }
-            }
-        }
+		//calculate maximum no. of levels to display
+		$has_found_good_example = false;
+		foreach($places_list as $place){
+			$levels = explode(",", $place);
+			$parts = count($levels);
+			if ($parts >= $nb_levels){
+				$nb_levels = $parts;
+				if(!$has_found_good_example){
+					$random_place = $place;
+					if(min(array_map('strlen', $levels)) > 0){
+						$has_found_good_example = true;
+					}
+				}
+			}
+		}
         
-        return array_reverse(array_map('trim',explode(',', $random_place)));
-    }
+		return array_reverse(array_map('trim',explode(',', $random_place)));
+	}
     
-    /**
-     * 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

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

Indentation +178 added lines, -178 removed lines

@@ -24,64 +24,64 @@ 
 	 * Geo Analysis ID
 	 * @var int $id
 	 */
-    protected $id;
+	protected $id;
     
 	/**
 	 * Geo Analysis Title
 	 * @var string $title
 	 */
-    protected $title;
+	protected $title;
     
 	/**
 	 * Level of the Gedcom hierarchy for the analysis
 	 * @var int $analysis_level
 	 */
-    protected $analysis_level;
+	protected $analysis_level;
     
-    /**
-     * Display options
-     * @var GeoDisplayOptions $options
-     */
-    protected $options;
+	/**
+	 * Display options
+	 * @var GeoDisplayOptions $options
+	 */
+	protected $options;
     
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    protected $tree;
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	protected $tree;
     
-    /**
-     * Is the analysis enabled
-     * @var bool $enabled
-     */
-    protected $enabled;
+	/**
+	 * Is the analysis enabled
+	 * @var bool $enabled
+	 */
+	protected $enabled;
     
-    /**
-     * Constructor for GeoAnalysis.
-     *
-     * @param Tree $tree Reference tree
+	/**
+	 * Constructor for GeoAnalysis.
+	 *
+	 * @param Tree $tree Reference tree
 	 * @param int $id GeoAnalysis ID
 	 * @param string $title GeoAnalysis title
 	 * @param int $analysis_level Analysis level
 	 * @param (GeoDisplayOptions|null) $options Display options
 	 * @param bool $enabled Is analysis enabled
-     */
-    public function __construct(Tree $tree, $id, $title, $analysis_level, GeoDisplayOptions $options = null, $enabled = true) {
-        $this->tree = $tree;
-        $this->id = $id;
-        $this->title = $title;
-        $this->analysis_level = $analysis_level;
-        $this->options = $options;
-        $this->enabled = $enabled;
-    }
+	 */
+	public function __construct(Tree $tree, $id, $title, $analysis_level, GeoDisplayOptions $options = null, $enabled = true) {
+		$this->tree = $tree;
+		$this->id = $id;
+		$this->title = $title;
+		$this->analysis_level = $analysis_level;
+		$this->options = $options;
+		$this->enabled = $enabled;
+	}
     
 	/**
 	 * Get the analysis title
 	 * @return string
 	 */
-    public function getTitle() {
-        return $this->title;
-    }
+	public function getTitle() {
+		return $this->title;
+	}
     
 	/**
 	 * Set the analysis title
@@ -89,53 +89,53 @@ 
 	 * @param string $title
 	 * @return self Enable method-chaining
 	 */
-    public function setTitle($title) {
-        $this->title = $title;
-        return $this;
-    }
+	public function setTitle($title) {
+		$this->title = $title;
+		return $this;
+	}
     
 	/**
 	 * Get the analysis ID
 	 * @return int
 	 */
-    public function getId() {
-        return $this->id;
-    }
+	public function getId() {
+		return $this->id;
+	}
     
 	/**
 	 * Get the analysis status (enabled/disabled)
 	 * @return bool
 	 */
-    public function isEnabled() {
-        return $this->enabled;
-    }
+	public function isEnabled() {
+		return $this->enabled;
+	}
     
-    /**
-     * Get analysis options
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoDisplayOptions
-     */
-    public function getOptions() {
-        return $this->options;
-    }
+	/**
+	 * Get analysis options
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoDisplayOptions
+	 */
+	public function getOptions() {
+		return $this->options;
+	}
     
 	/**
-     * Set analysis options
+	 * Set analysis options
 	 *
-     * @param \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoDisplayOptions $options
+	 * @param \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoDisplayOptions $options
 	 * @return self Enable method-chaining
-     */
-    public function setOptions(GeoDisplayOptions $options) {
-        $this->options = $options;
-        return $this;
-    }
+	 */
+	public function setOptions(GeoDisplayOptions $options) {
+		$this->options = $options;
+		return $this;
+	}
     
 	/**
 	 * Get analysis level
 	 * @return int
 	 */
-    public function getAnalysisLevel() {
-        return $this->analysis_level;
-    }
+	public function getAnalysisLevel() {
+		return $this->analysis_level;
+	}
     
 	/**
 	 * Get analysis level
@@ -143,19 +143,19 @@ 
 	 * @param int $analysis_level
 	 * @return self Enable method-chaining
 	 */
-    public function setAnalysisLevel($analysis_level) {
-        $this->analysis_level = $analysis_level;
-        return $this;
-    }
+	public function setAnalysisLevel($analysis_level) {
+		$this->analysis_level = $analysis_level;
+		return $this;
+	}
     
 	/**
 	 * Check whether the analysis has a linked map
 	 *
 	 * @return bool
 	 */
-    public function hasMap() {
-        return $this->options && $this->options->getMap();
-    }
+	public function hasMap() {
+		return $this->options && $this->options->getMap();
+	}
     
 	/**
 	 * Get the URL for the GeoAnalysis.
@@ -163,120 +163,120 @@ 
 	 * @return string
 	 */
 	 public function getHtmlUrl() {
-        return 'module.php?mod='. Constants::MODULE_MAJ_GEODISP_NAME . '&mod_action=GeoAnalysis&ga_id=' . $this->getId() . '&ged=' . $this->tree->getNameUrl();
-    }
+		return 'module.php?mod='. Constants::MODULE_MAJ_GEODISP_NAME . '&mod_action=GeoAnalysis&ga_id=' . $this->getId() . '&ged=' . $this->tree->getNameUrl();
+	}
     
-    /**
-     * Return the dispersion analysis tables.
-     * Two arrays are returned :
-     * 	- the General analysis, which returns the number of ancestors for each place found, plus 4 additional indicators :
-     * 		- knownsum : Number of known places
-     * 		- unknown : Number of unknown places
-     * 		- max : Maximum count of ancestors within a place
-     * 		- other : Other places (not in the top level area)
-     * - the Generations analysis, which returns the number of ancestors for each place found for each generation, plus 3 additional indicators within each generation :
-     * 		- sum : Number of known places
-     * 		- unknown : Number of unknown places
-     * 		- other : Other places (not in the top level area)
-     *
-     * @param array $sosalist List of all sosas
-     * @return array Array of the general and generations table
-     */
-    public function getAnalysisResults($sosalist) {
-        $placesDispGeneral = null;
-        $placesDispGenerations = null;
+	/**
+	 * Return the dispersion analysis tables.
+	 * Two arrays are returned :
+	 * 	- the General analysis, which returns the number of ancestors for each place found, plus 4 additional indicators :
+	 * 		- knownsum : Number of known places
+	 * 		- unknown : Number of unknown places
+	 * 		- max : Maximum count of ancestors within a place
+	 * 		- other : Other places (not in the top level area)
+	 * - the Generations analysis, which returns the number of ancestors for each place found for each generation, plus 3 additional indicators within each generation :
+	 * 		- sum : Number of known places
+	 * 		- unknown : Number of unknown places
+	 * 		- other : Other places (not in the top level area)
+	 *
+	 * @param array $sosalist List of all sosas
+	 * @return array Array of the general and generations table
+	 */
+	public function getAnalysisResults($sosalist) {
+		$placesDispGeneral = null;
+		$placesDispGenerations = null;
         
-        if($sosalist && count($sosalist) > 0) {
-            $placesDispGeneral['knownsum'] = 0;
-            $placesDispGeneral['unknown'] = 0;
-            $placesDispGeneral['max'] = 0;
-            $placesDispGeneral['places'] = array();
-            foreach($sosalist as $sosaid => $gens) {
-                $sosa = Individual::getIntance($sosaid, $this->tree);
-                $place =$sosa->getSignificantPlace();
-                $genstab = explode(',', $gens);
-                $isUnknown=true;
-                if($sosa->getDerivedRecord()->canShow() && !is_null($place)){
-                    $levels = array_reverse(array_map('trim',explode(',', $place)));
-                    if(count($levels)>= $this->analysis_level){                        
-                        $toplevelvalues = array();
-                        if($this->hasMap()
-                            && $this->options->getMap()->isLoaded()
-                            && $toplevelvalue = $this->options->getMap()->getTopLevelName()
-                        ) {
-                            $toplevelvalues = array_map('trim',explode(',', strtolower($toplevelvalue)));
-                        }
-                        if(!$this->hasMap() 
-                            || is_null($this->options->getMapLevel()) 
-                            || ( $this->options->getMap()->isLoaded() && $this->options->getMap()->getTopLevelName() == '*') 
-                            || (
-                                $this->options->getMapLevel() <= $this->analysis_level 
-                                && $this->options->getMapLevel() > 0
-                                && count($levels) >= $this->options->getMapLevel()
-                                && in_array(strtolower($levels[$this->options->getMapLevel()-1]), $toplevelvalues)
-                            )
-                        ) {
-                            $placest = implode(I18N::$list_separator, array_slice($levels, 0, $this->analysis_level));
-                            if(isset($placesDispGeneral['places'][$placest])) {
-                                $placesDispGeneral['places'][$placest] += 1;
-                            }
-                            else { 
-                                $placesDispGeneral['places'][$placest] = 1;
-                            }
-                            if($placesDispGeneral['places'][$placest]>$placesDispGeneral['max'])
-                                $placesDispGeneral['max'] = $placesDispGeneral['places'][$placest];
-                            foreach($genstab as $gen) {
-                                if(isset($placesDispGenerations[$gen]['places'][$placest])) {
-                                    $placesDispGenerations[$gen]['places'][$placest] += 1;
-                                }
-                                else { 
-                                    $placesDispGenerations[$gen]['places'][$placest] = 1;
-                                }
-                                if(isset($placesDispGenerations[$gen]['sum'])) {
-                                    $placesDispGenerations[$gen]['sum'] += 1;
-                                }
-                                else { 
-                                    $placesDispGenerations[$gen]['sum'] = 1;
-                                }
-                            }
-                        }
-                        else{
-                            if(isset($placesDispGeneral['other'])) {
-                                $placesDispGeneral['other'] += 1;
-                            }
-                            else { 
-                                $placesDispGeneral['other'] = 1;
-                            }
-                            foreach($genstab as $gen) {
-                                if(isset($placesDispGenerations[$gen]['other'])) {
-                                    $placesDispGenerations[$gen]['other'] += 1;
-                                }
-                                else { 
-                                    $placesDispGenerations[$gen]['other'] = 1;
-                                }
-                            }
-                        }
-                        $placesDispGeneral['knownsum'] += 1;
-                        $isUnknown = false;
-                    }
-                }
-                if($isUnknown){
-                    $placesDispGeneral['unknown'] += 1;
-                    foreach($genstab as $gen) {
-                        if(isset($placesDispGenerations[$gen]['unknown'])) { 
-                            $placesDispGenerations[$gen]['unknown'] += 1;
-                        }
-                        else { 
-                            $placesDispGenerations[$gen]['unknown'] = 1; 
-                        }
-                    }
-                }
-            }
+		if($sosalist && count($sosalist) > 0) {
+			$placesDispGeneral['knownsum'] = 0;
+			$placesDispGeneral['unknown'] = 0;
+			$placesDispGeneral['max'] = 0;
+			$placesDispGeneral['places'] = array();
+			foreach($sosalist as $sosaid => $gens) {
+				$sosa = Individual::getIntance($sosaid, $this->tree);
+				$place =$sosa->getSignificantPlace();
+				$genstab = explode(',', $gens);
+				$isUnknown=true;
+				if($sosa->getDerivedRecord()->canShow() && !is_null($place)){
+					$levels = array_reverse(array_map('trim',explode(',', $place)));
+					if(count($levels)>= $this->analysis_level){                        
+						$toplevelvalues = array();
+						if($this->hasMap()
+							&& $this->options->getMap()->isLoaded()
+							&& $toplevelvalue = $this->options->getMap()->getTopLevelName()
+						) {
+							$toplevelvalues = array_map('trim',explode(',', strtolower($toplevelvalue)));
+						}
+						if(!$this->hasMap() 
+							|| is_null($this->options->getMapLevel()) 
+							|| ( $this->options->getMap()->isLoaded() && $this->options->getMap()->getTopLevelName() == '*') 
+							|| (
+								$this->options->getMapLevel() <= $this->analysis_level 
+								&& $this->options->getMapLevel() > 0
+								&& count($levels) >= $this->options->getMapLevel()
+								&& in_array(strtolower($levels[$this->options->getMapLevel()-1]), $toplevelvalues)
+							)
+						) {
+							$placest = implode(I18N::$list_separator, array_slice($levels, 0, $this->analysis_level));
+							if(isset($placesDispGeneral['places'][$placest])) {
+								$placesDispGeneral['places'][$placest] += 1;
+							}
+							else { 
+								$placesDispGeneral['places'][$placest] = 1;
+							}
+							if($placesDispGeneral['places'][$placest]>$placesDispGeneral['max'])
+								$placesDispGeneral['max'] = $placesDispGeneral['places'][$placest];
+							foreach($genstab as $gen) {
+								if(isset($placesDispGenerations[$gen]['places'][$placest])) {
+									$placesDispGenerations[$gen]['places'][$placest] += 1;
+								}
+								else { 
+									$placesDispGenerations[$gen]['places'][$placest] = 1;
+								}
+								if(isset($placesDispGenerations[$gen]['sum'])) {
+									$placesDispGenerations[$gen]['sum'] += 1;
+								}
+								else { 
+									$placesDispGenerations[$gen]['sum'] = 1;
+								}
+							}
+						}
+						else{
+							if(isset($placesDispGeneral['other'])) {
+								$placesDispGeneral['other'] += 1;
+							}
+							else { 
+								$placesDispGeneral['other'] = 1;
+							}
+							foreach($genstab as $gen) {
+								if(isset($placesDispGenerations[$gen]['other'])) {
+									$placesDispGenerations[$gen]['other'] += 1;
+								}
+								else { 
+									$placesDispGenerations[$gen]['other'] = 1;
+								}
+							}
+						}
+						$placesDispGeneral['knownsum'] += 1;
+						$isUnknown = false;
+					}
+				}
+				if($isUnknown){
+					$placesDispGeneral['unknown'] += 1;
+					foreach($genstab as $gen) {
+						if(isset($placesDispGenerations[$gen]['unknown'])) { 
+							$placesDispGenerations[$gen]['unknown'] += 1;
+						}
+						else { 
+							$placesDispGenerations[$gen]['unknown'] = 1; 
+						}
+					}
+				}
+			}
            
-        }        
+		}        
         
-        return array($placesDispGeneral, $placesDispGenerations);        
-    }
+		return array($placesDispGeneral, $placesDispGenerations);        
+	}
     
                    
 }

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

Indentation +32 added lines, -32 removed lines

@@ -25,24 +25,24 @@ 
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisTabGeneralView::htmlAnalysisData()
 	 */
-    protected function htmlAnalysisData() {
+	protected function htmlAnalysisData() {
         
-        /** @var OutlineMap $map */
-        $map = $this->data->get('map');
+		/** @var OutlineMap $map */
+		$map = $this->data->get('map');
         
-        if($map === null) {
-            return '<p class="warning">' .
-                I18N::translate('The map could not be loaded.') . 
-            '</p>';
-        }
+		if($map === null) {
+			return '<p class="warning">' .
+				I18N::translate('The map could not be loaded.') . 
+			'</p>';
+		}
         
-        $canvas = $map->getCanvas();
-        $subdvisions_results = $this->data->get('results_by_subdivisions');
+		$canvas = $map->getCanvas();
+		$subdvisions_results = $this->data->get('results_by_subdivisions');
         
-        $nb_found = $this->data->get('stats_gen_nb_found');
-        $nb_other = $this->data->get('stats_gen_nb_other');
+		$nb_found = $this->data->get('stats_gen_nb_found');
+		$nb_other = $this->data->get('stats_gen_nb_other');
         
-        $html = '<script>
+		$html = '<script>
 			var tip = null;
 			var tipText = "";
 			var over = false;
@@ -89,29 +89,29 @@ 
 				var map = {};
 		';
         
-        foreach($subdvisions_results as $name => $location){
-            $html.= 'map.area'.$location['id'].' = paper.path("'.$location['coord'].'").attr(attr);';
-            if(isset($location['transparency'])) {
-                $textToolTip = '<strong>'.$location['displayname'].'</strong><br/>';
-                if($this->data->get('use_flags') && $location['flag'] != '') $textToolTip .= '<span class="geodispersion_flag">'.FunctionsPrint::htmlPlaceIcon($location['place'], $location['flag']).'</span><br/>';
-                $textToolTip .= I18N::translate('%d individuals', $location['count']).'<br/>'.I18N::percentage(Functions::safeDivision($location['count'], $nb_found - $nb_other), 1);
-                $html.= 'addTip(map.area'.$location['id'].'.node, "'.Filter::escapeJs($textToolTip).'");';
-                $html.= 'map.area'.$location['id'].'.attr({"fill" : "'. $canvas->max_color .'", "fill-opacity" : '.$location['transparency'].' });';
-                $html.= 'map.area'.$location['id'].'.mouseover(function () {'.
-                    'map.area'.$location['id'].'.stop().animate({"fill" : "'. $canvas->hover_color .'", "fill-opacity" : 1}, 100, "linear");'.
-                    '});'.
-                    'map.area'.$location['id'].'.mouseout(function () {'.
-                    'map.area'.$location['id'].'.stop().animate({"fill" : "'.$canvas->max_color.'", "fill-opacity" : '.$location['transparency'].'}, 100, "linear");'.
-                    '});';
-            }
-        }
-        $html .= '});
+		foreach($subdvisions_results as $name => $location){
+			$html.= 'map.area'.$location['id'].' = paper.path("'.$location['coord'].'").attr(attr);';
+			if(isset($location['transparency'])) {
+				$textToolTip = '<strong>'.$location['displayname'].'</strong><br/>';
+				if($this->data->get('use_flags') && $location['flag'] != '') $textToolTip .= '<span class="geodispersion_flag">'.FunctionsPrint::htmlPlaceIcon($location['place'], $location['flag']).'</span><br/>';
+				$textToolTip .= I18N::translate('%d individuals', $location['count']).'<br/>'.I18N::percentage(Functions::safeDivision($location['count'], $nb_found - $nb_other), 1);
+				$html.= 'addTip(map.area'.$location['id'].'.node, "'.Filter::escapeJs($textToolTip).'");';
+				$html.= 'map.area'.$location['id'].'.attr({"fill" : "'. $canvas->max_color .'", "fill-opacity" : '.$location['transparency'].' });';
+				$html.= 'map.area'.$location['id'].'.mouseover(function () {'.
+					'map.area'.$location['id'].'.stop().animate({"fill" : "'. $canvas->hover_color .'", "fill-opacity" : 1}, 100, "linear");'.
+					'});'.
+					'map.area'.$location['id'].'.mouseout(function () {'.
+					'map.area'.$location['id'].'.stop().animate({"fill" : "'.$canvas->max_color.'", "fill-opacity" : '.$location['transparency'].'}, 100, "linear");'.
+					'});';
+			}
+		}
+		$html .= '});
             </script>
             
             <div id="geodispersion_map"></div>
     	   <div id="geodispersion_tip"></div>';
         
-        return $html;
-    }
+		return $html;
+	}
     
 } 
\ No newline at end of file

src/Webtrees/Module/GeoDispersion/AdminConfigController.php

Indentation +221 added lines, -221 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,112 +234,112 @@ 
                        </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];
-		    } else {
-		        $datum[4] = $analysis_level . '(' . $place_hierarchy['hierarchy'][$analysis_level - 1] . ')';
-		    }
-		    $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];
-    		        } else {
-    		            $datum[7] .= $top_level . '(' . $place_hierarchy['hierarchy'][$top_level - 1] . ')';
-    		        }
-    		        $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];
+			} else {
+				$datum[4] = $analysis_level . '(' . $place_hierarchy['hierarchy'][$analysis_level - 1] . ')';
+			}
+			$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];
+					} else {
+						$datum[7] .= $top_level . '(' . $place_hierarchy['hierarchy'][$top_level - 1] . ')';
+					}
+					$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) {
@@ -352,8 +352,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,
@@ -371,33 +371,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();
@@ -411,34 +411,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

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

Indentation +613 added lines, -613 removed lines

@@ -22,389 +22,389 @@ 
  */
 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 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 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.', :dyear'.$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'],
-                        'dyear'.$i => $row['death_year']
-                    )
-                );
-            }
-            $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.', :dyear'.$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'],
+						'dyear'.$i => $row['death_year']
+					)
+				);
+			}
+			$i++;
+		}
         
-        $sql = 'REPLACE INTO `##maj_sosa`' .
-            ' (majs_gedcom_id, majs_user_id, majs_sosa, majs_i_id, majs_gen, majs_birth_year, majs_death_year)' .
-            ' 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_death_year)' .
+			' 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 last 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'],
-                        'lastBirth'				=>	$birthStats['last'],
-                        '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 last 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'],
+						'lastBirth'				=>	$birthStats['last'],
+						'avgBirth'				=>	$birthStats['avg']
+					);
+				}
+			}
+		}
+		return $this->statistics_tab;        
+	}
     
 	/**
 	 * How many individuals exist in the tree.
@@ -412,258 +412,258 @@ 
 	 * @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 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
-     *  - last : Last birth year in generation
-     *  - avg : Average birth year
-     *
-     * @param number $gen Generation
-     * @return array Birth statistics array
-     */
-    public function getStatsBirthYearInGeneration($gen){
-        if(!$this->is_setup) return array('first' => 0, 'avg' => 0, 'last' => 0);
-        return Database::prepare(
-            'SELECT MIN(majs_birth_year) AS first, AVG(majs_birth_year) AS avg, MAX(majs_birth_year) AS last'.
-            ' FROM `##maj_sosa`' .
-            ' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
-            ' AND majs_gen=:gen AND NOT majs_birth_year = :birth_year')
-            ->execute(array(
-                'tree_id' => $this->tree->getTreeId(), 
-                'user_id' => $this->user->getUserId(),
-                'gen' => $gen,
-                'birth_year' => 0))
-            ->fetchOneRow(\PDO::FETCH_ASSOC) ?: array('first' => 0, 'avg' => 0, 'last' => 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 = 0;
-        $sum_x=0;
-        $sum_y=0;
-        $sum_x2=0;
-        $n=count($this->statistics_tab);
-        foreach($this->statistics_tab as $gen=>$stats){
-            $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 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();
-    }
+	/**
+	 * 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
+	 *  - last : Last birth year in generation
+	 *  - avg : Average birth year
+	 *
+	 * @param number $gen Generation
+	 * @return array Birth statistics array
+	 */
+	public function getStatsBirthYearInGeneration($gen){
+		if(!$this->is_setup) return array('first' => 0, 'avg' => 0, 'last' => 0);
+		return Database::prepare(
+			'SELECT MIN(majs_birth_year) AS first, AVG(majs_birth_year) AS avg, MAX(majs_birth_year) AS last'.
+			' FROM `##maj_sosa`' .
+			' WHERE majs_gedcom_id=:tree_id AND majs_user_id=:user_id'.
+			' AND majs_gen=:gen AND NOT majs_birth_year = :birth_year')
+			->execute(array(
+				'tree_id' => $this->tree->getTreeId(), 
+				'user_id' => $this->user->getUserId(),
+				'gen' => $gen,
+				'birth_year' => 0))
+			->fetchOneRow(\PDO::FETCH_ASSOC) ?: array('first' => 0, 'avg' => 0, 'last' => 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 = 0;
+		$sum_x=0;
+		$sum_y=0;
+		$sum_x2=0;
+		$n=count($this->statistics_tab);
+		foreach($this->statistics_tab as $gen=>$stats){
+			$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 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();
+	}
     
                
 }

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

Indentation +146 added lines, -146 removed lines

@@ -22,187 +22,187 @@
 	 * Name of the file containing the description of the map.
 	 * @var string $filename
 	 */
-    protected $filename;
+	protected $filename;
     
 	/**
 	 * Indicates whether the description has been loaded from the file.
 	 * @var bool $is_loaded
 	 */
-    protected $is_loaded;
+	protected $is_loaded;
     
 	/**
 	 * Description/title of the map.
 	 * @var string $description
 	 */
-    protected $description;
+	protected $description;
     
 	/**
 	 * Name(s) of the parent level(s) of the map.
 	 * @var string $is_loaded
 	 */
-    protected $top_level_name;
-    
-    /**
-     * Map canvas
-     * @var OutlineMapCanvas $canvas
-     */
-    protected $canvas;
-    
-    /**
-     * Map subdivisions
-     * @var array $subdivisions
-     */
-    protected $subdivisions;
-    
-    /**
-     * Places mappings
-     * @var array $subdivisions
-     */
-    protected $mappings;
-    
-    /**
-     * Constructor for GeoAnalysisMap.
-     *
-     * @param string $filename Outline map file name
-     * @param bool $load Should the map be loaded immediately
-     */
-    public function __construct($filename, $load = false) {
-        $this->filename = $filename;
-        $this->is_loaded = false;
-        $this->subdivisions = array();
-        $this->mappings = array();
-        if($load) $this->load();
-    }
-    
-    /**
-     * Load the map settings contained within its XML representation
-     *
-     * XML structure :
-     * 	- displayName : Display name of the map
-     * 	- topLevel : Values of the top level subdivisions (separated by commas, if multiple)
-     * 	- canvas : all settings related to the map canvas.
-     * 		- width : canvas width, in px
-     * 		- height : canvas height, in px
-     * 		- maxcolor : color to identify places with ancestors, RGB hexadecimal
-     * 		- hovercolor : same as previous, color when mouse is hovering the place, RGB hexadecimal
-     * 		- bgcolor : map background color, RGB hexadecimal
-     * 		- bgstroke : map stroke color, RGB hexadecimal
-     * 		- defaultcolor : default color of places, RGB hexadecimal
-     * 		- defaultstroke : default stroke color, RGB hexadecimal
-     * 	- subdvisions : for each subdivision :
+	protected $top_level_name;
+    
+	/**
+	 * Map canvas
+	 * @var OutlineMapCanvas $canvas
+	 */
+	protected $canvas;
+    
+	/**
+	 * Map subdivisions
+	 * @var array $subdivisions
+	 */
+	protected $subdivisions;
+    
+	/**
+	 * Places mappings
+	 * @var array $subdivisions
+	 */
+	protected $mappings;
+    
+	/**
+	 * Constructor for GeoAnalysisMap.
+	 *
+	 * @param string $filename Outline map file name
+	 * @param bool $load Should the map be loaded immediately
+	 */
+	public function __construct($filename, $load = false) {
+		$this->filename = $filename;
+		$this->is_loaded = false;
+		$this->subdivisions = array();
+		$this->mappings = array();
+		if($load) $this->load();
+	}
+    
+	/**
+	 * Load the map settings contained within its XML representation
+	 *
+	 * XML structure :
+	 * 	- displayName : Display name of the map
+	 * 	- topLevel : Values of the top level subdivisions (separated by commas, if multiple)
+	 * 	- canvas : all settings related to the map canvas.
+	 * 		- width : canvas width, in px
+	 * 		- height : canvas height, in px
+	 * 		- maxcolor : color to identify places with ancestors, RGB hexadecimal
+	 * 		- hovercolor : same as previous, color when mouse is hovering the place, RGB hexadecimal
+	 * 		- bgcolor : map background color, RGB hexadecimal
+	 * 		- bgstroke : map stroke color, RGB hexadecimal
+	 * 		- defaultcolor : default color of places, RGB hexadecimal
+	 * 		- defaultstroke : default stroke color, RGB hexadecimal
+	 * 	- subdvisions : for each subdivision :
 	 *		- id : Subdivision id, must be compatible with PHP variable constraints, and unique
-     * 		- name: Display name for the place
+	 * 		- name: Display name for the place
 	 *		- parent: if any, describe to which parent level the place if belonging to
-     * 		- <em>Element value<em> : SVG description of the subdvision shape
+	 * 		- <em>Element value<em> : SVG description of the subdvision shape
 	 *	- mapping : for each subdivision :
 	 *		- name : Name of the place to map
-     * 		- mapto: Name of the place to map to
+	 * 		- mapto: Name of the place to map to
 	 * 
-     */
-    protected function load() {
-        if(file_exists(WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/'.$this->filename)){
-            $xml = simplexml_load_file(WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/'.$this->filename);
-            if($xml){
-                $this->description = trim($xml->displayName);
-                $this->top_level_name = trim($xml->topLevel);
-                $this->canvas = new OutlineMapCanvas(
-                    trim($xml->canvas->width),
-                    trim($xml->canvas->height), 
-                    trim($xml->canvas->maxcolor), 
-                    trim($xml->canvas->hovercolor), 
-                    trim($xml->canvas->bgcolor),
-                    trim($xml->canvas->bgstroke),
-                    trim($xml->canvas->defaultcolor), 
-                    trim($xml->canvas->defaultstroke)
-                );
-                foreach($xml->subdivisions->children() as $subdivision){
-                    $attributes = $subdivision->attributes();
-                    $key = I18N::strtolower(trim($attributes['name']));
-                    if(isset($attributes['parent'])) $key .= '@'. I18N::strtolower(trim($attributes['parent']));
-                    $this->subdivisions[$key] = array(
-                        'id' => trim($attributes['id']),
-                        'displayname' => trim($attributes['name']),
-                        'coord' => trim($subdivision[0])
-                    );
-                }
-                if(isset($xml->mappings)) {
-                    foreach($xml->mappings->children() as $mappings){
-                        $attributes = $mappings->attributes();
-                        $this->mappings[I18N::strtolower(trim($attributes['name']))] = I18N::strtolower(trim($attributes['mapto']));
-                    }
-                }
-                $this->is_loaded = true;
-                return;
-            }
-        }
-        throw new \Exception('The Outline Map could not be loaded from XML.');
-    }
-    
-    /**
-     * Get the status of the map loading from the XML file.
-     * 
-     * @return bool
-     */
-    public function isLoaded() {
-        try{
-            if(!$this->is_loaded) $this->load();
-        }
-        catch (\Exception $ex) { }
-        return $this->is_loaded;
-    }
+	 */
+	protected function load() {
+		if(file_exists(WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/'.$this->filename)){
+			$xml = simplexml_load_file(WT_ROOT.WT_MODULES_DIR.Constants::MODULE_MAJ_GEODISP_NAME.'/maps/'.$this->filename);
+			if($xml){
+				$this->description = trim($xml->displayName);
+				$this->top_level_name = trim($xml->topLevel);
+				$this->canvas = new OutlineMapCanvas(
+					trim($xml->canvas->width),
+					trim($xml->canvas->height), 
+					trim($xml->canvas->maxcolor), 
+					trim($xml->canvas->hovercolor), 
+					trim($xml->canvas->bgcolor),
+					trim($xml->canvas->bgstroke),
+					trim($xml->canvas->defaultcolor), 
+					trim($xml->canvas->defaultstroke)
+				);
+				foreach($xml->subdivisions->children() as $subdivision){
+					$attributes = $subdivision->attributes();
+					$key = I18N::strtolower(trim($attributes['name']));
+					if(isset($attributes['parent'])) $key .= '@'. I18N::strtolower(trim($attributes['parent']));
+					$this->subdivisions[$key] = array(
+						'id' => trim($attributes['id']),
+						'displayname' => trim($attributes['name']),
+						'coord' => trim($subdivision[0])
+					);
+				}
+				if(isset($xml->mappings)) {
+					foreach($xml->mappings->children() as $mappings){
+						$attributes = $mappings->attributes();
+						$this->mappings[I18N::strtolower(trim($attributes['name']))] = I18N::strtolower(trim($attributes['mapto']));
+					}
+				}
+				$this->is_loaded = true;
+				return;
+			}
+		}
+		throw new \Exception('The Outline Map could not be loaded from XML.');
+	}
+    
+	/**
+	 * Get the status of the map loading from the XML file.
+	 * 
+	 * @return bool
+	 */
+	public function isLoaded() {
+		try{
+			if(!$this->is_loaded) $this->load();
+		}
+		catch (\Exception $ex) { }
+		return $this->is_loaded;
+	}
     
 	/**
 	 * Get the map file name.
 	 * @return string
 	 */
-    public function getFileName() {
-        return $this->filename;
-    }
+	public function getFileName() {
+		return $this->filename;
+	}
     
 	/**
 	 * Get the map file name.
 	 * @return string
 	 */
-    public function getDescription() {
-        if(!$this->is_loaded) $this->load();
-        return $this->description;
-    }
+	public function getDescription() {
+		if(!$this->is_loaded) $this->load();
+		return $this->description;
+	}
     
 	/**
 	 * Get the name of the map parent level. 
 	 * @return string
 	 */
-    public function getTopLevelName() {
-        if(!$this->is_loaded) $this->load();
-        return $this->top_level_name;
-    }    
-    
-    /**
-     * Get the Outline Map canvas.
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\OutlineMapCanvas
-     */
-    public function getCanvas() {
-        if(!$this->is_loaded) $this->load();
-        return $this->canvas;
-    }
-    
-	/**
-     * Get the subdivisions of the map.
-     * @return array
-     */
-    public function getSubdivisions() {
-        if(!$this->is_loaded) $this->load();
-        return $this->subdivisions;
-    }
-    
-	/**
-     * Get the places mappings of the map.
-     * @return array
-     */
-    public function getPlacesMappings() {
-        if(!$this->is_loaded) $this->load();
-        return $this->mappings;
-    }
+	public function getTopLevelName() {
+		if(!$this->is_loaded) $this->load();
+		return $this->top_level_name;
+	}    
+    
+	/**
+	 * Get the Outline Map canvas.
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\OutlineMapCanvas
+	 */
+	public function getCanvas() {
+		if(!$this->is_loaded) $this->load();
+		return $this->canvas;
+	}
+    
+	/**
+	 * Get the subdivisions of the map.
+	 * @return array
+	 */
+	public function getSubdivisions() {
+		if(!$this->is_loaded) $this->load();
+		return $this->subdivisions;
+	}
+    
+	/**
+	 * Get the places mappings of the map.
+	 * @return array
+	 */
+	public function getPlacesMappings() {
+		if(!$this->is_loaded) $this->load();
+		return $this->mappings;
+	}
     
 }
  
\ No newline at end of file

src/Webtrees/Module/GeoDispersion/GeoAnalysisController.php

Indentation +230 added lines, -230 removed lines

@@ -36,47 +36,47 @@ 
  */
 class GeoAnalysisController extends MvcController
 {
-    /**
-     * GeoAnalysis Provider
-     * @var GeoAnalysisProvider $provider
-     */
-    protected $provider;
+	/**
+	 * GeoAnalysis Provider
+	 * @var GeoAnalysisProvider $provider
+	 */
+	protected $provider;
     
-    /**
-     * Constructor for GeoAnalysis controller
-     * @param AbstractModule $module
-     */
-    public function __construct(AbstractModule $module) {
-        parent::__construct($module);
+	/**
+	 * Constructor for GeoAnalysis controller
+	 * @param AbstractModule $module
+	 */
+	public function __construct(AbstractModule $module) {
+		parent::__construct($module);
         
-        $this->provider = $this->module->getProvider();
-    }    
+		$this->provider = $this->module->getProvider();
+	}    
     
-    /**
-     * Pages
-     */
+	/**
+	 * Pages
+	 */
         
-    /**
-     * GeoAnalysis@index
-     */
-    public function index() {
+	/**
+	 * GeoAnalysis@index
+	 */
+	public function index() {
         
-        $controller = new PageController();
-        $controller->setPageTitle(I18N::translate('Sosa Geographical dispersion'));
+		$controller = new PageController();
+		$controller->setPageTitle(I18N::translate('Sosa Geographical dispersion'));
         
-        $data = new ViewBag();
-        $data->set('title', $controller->getPageTitle());
-        $data->set('has_analysis', false);
+		$data = new ViewBag();
+		$data->set('title', $controller->getPageTitle());
+		$data->set('has_analysis', false);
         
-        $ga_id = Filter::getInteger('ga_id');        
+		$ga_id = Filter::getInteger('ga_id');        
         
-        if($ga_id && $ga = $this->provider->getGeoAnalysis($ga_id)) {
-            $data->set('has_analysis', true);
-            $data->set('geoanalysis', $ga);
+		if($ga_id && $ga = $this->provider->getGeoAnalysis($ga_id)) {
+			$data->set('has_analysis', true);
+			$data->set('geoanalysis', $ga);
             
-            $controller
-                ->addExternalJavascript(Constants::WT_RAPHAEL_JS_URL())
-                ->addInlineJavascript('
+			$controller
+				->addExternalJavascript(Constants::WT_RAPHAEL_JS_URL())
+				->addInlineJavascript('
                 jQuery("#geodispersion-tabs").tabs();
                 jQuery("#geodispersion-tabs").css("visibility", "visible");
                 
@@ -97,128 +97,128 @@ 
 					"json"
 				);
             ');
-        }
+		}
         
-        ViewFactory::make('GeoAnalysis', $this, $controller, $data)->render();
-    }
+		ViewFactory::make('GeoAnalysis', $this, $controller, $data)->render();
+	}
     
-    /**
-     * GeoAnalysis@listAll
-     */
-    public function listAll() {
+	/**
+	 * GeoAnalysis@listAll
+	 */
+	public function listAll() {
         
-        $controller = new PageController();
-        $controller->setPageTitle(I18N::translate('Sosa Geographical dispersion'));
+		$controller = new PageController();
+		$controller->setPageTitle(I18N::translate('Sosa Geographical dispersion'));
         
-        $data = new ViewBag();
-        $data->set('title', $controller->getPageTitle());
-        $data->set('has_list', false);
+		$data = new ViewBag();
+		$data->set('title', $controller->getPageTitle());
+		$data->set('has_list', false);
         
-        $ga_list = $this->provider->getGeoAnalysisList();
-        if(count($ga_list) > 0 ) {
-             $data->set('has_list', true);
-             $data->set('geoanalysislist', $ga_list);
-        }
+		$ga_list = $this->provider->getGeoAnalysisList();
+		if(count($ga_list) > 0 ) {
+			 $data->set('has_list', true);
+			 $data->set('geoanalysislist', $ga_list);
+		}
         
-        ViewFactory::make('GeoAnalysisList', $this, $controller, $data)->render();        
-    }
+		ViewFactory::make('GeoAnalysisList', $this, $controller, $data)->render();        
+	}
     	
 	/**
 	 * GeoAnalysis@setStatus
 	 */
-    public function setStatus() {
-        $controller = new JsonController();
+	public function setStatus() {
+		$controller = new JsonController();
         
-        $ga_id = Filter::getInteger('ga_id');
-        $ga = $this->provider->getGeoAnalysis($ga_id, false);
+		$ga_id = Filter::getInteger('ga_id');
+		$ga = $this->provider->getGeoAnalysis($ga_id, false);
         
-        $controller->restrictAccess(
-            true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
-            &&  Auth::isManager(Globals::getTree()) 
-            && $ga !== null
-        );
+		$controller->restrictAccess(
+			true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
+			&&  Auth::isManager(Globals::getTree()) 
+			&& $ga !== null
+		);
         
-        $status = Filter::getBool('status');
-        $res = array('geoanalysis' => $ga->getId() , 'error' => null);
-        try{
-            $this->provider->setGeoAnalysisStatus($ga, $status);
-            $res['status'] = $status;
+		$status = Filter::getBool('status');
+		$res = array('geoanalysis' => $ga->getId() , 'error' => null);
+		try{
+			$this->provider->setGeoAnalysisStatus($ga, $status);
+			$res['status'] = $status;
 			Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID "'.$ga->getId().'" has been '. ($status ? 'enabled' : 'disabled') .'.');
-        }
-        catch (\Exception $ex) {
-            $res['error'] = $ex->getMessage();
+		}
+		catch (\Exception $ex) {
+			$res['error'] = $ex->getMessage();
 			Log::addErrorLog('Module '.$this->module->getName().' : Geo Analysis ID "'.$ga->getId().'" could not be ' . ($status ? 'enabled' : 'disabled') .'. Error: '. $ex->getMessage());
-        }
+		}
         
-        $controller->pageHeader();
-        if($res['error']) http_response_code(500);
+		$controller->pageHeader();
+		if($res['error']) http_response_code(500);
         
-        $controller->encode($res);
-    }
+		$controller->encode($res);
+	}
     
 	/**
-     * GeoAnalysis@delete
-     */
-    public function delete() {
-        $controller = new JsonController();
+	 * GeoAnalysis@delete
+	 */
+	public function delete() {
+		$controller = new JsonController();
     
-        $ga_id = Filter::getInteger('ga_id');
-        $ga = $this->provider->getGeoAnalysis($ga_id, false);
+		$ga_id = Filter::getInteger('ga_id');
+		$ga = $this->provider->getGeoAnalysis($ga_id, false);
     
-        $controller->restrictAccess(
-            true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
-            &&  Auth::isManager(Globals::getTree())
-            && $ga
-            );
+		$controller->restrictAccess(
+			true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
+			&&  Auth::isManager(Globals::getTree())
+			&& $ga
+			);
             
-        $res = array('geoanalysis' => $ga->getId() , 'error' => null);
-        try{
-            $this->provider->deleteGeoAnalysis($ga);
+		$res = array('geoanalysis' => $ga->getId() , 'error' => null);
+		try{
+			$this->provider->deleteGeoAnalysis($ga);
 			Log::addConfigurationLog('Module '.$this->module->getName().' : Geo Analysis ID "'.$ga->getId().'" has been deleted.');
-        }
-        catch (\Exception $ex) {
-            $res['error'] = $ex->getMessage();
+		}
+		catch (\Exception $ex) {
+			$res['error'] = $ex->getMessage();
 			Log::addErrorLog('Module '.$this->module->getName().' : Geo Analysis ID "'.$ga->getId().'" could not be deleted. Error: '. $ex->getMessage());
-        }
+		}
     
-        $controller->pageHeader();
-        if($res['error']) http_response_code(500);
+		$controller->pageHeader();
+		if($res['error']) http_response_code(500);
 
-        $controller->encode($res);
-    }
+		$controller->encode($res);
+	}
         	
-    /**
-     * GeoAnalysis@dataTabs
-     */
-    public function dataTabs() {
-        $wt_tree = Globals::getTree();
-        $controller = new JsonController();
+	/**
+	 * GeoAnalysis@dataTabs
+	 */
+	public function dataTabs() {
+		$wt_tree = Globals::getTree();
+		$controller = new JsonController();
         
-        $ga_id = Filter::getInteger('ga_id');
-        $ga = $this->provider->getGeoAnalysis($ga_id);
-        $sosa_provider = new SosaProvider($wt_tree, Auth::user());
+		$ga_id = Filter::getInteger('ga_id');
+		$ga = $this->provider->getGeoAnalysis($ga_id);
+		$sosa_provider = new SosaProvider($wt_tree, Auth::user());
         
-        $controller
-            ->restrictAccess($ga && $sosa_provider->isSetup())
-            ->pageHeader();
+		$controller
+			->restrictAccess($ga && $sosa_provider->isSetup())
+			->pageHeader();
         
-        $jsonArray = array();
+		$jsonArray = array();
         
-        list($placesDispGeneral, $placesDispGenerations) = $ga->getAnalysisResults($sosa_provider->getAllSosaWithGenerations());
+		list($placesDispGeneral, $placesDispGenerations) = $ga->getAnalysisResults($sosa_provider->getAllSosaWithGenerations());
         
-        $flags = array();
-        if($placesDispGeneral && $ga->getOptions() && $ga->getOptions()->isUsingFlags()) {
-            $mapProvider = new GoogleMapsProvider();            
-            foreach($placesDispGeneral['places'] as $place => $count) {
-                $flags[$place] = $mapProvider->getPlaceIcon(new Place($place, $wt_tree));
-            }
-        }
+		$flags = array();
+		if($placesDispGeneral && $ga->getOptions() && $ga->getOptions()->isUsingFlags()) {
+			$mapProvider = new GoogleMapsProvider();            
+			foreach($placesDispGeneral['places'] as $place => $count) {
+				$flags[$place] = $mapProvider->getPlaceIcon(new Place($place, $wt_tree));
+			}
+		}
         
-        $jsonArray['generaltab'] = $this->htmlPlacesAnalysisGeneralTab($ga, $placesDispGeneral, $flags);
-        $jsonArray['generationstab'] = $this->htmlPlacesAnalysisGenerationsTab($ga, $placesDispGenerations, $flags);
+		$jsonArray['generaltab'] = $this->htmlPlacesAnalysisGeneralTab($ga, $placesDispGeneral, $flags);
+		$jsonArray['generationstab'] = $this->htmlPlacesAnalysisGenerationsTab($ga, $placesDispGenerations, $flags);
 
-        $controller->encode($jsonArray);
-    }
+		$controller->encode($jsonArray);
+	}
     
 	/**
 	 * Returns HTML code for the GeoAnalysis general tab (can be either a map or a table).
@@ -228,71 +228,71 @@ 
 	 * @param (null|array) $flags Array of flags
 	 * @return string HTML code for the general tab
 	 */
-    protected function htmlPlacesAnalysisGeneralTab(GeoAnalysis $ga, $placesGeneralResults, $flags= null) {        
-        if(!empty($placesGeneralResults)){
-            $data = new ViewBag();
+	protected function htmlPlacesAnalysisGeneralTab(GeoAnalysis $ga, $placesGeneralResults, $flags= null) {        
+		if(!empty($placesGeneralResults)){
+			$data = new ViewBag();
             
-            $nb_found = $placesGeneralResults['knownsum'];
-            $nb_other = 0;
-            if(isset($placesGeneralResults['other'])) $nb_other =$placesGeneralResults['other'];
-            $nb_unknown = $placesGeneralResults['unknown'];
+			$nb_found = $placesGeneralResults['knownsum'];
+			$nb_other = 0;
+			if(isset($placesGeneralResults['other'])) $nb_other =$placesGeneralResults['other'];
+			$nb_unknown = $placesGeneralResults['unknown'];
             
-            $data->set('stats_gen_nb_found', $nb_found);
-            $data->set('stats_gen_nb_other', $nb_other);
-            $data->set('stats_gen_nb_unknown', $nb_unknown);
+			$data->set('stats_gen_nb_found', $nb_found);
+			$data->set('stats_gen_nb_other', $nb_other);
+			$data->set('stats_gen_nb_unknown', $nb_unknown);
             
-            $data->set('use_flags', $ga->getOptions() && $ga->getOptions()->isUsingFlags());
+			$data->set('use_flags', $ga->getOptions() && $ga->getOptions()->isUsingFlags());
             
-            if($ga->hasMap()) {
-                $max = $placesGeneralResults['max'];
-                $map = $ga->getOptions()->getMap();
-                if($map->isLoaded()) {
-                    $results_by_subdivs = $map->getSubdivisions();
-                    $places_mappings = $map->getPlacesMappings();
-                    foreach ($placesGeneralResults['places'] as $location => $count) {
-                        $levelvalues = array_reverse(array_map('trim',explode(',', $location)));
-                        $level_map = $ga->getAnalysisLevel() - $ga->getOptions()->getMapLevel();
-                        if($level_map >= 0 && $level_map < count($levelvalues)) {
-                            $levelref = I18N::strtolower($levelvalues[0] . '@' . $levelvalues[$level_map]);
-                            if(!isset($results_by_subdivs[$levelref])) { $levelref = $levelvalues[0]; }
-                        }
-                        else {
-                            $levelref = $levelvalues[0];
-                        }
-                        $levelref = I18N::strtolower($levelref);
-                        if(isset($places_mappings[$levelref])) $levelref = $places_mappings[$levelref];
-                        if(isset($results_by_subdivs[$levelref])) {
-                            $count_subd = isset($results_by_subdivs[$levelref]['count']) ? $results_by_subdivs[$levelref]['count'] : 0;
-                            $count_subd  += $count;
-                            $results_by_subdivs[$levelref]['count'] = $count_subd;   
-                            $results_by_subdivs[$levelref]['transparency'] = Functions::safeDivision($count_subd, $max);
-                            if($ga->getOptions()->isUsingFlags() && $flags) {
-                                $results_by_subdivs[$levelref]['place'] = new Place($location, Globals::getTree());
-                                $results_by_subdivs[$levelref]['flag'] = $flags[$location];
-                            }
-                        }
-                    }             
+			if($ga->hasMap()) {
+				$max = $placesGeneralResults['max'];
+				$map = $ga->getOptions()->getMap();
+				if($map->isLoaded()) {
+					$results_by_subdivs = $map->getSubdivisions();
+					$places_mappings = $map->getPlacesMappings();
+					foreach ($placesGeneralResults['places'] as $location => $count) {
+						$levelvalues = array_reverse(array_map('trim',explode(',', $location)));
+						$level_map = $ga->getAnalysisLevel() - $ga->getOptions()->getMapLevel();
+						if($level_map >= 0 && $level_map < count($levelvalues)) {
+							$levelref = I18N::strtolower($levelvalues[0] . '@' . $levelvalues[$level_map]);
+							if(!isset($results_by_subdivs[$levelref])) { $levelref = $levelvalues[0]; }
+						}
+						else {
+							$levelref = $levelvalues[0];
+						}
+						$levelref = I18N::strtolower($levelref);
+						if(isset($places_mappings[$levelref])) $levelref = $places_mappings[$levelref];
+						if(isset($results_by_subdivs[$levelref])) {
+							$count_subd = isset($results_by_subdivs[$levelref]['count']) ? $results_by_subdivs[$levelref]['count'] : 0;
+							$count_subd  += $count;
+							$results_by_subdivs[$levelref]['count'] = $count_subd;   
+							$results_by_subdivs[$levelref]['transparency'] = Functions::safeDivision($count_subd, $max);
+							if($ga->getOptions()->isUsingFlags() && $flags) {
+								$results_by_subdivs[$levelref]['place'] = new Place($location, Globals::getTree());
+								$results_by_subdivs[$levelref]['flag'] = $flags[$location];
+							}
+						}
+					}             
                 
-                    $data->set('map', $map);
-                    $data->set('results_by_subdivisions', $results_by_subdivs);
-                }
+					$data->set('map', $map);
+					$data->set('results_by_subdivisions', $results_by_subdivs);
+				}
                 
-                $html = ViewFactory::make('GeoAnalysisTabGeneralMap', $this, new BaseController(), $data)->getHtmlPartial();
-            }
-            else {
-                $results = $placesGeneralResults['places'];
-                arsort($results);
-                $data->set('results', $results);
-                $data->set('analysis_level', $ga->getAnalysisLevel());
+				$html = ViewFactory::make('GeoAnalysisTabGeneralMap', $this, new BaseController(), $data)->getHtmlPartial();
+			}
+			else {
+				$results = $placesGeneralResults['places'];
+				arsort($results);
+				$data->set('results', $results);
+				$data->set('analysis_level', $ga->getAnalysisLevel());
                 
-                $html = ViewFactory::make('GeoAnalysisTabGeneralTable', $this, new BaseController(), $data)->getHtmlPartial();
-            }
-        }
-        else {
-            $html = '<p class="warning">' . I18N::translate('No data is available for the general analysis.') . '</p>';
-        }
-        return $html;
-    }
+				$html = ViewFactory::make('GeoAnalysisTabGeneralTable', $this, new BaseController(), $data)->getHtmlPartial();
+			}
+		}
+		else {
+			$html = '<p class="warning">' . I18N::translate('No data is available for the general analysis.') . '</p>';
+		}
+		return $html;
+	}
     
 	/**
 	 * Returns HTML code for the GeoAnalysis generations tab.
@@ -302,66 +302,66 @@ 
 	 * @param (null|array) $flags Array of flags
 	 * @return string HTML code for the generations tab
 	 */
-    protected function htmlPlacesAnalysisGenerationsTab(GeoAnalysis $ga, $placesGenerationsResults, $flags = null) {        
-        if(!empty($placesGenerationsResults) && $ga->getOptions()){
-            $data = new ViewBag();
+	protected function htmlPlacesAnalysisGenerationsTab(GeoAnalysis $ga, $placesGenerationsResults, $flags = null) {        
+		if(!empty($placesGenerationsResults) && $ga->getOptions()){
+			$data = new ViewBag();
             
-            ksort($placesGenerationsResults);
+			ksort($placesGenerationsResults);
             
-            $detailslevel = $ga->getOptions()->getMaxDetailsInGen();
-            $data->set('max_details_gen', $detailslevel);    
-            $data->set('use_flags', $ga->getOptions()->isUsingFlags());
-            $data->set('analysis_level', $ga->getAnalysisLevel());
-            $display_all_places = !is_null($detailslevel) && $detailslevel == 0;
-            $data->set('display_all_places', $display_all_places);
+			$detailslevel = $ga->getOptions()->getMaxDetailsInGen();
+			$data->set('max_details_gen', $detailslevel);    
+			$data->set('use_flags', $ga->getOptions()->isUsingFlags());
+			$data->set('analysis_level', $ga->getAnalysisLevel());
+			$display_all_places = !is_null($detailslevel) && $detailslevel == 0;
+			$data->set('display_all_places', $display_all_places);
             
-            $results_by_gen = array();
-            foreach($placesGenerationsResults as $gen => $genData){
-                $sum = 0;
-                $other = 0;
-                $unknown = 0;
-                if(isset($genData['sum'])) $sum = $genData['sum'];
-                if(isset($genData['other'])) $other = $genData['other'];
-                if(isset($genData['unknown'])) $unknown = $genData['unknown'];
+			$results_by_gen = array();
+			foreach($placesGenerationsResults as $gen => $genData){
+				$sum = 0;
+				$other = 0;
+				$unknown = 0;
+				if(isset($genData['sum'])) $sum = $genData['sum'];
+				if(isset($genData['other'])) $other = $genData['other'];
+				if(isset($genData['unknown'])) $unknown = $genData['unknown'];
                 
-                if($sum > 0) {                
-                    $results_by_gen[$gen]['sum'] = $sum;
-                    $results_by_gen[$gen]['other'] = $other;
-                    $results_by_gen[$gen]['unknown'] = $unknown;
-                    $results_by_gen[$gen]['places'] = array();                    
-                    arsort($genData['places']);
+				if($sum > 0) {                
+					$results_by_gen[$gen]['sum'] = $sum;
+					$results_by_gen[$gen]['other'] = $other;
+					$results_by_gen[$gen]['unknown'] = $unknown;
+					$results_by_gen[$gen]['places'] = array();                    
+					arsort($genData['places']);
                     
-                    if($display_all_places){
-                        foreach($genData['places'] as $placename=> $count){
-                            $results_by_gen[$gen]['places'][$placename]['count'] = $count;
+					if($display_all_places){
+						foreach($genData['places'] as $placename=> $count){
+							$results_by_gen[$gen]['places'][$placename]['count'] = $count;
                             
-                            if($ga->getOptions() && $ga->getOptions()->isUsingFlags() && ($flag = $flags[$placename]) != ''){
-                                $results_by_gen[$gen]['places'][$placename]['place'] = new Place($placename, Globals::getTree());
-                                $results_by_gen[$gen]['places'][$placename]['flag'] = $flag;
-                            }
-                        }
-                    }
-                    else {
-                        $tmp = $genData['places'];
-                        if($other > 0) {
-                            $tmp = array_slice($tmp, 0, 5, true);
-                            $tmp['other'] = $other;
-                            arsort($tmp);  
-                        }                      
-                        $results_by_gen[$gen]['places'] = array_slice($tmp, 0, 5, true);                        
-                    }
-                }
-            }
+							if($ga->getOptions() && $ga->getOptions()->isUsingFlags() && ($flag = $flags[$placename]) != ''){
+								$results_by_gen[$gen]['places'][$placename]['place'] = new Place($placename, Globals::getTree());
+								$results_by_gen[$gen]['places'][$placename]['flag'] = $flag;
+							}
+						}
+					}
+					else {
+						$tmp = $genData['places'];
+						if($other > 0) {
+							$tmp = array_slice($tmp, 0, 5, true);
+							$tmp['other'] = $other;
+							arsort($tmp);  
+						}                      
+						$results_by_gen[$gen]['places'] = array_slice($tmp, 0, 5, true);                        
+					}
+				}
+			}
             
-            $data->set('results_by_generations', $results_by_gen);
+			$data->set('results_by_generations', $results_by_gen);
             
-            $html = ViewFactory::make('GeoAnalysisTabGenerations', $this, new BaseController(), $data)->getHtmlPartial();
+			$html = ViewFactory::make('GeoAnalysisTabGenerations', $this, new BaseController(), $data)->getHtmlPartial();
             
-        }
-        else {
-            $html = '<p class="warning">' . I18N::translate('No data is available for the generations analysis.') . '</p>';
-        }
-        return $html;
-    }
+		}
+		else {
+			$html = '<p class="warning">' . I18N::translate('No data is available for the generations analysis.') . '</p>';
+		}
+		return $html;
+	}
         
 }
\ No newline at end of file

src/Webtrees/Module/CertificatesModule.php

Indentation +176 added lines, -176 removed lines

@@ -31,140 +31,140 @@ 
  * Certificates Module.
  */
 class CertificatesModule 
-    extends AbstractModule 
-    implements HookSubscriberInterface, ModuleConfigInterface, ModuleMenuItemInterface, FactSourceTextExtenderInterface, CustomSimpleTagManagerInterface
+	extends AbstractModule 
+	implements HookSubscriberInterface, ModuleConfigInterface, ModuleMenuItemInterface, FactSourceTextExtenderInterface, CustomSimpleTagManagerInterface
 {
-    /** @var string For custom modules - link for support, upgrades, etc. */
-    const CUSTOM_WEBSITE = 'https://github.com/jon48/webtrees-lib';
+	/** @var string For custom modules - link for support, upgrades, etc. */
+	const CUSTOM_WEBSITE = 'https://github.com/jon48/webtrees-lib';
         
-    /**
-     * Provider for Certificates
-     * @var CertificateProviderInterface $provider
-     */
-    protected $provider;
+	/**
+	 * Provider for Certificates
+	 * @var CertificateProviderInterface $provider
+	 */
+	protected $provider;
     
-    /**
-     * {@inhericDoc}
-     */
-    public function getTitle() {
-        return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
-    }
+	/**
+	 * {@inhericDoc}
+	 */
+	public function getTitle() {
+		return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
+	}
     
-    /**
-     * {@inhericDoc}
-     */
-    public function getDescription() {
-        return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
-    }
+	/**
+	 * {@inhericDoc}
+	 */
+	public function getDescription() {
+		return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
+	}
     
-    /**
-     * {@inhericDoc}
-     */
-    public function modAction($mod_action) {
-        \MyArtJaub\Webtrees\Mvc\Dispatcher::getInstance()->handle($this, $mod_action);
-    }
+	/**
+	 * {@inhericDoc}
+	 */
+	public function modAction($mod_action) {
+		\MyArtJaub\Webtrees\Mvc\Dispatcher::getInstance()->handle($this, $mod_action);
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink() {
-        return 'module.php?mod=' . $this->getName() . '&mod_action=AdminConfig';
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink() {
+		return 'module.php?mod=' . $this->getName() . '&mod_action=AdminConfig';
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookSubscriberInterface::getSubscribedHooks()
-     */
-    public function getSubscribedHooks() {
-        return array(
-            'hFactSourcePrepend' => 50,
-            'hGetExpectedTags' => 50,
-            'hHtmlSimpleTagDisplay#_ACT' => 50,
-            'hHtmlSimpleTagEditor#_ACT'	=> 50,
-            'hAddSimpleTag#SOUR'	=> 50,
-            'hHasHelpTextTag#_ACT'	=> 50,
-            'hGetHelpTextTag#_ACT'	=> 50
-        );
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookSubscriberInterface::getSubscribedHooks()
+	 */
+	public function getSubscribedHooks() {
+		return array(
+			'hFactSourcePrepend' => 50,
+			'hGetExpectedTags' => 50,
+			'hHtmlSimpleTagDisplay#_ACT' => 50,
+			'hHtmlSimpleTagEditor#_ACT'	=> 50,
+			'hAddSimpleTag#SOUR'	=> 50,
+			'hHasHelpTextTag#_ACT'	=> 50,
+			'hGetHelpTextTag#_ACT'	=> 50
+		);
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMenuItemInterface::getMenu()
-     */
-    public function getMenu(Tree $tree, $reference = null) {
-        $tree_url = $tree ? $tree->getNameUrl() : '';
-        return new Menu($this->getTitle(), 'module.php?mod=' . $this->getName() . '&mod_action=Certificate@listAll&ged=' . $tree_url, 'menu-maj-list-certificate', array('rel' => 'nofollow'));
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMenuItemInterface::getMenu()
+	 */
+	public function getMenu(Tree $tree, $reference = null) {
+		$tree_url = $tree ? $tree->getNameUrl() : '';
+		return new Menu($this->getTitle(), 'module.php?mod=' . $this->getName() . '&mod_action=Certificate@listAll&ged=' . $tree_url, 'menu-maj-list-certificate', array('rel' => 'nofollow'));
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\FactSourceTextExtenderInterface::hFactSourcePrepend()
-     */
-    public function hFactSourcePrepend($srec) {
-        $wt_tree = Globals::getTree();
-        $html='';
-        $sid=null;
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\FactSourceTextExtenderInterface::hFactSourcePrepend()
+	 */
+	public function hFactSourcePrepend($srec) {
+		$wt_tree = Globals::getTree();
+		$html='';
+		$sid=null;
         
-        if($this->getSetting('MAJ_SHOW_CERT', Auth::PRIV_HIDE) >= Auth::accessLevel($wt_tree)){
-            if (!$srec || strlen($srec) == 0) return $html;
+		if($this->getSetting('MAJ_SHOW_CERT', Auth::PRIV_HIDE) >= Auth::accessLevel($wt_tree)){
+			if (!$srec || strlen($srec) == 0) return $html;
             	
-            $certificate = null;
-            $subrecords = explode("\n", $srec);
-            $levelSOUR = substr($subrecords[0], 0, 1);
-            $match = null;
-            if (preg_match('~^'.$levelSOUR.' SOUR @('.WT_REGEX_XREF.')@$~', $subrecords[0], $match)) {
-                $sid=$match[1];
-            };
-            $nb_subrecords = count($subrecords);
-            for ($i=0; $i < $nb_subrecords; $i++) {
-                $subrecords[$i] = trim($subrecords[$i]);
-                $tag = substr($subrecords[$i], 2, 4);
-                $text = substr($subrecords[$i], 7);
-                if($tag == '_ACT') $certificate= new Certificate($text, $wt_tree, $this->getProvider());
-            }
+			$certificate = null;
+			$subrecords = explode("\n", $srec);
+			$levelSOUR = substr($subrecords[0], 0, 1);
+			$match = null;
+			if (preg_match('~^'.$levelSOUR.' SOUR @('.WT_REGEX_XREF.')@$~', $subrecords[0], $match)) {
+				$sid=$match[1];
+			};
+			$nb_subrecords = count($subrecords);
+			for ($i=0; $i < $nb_subrecords; $i++) {
+				$subrecords[$i] = trim($subrecords[$i]);
+				$tag = substr($subrecords[$i], 2, 4);
+				$text = substr($subrecords[$i], 7);
+				if($tag == '_ACT') $certificate= new Certificate($text, $wt_tree, $this->getProvider());
+			}
             	
-            if($certificate && $certificate->canShow())
-                $html = $this->getDisplay_ACT($certificate, $sid);
+			if($certificate && $certificate->canShow())
+				$html = $this->getDisplay_ACT($certificate, $sid);
                 	
-        }
-        return $html;
-    }
+		}
+		return $html;
+	}
    
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\FactSourceTextExtenderInterface::hFactSourceAppend()
-     */
-    public function hFactSourceAppend($srec) { }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\FactSourceTextExtenderInterface::hFactSourceAppend()
+	 */
+	public function hFactSourceAppend($srec) { }
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hGetExpectedTags()
-     */
-    public function hGetExpectedTags() {
-        return array('SOUR' => '_ACT');
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hGetExpectedTags()
+	 */
+	public function hGetExpectedTags() {
+		return array('SOUR' => '_ACT');
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHtmlSimpleTagDisplay()
-     */
-    public function hHtmlSimpleTagDisplay($tag, $value, $context = null, $contextid = null) {
-        $html = '';
-        switch($tag){
-            case '_ACT':
-                if($context == 'SOUR') $html = $this->getDisplay_ACT($value, $contextid);
-                break;
-        }
-        return $html;
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHtmlSimpleTagDisplay()
+	 */
+	public function hHtmlSimpleTagDisplay($tag, $value, $context = null, $contextid = null) {
+		$html = '';
+		switch($tag){
+			case '_ACT':
+				if($context == 'SOUR') $html = $this->getDisplay_ACT($value, $contextid);
+				break;
+		}
+		return $html;
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHtmlSimpleTagEditor()
-     */
-    public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null) {        
-        $html = '';
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHtmlSimpleTagEditor()
+	 */
+	public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null) {        
+		$html = '';
 		
 		switch($tag){
 			case '_ACT':
@@ -192,75 +192,75 @@ 
 		}
 		
 		return $html;
-    }
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hAddSimpleTag()
-     */
-    public function hAddSimpleTag($context, $level) {
-        switch($context){
-            case 'SOUR':
-                FunctionsEdit::addSimpleTag($level.' _ACT');
-                break;
-        }
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hAddSimpleTag()
+	 */
+	public function hAddSimpleTag($context, $level) {
+		switch($context){
+			case 'SOUR':
+				FunctionsEdit::addSimpleTag($level.' _ACT');
+				break;
+		}
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHasHelpTextTag()
-     */
-    public function hHasHelpTextTag($tag) {
-        switch($tag){
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHasHelpTextTag()
+	 */
+	public function hHasHelpTextTag($tag) {
+		switch($tag){
 			case '_ACT':
 				return true;
 		}
 		return false;
-    }
+	}
     
-    /**
-     * {@inhericDoc}
-     * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hGetHelpTextTag()
-     */
-    public function hGetHelpTextTag($tag) {
-        switch($tag){
-            case '_ACT':
-                return array(
-                I18N::translate('Certificate'),
-                '<p>'.I18N::translate('Path to a certificate linked to a source reference.').'</p>');
-            default:
-                return null;
-        }
-    }
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hGetHelpTextTag()
+	 */
+	public function hGetHelpTextTag($tag) {
+		switch($tag){
+			case '_ACT':
+				return array(
+				I18N::translate('Certificate'),
+				'<p>'.I18N::translate('Path to a certificate linked to a source reference.').'</p>');
+			default:
+				return null;
+		}
+	}
 
-    /**
-     * Returns the default Certificate File Provider, as configured in the module
-     *
-     * @return \MyArtJaub\Webtrees\Module\Certificates\Model\CertificateProviderInterface
-     */
-    public function getProvider() {
-        if(!$this->provider) {
-            $root_path = $this->getSetting('MAJ_CERT_ROOTDIR', 'certificates/');
-            $this->provider = new CertificateFileProvider($root_path, Globals::getTree());
-        }
-        return $this->provider;
-    }
+	/**
+	 * Returns the default Certificate File Provider, as configured in the module
+	 *
+	 * @return \MyArtJaub\Webtrees\Module\Certificates\Model\CertificateProviderInterface
+	 */
+	public function getProvider() {
+		if(!$this->provider) {
+			$root_path = $this->getSetting('MAJ_CERT_ROOTDIR', 'certificates/');
+			$this->provider = new CertificateFileProvider($root_path, Globals::getTree());
+		}
+		return $this->provider;
+	}
     
     
-    /**
-     * Return the HTML code for custom simple tag _ACT
-     *
-     * @param Certificate $certificatePath Certificate (as per the GEDCOM)
-     * @param string|null $sid Linked Source ID, if it exists
-     */
-    protected function getDisplay_ACT(Certificate $certificate, $sid = null){    
-        $html = '';
-        if($certificate){
-            $certificate->setSource($sid);
-            $html = $certificate->displayImage('icon');
-        }
-        return $html;
-    }
+	/**
+	 * Return the HTML code for custom simple tag _ACT
+	 *
+	 * @param Certificate $certificatePath Certificate (as per the GEDCOM)
+	 * @param string|null $sid Linked Source ID, if it exists
+	 */
+	protected function getDisplay_ACT(Certificate $certificate, $sid = null){    
+		$html = '';
+		if($certificate){
+			$certificate->setSource($sid);
+			$html = $certificate->displayImage('icon');
+		}
+		return $html;
+	}
 
 
 }

src/Webtrees/Module/PatronymicLineage/LineageController.php

Indentation +138 added lines, -138 removed lines

@@ -27,162 +27,162 @@
 class LineageController extends MvcController
 {   
     
-    /**
-     * Generate the patronymic lineage for this surname
-     * @var string $surname Reference surname
-     */
-    private $surname;   
+	/**
+	 * Generate the patronymic lineage for this surname
+	 * @var string $surname Reference surname
+	 */
+	private $surname;   
     
-    /**
-     * Initial letter
-     * @var string $alpha
-     */
-    private $alpha;
+	/**
+	 * Initial letter
+	 * @var string $alpha
+	 */
+	private $alpha;
     
-    /**
-     * Show all names (values: yes|no)
-     * @var bool $show
-     */
-    private $show_all;
+	/**
+	 * Show all names (values: yes|no)
+	 * @var bool $show
+	 */
+	private $show_all;
     
-    /**
-     * Page to display (values: surn|lineage)
-     * @var unknown $show
-     */
-    private $show;
+	/**
+	 * Page to display (values: surn|lineage)
+	 * @var unknown $show
+	 */
+	private $show;
     
-    /**
-     * Page title
-     * @var string $legend
-     */
-    private $legend;
+	/**
+	 * Page title
+	 * @var string $legend
+	 */
+	private $legend;
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Mvc\Controller\MvcController::__construct(AbstractModule $module)
-     */
-    public function __construct(AbstractModule $module) {        
-        parent::__construct($module);
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Mvc\Controller\MvcController::__construct(AbstractModule $module)
+	 */
+	public function __construct(AbstractModule $module) {        
+		parent::__construct($module);
         
-        $this->surname     = Filter::get('surname');
-        $this->alpha       = Filter::get('alpha'); // All surnames beginning with this letter where "@"=unknown and ","=none
-        $this->show_all    = Filter::get('show_all', 'no|yes', 'no'); // All indis
-        // Make sure selections are consistent.
-        // i.e. can’t specify show_all and surname at the same time.
-        if ($this->show_all === 'yes') {
-            $this->alpha   = '';
-            $this->surname = '';
-            $this->legend  = I18N::translate('All');
-            $this->show    = Filter::get('show', 'surn|lineage', 'surn');
-        } elseif ($this->surname) {
-            $this->alpha    = QueryName::initialLetter($this->surname); // so we can highlight the initial letter
-            $this->show_all = 'no';
-            if ($this->surname === '@N.N.') {
-                $this->legend = I18N::translateContext('Unknown surname', '…');
-            } else {
-                $this->legend = Filter::escapeHtml($this->surname);
-                // The surname parameter is a root/canonical form.
-                // Display it as the actual surname
-                foreach (QueryName::surnames(Globals::getTree(), $this->surname, $this->alpha, false, false) as $details) {
-                    $this->legend = implode('/', array_keys($details));
-                }                
-            }
-            $this->show = 'lineage'; // SURN list makes no sense here
-        } elseif ($this->alpha === '@') {
-            $this->show_all = 'no';
-            $this->legend   = I18N::translateContext('Unknown surname', '…');
-            $this->show     = 'lineage'; // SURN list makes no sense here
-        } elseif ($this->alpha === ',') {
-            $this->show_all = 'no';
-            $this->legend   = I18N::translate('None');
-            $this->show     = 'lineage'; // SURN list makes no sense here
-        } elseif ($this->alpha) {
-            $this->show_all = 'no';
-            $this->legend   = Filter::escapeHtml($this->alpha) . '…';
-            $this->show     = Filter::get('show', 'surn|lineage', 'surn');
-        } else {
-            $this->show_all = 'no';
-            $this->legend   = '…';
-            $this->show     = 'none'; // Don't show lists until something is chosen
-        }
-        $this->legend = '<span dir="auto">' . $this->legend . '</span>';
+		$this->surname     = Filter::get('surname');
+		$this->alpha       = Filter::get('alpha'); // All surnames beginning with this letter where "@"=unknown and ","=none
+		$this->show_all    = Filter::get('show_all', 'no|yes', 'no'); // All indis
+		// Make sure selections are consistent.
+		// i.e. can’t specify show_all and surname at the same time.
+		if ($this->show_all === 'yes') {
+			$this->alpha   = '';
+			$this->surname = '';
+			$this->legend  = I18N::translate('All');
+			$this->show    = Filter::get('show', 'surn|lineage', 'surn');
+		} elseif ($this->surname) {
+			$this->alpha    = QueryName::initialLetter($this->surname); // so we can highlight the initial letter
+			$this->show_all = 'no';
+			if ($this->surname === '@N.N.') {
+				$this->legend = I18N::translateContext('Unknown surname', '…');
+			} else {
+				$this->legend = Filter::escapeHtml($this->surname);
+				// The surname parameter is a root/canonical form.
+				// Display it as the actual surname
+				foreach (QueryName::surnames(Globals::getTree(), $this->surname, $this->alpha, false, false) as $details) {
+					$this->legend = implode('/', array_keys($details));
+				}                
+			}
+			$this->show = 'lineage'; // SURN list makes no sense here
+		} elseif ($this->alpha === '@') {
+			$this->show_all = 'no';
+			$this->legend   = I18N::translateContext('Unknown surname', '…');
+			$this->show     = 'lineage'; // SURN list makes no sense here
+		} elseif ($this->alpha === ',') {
+			$this->show_all = 'no';
+			$this->legend   = I18N::translate('None');
+			$this->show     = 'lineage'; // SURN list makes no sense here
+		} elseif ($this->alpha) {
+			$this->show_all = 'no';
+			$this->legend   = Filter::escapeHtml($this->alpha) . '…';
+			$this->show     = Filter::get('show', 'surn|lineage', 'surn');
+		} else {
+			$this->show_all = 'no';
+			$this->legend   = '…';
+			$this->show     = 'none'; // Don't show lists until something is chosen
+		}
+		$this->legend = '<span dir="auto">' . $this->legend . '</span>';
           
-    }
+	}
     
-    /**
-     * Indicates whether the list of surname should be displayed
-     * @return bool
-     */
-    protected function isShowingSurnames() {
-        return $this->show === 'surn';
-    }
+	/**
+	 * Indicates whether the list of surname should be displayed
+	 * @return bool
+	 */
+	protected function isShowingSurnames() {
+		return $this->show === 'surn';
+	}
     
-    /**
-     * Indicates whether the lineages should be displayed
-     * @return bool
-     */
-    protected function isShowingLineages() {
-        return $this->show === 'lineage';
-    } 
+	/**
+	 * Indicates whether the lineages should be displayed
+	 * @return bool
+	 */
+	protected function isShowingLineages() {
+		return $this->show === 'lineage';
+	} 
     
-    /**
-     * Get list of surnames, starting with the specified initial
-     * @return array
-     */
-    protected function getSurnamesList() {        
-        return QueryName::surnames(Globals::getTree(), $this->surname, $this->alpha, false, false);
-    }
+	/**
+	 * Get list of surnames, starting with the specified initial
+	 * @return array
+	 */
+	protected function getSurnamesList() {        
+		return QueryName::surnames(Globals::getTree(), $this->surname, $this->alpha, false, false);
+	}
     
-    /**
-     * Get the lineages for the controller's specified surname
-     */
-    protected function getLineages() {		
-        $builder = new LineageBuilder($this->surname, Globals::getTree());
+	/**
+	 * Get the lineages for the controller's specified surname
+	 */
+	protected function getLineages() {		
+		$builder = new LineageBuilder($this->surname, Globals::getTree());
 		$lineages = $builder->buildLineages();
 		
-    	return $lineages;
-    }    
+		return $lineages;
+	}    
     
-    /**
-     * Pages
-     */
+	/**
+	 * Pages
+	 */
     
-    /**
-     * Lineage@index
-     */
-    public function index() {
-        $controller = new PageController();
-        $controller->setPageTitle(
-            $this->show === 'none' ?
-            I18N::translate('Patronymic Lineages') :
-            I18N::translate('Patronymic Lineages') . ' : ' . $this->legend
-        );
+	/**
+	 * Lineage@index
+	 */
+	public function index() {
+		$controller = new PageController();
+		$controller->setPageTitle(
+			$this->show === 'none' ?
+			I18N::translate('Patronymic Lineages') :
+			I18N::translate('Patronymic Lineages') . ' : ' . $this->legend
+		);
         
-        $view_bag = new ViewBag();
-        $view_bag->set('title', $controller->getPageTitle());
-        $view_bag->set('tree', Globals::getTree());
-        $view_bag->set('alpha', $this->alpha);
-        $view_bag->set('surname', $this->surname);
-        $view_bag->set('legend', $this->legend);
-        $view_bag->set('show_all', $this->show_all);
-        if($this->isShowingSurnames()) {
-            $view_bag->set('issurnames', true);
-            $view_bag->set('surnameslist', $this->getSurnamesList());
-        }
-        if($this->isShowingLineages()) {
-            $view_bag->set('islineages', true);
-            $view_bag->set('lineages', $this->getLineages());
+		$view_bag = new ViewBag();
+		$view_bag->set('title', $controller->getPageTitle());
+		$view_bag->set('tree', Globals::getTree());
+		$view_bag->set('alpha', $this->alpha);
+		$view_bag->set('surname', $this->surname);
+		$view_bag->set('legend', $this->legend);
+		$view_bag->set('show_all', $this->show_all);
+		if($this->isShowingSurnames()) {
+			$view_bag->set('issurnames', true);
+			$view_bag->set('surnameslist', $this->getSurnamesList());
+		}
+		if($this->isShowingLineages()) {
+			$view_bag->set('islineages', true);
+			$view_bag->set('lineages', $this->getLineages());
 
-            if ($this->show_all==='no') {
-            	$view_bag->set('table_title', I18N::translate('Individuals in %s lineages', $this->legend));
-            }
-            else {
-            	$view_bag->set('table_title', I18N::translate('All lineages'));
-            }
-        }
+			if ($this->show_all==='no') {
+				$view_bag->set('table_title', I18N::translate('Individuals in %s lineages', $this->legend));
+			}
+			else {
+				$view_bag->set('table_title', I18N::translate('All lineages'));
+			}
+		}
         
-        ViewFactory::make('Lineage', $this, $controller, $view_bag)->render();   
-    }
+		ViewFactory::make('Lineage', $this, $controller, $view_bag)->render();   
+	}