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
 	 */

Spacing +4 added lines, -4 removed lines

@@ -30,10 +30,10 @@ 
 	 * @param string $gedcom
 	 * @return NULL|\MyArtJaub\Webtrees\Family
 	 */
-	public static function getIntance($xref, Tree $tree, $gedcom = null){
+	public static function getIntance($xref, Tree $tree, $gedcom = null) {
 		$dfam = null;
 		$fam = fw\Family::getInstance($xref, $tree, $gedcom);
-		if($fam){
+		if ($fam) {
 			$dfam = new Family($fam);
 		}
 		return $dfam;
@@ -44,8 +44,8 @@ 
 	*
 	* @return int Level of sources
 	* */
-	function isMarriageSourced(){
-		if($this->is_marriage_sourced !== null) return $this->is_marriage_sourced;
+	function isMarriageSourced() {
+		if ($this->is_marriage_sourced !== null) return $this->is_marriage_sourced;
 		$this->is_marriage_sourced = $this->isFactSourced(WT_EVENTS_MARR.'|MARC');
 		return $this->is_marriage_sourced;
 	}

src/Webtrees/Functions/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

Spacing +42 added lines, -42 removed lines

@@ -32,7 +32,7 @@ 
 	 * @return string List of elements
 	 */
 	public static function getListFromArray(array $array) {
-		$n=count($array);
+		$n = count($array);
 		switch ($n) {
 			case 0:
 				return '';
@@ -41,10 +41,10 @@ 
 			default:
 				return implode(
 						/* I18N: list separator */ I18N::translate(', '), 
-						array_slice($array, 0, $n-1)
-					) .
-					/* I18N: last list separator, " and " in English, " et " in French  */ I18N::translate(' and ') . 
-					$array[$n-1];
+						array_slice($array, 0, $n - 1)
+					).
+					/* I18N: last list separator, " and " in English, " et " in French  */ I18N::translate(' and '). 
+					$array[$n - 1];
 		}
 	}
 
@@ -60,10 +60,10 @@ 
 			\MyArtJaub\Webtrees\Map\MapProviderInterface $mapProvider
 	) {
 		$place = $fact->getPlace();
-		if(!$place->isEmpty()) {
-			$iconPlace= $mapProvider->getPlaceIcon($place);	
-			if($iconPlace && strlen($iconPlace) > 0){
-				return	'<div class="fact_flag">'. self::htmlPlaceIcon($place, $iconPlace, 50). '</div>';
+		if (!$place->isEmpty()) {
+			$iconPlace = $mapProvider->getPlaceIcon($place);	
+			if ($iconPlace && strlen($iconPlace) > 0) {
+				return	'<div class="fact_flag">'.self::htmlPlaceIcon($place, $iconPlace, 50).'</div>';
 			}
 		}
 		return '';
@@ -77,8 +77,8 @@ 
 	 * @param number $size
 	 * @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() . '" />';
+	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().'" />';
 	}
 	
 	/**
@@ -96,7 +96,7 @@ 
 		$minimum = PHP_INT_MAX;
 		$maximum = 1;
 		foreach ($list as $params) {
-			if(array_key_exists('count', $params)) {
+			if (array_key_exists('count', $params)) {
 				$maximum = max($maximum, $params['count']);
 				$minimum = min($minimum, $params['count']);
 			}
@@ -114,15 +114,15 @@ 
 				$size = 75.0 + 125.0 * ($count - $minimum) / ($maximum - $minimum);
 			}
 			
-			$html .= '<a style="font-size:' . $size . '%" href="' . $url . '">';
+			$html .= '<a style="font-size:'.$size.'%" href="'.$url.'">';
 			if ($totals) {
-				$html .= I18N::translate('%1$s (%2$s)', '<span dir="auto">' . $text . '</span>', I18N::number($count));
+				$html .= I18N::translate('%1$s (%2$s)', '<span dir="auto">'.$text.'</span>', I18N::number($count));
 			} else {
 				$html .= $text;
 			}
 			$html .= '</a>';
 		}
-		return '<div class="tag_cloud">' . $html . '</div>';
+		return '<div class="tag_cloud">'.$html.'</div>';
 	}
 	
 
@@ -157,11 +157,11 @@ 
 	 * @param bool $isStrong Bolden the name ?
 	 * @return string HTML Code for individual item
 	 */
-	public static function htmlIndividualForList(\Fisharebest\Webtrees\Individual $individual, $isStrong = true){
+	public static function htmlIndividualForList(\Fisharebest\Webtrees\Individual $individual, $isStrong = true) {
 		$html = '';
 		$tag = 'em';
-		if($isStrong) $tag = 'strong';
-		if($individual && $individual->canShow()){
+		if ($isStrong) $tag = 'strong';
+		if ($individual && $individual->canShow()) {
 			$dindi = new Individual($individual);
 			$html = $individual->getSexImage();
 			$html .= '<a class="list_item" href="'.
@@ -176,7 +176,7 @@ 
 			$html .= '</a>';
 		}
 		else {
-			$html .= '<span class=\"list_item\"><'.$tag.'>' . I18N::translate('Private') . '</'.$tag.'></span>';
+			$html .= '<span class=\"list_item\"><'.$tag.'>'.I18N::translate('Private').'</'.$tag.'></span>';
 		}
 		return $html;
 	}
@@ -188,20 +188,20 @@ 
 	 * @param boolean $anchor option to print a link to calendar
 	 * @return string HTML code for short date
 	 */
-	public static function formatFactDateShort(\Fisharebest\Webtrees\Fact $fact, $anchor=false) {
-		$html='';
+	public static function formatFactDateShort(\Fisharebest\Webtrees\Fact $fact, $anchor = false) {
+		$html = '';
 		$date = $fact->getDate();
-		if($date->isOK()){
-			$html.=' '.$date->Display($anchor && !Globals::isSearchSpider(), '%Y');
+		if ($date->isOK()) {
+			$html .= ' '.$date->Display($anchor && !Globals::isSearchSpider(), '%Y');
 		}
-		else{
+		else {
 			// 1 DEAT Y with no DATE => print YES
 			// 1 BIRT 2 SOUR @S1@ => print YES
 			// 1 DEAT N is not allowed
 			// It is not proper GEDCOM form to use a N(o) value with an event tag to infer that it did not happen.
 			$factdetail = explode(' ', trim($fact->getGedcom()));
 			if (isset($factdetail) && (count($factdetail) == 3 && strtoupper($factdetail[2]) == 'Y') || (count($factdetail) == 4 && $factdetail[2] == 'SOUR')) {
-				$html.=I18N::translate('yes');
+				$html .= I18N::translate('yes');
 			}
 		}
 		return $html;
@@ -215,12 +215,12 @@ 
 	 * @param boolean $anchor option to print a link to placelist
 	 * @return string HTML code for short place
 	 */
-	public static function formatFactPlaceShort(\Fisharebest\Webtrees\Fact $fact, $format, $anchor=false){
-		$html='';
+	public static function formatFactPlaceShort(\Fisharebest\Webtrees\Fact $fact, $format, $anchor = false) {
+		$html = '';
 		
 		if ($fact === null) return $html;
 		$place = $fact->getPlace();
-		if($place){
+		if ($place) {
 			$dplace = new Place($place);
 			$html .= $dplace->htmlFormattedName($format, $anchor);
 		}
@@ -238,21 +238,21 @@ 
 	 * @param string $size CSS size for the icon. A CSS style css_$size is required
 	 * @return string HTML code for the formatted Sosa numbers
 	 */
-	public static function formatSosaNumbers(array $sosatab, $format = 1, $size = 'small'){
+	public static function formatSosaNumbers(array $sosatab, $format = 1, $size = 'small') {
 		$html = '';
-		switch($format){
+		switch ($format) {
 			case 1:
-				if(count($sosatab)>0){
+				if (count($sosatab) > 0) {
 					$html = '<i class="icon-maj-sosa_'.$size.'" title="'.I18N::translate('Sosa').'"></i>';
 				}
 				break;
 			case 2:
-				if(count($sosatab)>0){
+				if (count($sosatab) > 0) {
 					ksort($sosatab);
 					$tmp_html = array();
 					foreach ($sosatab as $sosa => $gen) {
 						$tmp_html[] = sprintf(
-								'<i class="icon-maj-sosa_%1$s" title="'.I18N::translate('Sosa').'"></i>&nbsp;<strong>%2$d&nbsp;'.I18N::translate('(G%s)', $gen) .'</strong>',
+								'<i class="icon-maj-sosa_%1$s" title="'.I18N::translate('Sosa').'"></i>&nbsp;<strong>%2$d&nbsp;'.I18N::translate('(G%s)', $gen).'</strong>',
 								$size,
 								$sosa
 							);
@@ -278,15 +278,15 @@ 
 	 * @param string $size CSS size for the icon. A CSS style css_$size is required
 	 * @return string HTML code for IsSourced icon
 	 */
-	public static function formatIsSourcedIcon($sourceType, $isSourced, $tag='EVEN', $format = 1, $size='normal'){
-		$html='';
-		$image=null;
-		$title=null;
-		switch($format){
+	public static function formatIsSourcedIcon($sourceType, $isSourced, $tag = 'EVEN', $format = 1, $size = 'normal') {
+		$html = '';
+		$image = null;
+		$title = null;
+		switch ($format) {
 			case 1:
-				switch($sourceType){
+				switch ($sourceType) {
 					case 'E':
-						switch($isSourced){
+						switch ($isSourced) {
 							case 0:
 								$image = 'event_unknown';
 								$title = I18N::translate('%s not found', GedcomTag::getLabel($tag));
@@ -316,7 +316,7 @@ 
 						}
 						break;
 					case 'R':
-						switch($isSourced){
+						switch ($isSourced) {
 							case -1:
 								$image = 'record_notsourced';
 								$title = I18N::translate('%s not sourced', GedcomTag::getLabel($tag));
@@ -336,7 +336,7 @@ 
 					default:
 						break;
 				}
-				if($image && $title) $html = '<i class="icon-maj-sourced-'.$size.'_'.$image.'" title="'.$title.'"></i>';
+				if ($image && $title) $html = '<i class="icon-maj-sourced-'.$size.'_'.$image.'" title="'.$title.'"></i>';
 				break;
 			default:
 				break;

src/Webtrees/Individual.php

Doc Comments +1 added lines, -2 removed lines

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

Spacing +29 added lines, -29 removed lines

@@ -21,7 +21,7 @@ 
 class Individual extends GedcomRecord {
 
 	/** @var array|null List of titles the individal holds */	
-	protected $titles=null;
+	protected $titles = null;
 	
 	/** @var string|null Individual's primary surname, without any privacy applied to it */
 	protected $unprotected_prim_surname = null;
@@ -43,9 +43,9 @@ 
 	 * @param null|string $gedcom
 	 * @return null|Individual
 	 */
-	public static function getIntance($xref, Tree $tree, $gedcom = null){
+	public static function getIntance($xref, Tree $tree, $gedcom = null) {
 		$indi = \Fisharebest\Webtrees\Individual::getInstance($xref, $tree, $gedcom);
-		if($indi){
+		if ($indi) {
 			return new Individual($indi);
 		}
 		return null;
@@ -56,18 +56,18 @@ 
 	 * 
 	 * @return array Array of titles
 	 */
-	public function getTitles(){
-		if(is_null($this->titles) && $module = Module::getModuleByName(Constants::MODULE_MAJ_MISC_NAME)){
+	public function getTitles() {
+		if (is_null($this->titles) && $module = Module::getModuleByName(Constants::MODULE_MAJ_MISC_NAME)) {
 			$pattern = '/(.*) (('.$module->getSetting('MAJ_TITLE_PREFIX', '').')(.*))/';
-			$this->titles=array();
+			$this->titles = array();
 			$titlefacts = $this->gedcomrecord->getFacts('TITL');
-			foreach($titlefacts as $titlefact){
+			foreach ($titlefacts as $titlefact) {
 				$ct2 = preg_match_all($pattern, $titlefact->getValue(), $match2);
-				if($ct2>0){
-					$this->titles[$match2[1][0]][]= trim($match2[2][0]);
+				if ($ct2 > 0) {
+					$this->titles[$match2[1][0]][] = trim($match2[2][0]);
 				}
-				else{
-					$this->titles[$titlefact->getValue()][]='';
+				else {
+					$this->titles[$titlefact->getValue()][] = '';
 				}
 			}
 		}
@@ -81,8 +81,8 @@ 
 	 * @return string Primary surname
 	 */
 	public function getUnprotectedPrimarySurname() {
-		if(!$this->unprotected_prim_surname){
-			$tmp=$this->gedcomrecord->getAllNames();
+		if (!$this->unprotected_prim_surname) {
+			$tmp = $this->gedcomrecord->getAllNames();
 			$this->unprotected_prim_surname = $tmp[$this->gedcomrecord->getPrimaryName()]['surname'];
 		}
 		return $this->unprotected_prim_surname;
@@ -94,12 +94,12 @@ 
 	 * @param boolean $perc Should the coefficient of reliability be returned
 	 * @return string|array Estimated birth place if found, null otherwise
 	 */
-	public function getEstimatedBirthPlace($perc=false){
-		if($bplace = $this->gedcomrecord->getBirthPlace()){
-			if($perc){
-				return array ($bplace, 1);
+	public function getEstimatedBirthPlace($perc = false) {
+		if ($bplace = $this->gedcomrecord->getBirthPlace()) {
+			if ($perc) {
+				return array($bplace, 1);
 			}
-			else{
+			else {
 				return $bplace;
 			}
 		}
@@ -112,8 +112,8 @@ 
 	 * @param boolean $perc Should the coefficient of reliability be returned
 	 * @return string|array Estimated birth place if found, null otherwise
 	 */
-	public function getSignificantPlace(){
-	    if($bplace = $this->gedcomrecord->getBirthPlace()){
+	public function getSignificantPlace() {
+	    if ($bplace = $this->gedcomrecord->getBirthPlace()) {
 	        return $bplace;
 	    }
 	
@@ -123,11 +123,11 @@ 
 	        }
 	    }
 	
-	    if($dplace = $this->gedcomrecord->getDeathPlace()){
+	    if ($dplace = $this->gedcomrecord->getDeathPlace()) {
 	        return $dplace;
 	    }
 	
-	    foreach($this->gedcomrecord->getSpouseFamilies() as $fams) {
+	    foreach ($this->gedcomrecord->getSpouseFamilies() as $fams) {
 	        foreach ($fams->getAllEventPlaces('RESI') as $rplace) {
 	            if ($rplace) {
 	                return $rplace;
@@ -143,7 +143,7 @@ 
 	 *
 	 * @return boolean Is the individual a Sosa ancestor
 	 */
-	public function isSosa(){
+	public function isSosa() {
 	    return count($this->getSosaNumbers()) > 0;
 	}
 	
@@ -154,8 +154,8 @@ 
 	 * @uses \MyArtJaub\Webtrees\Functions\ModuleManager
 	 * @return array List of Sosa numbers
 	 */
-	public function getSosaNumbers(){
-	    if($this->sosa === null) {
+	public function getSosaNumbers() {
+	    if ($this->sosa === null) {
 	        $provider = new SosaProvider($this->gedcomrecord->getTree());
 	        $this->sosa = $provider->getSosaNumbers($this->gedcomrecord);	        
 	    }
@@ -167,8 +167,8 @@ 
 	 *
 	 * @return int Level of sources
 	 * */
-	public function isBirthSourced(){
-		if($this->is_birth_sourced !== null) return $this->is_birth_sourced;
+	public function isBirthSourced() {
+		if ($this->is_birth_sourced !== null) return $this->is_birth_sourced;
 		$this->is_birth_sourced = $this->isFactSourced(WT_EVENTS_BIRT);
 		return $this->is_birth_sourced;
 	}
@@ -178,8 +178,8 @@ 
 	*
 	* @return int Level of sources
 	* */
-	public function isDeathSourced(){
-		if($this->is_death_sourced !== null) return $this->is_death_sourced;
+	public function isDeathSourced() {
+		if ($this->is_death_sourced !== null) return $this->is_death_sourced;
 		$this->is_death_sourced = $this->isFactSourced(WT_EVENTS_DEAT);
 		return $this->is_death_sourced;
 	}

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

Doc Comments +1 added lines, -1 removed lines

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

Spacing +20 added lines, -20 removed lines

@@ -80,7 +80,7 @@ 
 	 * @param string $file Filename containing the task object
 	 * @param TaskProviderInterface $provider Provider for tasks
      */
-    public function __construct($file, TaskProviderInterface $provider = null){
+    public function __construct($file, TaskProviderInterface $provider = null) {
         $this->name = trim(basename($file, '.php'));
 		$this->provider = $provider;
     }
@@ -90,7 +90,7 @@ 
      *
      * @return TaskProviderInterface 
      */
-    public function getProvider(){
+    public function getProvider() {
         return $this->provider;
     }
     
@@ -100,7 +100,7 @@ 
      * @param TaskProviderInterface $provider
      * @return self Enable method-chaining
      */
-    public function setProvider(TaskProviderInterface $provider){
+    public function setProvider(TaskProviderInterface $provider) {
         $this->provider = $provider;
         return $this;
     }
@@ -115,7 +115,7 @@ 
      * @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){
+    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;
@@ -129,7 +129,7 @@ 
      *
      * @return string
      */
-    public function getName(){
+    public function getName() {
         return $this->name;
     }
     
@@ -139,7 +139,7 @@ 
      *
      * @return boolean True if enabled
      */
-    public function isEnabled(){
+    public function isEnabled() {
         return $this->is_enabled;
     }
     
@@ -148,7 +148,7 @@ 
      *
      * @return \DateTime
      */
-    public function getLastUpdated(){
+    public function getLastUpdated() {
         return $this->last_updated;
     }
     
@@ -157,7 +157,7 @@ 
      *
      * @return bool
      */
-    public function isLastRunSuccess(){
+    public function isLastRunSuccess() {
         return $this->last_result;
     }
     
@@ -166,7 +166,7 @@ 
      *
      * @return int
      */
-    public function getFrequency(){
+    public function getFrequency() {
         return $this->frequency;
     }
 	
@@ -176,7 +176,7 @@ 
 	 * @param int $frequency
      * @return self Enable method-chaining
      */
-    public function setFrequency($frequency){
+    public function setFrequency($frequency) {
         $this->frequency = $frequency;
 		return $this;
     }
@@ -186,7 +186,7 @@ 
      *
      * @return int
      */
-    public function getRemainingOccurrences(){
+    public function getRemainingOccurrences() {
         return $this->nb_occurrences;
     }
 	
@@ -196,7 +196,7 @@ 
 	 * @param int $nb_occur
      * @return self Enable method-chaining
      */
-    public function setRemainingOccurrences($nb_occur){
+    public function setRemainingOccurrences($nb_occur) {
         $this->nb_occurrences = $nb_occur;
 		return $this;
     }
@@ -206,7 +206,7 @@ 
      *
      * @return bool
      */
-    public function isRunning(){
+    public function isRunning() {
         return $this->is_running;
     }
     
@@ -235,7 +235,7 @@ 
 	 * @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);
 	}
 	
@@ -243,23 +243,23 @@ 
      * Execute the task, default skeleton
      *
      */
-    public function execute(){
+    public function execute() {
     
-        if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
+        if ($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
             $this->is_running = false;
     
-        if(!$this->is_running){
+        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){
+            if ($this->last_result) {
                 $this->last_updated = new \DateTime();
-                if($this->nb_occurrences > 0){
+                if ($this->nb_occurrences > 0) {
                     $this->nb_occurrences--;
-                    if($this->nb_occurrences == 0) $this->is_enabled = false;
+                    if ($this->nb_occurrences == 0) $this->is_enabled = false;
                 }
             }
             $this->is_running = false;

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

Doc Comments +3 added lines, -2 removed lines

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

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

Doc Comments +2 added lines, -1 removed lines

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

Spacing +58 added lines, -58 removed lines

@@ -35,7 +35,7 @@ 
  */
 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...
@@ -95,8 +95,8 @@ 
 		
 		$match = null;
 		$ct = preg_match("/(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}) )?(?<details>.*)/", $this->title, $match);
-		if($ct > 0){
-			$monthId = (int) $match['month'];
+		if ($ct > 0) {
+			$monthId = (int)$match['month'];
 			$calendarShortMonths = Functions::getCalendarShortMonths();
 			$monthShortName = array_key_exists($monthId, $calendarShortMonths) ? $calendarShortMonths[$monthId] : $monthId;
 			$this->certDate = new Date($match['day'].' '.strtoupper($monthShortName).' '.$match['year']);
@@ -112,11 +112,11 @@ 
 	 * @see \Fisharebest\Webtrees\GedcomRecord::getInstance()
 	 */	
 	static public function getInstance($xref, Tree $tree, $gedcom = null, CertificateProviderInterface $provider = null) {
-		try{
+		try {
 			$certfile = Functions::decryptFromSafeBase64($xref);
 			
 			//NEED TO CHECK THAT !!!
-			if(Functions::isValidPath($certfile, true)) {
+			if (Functions::isValidPath($certfile, true)) {
 				return new Certificate($certfile, $tree, $provider);
 			}
 		}
@@ -153,8 +153,8 @@ 
 	 *
 	 * @param string|Source $xref
 	 */
-	public function setSource($xref){
-		if($xref instanceof Source){
+	public function setSource($xref) {
+		if ($xref instanceof Source) {
 			$this->source = $xref;
 		} else {
 			$this->source = Source::getInstance($xref, $this->tree);
@@ -174,7 +174,7 @@ 
 	 *
 	 * @return Date Certificate date
 	 */
-	public function getCertificateDate(){
+	public function getCertificateDate() {
 		return $this->certDate;
 	}
 	
@@ -183,7 +183,7 @@ 
 	 *
 	 * @return string Certificate date
 	 */
-	public function getCertificateType(){
+	public function getCertificateType() {
 		return $this->certType;
 	}
 	
@@ -192,7 +192,7 @@ 
 	 *
 	 * @return string Certificate details
 	 */
-	public function getCertificateDetails(){
+	public function getCertificateDetails() {
 		return $this->certDetails;
 	}
 	
@@ -201,9 +201,9 @@ 
 	 *
 	 * @return string|NULL Certificate city
 	 */
-	public function getCity(){
+	public function getCity() {
 		$chunks = explode('/', $this->getFilename(), 2);
-		if(count($chunks) > 1) return $chunks[0];
+		if (count($chunks) > 1) return $chunks[0];
 		return null;
 	}
 	
@@ -211,8 +211,8 @@ 
 	 * {@inhericDoc}
 	 * @see \Fisharebest\Webtrees\Media::getServerFilename()
 	 */
-	public function getServerFilename($which='main') {
-		$filename =  $this->provider->getRealCertificatesDirectory() . $this->getFilename();
+	public function getServerFilename($which = 'main') {
+		$filename = $this->provider->getRealCertificatesDirectory().$this->getFilename();
 		return Functions::encodeUtf8ToFileSystem($filename);
 	}
 	
@@ -223,11 +223,11 @@ 
 	public function getHtmlUrlDirect($which = 'main', $download = false) {
 		$sidstr = ($this->source) ? '&sid='.$this->source->getXref() : '';
 		return
-			'module.php?mod='. \MyArtJaub\Webtrees\Constants::MODULE_MAJ_CERTIF_NAME . 
-			'&mod_action=Certificate@image' . 
-			'&ged='. $this->tree->getNameUrl() .
-			'&cid=' . $this->getXref() . $sidstr .
-			'&cb=' . $this->getEtag($which);
+			'module.php?mod='.\MyArtJaub\Webtrees\Constants::MODULE_MAJ_CERTIF_NAME. 
+			'&mod_action=Certificate@image'. 
+			'&ged='.$this->tree->getNameUrl().
+			'&cid='.$this->getXref().$sidstr.
+			'&cb='.$this->getEtag($which);
 	}
 	
 	/**
@@ -238,26 +238,26 @@ 
 	 *
 	 * @return string Watermark text
 	 */
-	 public function getWatermarkText(){	
+	 public function getWatermarkText() {	
 	 	$module = Module::getModuleByName(Constants::MODULE_MAJ_CERTIF_NAME);
 	 	
-	 	if($module) {
+	 	if ($module) {
     		$wmtext = $module->getSetting('MAJ_WM_DEFAULT', I18N::translate('This image is protected under copyright law.'));
-    		$sid= Filter::get('sid', WT_REGEX_XREF);	
+    		$sid = Filter::get('sid', WT_REGEX_XREF);	
     	
-    		if($sid){
+    		if ($sid) {
     			$this->source = Source::getInstance($sid, $this->tree);
     		}
-    		else{
-    			$this->fetchALinkedSource();  // the method already attach the source to the Certificate object;
+    		else {
+    			$this->fetchALinkedSource(); // the method already attach the source to the Certificate object;
     		}
     		
-    		if($this->source) {
+    		if ($this->source) {
     			$wmtext = '&copy;';
     			$repofact = $this->source->getFirstFact('REPO');
-    			if($repofact) {
+    			if ($repofact) {
     				$repo = $repofact->getTarget();
-    				if($repo && $repo instanceof Repository)  $wmtext .= ' '.$repo->getFullName().' - ';
+    				if ($repo && $repo instanceof Repository)  $wmtext .= ' '.$repo->getFullName().' - ';
     			}
     			$wmtext .= $this->source->getFullName();			
     		}	
@@ -279,45 +279,45 @@ 
 		
 		$script = '';
 		$controller = Globals::getController();
-		if($controller && !($controller instanceof IndividualController)){
+		if ($controller && !($controller instanceof IndividualController)) {
 			$controller->addInlineJavascript('$(document).ready(function() { '.$js.' });');
 		} else {
-			$script = '<script>' . $js . '</script>';
+			$script = '<script>'.$js.'</script>';
 		}
 		
 		if ($which == 'icon' || !file_exists($this->getServerFilename())) {
 			// Use an icon
 			$image =
-			'<i dir="auto" class="icon-maj-certificate margin-h-2"' .
-			' title="' . strip_tags($this->getFullName()) . '"' .
+			'<i dir="auto" class="icon-maj-certificate margin-h-2"'.
+			' title="'.strip_tags($this->getFullName()).'"'.
 			'></i>';
 		} else {
 			$imgsize = getimagesize($this->getServerFilename());
 			$image =
-			'<img' .
-			' class ="'. 'certif_image'					 	. '"' .
-			' dir="'   . 'auto'                           	. '"' . // For the tool-tip
-			' src="'   . $this->getHtmlUrlDirect() 			. '"' .
-			' alt="'   . strip_tags($this->getFullName()) 	. '"' .
-			' title="' . strip_tags($this->getFullName()) 	. '"' .
-			$imgsize[3] . // height="yyy" width="xxx"
+			'<img'.
+			' class ="'.'certif_image'.'"'.
+			' dir="'.'auto'.'"'.// For the tool-tip
+			' src="'.$this->getHtmlUrlDirect().'"'.
+			' alt="'.strip_tags($this->getFullName()).'"'.
+			' title="'.strip_tags($this->getFullName()).'"'.
+			$imgsize[3].// height="yyy" width="xxx"
 			'>';
 		}	
 		return
-		'<a' .
-		' class="'          . 'certgallery'                          . '"' .
-		' href="'           . $this->getHtmlUrlDirect()    		 . '"' .
-		' type="'           . $this->mimeType()                  . '"' .
-		' data-obje-url="'  . $this->getHtmlUrl()                . '"' .
-		' data-title="'     . strip_tags($this->getFullName())   . '"' .
-		'>' . $image . '</a>'.$script;
+		'<a'.
+		' class="'.'certgallery'.'"'.
+		' href="'.$this->getHtmlUrlDirect().'"'.
+		' type="'.$this->mimeType().'"'.
+		' data-obje-url="'.$this->getHtmlUrl().'"'.
+		' data-title="'.strip_tags($this->getFullName()).'"'.
+		'>'.$image.'</a>'.$script;
 	}
 	
 	/**
 	 * {@inhericDoc}
 	 * @see \Fisharebest\Webtrees\GedcomRecord::linkedIndividuals()
 	 */
-	public function linkedIndividuals($link = '_ACT'){
+	public function linkedIndividuals($link = '_ACT') {
 		$rows = Database::prepare(
 				'SELECT i_id AS xref, i_gedcom AS gedcom'.
 				' FROM `##individuals`'.
@@ -341,7 +341,7 @@ 
 	 * {@inhericDoc}
 	 * @see \Fisharebest\Webtrees\GedcomRecord::linkedFamilies()
 	 */
-	public function linkedFamilies($link = '_ACT'){
+	public function linkedFamilies($link = '_ACT') {
 		$rows = Database::prepare(
 				'SELECT f_id AS xref, f_gedcom AS gedcom'.
 				' FROM `##families`'.
@@ -366,7 +366,7 @@ 
 	 *
 	 * @return Source|NULL Linked source
 	 */
-	public function fetchALinkedSource(){		
+	public function fetchALinkedSource() {		
 		$sid = null;
 		
 		// Try to find in individual, then families, then other types of records. We are interested in the first available value.
@@ -378,7 +378,7 @@ 
 		      'gedcom_id' => $this->tree->getTreeId(), 
 		      'gedcom' => '%_ACT '.$this->getFilename().'%'		      
 		  ))->fetchOne();
-		if(!$ged){
+		if (!$ged) {
 			$ged = Database::prepare(
 					'SELECT f_gedcom AS gedrec FROM `##families`'.
 					' WHERE f_file=:gedcom_id AND f_gedcom LIKE :gedcom')
@@ -386,7 +386,7 @@ 
 			         'gedcom_id' => $this->tree->getTreeId(), 
 			         'gedcom' => '%_ACT '.$this->getFilename().'%'			         
 			     ))->fetchOne();
-			if(!$ged){
+			if (!$ged) {
 				$ged = Database::prepare(
 				    'SELECT o_gedcom AS gedrec FROM `##other`'.
 				    ' WHERE o_file=:gedcom_id AND o_gedcom LIKE :gedcom')
@@ -397,19 +397,19 @@ 
 			}
 		}
 		//If a record has been found, parse it to find the source reference.
-		if($ged){
+		if ($ged) {
 			$gedlines = explode("\n", $ged);
 			$level = 0;
 			$levelsource = -1;
-			$sid_tmp=null;
+			$sid_tmp = null;
 			$sourcefound = false;
-			foreach($gedlines as $gedline){
+			foreach ($gedlines as $gedline) {
 				// Get the level
 				$match = null;
 				if (!$sourcefound && preg_match('~^('.WT_REGEX_INTEGER.') ~', $gedline, $match)) {
 					$level = $match[1];
 					//If we are not any more within the context of a source, reset
-					if($level <= $levelsource){
+					if ($level <= $levelsource) {
 						$levelsource = -1;
 						$sid_tmp = null;
 					}
@@ -417,11 +417,11 @@ 
 					$match2 = null;
 					if (preg_match('~^'.$level.' SOUR @('.WT_REGEX_XREF.')@$~', $gedline, $match2)) {
 						$levelsource = $level;
-						$sid_tmp=$match2[1];
+						$sid_tmp = $match2[1];
 					}
 					// If the image has be found, get the source reference and exit.
 					$match3 = null;
-					if($levelsource>=0 && $sid_tmp && preg_match('~^'.$level.' _ACT '.preg_quote($this->getFilename()).'~', $gedline, $match3)){
+					if ($levelsource >= 0 && $sid_tmp && preg_match('~^'.$level.' _ACT '.preg_quote($this->getFilename()).'~', $gedline, $match3)) {
 						$sid = $sid_tmp;
 						$sourcefound = true;
 					}
@@ -429,7 +429,7 @@ 
 			}
 		}
 		
-		if($sid) $this->source = Source::getInstance($sid, $this->tree);
+		if ($sid) $this->source = Source::getInstance($sid, $this->tree);
 		
 		return $this->source;	
 	}

src/Webtrees/Module/CertificatesModule.php

Doc Comments +1 added lines, -1 removed lines

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

Spacing +22 added lines, -22 removed lines

@@ -77,7 +77,7 @@ 
      * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
      */
     public function getConfigLink() {
-        return 'module.php?mod=' . $this->getName() . '&mod_action=AdminConfig';
+        return 'module.php?mod='.$this->getName().'&mod_action=AdminConfig';
     }
     
     /**
@@ -102,7 +102,7 @@ 
      */
     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'));
+        return new Menu($this->getTitle(), 'module.php?mod='.$this->getName().'&mod_action=Certificate@listAll&ged='.$tree_url, 'menu-maj-list-certificate', array('rel' => 'nofollow'));
     }
     
     /**
@@ -111,10 +111,10 @@ 
      */
     public function hFactSourcePrepend($srec) {
         $wt_tree = Globals::getTree();
-        $html='';
-        $sid=null;
+        $html = '';
+        $sid = null;
         
-        if($this->getSetting('MAJ_SHOW_CERT', Auth::PRIV_HIDE) >= Auth::accessLevel($wt_tree)){
+        if ($this->getSetting('MAJ_SHOW_CERT', Auth::PRIV_HIDE) >= Auth::accessLevel($wt_tree)) {
             if (!$srec || strlen($srec) == 0) return $html;
             	
             $certificate = null;
@@ -122,17 +122,17 @@ 
             $levelSOUR = substr($subrecords[0], 0, 1);
             $match = null;
             if (preg_match('~^'.$levelSOUR.' SOUR @('.WT_REGEX_XREF.')@$~', $subrecords[0], $match)) {
-                $sid=$match[1];
+                $sid = $match[1];
             };
             $nb_subrecords = count($subrecords);
-            for ($i=0; $i < $nb_subrecords; $i++) {
+            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 ($tag == '_ACT') $certificate = new Certificate($text, $wt_tree, $this->getProvider());
             }
             	
-            if($certificate && $certificate->canShow())
+            if ($certificate && $certificate->canShow())
                 $html = $this->getDisplay_ACT($certificate, $sid);
                 	
         }
@@ -159,9 +159,9 @@ 
      */
     public function hHtmlSimpleTagDisplay($tag, $value, $context = null, $contextid = null) {
         $html = '';
-        switch($tag){
+        switch ($tag) {
             case '_ACT':
-                if($context == 'SOUR') $html = $this->getDisplay_ACT($value, $contextid);
+                if ($context == 'SOUR') $html = $this->getDisplay_ACT($value, $contextid);
                 break;
         }
         return $html;
@@ -174,7 +174,7 @@ 
     public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null) {        
         $html = '';
 		
-		switch($tag){
+		switch ($tag) {
 			case '_ACT':
 				$element_id = Uuid::uuid4();
 				Globals::getController()
@@ -182,14 +182,14 @@ 
 					->addExternalJavascript(WT_STATIC_URL.WT_MODULES_DIR.$this->getName().'/js/autocomplete.js')
 					->addExternalJavascript(WT_STATIC_URL.WT_MODULES_DIR.$this->getName().'/js/updatecertificatevalues.js');
 				$certificate = null;
-				if($value){
+				if ($value) {
 					$certificate = new Certificate($value, Globals::getTree(), $this->getProvider());
 				}
 				$tabCities = $this->getProvider()->getCitiesList();
 				$html .= '<select id="certifCity'.$element_id.'" class="_CITY">';
-				foreach ($tabCities as $cities){
-					$selectedCity='';
-					if($certificate && $cities== $certificate->getCity()) $selectedCity='selected="true"';
+				foreach ($tabCities as $cities) {
+					$selectedCity = '';
+					if ($certificate && $cities == $certificate->getCity()) $selectedCity = 'selected="true"';
 					$html .= '<option value="'.$cities.'" '.$selectedCity.' />'.$cities.'</option>';
 				}
 				$html .= '</select>';
@@ -207,7 +207,7 @@ 
      * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hAddSimpleTag()
      */
     public function hAddSimpleTag($context, $level) {
-        switch($context){
+        switch ($context) {
             case 'SOUR':
                 FunctionsEdit::addSimpleTag($level.' _ACT');
                 break;
@@ -219,7 +219,7 @@ 
      * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hHasHelpTextTag()
      */
     public function hHasHelpTextTag($tag) {
-        switch($tag){
+        switch ($tag) {
 			case '_ACT':
 				return true;
 		}
@@ -231,7 +231,7 @@ 
      * @see \MyArtJaub\Webtrees\Hook\HookInterfaces\CustomSimpleTagManagerInterface::hGetHelpTextTag()
      */
     public function hGetHelpTextTag($tag) {
-        switch($tag){
+        switch ($tag) {
             case '_ACT':
                 return array(
                 I18N::translate('Certificate'),
@@ -247,7 +247,7 @@ 
      * @return \MyArtJaub\Webtrees\Module\Certificates\Model\CertificateProviderInterface
      */
     public function getProvider() {
-        if(!$this->provider) {
+        if (!$this->provider) {
             $root_path = $this->getSetting('MAJ_CERT_ROOTDIR', 'certificates/');
             $this->provider = new CertificateFileProvider($root_path, Globals::getTree());
         }
@@ -261,9 +261,9 @@ 
      * @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){    
+    protected function getDisplay_ACT(Certificate $certificate, $sid = null) {    
         $html = '';
-        if($certificate){
+        if ($certificate) {
             $certificate->setSource($sid);
             $html = $certificate->displayImage('icon');
         }

src/Webtrees/Mvc/View/ViewBag.php

Doc Comments -1 removed lines

@@ -42,7 +42,6 @@
      * Get all the data from the bag for a given key.
      *
      * @param  string  $key
-     * @param  string  $format
      * @return unknown
      */
     public function get($key, $default = null)

Spacing +3 added lines, -3 removed lines

@@ -73,8 +73,8 @@ 
      * @param bool $override
      */
     public function set($key, $value, $override = true) {
-        if(is_null($key)) return;
-        if(!$override && array_key_exists($key, $this->data)) return;
+        if (is_null($key)) return;
+        if (!$override && array_key_exists($key, $this->data)) return;
         $this->data[$key] = $value;        
     }
     
@@ -107,7 +107,7 @@ 
      * @param string $key
      */
     public function __unset($key) {
-        unset($this->data[$key]);;
+        unset($this->data[$key]); ;
     }
     
 }

src/Webtrees/Constants.php

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
 	 * @return string $WT_RAPHAEL_JS_URL
 	 */
 	public static function WT_RAPHAEL_JS_URL() {
-	    return WT_STATIC_URL . 'packages/raphael-2.1.4/raphael-min.js';
+	    return WT_STATIC_URL.'packages/raphael-2.1.4/raphael-min.js';
 	}
 		
 }
\ No newline at end of file