jon48 / webtrees-lib

src/Webtrees/Cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
 	 *
 	 * @param string $value Value name
 	 * @param AbstractModule $mod Calling module
-	 * @return bool True is cached
+	 * @return boolean|null True is cached
 	 */
 	public static function isCached($value, AbstractModule $mod = null) {
 	    self::getInstance()->isCachedI($value, $mod);

Indentation +14 added lines, -14 removed lines

@@ -16,10 +16,10 @@ 
  */
 class Cache{
 	
-    /**
-     * Underlying Zend Cache object
-     * @var \Zend_Cache_Core|\Zend_Cache_FrontEnd $cache
-     */
+	/**
+	 * Underlying Zend Cache object
+	 * @var \Zend_Cache_Core|\Zend_Cache_FrontEnd $cache
+	 */
 	protected $cache=null;
 	
 	/**
@@ -41,11 +41,11 @@ 
 	 */
 	protected static function getInstance()
 	{
-	    if (null === static::$instance) {
-	        static::$instance = new static();
-	    }
+		if (null === static::$instance) {
+			static::$instance = new static();
+		}
 	
-	    return static::$instance;
+		return static::$instance;
 	}
 	
 	/**
@@ -91,7 +91,7 @@ 
 	 * @return string Cached key name
 	 */
 	protected function getKeyName($value, AbstractModule $mod = null){
-	    $this->checkInit();
+		$this->checkInit();
 		$mod_name = 'myartjaub';
 		if($mod != null) $mod_name = $mod->getName();
 		return $mod_name.'_'.$value;
@@ -117,7 +117,7 @@ 
 	 * @return bool True is cached
 	 */
 	public static function isCached($value, AbstractModule $mod = null) {
-	    self::getInstance()->isCachedI($value, $mod);
+		self::getInstance()->isCachedI($value, $mod);
 	}
 	
 	/**
@@ -140,7 +140,7 @@ 
 	 * @return unknown_type Cached value
 	 */
 	public static function get($value, AbstractModule $mod = null){
-	    self::getInstance()->getI($value, $mod);
+		self::getInstance()->getI($value, $mod);
 	}
 	
 	/**
@@ -166,7 +166,7 @@ 
 	 * @return unknown_type Cached value
 	 */
 	public static function save($value, $data, AbstractModule $mod = null){
-	    self::getInstance()->saveI($value, $data, $mod);
+		self::getInstance()->saveI($value, $data, $mod);
 	}
 	
 	/**
@@ -174,7 +174,7 @@ 
 	 *
 	 */
 	public function cleanI(){
-	    $this->checkInit();
+		$this->checkInit();
 		$this->cache->clean();
 	}
 	
@@ -182,7 +182,7 @@ 
 	 * Static invocation of the *clean* method.
 	 */
 	public static function clean() {
-	    self::getInstance()->cleanI();
+		self::getInstance()->cleanI();
 	}
 	
 }
\ No newline at end of file

Spacing +12 added lines, -12 removed lines

@@ -14,13 +14,13 @@ 
 /**
  * Cache component to speed up some potential data retrievals
  */
-class Cache{
+class Cache {
 	
     /**
      * Underlying Zend Cache object
      * @var \Zend_Cache_Core|\Zend_Cache_FrontEnd $cache
      */
-	protected $cache=null;
+	protected $cache = null;
 	
 	/**
 	 * Defines whether the cache has been initialised
@@ -54,7 +54,7 @@ 
 	 */
 	protected function init() {	
 		// The translation libraries only work with a cache.
-		$cache_options=array('automatic_serialization'=>true);
+		$cache_options = array('automatic_serialization'=>true);
 	
 		if (ini_get('apc.enabled')) {
 			 $this->cache = \Zend_Cache::factory('Core', 'Apc', $cache_options, array());
@@ -79,8 +79,8 @@ 
 	 * Initiliase the Cache if not done.
 	 *
 	 */
-	protected function checkInit(){
-		if(!$this->is_init) $this->init();
+	protected function checkInit() {
+		if (!$this->is_init) $this->init();
 	}
 	
 	/**
@@ -90,10 +90,10 @@ 
 	 * @param AbstractModule $mod Calling module
 	 * @return string Cached key name
 	 */
-	protected function getKeyName($value, AbstractModule $mod = null){
+	protected function getKeyName($value, AbstractModule $mod = null) {
 	    $this->checkInit();
 		$mod_name = 'myartjaub';
-		if($mod != null) $mod_name = $mod->getName();
+		if ($mod != null) $mod_name = $mod->getName();
 		return $mod_name.'_'.$value;
 	}
 
@@ -127,7 +127,7 @@ 
 	 * @param AbstractModule $mod Calling module
 	 * @return unknown_type Cached value
 	 */
-	public function getI($value, AbstractModule $mod = null){
+	public function getI($value, AbstractModule $mod = null) {
 		$this->checkInit();
 		return $this->cache->load($this->getKeyName($value, $mod));
 	}
@@ -139,7 +139,7 @@ 
 	 * @param AbstractModule $mod Calling module
 	 * @return unknown_type Cached value
 	 */
-	public static function get($value, AbstractModule $mod = null){
+	public static function get($value, AbstractModule $mod = null) {
 	    self::getInstance()->getI($value, $mod);
 	}
 	
@@ -151,7 +151,7 @@ 
 	 * @param AbstractModule $mod Calling module
 	 * @return unknown_type Cached value
 	 */
-	public function saveI($value, $data, AbstractModule $mod = null){
+	public function saveI($value, $data, AbstractModule $mod = null) {
 		$this->checkInit();
 		$this->cache->save($data, $this->getKeyName($value, $mod));
 		return $this->get($value, $mod);
@@ -165,7 +165,7 @@ 
 	 * @param AbstractModule $mod Calling module
 	 * @return unknown_type Cached value
 	 */
-	public static function save($value, $data, AbstractModule $mod = null){
+	public static function save($value, $data, AbstractModule $mod = null) {
 	    self::getInstance()->saveI($value, $data, $mod);
 	}
 	
@@ -173,7 +173,7 @@ 
 	 * Clean the cache
 	 *
 	 */
-	public function cleanI(){
+	public function cleanI() {
 	    $this->checkInit();
 		$this->cache->clean();
 	}

Braces +6 added lines, -2 removed lines

@@ -80,7 +80,9 @@ 
 	 *
 	 */
 	protected function checkInit(){
-		if(!$this->is_init) $this->init();
+		if(!$this->is_init) {
+			$this->init();
+		}
 	}
 	
 	/**
@@ -93,7 +95,9 @@ 
 	protected function getKeyName($value, AbstractModule $mod = null){
 	    $this->checkInit();
 		$mod_name = 'myartjaub';
-		if($mod != null) $mod_name = $mod->getName();
+		if($mod != null) {
+			$mod_name = $mod->getName();
+		}
 		return $mod_name.'_'.$value;
 	}
 

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');

Spacing +4 added lines, -4 removed lines

@@ -29,10 +29,10 @@ 
 	 * @param unknown_type $data Data to identify the individual
 	 * @return \MyArtJaub\Webtrees\Family|null \MyArtJaub\Webtrees\Family instance
 	 */
-	public static function getIntance($data){
+	public static function getIntance($data) {
 		$dfam = null;
 		$fam = fw\Family::getInstance($data);
-		if($fam){
+		if ($fam) {
 			$dfam = new Family($fam);
 		}
 		return $dfam;
@@ -43,8 +43,8 @@ 
 	*
 	* @return int Level of sources
 	* */
-	function isMarriageSourced(){
-		if($this->_ismarriagesourced != null) return $this->_ismarriagesourced;
+	function isMarriageSourced() {
+		if ($this->_ismarriagesourced != null) return $this->_ismarriagesourced;
 		$this->_ismarriagesourced = $this->isFactSourced(WT_EVENTS_MARR.'|MARC');
 		return $this->_ismarriagesourced;
 	}

Braces +3 added lines, -1 removed lines

@@ -44,7 +44,9 @@
 	* @return int Level of sources
 	* */
 	function isMarriageSourced(){
-		if($this->_ismarriagesourced != null) return $this->_ismarriagesourced;
+		if($this->_ismarriagesourced != null) {
+			return $this->_ismarriagesourced;
+		}
 		$this->_ismarriagesourced = $this->isFactSourced(WT_EVENTS_MARR.'|MARC');
 		return $this->_ismarriagesourced;
 	}

src/Webtrees/Functions/Functions.php

Doc Comments +7 added lines, -7 removed lines

@@ -51,8 +51,8 @@ 
 	 * 
 	 * @param integer $num Numerator
 	 * @param integer $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Result of the safe division
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Result of the safe division
 	 */
 	public static function safeDivision($num, $denom, $default = 0) {
 		if($denom && $denom!=0){
@@ -66,8 +66,8 @@ 
 	 *
 	 * @param int $num Numerator
 	 * @param int $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Percentage
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Percentage
 	 */
 	public static function getPercentage($num, $denom, $default = 0){
 		return 100 * self::safeDivision($num, $denom, $default);
@@ -78,7 +78,7 @@ 
 	 *
 	 * @param string $file The image to resize
 	 * @param int $target	The final max width/height
-	 * @return array array of ($width, $height). One of them must be $target
+	 * @return integer[] array of ($width, $height). One of them must be $target
 	 */
 	static public function getResizedImageSize($file, $target=25){
 		list($width, $height, $type, $attr) = getimagesize($file);
@@ -233,7 +233,7 @@ 
 	 * Returns the generation associated with a Sosa number
 	 *
 	 * @param int $sosa Sosa number
-	 * @return number
+	 * @return integer
 	 */
 	public static function getGeneration($sosa){
 		return(int)log($sosa, 2)+1;
@@ -246,7 +246,7 @@ 
 	 * Returns whether the image type is supported by the system, and if so, return the standardised type
 	 *
 	 * @param string $reqtype Extension to test
-	 * @return boolean|string Is supported?
+	 * @return false|string Is supported?
 	 */
 	public static function isImageTypeSupported($reqtype) {
 	    $supportByGD = array('jpg'=>'jpeg', 'jpeg'=>'jpeg', 'gif'=>'gif', 'png'=>'png');

Indentation +11 added lines, -11 removed lines

@@ -184,7 +184,7 @@ 
 	 */
 	public static function encodeFileSystemToUtf8($string){
 		if (strtoupper(substr(php_uname('s'), 0, 7)) === 'WINDOWS') {
-		    return iconv('cp1252', 'utf-8//IGNORE',$string);
+			return iconv('cp1252', 'utf-8//IGNORE',$string);
 		}
 		return $string;
 	}
@@ -249,20 +249,20 @@ 
 	 * @return boolean|string Is supported?
 	 */
 	public static function isImageTypeSupported($reqtype) {
-	    $supportByGD = array('jpg'=>'jpeg', 'jpeg'=>'jpeg', 'gif'=>'gif', 'png'=>'png');
-	    $reqtype = strtolower($reqtype);
+		$supportByGD = array('jpg'=>'jpeg', 'jpeg'=>'jpeg', 'gif'=>'gif', 'png'=>'png');
+		$reqtype = strtolower($reqtype);
 	
-	    if (empty($supportByGD[$reqtype])) {
-	        return false;
-	    }
+		if (empty($supportByGD[$reqtype])) {
+			return false;
+		}
 	
-	    $type = $supportByGD[$reqtype];
+		$type = $supportByGD[$reqtype];
 	
-	    if (function_exists('imagecreatefrom'.$type) && function_exists('image'.$type)) {
-	        return $type;
-	    }
+		if (function_exists('imagecreatefrom'.$type) && function_exists('image'.$type)) {
+			return $type;
+		}
 	
-	    return false;
+		return false;
 	}
 		
 }

Spacing +26 added lines, -26 removed lines

@@ -40,9 +40,9 @@ 
 	 *
 	 * @param string $text Text to display
 	 */
-	static public function promptAlert($text){
+	static public function promptAlert($text) {
 		echo '<script>';
-		echo 'alert("',fw\Filter::escapeHtml($text),'")';
+		echo 'alert("', fw\Filter::escapeHtml($text), '")';
 		echo '</script>';
 	}
 	
@@ -55,7 +55,7 @@ 
 	 * @return float Result of the safe division
 	 */
 	public static function safeDivision($num, $denom, $default = 0) {
-		if($denom && $denom!=0){
+		if ($denom && $denom != 0) {
 			return $num / $denom;
 		}
 		return $default;
@@ -69,7 +69,7 @@ 
 	 * @param float $default Default value if denominator null or 0
 	 * @return float Percentage
 	 */
-	public static function getPercentage($num, $denom, $default = 0){
+	public static function getPercentage($num, $denom, $default = 0) {
 		return 100 * self::safeDivision($num, $denom, $default);
 	}
 	
@@ -80,7 +80,7 @@ 
 	 * @param int $target	The final max width/height
 	 * @return array array of ($width, $height). One of them must be $target
 	 */
-	static public function getResizedImageSize($file, $target=25){
+	static public function getResizedImageSize($file, $target = 25) {
 		list($width, $height, $type, $attr) = getimagesize($file);
 		$max = max($width, $height);
 		$rapp = $target / $max;
@@ -111,21 +111,21 @@ 
 	 * @param int $length Length of the token, default to 32
 	 * @return string Random token
 	 */
-	public static function generateRandomToken($length=32) {
+	public static function generateRandomToken($length = 32) {
 		$chars = str_split('abcdefghijkmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
 		$len_chars = count($chars);
 		$token = '';
 		
 		for ($i = 0; $i < $length; $i++)
-			$token .= $chars[ mt_rand(0, $len_chars - 1) ];
+			$token .= $chars[mt_rand(0, $len_chars - 1)];
 		
 		# Number of 32 char chunks
-		$chunks = ceil( strlen($token) / 32 );
+		$chunks = ceil(strlen($token) / 32);
 		$md5token = '';
 		
 		# Run each chunk through md5
-		for ( $i=1; $i<=$chunks; $i++ )
-			$md5token .= md5( substr($token, $i * 32 - 32, 32) );
+		for ($i = 1; $i <= $chunks; $i++)
+			$md5token .= md5(substr($token, $i * 32 - 32, 32));
 		
 			# Trim the token
 		return substr($md5token, 0, $length);		
@@ -138,12 +138,12 @@ 
 	 * @param string $data Text to encrypt
 	 * @return string Encrypted and encoded text
 	 */
-	public static function encryptToSafeBase64($data){
+	public static function encryptToSafeBase64($data) {
 		$key = 'STANDARDKEYIFNOSERVER';
-		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
+		if ($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
 			$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
 		$iv = mcrypt_create_iv(self::ENCRYPTION_IV_SIZE, MCRYPT_RAND);
-		$id = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $data, MCRYPT_MODE_CBC,$iv);
+		$id = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $data, MCRYPT_MODE_CBC, $iv);
 		$encrypted = base64_encode($iv.$id);
 		// +, / and = are not URL-compatible
 		$encrypted = str_replace('+', '-', $encrypted);
@@ -158,22 +158,22 @@ 
 	 * @param string $encrypted Text to decrypt
 	 * @return string Decrypted text
 	 */
-	public static function decryptFromSafeBase64($encrypted){
+	public static function decryptFromSafeBase64($encrypted) {
 		$key = 'STANDARDKEYIFNOSERVER';
-		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
+		if ($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
 			$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
 		$encrypted = str_replace('-', '+', $encrypted);
 		$encrypted = str_replace('_', '/', $encrypted);
 		$encrypted = str_replace('*', '=', $encrypted);
 		$encrypted = base64_decode($encrypted);
-		if(!$encrypted)
+		if (!$encrypted)
 			throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
-		if(strlen($encrypted) < self::ENCRYPTION_IV_SIZE) 
+		if (strlen($encrypted) < self::ENCRYPTION_IV_SIZE) 
 			throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
 		$iv_dec = substr($encrypted, 0, self::ENCRYPTION_IV_SIZE);
 		$encrypted = substr($encrypted, self::ENCRYPTION_IV_SIZE);
 		$decrypted = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key, $encrypted, MCRYPT_MODE_CBC, $iv_dec);
-		return  preg_replace('~(?:\\000+)$~','',$decrypted);
+		return  preg_replace('~(?:\\000+)$~', '', $decrypted);
 	}
 	
 	/**
@@ -182,9 +182,9 @@ 
 	 * @param string $string Filesystem encoded string to encode
 	 * @return string UTF-8 encoded string
 	 */
-	public static function encodeFileSystemToUtf8($string){
+	public static function encodeFileSystemToUtf8($string) {
 		if (strtoupper(substr(php_uname('s'), 0, 7)) === 'WINDOWS') {
-		    return iconv('cp1252', 'utf-8//IGNORE',$string);
+		    return iconv('cp1252', 'utf-8//IGNORE', $string);
 		}
 		return $string;
 	}
@@ -195,9 +195,9 @@ 
 	 * @param string $string UTF-8 encoded string to encode
 	 * @return string Filesystem encoded string
 	 */
-	public static function encodeUtf8ToFileSystem($string){
+	public static function encodeUtf8ToFileSystem($string) {
 		if (preg_match('//u', $string) && strtoupper(substr(php_uname('s'), 0, 7)) === 'WINDOWS') {
-			return iconv('utf-8', 'cp1252//IGNORE' ,  $string);
+			return iconv('utf-8', 'cp1252//IGNORE', $string);
 		}
 		return $string;
 	}
@@ -210,7 +210,7 @@ 
 	 * @return boolean True if path valid
 	 */
 	public static function isValidPath($filename, $acceptfolder = FALSE) {		
-		if(strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) return true;
+		if (strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) return true;
 		return false;
 	}
 	
@@ -222,7 +222,7 @@ 
 	 * @return array Array of month short names
 	 */
 	public static function getCalendarShortMonths($calendarId = 0) {
-		if(!isset(self::$calendarShortMonths[$calendarId])) {
+		if (!isset(self::$calendarShortMonths[$calendarId])) {
 			$calendar_info = cal_info($calendarId);
 			self::$calendarShortMonths[$calendarId] = $calendar_info['abbrevmonths'];
 		}		
@@ -235,8 +235,8 @@ 
 	 * @param int $sosa Sosa number
 	 * @return number
 	 */
-	public static function getGeneration($sosa){
-		return(int)log($sosa, 2)+1;
+	public static function getGeneration($sosa) {
+		return(int)log($sosa, 2) + 1;
 	}
 	
 	

Braces +21 added lines, -13 removed lines

@@ -116,16 +116,18 @@ 
 		$len_chars = count($chars);
 		$token = '';
 		
-		for ($i = 0; $i < $length; $i++)
-			$token .= $chars[ mt_rand(0, $len_chars - 1) ];
+		for ($i = 0; $i < $length; $i++) {
+					$token .= $chars[ mt_rand(0, $len_chars - 1) ];
+		}
 		
 		# Number of 32 char chunks
 		$chunks = ceil( strlen($token) / 32 );
 		$md5token = '';
 		
 		# Run each chunk through md5
-		for ( $i=1; $i<=$chunks; $i++ )
-			$md5token .= md5( substr($token, $i * 32 - 32, 32) );
+		for ( $i=1; $i<=$chunks; $i++ ) {
+					$md5token .= md5( substr($token, $i * 32 - 32, 32) );
+		}
 		
 			# Trim the token
 		return substr($md5token, 0, $length);		
@@ -140,8 +142,9 @@ 
 	 */
 	public static function encryptToSafeBase64($data){
 		$key = 'STANDARDKEYIFNOSERVER';
-		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
-			$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
+		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE']) {
+					$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
+		}
 		$iv = mcrypt_create_iv(self::ENCRYPTION_IV_SIZE, MCRYPT_RAND);
 		$id = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $data, MCRYPT_MODE_CBC,$iv);
 		$encrypted = base64_encode($iv.$id);
@@ -160,16 +163,19 @@ 
 	 */
 	public static function decryptFromSafeBase64($encrypted){
 		$key = 'STANDARDKEYIFNOSERVER';
-		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE'])
-			$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
+		if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_SOFTWARE']) {
+					$key = md5($_SERVER['SERVER_NAME'].$_SERVER['SERVER_SOFTWARE']);
+		}
 		$encrypted = str_replace('-', '+', $encrypted);
 		$encrypted = str_replace('_', '/', $encrypted);
 		$encrypted = str_replace('*', '=', $encrypted);
 		$encrypted = base64_decode($encrypted);
-		if(!$encrypted)
-			throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
-		if(strlen($encrypted) < self::ENCRYPTION_IV_SIZE) 
-			throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		if(!$encrypted) {
+					throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
+		}
+		if(strlen($encrypted) < self::ENCRYPTION_IV_SIZE) {
+					throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		}
 		$iv_dec = substr($encrypted, 0, self::ENCRYPTION_IV_SIZE);
 		$encrypted = substr($encrypted, self::ENCRYPTION_IV_SIZE);
 		$decrypted = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key, $encrypted, MCRYPT_MODE_CBC, $iv_dec);
@@ -210,7 +216,9 @@ 
 	 * @return boolean True if path valid
 	 */
 	public static function isValidPath($filename, $acceptfolder = FALSE) {		
-		if(strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) return true;
+		if(strpbrk($filename, $acceptfolder ? '?%*:|"<>' : '\\/?%*:|"<>') === FALSE) {
+			return true;
+		}
 		return false;
 	}
 	

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 +1 added lines, -1 removed lines

@@ -78,7 +78,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() . '" />';
 	}
 	
 	/**

Spacing +44 added lines, -44 removed lines

@@ -32,7 +32,7 @@ 
 	 * @return string List of elements
 	 */
 	static public 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];
 		}
 	}
 
@@ -59,11 +59,11 @@ 
 			\Fisharebest\Webtrees\Fact $fact,
 			\MyArtJaub\Webtrees\Map\MapProviderInterface $mapProvider
 	) {
-		$html='';
-		if($place = $fact->getPlace()) {
-			$iconPlace= $mapProvider->getPlaceIcon($place);	
-			if($iconPlace && strlen($iconPlace) > 0){
-				$html.=	'<div class="fact_flag">'. self::htmlPlaceIcon($place, $iconPlace, 50). '</div>';
+		$html = '';
+		if ($place = $fact->getPlace()) {
+			$iconPlace = $mapProvider->getPlaceIcon($place);	
+			if ($iconPlace && strlen($iconPlace) > 0) {
+				$html .= '<div class="fact_flag">'.self::htmlPlaceIcon($place, $iconPlace, 50).'</div>';
 			}
 		}
 		return $html;
@@ -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 $item => $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,22 +188,22 @@ 
 	 * @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) {
+	public static function formatFactDateShort(\Fisharebest\Webtrees\Fact $fact, $anchor = false) {
 		global $SEARCH_SPIDER;
 
-		$html='';
+		$html = '';
 		$date = $fact->getDate();
-		if($date->isOK()){
-			$html.=' '.$date->Display($anchor && !$SEARCH_SPIDER, '%Y');
+		if ($date->isOK()) {
+			$html .= ' '.$date->Display($anchor && !$SEARCH_SPIDER, '%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;
@@ -217,12 +217,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;
+		if ($fact == null) return $html;
 		$place = $fact->getPlace();
-		if($place){
+		if ($place) {
 			$dplace = new Place($place);
 			$html .= $dplace->htmlFormattedName($format, $anchor);
 		}
@@ -240,21 +240,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
 							);
@@ -280,15 +280,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));
@@ -318,7 +318,7 @@ 
 						}
 						break;
 					case 'R':
-						switch($isSourced){
+						switch ($isSourced) {
 							case -1:
 								$image = 'record_notsourced';
 								$title = I18N::translate('%s not sourced', GedcomTag::getLabel($tag));
@@ -339,7 +339,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;

Braces +11 added lines, -7 removed lines

@@ -160,7 +160,9 @@ 
 	public static function htmlIndividualForList(\Fisharebest\Webtrees\Individual $individual, $isStrong = true){
 		$html = '';
 		$tag = 'em';
-		if($isStrong) $tag = 'strong';
+		if($isStrong) {
+			$tag = 'strong';
+		}
 		if($individual && $individual->canShow()){
 			$dindi = new Individual($individual);
 			$html = $individual->getSexImage();
@@ -174,8 +176,7 @@ 
 			$html .= '&nbsp;<span><small><em>'.$dindi->format_first_major_fact(WT_EVENTS_BIRT, 10).'</em></small></span>';
 			$html .= '&nbsp;<span><small><em>'.$dindi->format_first_major_fact(WT_EVENTS_DEAT, 10).'</em></small></span>';
 			$html .= '</a>';
-		}
-		else {
+		} else {
 			$html .= '<span class=\"list_item\"><'.$tag.'>' . I18N::translate('Private') . '</'.$tag.'></span>';
 		}
 		return $html;
@@ -195,8 +196,7 @@ 
 		$date = $fact->getDate();
 		if($date->isOK()){
 			$html.=' '.$date->Display($anchor && !$SEARCH_SPIDER, '%Y');
-		}
-		else{
+		} else{
 			// 1 DEAT Y with no DATE => print YES
 			// 1 BIRT 2 SOUR @S1@ => print YES
 			// 1 DEAT N is not allowed
@@ -220,7 +220,9 @@ 
 	public static function formatFactPlaceShort(\Fisharebest\Webtrees\Fact $fact, $format, $anchor=false){
 		$html='';
 		
-		if ($fact==null) return $html;
+		if ($fact==null) {
+			return $html;
+		}
 		$place = $fact->getPlace();
 		if($place){
 			$dplace = new Place($place);
@@ -339,7 +341,9 @@ 
 					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/Hook/HookInterfaces/CustomSimpleTagManager.php

Doc Comments +2 added lines

@@ -45,6 +45,7 @@ 
 	 * @param string $element_name Element name from the edit interface, used to POST values for update
 	 * @param string $context Tag context
 	 * @param string $contextid Id of tag context
+	 * @return string
 	 */
 	public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null);
 	
@@ -53,6 +54,7 @@ 
 	 * 
 	 * @param string $context Context of the edition
 	 * @param int $level Level to which add the tags
+	 * @return void
 	 */
 	public function hAddSimpleTag($context, $level);
 

Indentation +14 added lines, -14 removed lines

@@ -1,13 +1,13 @@ 
 <?php
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hook
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hook
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 namespace MyArtJaub\Webtrees\Hook\HookInterfaces;
 
 /**
@@ -18,12 +18,12 @@ 
 interface CustomSimpleTagManager {
 
 
-    /**
-     * Returns the list of expected tags, classified by type of records.
-     *
-     * @return array List of expected tags
-     */
-    public function hGetExpectedTags();
+	/**
+	 * Returns the list of expected tags, classified by type of records.
+	 *
+	 * @return array List of expected tags
+	 */
+	public function hGetExpectedTags();
     
 	/**
 	 * Return the HTML code to be display for this tag.

src/Webtrees/Hook/HookInterfaces/FactSourceTextExtender.php

Doc Comments +2 added lines

@@ -19,6 +19,7 @@ 
 	 * Insert some content before the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return string
 	 */
 	public function hFactSourcePrepend($srec);
 	
@@ -26,6 +27,7 @@ 
 	 * Insert some content after the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return void
 	 */
 	public function hFactSourceAppend($srec);
 	

Indentation +8 added lines, -8 removed lines

@@ -1,13 +1,13 @@
 <?php
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hook
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hook
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 namespace MyArtJaub\Webtrees\Hook\HookInterfaces;
 
 /**

src/Webtrees/Hook/HookInterfaces/RecordNameTextExtender.php

Doc Comments +2 added lines

@@ -21,6 +21,7 @@ 
 	 * Insert some content before the record name text.
 	 * 
 	 * @param GedcomRecord $grec Gedcom record
+	 * @return void
 	 */
 	public function hRecordNamePrepend(GedcomRecord $grec);
 	
@@ -28,6 +29,7 @@ 
 	 * Insert some content after the record name text.
 	 * 
 	 * @param GedcomRecord $grec Gedcom record
+	 * @return string
 	 */
 	public function hRecordNameAppend(GedcomRecord $grec);
 	

Indentation +8 added lines, -8 removed lines

@@ -1,13 +1,13 @@
 <?php
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hook
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hook
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2016, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 namespace MyArtJaub\Webtrees\Hook\HookInterfaces;
 
 use Fisharebest\Webtrees\GedcomRecord;

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

@@ -114,29 +114,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;
 	}
 	
 	/**
@@ -145,7 +145,7 @@ 
 	 * @return boolean Is the individual a Sosa ancestor
 	 */
 	public function isSosa(){
-	    return count($this->getSosaNumbers()) > 0;
+		return count($this->getSosaNumbers()) > 0;
 	}
 	
 	/**
@@ -156,11 +156,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;
 	}
 		
 	/** 
@@ -175,10 +175,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->_isdeathsourced != null) return $this->_isdeathsourced;
 		$this->_isdeathsourced = $this->isFactSourced(WT_EVENTS_DEAT);

Spacing +29 added lines, -29 removed lines

@@ -22,7 +22,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 $_unprotectedPrimarySurname = null;
@@ -44,9 +44,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;
@@ -57,18 +57,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()][] = '';
 				}
 			}
 		}
@@ -82,8 +82,8 @@ 
 	 * @return string Primary surname
 	 */
 	public function getUnprotectedPrimarySurname() {
-		if(!$this->_unprotectedPrimarySurname){
-			$tmp=$this->gedcomrecord->getAllNames();
+		if (!$this->_unprotectedPrimarySurname) {
+			$tmp = $this->gedcomrecord->getAllNames();
 			$this->_unprotectedPrimarySurname = $tmp[$this->gedcomrecord->getPrimaryName()]['surname'];
 		}
 		return $this->_unprotectedPrimarySurname;
@@ -95,12 +95,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;
 			}
 		}
@@ -113,8 +113,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;
 	    }
 	
@@ -124,11 +124,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;
@@ -144,7 +144,7 @@ 
 	 *
 	 * @return boolean Is the individual a Sosa ancestor
 	 */
-	public function isSosa(){
+	public function isSosa() {
 	    return count($this->getSosaNumbers()) > 0;
 	}
 	
@@ -155,8 +155,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);	        
 	    }
@@ -168,8 +168,8 @@ 
 	 *
 	 * @return int Level of sources
 	 * */
-	public function isBirthSourced(){
-		if($this->_isbirthsourced != null) return $this->_isbirthsourced;
+	public function isBirthSourced() {
+		if ($this->_isbirthsourced != null) return $this->_isbirthsourced;
 		$this->_isbirthsourced = $this->isFactSourced(WT_EVENTS_BIRT);
 		return $this->_isbirthsourced;
 	}
@@ -179,8 +179,8 @@ 
 	*
 	* @return int Level of sources
 	* */
-	public function isDeathSourced(){
-		if($this->_isdeathsourced != null) return $this->_isdeathsourced;
+	public function isDeathSourced() {
+		if ($this->_isdeathsourced != null) return $this->_isdeathsourced;
 		$this->_isdeathsourced = $this->isFactSourced(WT_EVENTS_DEAT);
 		return $this->_isdeathsourced;
 	}

Braces +8 added lines, -6 removed lines

@@ -66,8 +66,7 @@ 
 				$ct2 = preg_match_all($pattern, $titlefact->getValue(), $match2);
 				if($ct2>0){
 					$this->_titles[$match2[1][0]][]= trim($match2[2][0]);
-				}
-				else{
+				} else{
 					$this->_titles[$titlefact->getValue()][]='';
 				}
 			}
@@ -99,8 +98,7 @@ 
 		if($bplace = $this->gedcomrecord->getBirthPlace()){
 			if($perc){
 				return array ($bplace, 1);
-			}
-			else{
+			} else{
 				return $bplace;
 			}
 		}
@@ -169,7 +167,9 @@ 
 	 * @return int Level of sources
 	 * */
 	public function isBirthSourced(){
-		if($this->_isbirthsourced != null) return $this->_isbirthsourced;
+		if($this->_isbirthsourced != null) {
+			return $this->_isbirthsourced;
+		}
 		$this->_isbirthsourced = $this->isFactSourced(WT_EVENTS_BIRT);
 		return $this->_isbirthsourced;
 	}
@@ -180,7 +180,9 @@ 
 	* @return int Level of sources
 	* */
 	public function isDeathSourced(){
-		if($this->_isdeathsourced != null) return $this->_isdeathsourced;
+		if($this->_isdeathsourced != null) {
+			return $this->_isdeathsourced;
+		}
 		$this->_isdeathsourced = $this->isFactSourced(WT_EVENTS_DEAT);
 		return $this->_isdeathsourced;
 	}

src/Webtrees/Module/AdminTasks/AdminConfigController.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 use Fisharebest\Webtrees\Controller\AjaxController;
 use Fisharebest\Webtrees\Controller\PageController;
 use Fisharebest\Webtrees\Filter;
-use Fisharebest\Webtrees\Html;
 use Fisharebest\Webtrees\I18N;
 use Fisharebest\Webtrees\Log;
 use Fisharebest\Webtrees\Module;

Indentation +88 added lines, -88 removed lines

@@ -35,37 +35,37 @@ 
  */
 class AdminConfigController extends MvcController
 {    
-    /**
-     * Tasks Provider
-     * @var TaskProviderInterface $provider
-     */
-    protected $provider;    
+	/**
+	 * Tasks Provider
+	 * @var TaskProviderInterface $provider
+	 */
+	protected $provider;    
     
-    /**
-     * Constructor for Admin Config controller
-     * @param AbstractModule $module
-     */
-    public function __construct(AbstractModule $module) {
-        parent::__construct($module);
+	/**
+	 * Constructor for Admin Config controller
+	 * @param AbstractModule $module
+	 */
+	public function __construct(AbstractModule $module) {
+		parent::__construct($module);
         
-        $this->provider = $this->module->getProvider();
-    }    
+		$this->provider = $this->module->getProvider();
+	}    
     
-    /**
-     * Pages
-     */
+	/**
+	 * Pages
+	 */
         
-    /**
-     * AdminConfig@index
-     */
-    public function index() {
-        global $WT_TREE;
+	/**
+	 * AdminConfig@index
+	 */
+	public function index() {
+		global $WT_TREE;
         
-        Theme::theme(new AdministrationTheme)->init($WT_TREE);
-        $controller = new PageController();
-        $controller
-            ->restrictAccess(Auth::isAdmin())
-            ->setPageTitle($this->module->getTitle());
+		Theme::theme(new AdministrationTheme)->init($WT_TREE);
+		$controller = new PageController();
+		$controller
+			->restrictAccess(Auth::isAdmin())
+			->setPageTitle($this->module->getTitle());
 			
 		$token = $this->module->getSetting('MAJ_AT_FORCE_EXEC_TOKEN');
 		if(is_null($token)) {
@@ -73,11 +73,11 @@ 
 			$this->module->setSetting('PAT_FORCE_EXEC_TOKEN', $token);
 		}
         
-        $data = new ViewBag();
-        $data->set('title', $controller->getPageTitle());
+		$data = new ViewBag();
+		$data->set('title', $controller->getPageTitle());
         
-        $table_id = 'table-admintasks-' . Uuid::uuid4();
-        $data->set('table_id', $table_id);
+		$table_id = 'table-admintasks-' . Uuid::uuid4();
+		$data->set('table_id', $table_id);
 		
 		$data->set('trigger_url_root', WT_BASE_URL.'module.php?mod='.$this->module->getName().'&mod_action=Task@trigger');
 		$token = $this->module->getSetting('MAJ_AT_FORCE_EXEC_TOKEN');
@@ -90,9 +90,9 @@ 
 		$this->provider->getInstalledTasks();
 		
 		$controller
-            ->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL)
-            ->addExternalJavascript(WT_DATATABLES_BOOTSTRAP_JS_URL)
-            ->addInlineJavascript('
+			->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL)
+			->addExternalJavascript(WT_DATATABLES_BOOTSTRAP_JS_URL)
+			->addInlineJavascript('
                 //Datatable initialisation
 				jQuery.fn.dataTableExt.oSort["unicode-asc"  ]=function(a,b) {return a.replace(/<[^<]*>/, "").localeCompare(b.replace(/<[^<]*>/, ""))};
 				jQuery.fn.dataTableExt.oSort["unicode-desc" ]=function(a,b) {return b.replace(/<[^<]*>/, "").localeCompare(a.replace(/<[^<]*>/, ""))};
@@ -124,7 +124,7 @@ 
 				});
                 
                 ')
-                ->addInlineJavascript('					
+				->addInlineJavascript('					
 					function generate_force_token() {
 						jQuery("#bt_genforcetoken").attr("disabled", "disabled");
 						jQuery("#bt_tokentext").empty().html("<i class=\"fa fa-spinner fa-pulse fa-fw\"></i>");
@@ -172,56 +172,56 @@ 
                     } 
                 ');
         
-        ViewFactory::make('AdminConfig', $this, $controller, $data)->render();
-    }
+		ViewFactory::make('AdminConfig', $this, $controller, $data)->render();
+	}
     
-    /**
-     * AdminConfig@jsonTasksList
-     */
-    public function jsonTasksList() {
-        global $WT_TREE;
+	/**
+	 * AdminConfig@jsonTasksList
+	 */
+	public function jsonTasksList() {
+		global $WT_TREE;
     
-        $controller = new JsonController();
-        $controller
-            ->restrictAccess(Auth::isAdmin());
+		$controller = new JsonController();
+		$controller
+			->restrictAccess(Auth::isAdmin());
     
-        // Generate an AJAX/JSON response for datatables to load a block of rows
-        $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
-        $start  = Filter::postInteger('start');
-        $length = Filter::postInteger('length');
-        $order  = Filter::postArray('order');
+		// Generate an AJAX/JSON response for datatables to load a block of rows
+		$search = Filter::postArray('search');
+		if($search) $search = $search['value'];
+		$start  = Filter::postInteger('start');
+		$length = Filter::postInteger('length');
+		$order  = Filter::postArray('order');
     
 		$order_by_name = false;
-        foreach($order as $key => &$value) {
-            switch($value['column']) {
-                case 3:
+		foreach($order as $key => &$value) {
+			switch($value['column']) {
+				case 3:
 					$order_by_name = true;
-                    unset($order[$key]);
-                    break;
-                case 4;
+					unset($order[$key]);
+					break;
+				case 4;
 					$value['column'] = 'majat_last_run';
 					break;
 				case 4;
 					$value['column'] = 'majat_last_result';
 					break;
-                default:
-                    unset($order[$key]);
-            }
-        }
+				default:
+					unset($order[$key]);
+			}
+		}
     
-        $list = $this->provider->getFilteredTasksList($search, $order, $start, $length);
+		$list = $this->provider->getFilteredTasksList($search, $order, $start, $length);
 		if($order_by_name) {
 			usort($list, function(AbstractTask $a, AbstractTask $b) { return I18N::strcasecmp($a->getTitle(), $b->getTitle()); });
 		}
-        $recordsFiltered = count($list);
-        $recordsTotal = $this->provider->getTasksCount();
+		$recordsFiltered = count($list);
+		$recordsTotal = $this->provider->getTasksCount();
     
-        $data = array();
-        foreach($list as $task) {    
-            $datum = array();
+		$data = array();
+		foreach($list as $task) {    
+			$datum = array();
 			
-            $datum[0] = '
+			$datum[0] = '
                 <div class="btn-group">
                     <button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
                         <i class="fa fa-pencil"></i><span class="caret"></span>
@@ -239,50 +239,50 @@ 
                        </li>
                     </ul>
                 </div>';
-            $datum[1] = $task->getName();
-            $datum[2] = $task->isEnabled() ? 
+			$datum[1] = $task->getName();
+			$datum[2] = $task->isEnabled() ? 
 				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : 
 				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
-            $datum[3] = $task->getTitle();
-            $date_format = str_replace('%', '', I18N::dateFormat()) . ' H:i:s';
+			$datum[3] = $task->getTitle();
+			$date_format = str_replace('%', '', I18N::dateFormat()) . ' H:i:s';
 			$datum[4] = $task->getLastUpdated()->format($date_format);
-            $datum[5] = $task->isLastRunSuccess() ? 
+			$datum[5] = $task->isLastRunSuccess() ? 
 				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : 
 				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
-            $dtF = new \DateTime('@0');
-            $dtT = new \DateTime('@' . ($task->getFrequency() * 60));            
-            $datum[6] = $dtF->diff($dtT)->format(I18N::translate('%a d %h h %i m'));
+			$dtF = new \DateTime('@0');
+			$dtT = new \DateTime('@' . ($task->getFrequency() * 60));            
+			$datum[6] = $dtF->diff($dtT)->format(I18N::translate('%a d %h h %i m'));
 			$datum[7] = $task->getRemainingOccurrences() > 0 ? I18N::number($task->getRemainingOccurrences()) : I18N::translate('Unlimited');
 			$datum[8] = $task->isRunning() ? 
 				'<i class="fa fa-cog fa-spin fa-fw"></i><span class="sr-only">'.I18N::translate('Running').'</span>' : 
 				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Not running').'</span>';
 			if($task->isEnabled() && !$task->isRunning()) {
-			    $datum[9] = '
+				$datum[9] = '
     			    <button id="bt_runtask_'. $task->getName() .'" class="btn btn-primary" href="#" onclick="return run_admintask(\''. $task->getName() .'\')">
     			         <div id="bt_runtasktext_'. $task->getName() .'"><i class="fa fa-cog fa-fw" ></i>' . I18N::translate('Run') . '</div>
     			    </button>';
 			}
 			else {
-			    $datum[9] = '';
+				$datum[9] = '';
 			}			    
 						
-            $data[] = $datum;
-        }
+			$data[] = $datum;
+		}
     
-        $controller->pageHeader();
+		$controller->pageHeader();
     
-        echo \Zend_Json::encode(array(
-            'draw'            => Filter::getInteger('draw'),
-            'recordsTotal'    => $recordsTotal,
-            'recordsFiltered' => $recordsFiltered,
-            'data'            => $data
-        ));
+		echo \Zend_Json::encode(array(
+			'draw'            => Filter::getInteger('draw'),
+			'recordsTotal'    => $recordsTotal,
+			'recordsFiltered' => $recordsFiltered,
+			'data'            => $data
+		));
     
-    }
+	}
 		
 	/**
 	 * AdminConfig@generateToken
-     *
+	 *
 	 * Ajax call to generate a new token. Display the token, if generated.
 	 * Tokens call only be generated by a site administrator.
 	 *

Spacing +22 added lines, -25 removed lines

@@ -68,7 +68,7 @@ 
             ->setPageTitle($this->module->getTitle());
 			
 		$token = $this->module->getSetting('MAJ_AT_FORCE_EXEC_TOKEN');
-		if(is_null($token)) {
+		if (is_null($token)) {
 			$token = Functions::generateRandomToken();
 			$this->module->setSetting('PAT_FORCE_EXEC_TOKEN', $token);
 		}
@@ -76,12 +76,12 @@ 
         $data = new ViewBag();
         $data->set('title', $controller->getPageTitle());
         
-        $table_id = 'table-admintasks-' . Uuid::uuid4();
+        $table_id = 'table-admintasks-'.Uuid::uuid4();
         $data->set('table_id', $table_id);
 		
 		$data->set('trigger_url_root', WT_BASE_URL.'module.php?mod='.$this->module->getName().'&mod_action=Task@trigger');
 		$token = $this->module->getSetting('MAJ_AT_FORCE_EXEC_TOKEN');
-		if(is_null($token)) {
+		if (is_null($token)) {
 			$token = Functions::generateRandomToken();
 			$this->module->setSetting('MAJ_AT_FORCE_EXEC_TOKEN', $token);
 		}
@@ -106,7 +106,7 @@ 
                     processing: true,
                     serverSide : true,
 					ajax : {
-						url : "module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@jsonTasksList&ged='. $WT_TREE->getNameUrl().'",
+						url : "module.php?mod='.$this->module->getName().'&mod_action=AdminConfig@jsonTasksList&ged='.$WT_TREE->getNameUrl().'",
                         type : "POST"
 					},
                     columns: [
@@ -143,14 +143,14 @@ 
                             url: "module.php", 
                             type: "GET",
                             data: {
-                			    mod: "' . $this->module->getName() .'",
+                			    mod: "' . $this->module->getName().'",
                                 mod_action:  "Task@setStatus",
                 			    task: task,
                                 status: status
                             },
                             error: function(result, stat, error) {
                                 var err = typeof result.responseJSON === "undefined" ? error : result.responseJSON.error;
-                                alert("' . I18N::translate('An error occured while editing this task:') . '" + err);
+                                alert("' . I18N::translate('An error occured while editing this task:').'" + err);
                             },
                             complete: function(result, stat) {
                                 adminTasksTable.ajax.reload(null, false);
@@ -187,14 +187,14 @@ 
     
         // Generate an AJAX/JSON response for datatables to load a block of rows
         $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
+        if ($search) $search = $search['value'];
         $start  = Filter::postInteger('start');
         $length = Filter::postInteger('length');
         $order  = Filter::postArray('order');
     
 		$order_by_name = false;
-        foreach($order as $key => &$value) {
-            switch($value['column']) {
+        foreach ($order as $key => &$value) {
+            switch ($value['column']) {
                 case 3:
 					$order_by_name = true;
                     unset($order[$key]);
@@ -211,14 +211,14 @@ 
         }
     
         $list = $this->provider->getFilteredTasksList($search, $order, $start, $length);
-		if($order_by_name) {
+		if ($order_by_name) {
 			usort($list, function(AbstractTask $a, AbstractTask $b) { return I18N::strcasecmp($a->getTitle(), $b->getTitle()); });
 		}
         $recordsFiltered = count($list);
         $recordsTotal = $this->provider->getTasksCount();
     
         $data = array();
-        foreach($list as $task) {    
+        foreach ($list as $task) {    
             $datum = array();
 			
             $datum[0] = '
@@ -229,37 +229,34 @@ 
                     <ul class="dropdown-menu" role="menu">
                        <li>
                             <a href="#" onclick="return set_admintask_status(\''. $task->getName().'\', '.($task->isEnabled() ? 'false' : 'true').');">
-                                <i class="fa fa-fw '.($task->isEnabled() ? 'fa-times' : 'fa-check').'"></i> ' . ($task->isEnabled() ? I18N::translate('Disable') : I18N::translate('Enable')) . '
+                                <i class="fa fa-fw '.($task->isEnabled() ? 'fa-times' : 'fa-check').'"></i> '.($task->isEnabled() ? I18N::translate('Disable') : I18N::translate('Enable')).'
                             </a>
                        </li>
                         <li>
-                            <a href="module.php?mod='.$this->module->getName().'&mod_action=Task@edit&task='. $task->getName().'">
-                                <i class="fa fa-fw fa-pencil"></i> ' . I18N::translate('Edit') . '
+                            <a href="module.php?mod='.$this->module->getName().'&mod_action=Task@edit&task='.$task->getName().'">
+                                <i class="fa fa-fw fa-pencil"></i> ' . I18N::translate('Edit').'
                             </a>
                        </li>
                     </ul>
                 </div>';
             $datum[1] = $task->getName();
             $datum[2] = $task->isEnabled() ? 
-				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : 
-				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
+				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Enabled').'</span>' : '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Disabled').'</span>';
             $datum[3] = $task->getTitle();
-            $date_format = str_replace('%', '', I18N::dateFormat()) . ' H:i:s';
+            $date_format = str_replace('%', '', I18N::dateFormat()).' H:i:s';
 			$datum[4] = $task->getLastUpdated()->format($date_format);
             $datum[5] = $task->isLastRunSuccess() ? 
-				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : 
-				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
+				'<i class="fa fa-check"></i><span class="sr-only">'.I18N::translate('Yes').'</span>' : '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('No').'</span>';
             $dtF = new \DateTime('@0');
-            $dtT = new \DateTime('@' . ($task->getFrequency() * 60));            
+            $dtT = new \DateTime('@'.($task->getFrequency() * 60));            
             $datum[6] = $dtF->diff($dtT)->format(I18N::translate('%a d %h h %i m'));
 			$datum[7] = $task->getRemainingOccurrences() > 0 ? I18N::number($task->getRemainingOccurrences()) : I18N::translate('Unlimited');
 			$datum[8] = $task->isRunning() ? 
-				'<i class="fa fa-cog fa-spin fa-fw"></i><span class="sr-only">'.I18N::translate('Running').'</span>' : 
-				'<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Not running').'</span>';
-			if($task->isEnabled() && !$task->isRunning()) {
+				'<i class="fa fa-cog fa-spin fa-fw"></i><span class="sr-only">'.I18N::translate('Running').'</span>' : '<i class="fa fa-times"></i><span class="sr-only">'.I18N::translate('Not running').'</span>';
+			if ($task->isEnabled() && !$task->isRunning()) {
 			    $datum[9] = '
-    			    <button id="bt_runtask_'. $task->getName() .'" class="btn btn-primary" href="#" onclick="return run_admintask(\''. $task->getName() .'\')">
-    			         <div id="bt_runtasktext_'. $task->getName() .'"><i class="fa fa-cog fa-fw" ></i>' . I18N::translate('Run') . '</div>
+    			    <button id="bt_runtask_'. $task->getName().'" class="btn btn-primary" href="#" onclick="return run_admintask(\''.$task->getName().'\')">
+    			         <div id="bt_runtasktext_'. $task->getName().'"><i class="fa fa-cog fa-fw" ></i>'.I18N::translate('Run').'</div>
     			    </button>';
 			}
 			else {

Braces +4 added lines, -3 removed lines

@@ -187,7 +187,9 @@ 
     
         // Generate an AJAX/JSON response for datatables to load a block of rows
         $search = Filter::postArray('search');
-        if($search) $search = $search['value'];
+        if($search) {
+        	$search = $search['value'];
+        }
         $start  = Filter::postInteger('start');
         $length = Filter::postInteger('length');
         $order  = Filter::postArray('order');
@@ -261,8 +263,7 @@ 
     			    <button id="bt_runtask_'. $task->getName() .'" class="btn btn-primary" href="#" onclick="return run_admintask(\''. $task->getName() .'\')">
     			         <div id="bt_runtasktext_'. $task->getName() .'"><i class="fa fa-cog fa-fw" ></i>' . I18N::translate('Run') . '</div>
     			    </button>';
-			}
-			else {
+			} else {
 			    $datum[9] = '';
 			}