Inspection of "RESOLVED - #JJ263: Do not use Estimated dates in S..." - jon48/webtrees-lib - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e8097c...9fd6b6 )

by Jonathan

created 2019-07-07 21:32 UTC

Status

Indentation +101 added lines, -101 removed lines patch added patch discarded remove patch

@@ -19,121 +19,121 @@
 block discarded – undo
  */
 class SosaCalculator {
     
-    /**
-     * Maximium size for the temporary Sosa table
-     * @var int TMP_SOSA_TABLE_LIMIT
-     */
-    const TMP_SOSA_TABLE_LIMIT = 1000;
+	/**
+	 * Maximium size for the temporary Sosa table
+	 * @var int TMP_SOSA_TABLE_LIMIT
+	 */
+	const TMP_SOSA_TABLE_LIMIT = 1000;
     
-    /**
-     * Reference user
-     * @var Fisharebest\Webtrees\User $user
-     */
-    protected $user;
+	/**
+	 * Reference user
+	 * @var Fisharebest\Webtrees\User $user
+	 */
+	protected $user;
     
-    /**
-     * Reference tree
-     * @var Fisharebest\Webtrees\Tree $tree
-     */
-    protected $tree;
+	/**
+	 * Reference tree
+	 * @var Fisharebest\Webtrees\Tree $tree
+	 */
+	protected $tree;
     
-    /**
-     * Sosa Provider for the calculator
-     * @var \MyArtJaub\Webtrees\Module\Sosa\Model\SosaCalculator $sosa_provider
-     */
-    protected $sosa_provider;
+	/**
+	 * Sosa Provider for the calculator
+	 * @var \MyArtJaub\Webtrees\Module\Sosa\Model\SosaCalculator $sosa_provider
+	 */
+	protected $sosa_provider;
     
-    /**
-     * Temporary Sosa table, used during construction
-     * @var array $tmp_sosa_table
-     */
-    protected $tmp_sosa_table;
+	/**
+	 * Temporary Sosa table, used during construction
+	 * @var array $tmp_sosa_table
+	 */
+	protected $tmp_sosa_table;
     
-    /**
-     * Constructor for the Sosa Calculator
-     * @param Tree $tree
-     * @param User $user
-     */
-    public function __construct(Tree $tree, User $user) {        
-        $this->tree = $tree;
-        $this->user = $user;
+	/**
+	 * Constructor for the Sosa Calculator
+	 * @param Tree $tree
+	 * @param User $user
+	 */
+	public function __construct(Tree $tree, User $user) {        
+		$this->tree = $tree;
+		$this->user = $user;
         
-        $this->sosa_provider = new SosaProvider($this->tree, $this->user);;
-    }
+		$this->sosa_provider = new SosaProvider($this->tree, $this->user);;
+	}
     
-    /**
-     * Compute all Sosa ancestors from the user's root individual.
-     * @return bool Result of the computation
-     */
-    public function computeAll() {
-        $root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');        
-        $indi = Individual::getInstance($root_id, $this->tree);
-        if($indi){
-            $this->sosa_provider->deleteAll();
-            $this->addNode($indi, 1);
-            $this->flushTmpSosaTable(true);
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * Compute all Sosa ancestors from the user's root individual.
+	 * @return bool Result of the computation
+	 */
+	public function computeAll() {
+		$root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');        
+		$indi = Individual::getInstance($root_id, $this->tree);
+		if($indi){
+			$this->sosa_provider->deleteAll();
+			$this->addNode($indi, 1);
+			$this->flushTmpSosaTable(true);
+			return true;
+		}
+		return false;
+	}
     
-    /**
-     * Compute all Sosa Ancestors from a specified Individual
-     * @param Individual $indi
-     * @return bool Result of the computation
-     */
-    public function computeFromIndividual(Individual $indi) {
-        $dindi = new \MyArtJaub\Webtrees\Individual($indi);
-        $current_sosas = $dindi->getSosaNumbers();
-        foreach($current_sosas as $current_sosa => $gen) {
-            $this->sosa_provider->deleteAncestors($current_sosa);
-            $this->addNode($indi, $current_sosa);
-        }
-        $this->flushTmpSosaTable(true);
-        return true;
-    }
+	/**
+	 * Compute all Sosa Ancestors from a specified Individual
+	 * @param Individual $indi
+	 * @return bool Result of the computation
+	 */
+	public function computeFromIndividual(Individual $indi) {
+		$dindi = new \MyArtJaub\Webtrees\Individual($indi);
+		$current_sosas = $dindi->getSosaNumbers();
+		foreach($current_sosas as $current_sosa => $gen) {
+			$this->sosa_provider->deleteAncestors($current_sosa);
+			$this->addNode($indi, $current_sosa);
+		}
+		$this->flushTmpSosaTable(true);
+		return true;
+	}
     
-    /**
-     * Recursive method to add individual to the Sosa table, and flush it regularly
-     * @param Individual $indi Individual to add
-     * @param int $sosa Individual's sosa
-     */
-    protected function addNode(Individual $indi, $sosa) {                
-        $birth_year = $indi->getBirthDate()->gregorianYear();
-        $birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
+	/**
+	 * Recursive method to add individual to the Sosa table, and flush it regularly
+	 * @param Individual $indi Individual to add
+	 * @param int $sosa Individual's sosa
+	 */
+	protected function addNode(Individual $indi, $sosa) {                
+		$birth_year = $indi->getBirthDate()->gregorianYear();
+		$birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
         
-        $death_year = $indi->getDeathDate()->gregorianYear();
-        $death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
+		$death_year = $indi->getDeathDate()->gregorianYear();
+		$death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
         
-        $this->tmp_sosa_table[] = array(
-            'indi' => $indi->getXref(),
-            'sosa' => $sosa,
-            'birth_year' => $birth_year === 0 ? null : $birth_year,
-            'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
-            'death_year' => $death_year === 0 ? null : $death_year,
-            'death_year_est' => $death_year_est === 0 ? null : $death_year_est
-        );
+		$this->tmp_sosa_table[] = array(
+			'indi' => $indi->getXref(),
+			'sosa' => $sosa,
+			'birth_year' => $birth_year === 0 ? null : $birth_year,
+			'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
+			'death_year' => $death_year === 0 ? null : $death_year,
+			'death_year_est' => $death_year_est === 0 ? null : $death_year_est
+		);
         
-        $this->flushTmpSosaTable();
+		$this->flushTmpSosaTable();
         
-        if($fam = $indi->getPrimaryChildFamily()) {
-            if($husb = $fam->getHusband()) $this->addNode($husb, 2 * $sosa);
-            if($wife = $fam->getWife()) $this->addNode($wife, 2 * $sosa + 1);
-        }
-    }
+		if($fam = $indi->getPrimaryChildFamily()) {
+			if($husb = $fam->getHusband()) $this->addNode($husb, 2 * $sosa);
+			if($wife = $fam->getWife()) $this->addNode($wife, 2 * $sosa + 1);
+		}
+	}
     
-    /**
-     * Write sosas in the table, if the number of items is superior to the limit, or if forced.
-     *
-     * @param bool $force Should the flush be forced
-     */
-    protected function flushTmpSosaTable($force = false) {
-        if( count($this->tmp_sosa_table)> 0 && 
-            ($force ||  count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT)){            
-                $this->sosa_provider->insertOrUpdate($this->tmp_sosa_table);
-                $this->tmp_sosa_table = array();
-        }
-    }
+	/**
+	 * Write sosas in the table, if the number of items is superior to the limit, or if forced.
+	 *
+	 * @param bool $force Should the flush be forced
+	 */
+	protected function flushTmpSosaTable($force = false) {
+		if( count($this->tmp_sosa_table)> 0 && 
+			($force ||  count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT)){            
+				$this->sosa_provider->insertOrUpdate($this->tmp_sosa_table);
+				$this->tmp_sosa_table = array();
+		}
+	}
                
 }
  
\ No newline at end of file

Please login to merge, or discard this patch.

		@@ -19,121 +19,121 @@
		block discarded – undo
19	19	*/
20	20	class SosaCalculator {
21	21
22		- /**
23		- * Maximium size for the temporary Sosa table
24		- * @var int TMP_SOSA_TABLE_LIMIT
25		- */
26		- const TMP_SOSA_TABLE_LIMIT = 1000;
	22	+ /**
	23	+ * Maximium size for the temporary Sosa table
	24	+ * @var int TMP_SOSA_TABLE_LIMIT
	25	+ */
	26	+ const TMP_SOSA_TABLE_LIMIT = 1000;
27	27
28		- /**
29		- * Reference user
30		- * @var Fisharebest\Webtrees\User $user
31		- */
32		- protected $user;
	28	+ /**
	29	+ * Reference user
	30	+ * @var Fisharebest\Webtrees\User $user
	31	+ */
	32	+ protected $user;
33	33
34		- /**
35		- * Reference tree
36		- * @var Fisharebest\Webtrees\Tree $tree
37		- */
38		- protected $tree;
	34	+ /**
	35	+ * Reference tree
	36	+ * @var Fisharebest\Webtrees\Tree $tree
	37	+ */
	38	+ protected $tree;
39	39
40		- /**
41		- * Sosa Provider for the calculator
42		- * @var \MyArtJaub\Webtrees\Module\Sosa\Model\SosaCalculator $sosa_provider
43		- */
44		- protected $sosa_provider;
	40	+ /**
	41	+ * Sosa Provider for the calculator
	42	+ * @var \MyArtJaub\Webtrees\Module\Sosa\Model\SosaCalculator $sosa_provider
	43	+ */
	44	+ protected $sosa_provider;
45	45
46		- /**
47		- * Temporary Sosa table, used during construction
48		- * @var array $tmp_sosa_table
49		- */
50		- protected $tmp_sosa_table;
	46	+ /**
	47	+ * Temporary Sosa table, used during construction
	48	+ * @var array $tmp_sosa_table
	49	+ */
	50	+ protected $tmp_sosa_table;
51	51
52		- /**
53		- * Constructor for the Sosa Calculator
54		- * @param Tree $tree
55		- * @param User $user
56		- */
57		- public function __construct(Tree $tree, User $user) {
58		- $this->tree = $tree;
59		- $this->user = $user;
	52	+ /**
	53	+ * Constructor for the Sosa Calculator
	54	+ * @param Tree $tree
	55	+ * @param User $user
	56	+ */
	57	+ public function __construct(Tree $tree, User $user) {
	58	+ $this->tree = $tree;
	59	+ $this->user = $user;
60	60
61		- $this->sosa_provider = new SosaProvider($this->tree, $this->user);;
62		- }
	61	+ $this->sosa_provider = new SosaProvider($this->tree, $this->user);;
	62	+ }
63	63
64		- /**
65		- * Compute all Sosa ancestors from the user's root individual.
66		- * @return bool Result of the computation
67		- */
68		- public function computeAll() {
69		- $root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
70		- $indi = Individual::getInstance($root_id, $this->tree);
71		- if($indi){
72		- $this->sosa_provider->deleteAll();
73		- $this->addNode($indi, 1);
74		- $this->flushTmpSosaTable(true);
75		- return true;
76		- }
77		- return false;
78		- }
	64	+ /**
	65	+ * Compute all Sosa ancestors from the user's root individual.
	66	+ * @return bool Result of the computation
	67	+ */
	68	+ public function computeAll() {
	69	+ $root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
	70	+ $indi = Individual::getInstance($root_id, $this->tree);
	71	+ if($indi){
	72	+ $this->sosa_provider->deleteAll();
	73	+ $this->addNode($indi, 1);
	74	+ $this->flushTmpSosaTable(true);
	75	+ return true;
	76	+ }
	77	+ return false;
	78	+ }
79	79
80		- /**
81		- * Compute all Sosa Ancestors from a specified Individual
82		- * @param Individual $indi
83		- * @return bool Result of the computation
84		- */
85		- public function computeFromIndividual(Individual $indi) {
86		- $dindi = new \MyArtJaub\Webtrees\Individual($indi);
87		- $current_sosas = $dindi->getSosaNumbers();
88		- foreach($current_sosas as $current_sosa => $gen) {
89		- $this->sosa_provider->deleteAncestors($current_sosa);
90		- $this->addNode($indi, $current_sosa);
91		- }
92		- $this->flushTmpSosaTable(true);
93		- return true;
94		- }
	80	+ /**
	81	+ * Compute all Sosa Ancestors from a specified Individual
	82	+ * @param Individual $indi
	83	+ * @return bool Result of the computation
	84	+ */
	85	+ public function computeFromIndividual(Individual $indi) {
	86	+ $dindi = new \MyArtJaub\Webtrees\Individual($indi);
	87	+ $current_sosas = $dindi->getSosaNumbers();
	88	+ foreach($current_sosas as $current_sosa => $gen) {
	89	+ $this->sosa_provider->deleteAncestors($current_sosa);
	90	+ $this->addNode($indi, $current_sosa);
	91	+ }
	92	+ $this->flushTmpSosaTable(true);
	93	+ return true;
	94	+ }
95	95
96		- /**
97		- * Recursive method to add individual to the Sosa table, and flush it regularly
98		- * @param Individual $indi Individual to add
99		- * @param int $sosa Individual's sosa
100		- */
101		- protected function addNode(Individual $indi, $sosa) {
102		- $birth_year = $indi->getBirthDate()->gregorianYear();
103		- $birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
	96	+ /**
	97	+ * Recursive method to add individual to the Sosa table, and flush it regularly
	98	+ * @param Individual $indi Individual to add
	99	+ * @param int $sosa Individual's sosa
	100	+ */
	101	+ protected function addNode(Individual $indi, $sosa) {
	102	+ $birth_year = $indi->getBirthDate()->gregorianYear();
	103	+ $birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
104	104
105		- $death_year = $indi->getDeathDate()->gregorianYear();
106		- $death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
	105	+ $death_year = $indi->getDeathDate()->gregorianYear();
	106	+ $death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
107	107
108		- $this->tmp_sosa_table[] = array(
109		- 'indi' => $indi->getXref(),
110		- 'sosa' => $sosa,
111		- 'birth_year' => $birth_year === 0 ? null : $birth_year,
112		- 'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
113		- 'death_year' => $death_year === 0 ? null : $death_year,
114		- 'death_year_est' => $death_year_est === 0 ? null : $death_year_est
115		- );
	108	+ $this->tmp_sosa_table[] = array(
	109	+ 'indi' => $indi->getXref(),
	110	+ 'sosa' => $sosa,
	111	+ 'birth_year' => $birth_year === 0 ? null : $birth_year,
	112	+ 'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
	113	+ 'death_year' => $death_year === 0 ? null : $death_year,
	114	+ 'death_year_est' => $death_year_est === 0 ? null : $death_year_est
	115	+ );
116	116
117		- $this->flushTmpSosaTable();
	117	+ $this->flushTmpSosaTable();
118	118
119		- if($fam = $indi->getPrimaryChildFamily()) {
120		- if($husb = $fam->getHusband()) $this->addNode($husb, 2 * $sosa);
121		- if($wife = $fam->getWife()) $this->addNode($wife, 2 * $sosa + 1);
122		- }
123		- }
	119	+ if($fam = $indi->getPrimaryChildFamily()) {
	120	+ if($husb = $fam->getHusband()) $this->addNode($husb, 2 * $sosa);
	121	+ if($wife = $fam->getWife()) $this->addNode($wife, 2 * $sosa + 1);
	122	+ }
	123	+ }
124	124
125		- /**
126		- * Write sosas in the table, if the number of items is superior to the limit, or if forced.
127		- *
128		- * @param bool $force Should the flush be forced
129		- */
130		- protected function flushTmpSosaTable($force = false) {
131		- if( count($this->tmp_sosa_table)> 0 &&
132		- ($force \|\| count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT)){
133		- $this->sosa_provider->insertOrUpdate($this->tmp_sosa_table);
134		- $this->tmp_sosa_table = array();
135		- }
136		- }
	125	+ /**
	126	+ * Write sosas in the table, if the number of items is superior to the limit, or if forced.
	127	+ *
	128	+ * @param bool $force Should the flush be forced
	129	+ */
	130	+ protected function flushTmpSosaTable($force = false) {
	131	+ if( count($this->tmp_sosa_table)> 0 &&
	132	+ ($force \|\| count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT)){
	133	+ $this->sosa_provider->insertOrUpdate($this->tmp_sosa_table);
	134	+ $this->tmp_sosa_table = array();
	135	+ }
	136	+ }
137	137
138	138	}
139	139
140	140	\ No newline at end of file

jon48 / webtrees-lib

Push — master ( e8097c...9fd6b6 )

Status

Category

Indentation +101 added lines, -101 removed lines patch added patch discarded remove patch