jon48 / webtrees-lib

src/Webtrees/Family.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +4 added lines, -4 removed lines

@@ -39,10 +39,10 @@
 	}
 	
 	/**
-	* Check if this family's marriages are sourced
-	*
-	* @return int Level of sources
-	* */
+	 * Check if this family's marriages are sourced
+	 *
+	 * @return int Level of sources
+	 * */
 	function isMarriageSourced(){
 		if($this->_ismarriagesourced != null) return $this->_ismarriagesourced;
 		$this->_ismarriagesourced = $this->isFactSourced(WT_EVENTS_MARR.'|MARC');

src/Webtrees/Functions/FunctionsPrint.php

Doc Comments +1 added lines, -3 removed lines

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

Indentation +2 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
 	 * @return string HTML code of the inserted flag
 	 */
 	public static function htmlPlaceIcon(\Fisharebest\Webtrees\Place $place, $icon_path , $size = 50) {
-	    return '<img class="flag_gm_h'. $size . '" src="' . $icon_path . '" title="' . $place->getGedcomName() . '" alt="' . $place->getGedcomName() . '" />';
+		return '<img class="flag_gm_h'. $size . '" src="' . $icon_path . '" title="' . $place->getGedcomName() . '" alt="' . $place->getGedcomName() . '" />';
 	}
 	
 	/**
@@ -355,7 +355,7 @@ 
 	 * @return boolean
 	 */
 	public static function isDateWithinChartsRange(Date $date) {
-	    return $date->gregorianYear() >= 1550 && $date->gregorianYear() < 2030;
+		return $date->gregorianYear() >= 1550 && $date->gregorianYear() < 2030;
 	}
 
 }

src/Webtrees/Individual.php

Doc Comments +1 added lines, -2 removed lines

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

Indentation +29 added lines, -29 removed lines

@@ -113,29 +113,29 @@ 
 	 * @return string|array Estimated birth place if found, null otherwise
 	 */
 	public function getSignificantPlace(){
-	    if($bplace = $this->gedcomrecord->getBirthPlace()){
-	        return $bplace;
-	    }
+		if($bplace = $this->gedcomrecord->getBirthPlace()){
+			return $bplace;
+		}
 	
-	    foreach ($this->gedcomrecord->getAllEventPlaces('RESI') as $rplace) {
-	        if ($rplace) {
-	            return $rplace;
-	        }
-	    }
+		foreach ($this->gedcomrecord->getAllEventPlaces('RESI') as $rplace) {
+			if ($rplace) {
+				return $rplace;
+			}
+		}
 	
-	    if($dplace = $this->gedcomrecord->getDeathPlace()){
-	        return $dplace;
-	    }
+		if($dplace = $this->gedcomrecord->getDeathPlace()){
+			return $dplace;
+		}
 	
-	    foreach($this->gedcomrecord->getSpouseFamilies() as $fams) {
-	        foreach ($fams->getAllEventPlaces('RESI') as $rplace) {
-	            if ($rplace) {
-	                return $rplace;
-	            }
-	        }
-	    }
+		foreach($this->gedcomrecord->getSpouseFamilies() as $fams) {
+			foreach ($fams->getAllEventPlaces('RESI') as $rplace) {
+				if ($rplace) {
+					return $rplace;
+				}
+			}
+		}
 	
-	    return null;
+		return null;
 	}
 	
 	/**
@@ -144,7 +144,7 @@ 
 	 * @return boolean Is the individual a Sosa ancestor
 	 */
 	public function isSosa(){
-	    return count($this->getSosaNumbers()) > 0;
+		return count($this->getSosaNumbers()) > 0;
 	}
 	
 	/**
@@ -155,11 +155,11 @@ 
 	 * @return array List of Sosa numbers
 	 */
 	public function getSosaNumbers(){
-	    if($this->sosa === null) {
-	        $provider = new SosaProvider($this->gedcomrecord->getTree());
-	        $this->sosa = $provider->getSosaNumbers($this->gedcomrecord);	        
-	    }
-	    return $this->sosa;
+		if($this->sosa === null) {
+			$provider = new SosaProvider($this->gedcomrecord->getTree());
+			$this->sosa = $provider->getSosaNumbers($this->gedcomrecord);	        
+		}
+		return $this->sosa;
 	}
 		
 	/** 
@@ -174,10 +174,10 @@ 
 	}
 	
 	/**
-	* Check if this individual's death is sourced
-	*
-	* @return int Level of sources
-	* */
+	 * Check if this individual's death is sourced
+	 *
+	 * @return int Level of sources
+	 * */
 	public function isDeathSourced(){
 		if($this->is_death_sourced !== null) return $this->is_death_sourced;
 		$this->is_death_sourced = $this->isFactSourced(WT_EVENTS_DEAT);

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

Doc Comments +1 added lines, -1 removed lines

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

Indentation +194 added lines, -194 removed lines

@@ -20,253 +20,253 @@
  */
 abstract class AbstractTask {
     
-    /**
-     * Time out for runnign tasks, in seconds. Default 5 min
-     * @var int TASK_TIME_OUT
-     */
-    const TASK_TIME_OUT = 300;
+	/**
+	 * Time out for runnign tasks, in seconds. Default 5 min
+	 * @var int TASK_TIME_OUT
+	 */
+	const TASK_TIME_OUT = 300;
               
-    /**
-     * Task provider
-     * @var TaskProviderInterface $provider
-     */
+	/**
+	 * Task provider
+	 * @var TaskProviderInterface $provider
+	 */
 	protected $provider;
 			
 	/**
 	 * Task name
 	 * @var string $name
 	 */
-    protected $name;
+	protected $name;
     
-    /**
-     * Status of the task
-     * @var bool $is_enabled
-     */
-    protected $is_enabled;
+	/**
+	 * Status of the task
+	 * @var bool $is_enabled
+	 */
+	protected $is_enabled;
     
-    /**
-     * Last updated date
-     * @var \DateTime $last_updated
-     */
-    protected $last_updated;
+	/**
+	 * Last updated date
+	 * @var \DateTime $last_updated
+	 */
+	protected $last_updated;
     
-    /**
-     * Last run result
-     * @var bool $last_result
-     */
-    protected $last_result;
+	/**
+	 * Last run result
+	 * @var bool $last_result
+	 */
+	protected $last_result;
     
-    /**
-     * Task run frequency
-     * @var int $frequency
-     */
-    protected $frequency;
+	/**
+	 * Task run frequency
+	 * @var int $frequency
+	 */
+	protected $frequency;
     
-    /**
-     * Task remaining runs
-     * @var int $nb_occurrences
-     */
-    protected $nb_occurrences;
+	/**
+	 * Task remaining runs
+	 * @var int $nb_occurrences
+	 */
+	protected $nb_occurrences;
     
-    /**
-     * Current running status of the task
-     * @var bool $is_running
-     */
-    protected $is_running;
+	/**
+	 * Current running status of the task
+	 * @var bool $is_running
+	 */
+	protected $is_running;
     
-    /**
-     * Constructor for the Admin task class
+	/**
+	 * Constructor for the Admin task class
 	 *
 	 * @param string $file Filename containing the task object
 	 * @param TaskProviderInterface $provider Provider for tasks
-     */
-    public function __construct($file, TaskProviderInterface $provider = null){
-        $this->name = trim(basename($file, '.php'));
+	 */
+	public function __construct($file, TaskProviderInterface $provider = null){
+		$this->name = trim(basename($file, '.php'));
 		$this->provider = $provider;
-    }
+	}
     
-    /**
-     * Get the provider.
-     *
-     * @return TaskProviderInterface 
-     */
-    public function getProvider(){
-        return $this->provider;
-    }
+	/**
+	 * Get the provider.
+	 *
+	 * @return TaskProviderInterface 
+	 */
+	public function getProvider(){
+		return $this->provider;
+	}
     
-    /**
-     * Set the provider.
-     *
-     * @param TaskProviderInterface $provider
-     * @return self Enable method-chaining
-     */
-    public function setProvider(TaskProviderInterface $provider){
-        $this->provider = $provider;
-        return $this;
-    }
+	/**
+	 * Set the provider.
+	 *
+	 * @param TaskProviderInterface $provider
+	 * @return self Enable method-chaining
+	 */
+	public function setProvider(TaskProviderInterface $provider){
+		$this->provider = $provider;
+		return $this;
+	}
     
-    /**
-     * Set parameters of the Task
-     *
-     * @param bool $is_enabled Status of the task
-     * @param \DateTime $lastupdated Time of the last task run
-     * @param bool $last_result Result of the last run, true for success, false for failure
-     * @param int $frequency Frequency of execution in minutes
-     * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited
-     * @param bool $is_running Indicates if the task is currently running
-     */
-    public function setParameters($is_enabled, \DateTime $last_updated, $last_result, $frequency, $nb_occur, $is_running){
-        $this->is_enabled = $is_enabled;
-        $this->last_updated = $last_updated;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occur;
-        $this->is_running = $is_running;
-    }
+	/**
+	 * Set parameters of the Task
+	 *
+	 * @param bool $is_enabled Status of the task
+	 * @param \DateTime $lastupdated Time of the last task run
+	 * @param bool $last_result Result of the last run, true for success, false for failure
+	 * @param int $frequency Frequency of execution in minutes
+	 * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited
+	 * @param bool $is_running Indicates if the task is currently running
+	 */
+	public function setParameters($is_enabled, \DateTime $last_updated, $last_result, $frequency, $nb_occur, $is_running){
+		$this->is_enabled = $is_enabled;
+		$this->last_updated = $last_updated;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occur;
+		$this->is_running = $is_running;
+	}
     
-    /**
-     * Get the name of the task
-     *
-     * @return string
-     */
-    public function getName(){
-        return $this->name;
-    }
+	/**
+	 * Get the name of the task
+	 *
+	 * @return string
+	 */
+	public function getName(){
+		return $this->name;
+	}
     
     
-    /**
-     * Return the status of the task in a boolean way
-     *
-     * @return boolean True if enabled
-     */
-    public function isEnabled(){
-        return $this->is_enabled;
-    }
+	/**
+	 * Return the status of the task in a boolean way
+	 *
+	 * @return boolean True if enabled
+	 */
+	public function isEnabled(){
+		return $this->is_enabled;
+	}
     
-    /**
-     * Get the last updated time.
-     *
-     * @return \DateTime
-     */
-    public function getLastUpdated(){
-        return $this->last_updated;
-    }
+	/**
+	 * Get the last updated time.
+	 *
+	 * @return \DateTime
+	 */
+	public function getLastUpdated(){
+		return $this->last_updated;
+	}
     
-    /**
-     * Check if the last result has been successful.
-     *
-     * @return bool
-     */
-    public function isLastRunSuccess(){
-        return $this->last_result;
-    }
+	/**
+	 * Check if the last result has been successful.
+	 *
+	 * @return bool
+	 */
+	public function isLastRunSuccess(){
+		return $this->last_result;
+	}
     
-    /**
-     * Get the task frequency.
-     *
-     * @return int
-     */
-    public function getFrequency(){
-        return $this->frequency;
-    }
+	/**
+	 * Get the task frequency.
+	 *
+	 * @return int
+	 */
+	public function getFrequency(){
+		return $this->frequency;
+	}
 	
 	/**
-     * Set the task frequency.
-     *
+	 * Set the task frequency.
+	 *
 	 * @param int $frequency
-     * @return self Enable method-chaining
-     */
-    public function setFrequency($frequency){
-        $this->frequency = $frequency;
+	 * @return self Enable method-chaining
+	 */
+	public function setFrequency($frequency){
+		$this->frequency = $frequency;
 		return $this;
-    }
+	}
     
-    /**
-     * Get the number of remaining occurrences.
-     *
-     * @return int
-     */
-    public function getRemainingOccurrences(){
-        return $this->nb_occurrences;
-    }
+	/**
+	 * Get the number of remaining occurrences.
+	 *
+	 * @return int
+	 */
+	public function getRemainingOccurrences(){
+		return $this->nb_occurrences;
+	}
 	
 	/**
-     * Set the number of remaining occurrences.
-     *
+	 * Set the number of remaining occurrences.
+	 *
 	 * @param int $nb_occur
-     * @return self Enable method-chaining
-     */
-    public function setRemainingOccurrences($nb_occur){
-        $this->nb_occurrences = $nb_occur;
+	 * @return self Enable method-chaining
+	 */
+	public function setRemainingOccurrences($nb_occur){
+		$this->nb_occurrences = $nb_occur;
 		return $this;
-    }
+	}
     
-    /**
-     * Check if the task if running.
-     *
-     * @return bool
-     */
-    public function isRunning(){
-        return $this->is_running;
-    }
+	/**
+	 * Check if the task if running.
+	 *
+	 * @return bool
+	 */
+	public function isRunning(){
+		return $this->is_running;
+	}
     
     
-    /**
-     * Return the name to display for the task
-     *
-     * @return string Title for the task
-     */
-    abstract public function getTitle();
+	/**
+	 * Return the name to display for the task
+	 *
+	 * @return string Title for the task
+	 */
+	abstract public function getTitle();
     
-    /**
-     * Return the default frequency for the execution of the task
-     *
-     * @return int Frequency for the execution of the task
-     */
-    abstract public function getDefaultFrequency();
+	/**
+	 * Return the default frequency for the execution of the task
+	 *
+	 * @return int Frequency for the execution of the task
+	 */
+	abstract public function getDefaultFrequency();
     
-    /**
-     * Execute the task's actions
-     */
-    abstract protected function executeSteps();
+	/**
+	 * Execute the task's actions
+	 */
+	abstract protected function executeSteps();
     
 	/**
 	 * Persist task state into database.
 	 * @return bool
 	 */
 	public function save() {
-	    if(!$this->provider) throw new \Exception('The task has not been initialised with a provider.');
+		if(!$this->provider) throw new \Exception('The task has not been initialised with a provider.');
 		return $this->provider->updateTask($this);
 	}
 	
-    /**
-     * Execute the task, default skeleton
-     *
-     */
-    public function execute(){
+	/**
+	 * Execute the task, default skeleton
+	 *
+	 */
+	public function execute(){
     
-        if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
-            $this->is_running = false;
+		if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
+			$this->is_running = false;
     
-        if(!$this->is_running){
-            $this->last_result = false;
-            $this->is_running = true;
-            $this->save();
+		if(!$this->is_running){
+			$this->last_result = false;
+			$this->is_running = true;
+			$this->save();
     
-            Log::addDebugLog('Start execution of Admin task: '.$this->getTitle());
-            $this->last_result = $this->executeSteps();
-            if($this->last_result){
-                $this->last_updated = new \DateTime();
-                if($this->nb_occurrences > 0){
-                    $this->nb_occurrences--;
-                    if($this->nb_occurrences == 0) $this->is_enabled = false;
-                }
-            }
-            $this->is_running = false;
-            $this->save();
-            Log::addDebugLog('Execution completed for Admin task: '.$this->getTitle().' - '.($this->last_result ? 'Success' : 'Failure'));
-        }
-    }
+			Log::addDebugLog('Start execution of Admin task: '.$this->getTitle());
+			$this->last_result = $this->executeSteps();
+			if($this->last_result){
+				$this->last_updated = new \DateTime();
+				if($this->nb_occurrences > 0){
+					$this->nb_occurrences--;
+					if($this->nb_occurrences == 0) $this->is_enabled = false;
+				}
+			}
+			$this->is_running = false;
+			$this->save();
+			Log::addDebugLog('Execution completed for Admin task: '.$this->getTitle().' - '.($this->last_result ? 'Success' : 'Failure'));
+		}
+	}
     
     
 }

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

Doc Comments +3 added lines, -2 removed lines

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

Indentation +36 added lines, -36 removed lines

@@ -37,47 +37,47 @@
 	 */
 	public function setTaskStatus(AbstractTask $task, $status);
 		
-    /**
-     * Update an Admin Task in the database.
-     * 
-     * @param AbstractTask $task Task to update
-     * @return bool
-     */
-    function updateTask(AbstractTask $task);    
+	/**
+	 * Update an Admin Task in the database.
+	 * 
+	 * @param AbstractTask $task Task to update
+	 * @return bool
+	 */
+	function updateTask(AbstractTask $task);    
     
-    /**
-     * Delete the task from the database, in a transactional manner.
-     *
-     * @param string $task_name Task to delete
-     */
-    public function deleteTask($task_name);
+	/**
+	 * Delete the task from the database, in a transactional manner.
+	 *
+	 * @param string $task_name Task to delete
+	 */
+	public function deleteTask($task_name);
     
 
-    /**
-     * Returns the number of Admin Tasks (active and inactive).
-     *
-     * @return int
-     */
-    public function getTasksCount();
+	/**
+	 * Returns the number of Admin Tasks (active and inactive).
+	 *
+	 * @return int
+	 */
+	public function getTasksCount();
     
-    /**
-     * Return the list of Admin Tasks 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[]
-     */
-    function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null);
+	/**
+	 * Return the list of Admin Tasks 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[]
+	 */
+	function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null);
     
-    /**
-     * Returns the list of tasks that are currently meant to run.
-     * Tasks to run can be forced, or can be limited to only one.
-     * 
-     * @param string|null $force Force the enabled tasks to run.
-     * @param string|null $task_name Name of the specific task to run
-     */
+	/**
+	 * Returns the list of tasks that are currently meant to run.
+	 * Tasks to run can be forced, or can be limited to only one.
+	 * 
+	 * @param string|null $force Force the enabled tasks to run.
+	 * @param string|null $task_name Name of the specific task to run
+	 */
 	function getTasksToRun($force = false, $task_name = null);
 		
 	/**

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

Doc Comments +2 added lines, -1 removed lines

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

Indentation +41 added lines, -41 removed lines

@@ -35,12 +35,12 @@ 
  */
 class Certificate extends Media {
     
-    const URL_PREFIX  = 'module.php?mod=myartjaub_certificates&mod_action=Certificate&cid=';
+	const URL_PREFIX  = 'module.php?mod=myartjaub_certificates&mod_action=Certificate&cid=';
 		
-    /** @var string The "TITL" value from the GEDCOM 
-     * This is a tweak to overcome the private level from the parent object...
-     */
-    protected $title = '';
+	/** @var string The "TITL" value from the GEDCOM 
+	 * This is a tweak to overcome the private level from the parent object...
+	 */
+	protected $title = '';
     
 	/**
 	 * Certificate provider
@@ -80,7 +80,7 @@ 
 	 * @param CertificateProviderInterface $provider
 	 */
 	public function __construct($data, Tree $tree, CertificateProviderInterface $provider) {
-	    $this->provider = $provider;
+		$this->provider = $provider;
 		// Data is only the file name
 		$data = str_replace("\\", '/', $data);
 		$xref = Functions::encryptToSafeBase64($data);
@@ -165,7 +165,7 @@ 
 	 * @see \Fisharebest\Webtrees\Media::getTitle()
 	 */
 	public function getTitle() {
-	    return $this->title;
+		return $this->title;
 	}
 	
 	/**
@@ -241,26 +241,26 @@ 
 	 	$module = Module::getModuleByName(Constants::MODULE_MAJ_CERTIF_NAME);
 	 	
 	 	if($module) {
-    		$wmtext = $module->getSetting('MAJ_WM_DEFAULT', I18N::translate('This image is protected under copyright law.'));
-    		$sid= Filter::get('sid', WT_REGEX_XREF);	
+			$wmtext = $module->getSetting('MAJ_WM_DEFAULT', I18N::translate('This image is protected under copyright law.'));
+			$sid= Filter::get('sid', WT_REGEX_XREF);	
     	
-    		if($sid){
-    			$this->source = Source::getInstance($sid, $this->tree);
-    		}
-    		else{
-    			$this->fetchALinkedSource();  // the method already attach the source to the Certificate object;
-    		}
+			if($sid){
+				$this->source = Source::getInstance($sid, $this->tree);
+			}
+			else{
+				$this->fetchALinkedSource();  // the method already attach the source to the Certificate object;
+			}
     		
-    		if($this->source) {
-    			$wmtext = '©';
-    			$repofact = $this->source->getFirstFact('REPO');
-    			if($repofact) {
-    				$repo = $repofact->getTarget();
-    				if($repo && $repo instanceof Repository)  $wmtext .= ' '.$repo->getFullName().' - ';
-    			}
-    			$wmtext .= $this->source->getFullName();			
-    		}	
-    		return $wmtext;
+			if($this->source) {
+				$wmtext = '©';
+				$repofact = $this->source->getFirstFact('REPO');
+				if($repofact) {
+					$repo = $repofact->getTarget();
+					if($repo && $repo instanceof Repository)  $wmtext .= ' '.$repo->getFullName().' - ';
+				}
+				$wmtext .= $this->source->getFullName();			
+			}	
+			return $wmtext;
 	 	}
 	 	return '';
 	}
@@ -323,8 +323,8 @@ 
 				' FROM `##individuals`'.
 				' WHERE i_file= :gedcom_id AND i_gedcom LIKE :gedcom')
 		->execute(array(
-		    'gedcom_id' => $this->tree->getTreeId(),
-		    'gedcom' => '%_ACT '.$this->getFilename().'%'		    
+			'gedcom_id' => $this->tree->getTreeId(),
+			'gedcom' => '%_ACT '.$this->getFilename().'%'		    
 		))->fetchAll();
 		
 		$list = array();
@@ -347,8 +347,8 @@ 
 				' FROM `##families`'.
 				' WHERE f_file= :gedcom_id AND f_gedcom LIKE :gedcom')
 		->execute(array(
-		    'gedcom_id' => $this->tree->getTreeId(),
-		    'gedcom' => '%_ACT '.$this->getFilename().'%'		    
+			'gedcom_id' => $this->tree->getTreeId(),
+			'gedcom' => '%_ACT '.$this->getFilename().'%'		    
 		))->fetchAll();
 		
 		$list = array();
@@ -375,25 +375,25 @@ 
 				'SELECT i_gedcom AS gedrec FROM `##individuals`'.
 				' WHERE i_file=:gedcom_id AND i_gedcom LIKE :gedcom')
 		  ->execute(array(
-		      'gedcom_id' => $this->tree->getTreeId(), 
-		      'gedcom' => '%_ACT '.$this->getFilename().'%'		      
+			  'gedcom_id' => $this->tree->getTreeId(), 
+			  'gedcom' => '%_ACT '.$this->getFilename().'%'		      
 		  ))->fetchOne();
 		if(!$ged){
 			$ged = Database::prepare(
 					'SELECT f_gedcom AS gedrec FROM `##families`'.
 					' WHERE f_file=:gedcom_id AND f_gedcom LIKE :gedcom')
-			     ->execute(array(
-			         'gedcom_id' => $this->tree->getTreeId(), 
-			         'gedcom' => '%_ACT '.$this->getFilename().'%'			         
-			     ))->fetchOne();
+				 ->execute(array(
+					 'gedcom_id' => $this->tree->getTreeId(), 
+					 'gedcom' => '%_ACT '.$this->getFilename().'%'			         
+				 ))->fetchOne();
 			if(!$ged){
 				$ged = Database::prepare(
-				    'SELECT o_gedcom AS gedrec FROM `##other`'.
-				    ' WHERE o_file=:gedcom_id AND o_gedcom LIKE :gedcom')
-				    ->execute(array(
-				        'gedcom_id' => $this->tree->getTreeId(),
-				        'gedcom' => '%_ACT '.$this->getFilename().'%'				        
-				    ))->fetchOne();
+					'SELECT o_gedcom AS gedrec FROM `##other`'.
+					' WHERE o_file=:gedcom_id AND o_gedcom LIKE :gedcom')
+					->execute(array(
+						'gedcom_id' => $this->tree->getTreeId(),
+						'gedcom' => '%_ACT '.$this->getFilename().'%'				        
+					))->fetchOne();
 			}
 		}
 		//If a record has been found, parse it to find the source reference.

src/Webtrees/Module/CertificatesModule.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +178 added lines, -178 removed lines

@@ -29,143 +29,143 @@ 
  * 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) {
-        global $WT_TREE;
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\FactSourceTextExtenderInterface::hFactSourcePrepend()
+	 */
+	public function hFactSourcePrepend($srec) {
+		global $WT_TREE;
         
-        $html='';
-        $sid=null;
+		$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) {
-        global $controller, $WT_TREE;
+	/**
+	 * {@inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHtmlSimpleTagEditor()
+	 */
+	public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null) {
+		global $controller, $WT_TREE;
         
-        $html = '';
+		$html = '';
 		
 		switch($tag){
 			case '_ACT':
@@ -193,77 +193,77 @@ 
 		}
 		
 		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() {
-        global $WT_TREE;
+	/**
+	 * Returns the default Certificate File Provider, as configured in the module
+	 *
+	 * @return \MyArtJaub\Webtrees\Module\Certificates\Model\CertificateProviderInterface
+	 */
+	public function getProvider() {
+		global $WT_TREE;
     
-        if(!$this->provider) {
-            $root_path = $this->getSetting('MAJ_CERT_ROOTDIR', 'certificates/');
-            $this->provider = new CertificateFileProvider($root_path, $WT_TREE);
-        }
-        return $this->provider;
-    }
+		if(!$this->provider) {
+			$root_path = $this->getSetting('MAJ_CERT_ROOTDIR', 'certificates/');
+			$this->provider = new CertificateFileProvider($root_path, $WT_TREE);
+		}
+		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;
+	}
 
 }
  
\ No newline at end of file

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

Doc Comments +1 added lines, -1 removed lines

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

Indentation +329 added lines, -329 removed lines

@@ -21,130 +21,130 @@ 
  */
 class GeoAnalysisProvider {
     
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    protected $tree;
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	protected $tree;
     
-    /**
-     * Cached hierarchy of places in the Gedcom file.
-     * 
-     * @var (array|null) $place_hierarchy
-     */
-    protected $place_hierarchy;
+	/**
+	 * Cached hierarchy of places in the Gedcom file.
+	 * 
+	 * @var (array|null) $place_hierarchy
+	 */
+	protected $place_hierarchy;
     
-    /**
-     * Constructor for GeoAnalysis Provider.
-     * A provider is defined in relation to a specific tree.
-     *
-     * @param Tree $tree
-     */
-    public function __construct(Tree $tree) {
-        $this->tree = $tree;
-        $this->place_hierarchy = null;
-    }
+	/**
+	 * Constructor for GeoAnalysis Provider.
+	 * A provider is defined in relation to a specific tree.
+	 *
+	 * @param Tree $tree
+	 */
+	public function __construct(Tree $tree) {
+		$this->tree = $tree;
+		$this->place_hierarchy = null;
+	}
     
-    /**
-     * Creates and returns a GeoAnalysis object from a data row.
-     * The row data is expected to be an array with the indexes:
-     *  - majgd_id: geodispersion analysis ID
-     *  - majgd_descr: geodispersion analysis description/title
-     *  - majgd_sublevel: Analysis level
-     *  - majgd_useflagsgen: Use flags in places display
-     *  - majgd_detailsgen: Number of top places
-     *  - majgd_map: file name of the map
-     *  - majgd_toplevel: parent level for the map
-     * 
-     * @param array $row
-     * @return GeoAnalysis
-     */
-    protected function loadGeoAnalysisFromRow($row) {
-        $options = new GeoDisplayOptions();
-        $options
-        ->setUsingFlags($row['majgd_useflagsgen'] == 'yes')
-        ->setMaxDetailsInGen($row['majgd_detailsgen']);
+	/**
+	 * Creates and returns a GeoAnalysis object from a data row.
+	 * The row data is expected to be an array with the indexes:
+	 *  - majgd_id: geodispersion analysis ID
+	 *  - majgd_descr: geodispersion analysis description/title
+	 *  - majgd_sublevel: Analysis level
+	 *  - majgd_useflagsgen: Use flags in places display
+	 *  - majgd_detailsgen: Number of top places
+	 *  - majgd_map: file name of the map
+	 *  - majgd_toplevel: parent level for the map
+	 * 
+	 * @param array $row
+	 * @return GeoAnalysis
+	 */
+	protected function loadGeoAnalysisFromRow($row) {
+		$options = new GeoDisplayOptions();
+		$options
+		->setUsingFlags($row['majgd_useflagsgen'] == 'yes')
+		->setMaxDetailsInGen($row['majgd_detailsgen']);
         
-        if($row['majgd_map']) {
-            $options
-            ->setMap(new OutlineMap($row['majgd_map']))
-            ->setMapLevel($row['majgd_toplevel']);
-        }
+		if($row['majgd_map']) {
+			$options
+			->setMap(new OutlineMap($row['majgd_map']))
+			->setMapLevel($row['majgd_toplevel']);
+		}
         
-        $enabled = true;
-        if(isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
-            $enabled = false;
-        }
+		$enabled = true;
+		if(isset($row['majgd_status']) && $row['majgd_status'] == 'disabled') {
+			$enabled = false;
+		}
         
-        return new GeoAnalysis(
-            $this->tree,
-            $row['majgd_id'],
-            $row['majgd_descr'],
-            $row['majgd_sublevel'],
-            $options,
-            $enabled
-            );
-    }
+		return new GeoAnalysis(
+			$this->tree,
+			$row['majgd_id'],
+			$row['majgd_descr'],
+			$row['majgd_sublevel'],
+			$options,
+			$enabled
+			);
+	}
     
-    /**
-     * Returns the number of geographical analysis (active and inactive). 
-     * 
-     * @return int
-     */
-    public function getGeoAnalysisCount() {
-        return Database::prepare(
-            'SELECT COUNT(majgd_id)' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id'
-            )->execute(array(
-                'gedcom_id' => $this->tree->getTreeId()
-            ))->fetchOne();
-    }
+	/**
+	 * Returns the number of geographical analysis (active and inactive). 
+	 * 
+	 * @return int
+	 */
+	public function getGeoAnalysisCount() {
+		return Database::prepare(
+			'SELECT COUNT(majgd_id)' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id'
+			)->execute(array(
+				'gedcom_id' => $this->tree->getTreeId()
+			))->fetchOne();
+	}
     
-    /**
-     * Get a geographical analysis by its ID.
-     * The function can only search for only enabled analysis, or all.
-     * 
-     * @param int $id geodispersion analysis ID
-     * @param bool $only_enabled Search for only enabled geodispersion analysis
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis|NULL
-     */
-    public function getGeoAnalysis($id, $only_enabled = true) {
-        $args = array (
-            'gedcom_id' => $this->tree->getTreeId(),
-            'ga_id' => $id
-        );
+	/**
+	 * Get a geographical analysis by its ID.
+	 * The function can only search for only enabled analysis, or all.
+	 * 
+	 * @param int $id geodispersion analysis ID
+	 * @param bool $only_enabled Search for only enabled geodispersion analysis
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis|NULL
+	 */
+	public function getGeoAnalysis($id, $only_enabled = true) {
+		$args = array (
+			'gedcom_id' => $this->tree->getTreeId(),
+			'ga_id' => $id
+		);
         
-        $sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
-            ' FROM `##maj_geodispersion`' .
-            ' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id';
-        if($only_enabled) {
-            $sql .= ' AND majgd_status = :status';
-            $args['status'] = 'enabled';
-        }
-        $sql .= ' ORDER BY majgd_descr';
+		$sql = 'SELECT majgd_id, majgd_descr, majgd_sublevel, majgd_map, majgd_toplevel, majgd_useflagsgen, majgd_detailsgen, majgd_status' .
+			' FROM `##maj_geodispersion`' .
+			' WHERE majgd_file = :gedcom_id AND majgd_id=:ga_id';
+		if($only_enabled) {
+			$sql .= ' AND majgd_status = :status';
+			$args['status'] = 'enabled';
+		}
+		$sql .= ' ORDER BY majgd_descr';
         
-        $ga_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
+		$ga_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
         
-        if($ga_array) {
-            return $this->loadGeoAnalysisFromRow($ga_array);
-        }
+		if($ga_array) {
+			return $this->loadGeoAnalysisFromRow($ga_array);
+		}
         
-        return null;            
-    }
+		return null;            
+	}
     
-    /**
-     * Add a new geodispersion analysis in the database, in a transactional manner.
-     * When successful, eturns the newly created GeoAnalysis object.
-     * 
-     * @param string $description geodispersion analysis title
-     * @param int $analysis_level Analysis level
-     * @param string $map_file Filename of the map
-     * @param int $map_top_level Parent level of the map
-     * @param bool $use_flags Use flag in the place display
-     * @param int $gen_details Number of top places to display
-     * @return GeoAnalysis
-     */
+	/**
+	 * Add a new geodispersion analysis in the database, in a transactional manner.
+	 * When successful, eturns the newly created GeoAnalysis object.
+	 * 
+	 * @param string $description geodispersion analysis title
+	 * @param int $analysis_level Analysis level
+	 * @param string $map_file Filename of the map
+	 * @param int $map_top_level Parent level of the map
+	 * @param bool $use_flags Use flag in the place display
+	 * @param int $gen_details Number of top places to display
+	 * @return GeoAnalysis
+	 */
 	public function createGeoAnalysis($description, $analysis_level, $map_file, $map_top_level, $use_flags, $gen_details) {
 		try{
 			Database::beginTransaction();
@@ -174,17 +174,17 @@ 
 			Log::addErrorLog('A new Geo Analysis failed to be created. Transaction rollbacked. Parameters ['.$description.', '.$analysis_level.','.$map_file.','.$map_top_level.','.$use_flags.', '.$gen_details.']. Exception: '.$ex->getMessage());
 		}
 		return $ga;
-    }
+	}
 	
-    /**
-     * Update a geodispersion analysis in the database, in transactional manner.
-     * When successful, returns the updated GeoAnalysis object
-     *  
-     * @param GeoAnalysis $ga
-     * @return GeoAnalysis
-     */
-    public function updateGeoAnalysis(GeoAnalysis $ga) {
-        try {
+	/**
+	 * Update a geodispersion analysis in the database, in transactional manner.
+	 * When successful, returns the updated GeoAnalysis object
+	 *  
+	 * @param GeoAnalysis $ga
+	 * @return GeoAnalysis
+	 */
+	public function updateGeoAnalysis(GeoAnalysis $ga) {
+		try {
 			Database::beginTransaction();
 		
 			Database::prepare(
@@ -217,238 +217,238 @@ 
 			$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() {
-        $random_place = null;
-        $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() {
+		$random_place = null;
+		$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) {
-            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) {
+			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
-        $places_parts=array();
-        usort($places_list, array('I18N', 'strcasecmp'));
-        $nb_places = count($places_list);
+		//sort the array, limit to unique values, and count them
+		$places_parts=array();
+		usort($places_list, array('I18N', 'strcasecmp'));
+		$nb_places = count($places_list);
         
-        //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(',', $randomPlace)));
-    }
+		return array_reverse(array_map('trim',explode(',', $randomPlace)));
+	}
     
-    /**
-     * 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/PatronymicLineage/Model/LineageNode.php

Doc Comments +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
 	/**
 	 * Constructor for Lineage node
 	 * 
-	 * @param Fisharebest\Webtrees\Individual $node_indi Main individual
+	 * @param Individual $node_indi Main individual
 	 * @param LineageRootNode $root_node Node of the lineage root
 	 * @param unknown $alt_surname Follow-up surname
 	 */
@@ -54,7 +54,7 @@ 
 	/**
 	 * Add a spouse family to the node
 	 * 
-	 * @param Fisharebest\Webtrees\Family $fams
+	 * @param Family $fams
 	 */
 	public function addFamily(Family $fams) {
 		if($fams && !isset($this->linked_fams[$fams])) {
@@ -65,7 +65,7 @@ 
 	/**
 	 * Add a child LineageNode to the node
 	 * 
-	 * @param Fisharebest\Webtrees\Family $fams
+	 * @param Family $fams
 	 * @param LineageNode $child
 	 */
 	public function addChild(Family $fams, LineageNode $child = null) {
@@ -80,7 +80,7 @@ 
 	/**
 	 * Returns the node individual
 	 * 
-	 * @return Fisharebest\Webtrees\Individual
+	 * @return \Fisharebest\Webtrees\GedcomRecord
 	 */
 	public function getIndividual() {
 		return $this->node_indi;