Version 5.0.0 beta 4

applications/convert/sources/Software/Core/Smf.php

@@ -49,9 +49,9 @@ class Smf extends Software
 	/**
 	 * Software Name
 	 *
-	 * @return	string
+	 * @return    string
 	 */
-	public static function softwareName()
+	public static function softwareName(): string
 	{
 		/* Child classes must override this method */
 		return "Simple Machines Forum (2.0.x)";
@@ -60,9 +60,9 @@ class Smf extends Software
 	/**
 	 * Software Key
 	 *
-	 * @return	string
+	 * @return    string
 	 */
-	public static function softwareKey()
+	public static function softwareKey(): string
 	{
 		/* Child classes must override this method */
 		return "smf";
@@ -71,9 +71,9 @@ class Smf extends Software
 	/**
 	 * Content we can convert from this software. 
 	 *
-	 * @return	array
+	 * @return    array|null
 	 */
-	public static function canConvert()
+	public static function canConvert(): ?array
 	{
 		return array(
 			'convertBanfilters'			=> array(
@@ -114,9 +114,9 @@ class Smf extends Software
 	/**
 	 * Can we convert passwords from this software.
 	 *
-	 * @return 	boolean
+	 * @return    boolean
 	 */
-	public static function loginEnabled()
+	public static function loginEnabled(): bool
 	{
 		return TRUE;
 	}
@@ -124,9 +124,9 @@ class Smf extends Software
 	/**
 	 * List of conversion methods that require additional information
 	 *
-	 * @return	array
+	 * @return    array
 	 */
-	public static function checkConf()
+	public static function checkConf(): array
 	{
 		return array(
 			'convertEmoticons',
@@ -139,13 +139,13 @@ class Smf extends Software
 	/**
 	 * Count Source Rows for a specific step
 	 *
-	 * @param	string		$table		The table containing the rows to count.
-	 * @param	array|NULL	$where		WHERE clause to only count specific rows, or NULL to count all.
-	 * @param	bool		$recache	Skip cache and pull directly (updating cache)
-	 * @return	integer
+	 * @param string $table		The table containing the rows to count.
+	 * @param string|array|NULL $where		WHERE clause to only count specific rows, or NULL to count all.
+	 * @param bool $recache	Skip cache and pull directly (updating cache)
+	 * @return    integer
 	 * @throws	\IPS\convert\Exception
 	 */
-	public function countRows( $table, $where=NULL, $recache=FALSE )
+	public function countRows( string $table, string|array|null $where=NULL, bool $recache=FALSE ): int
 	{
 		switch( $table )
 		{
@@ -162,21 +162,19 @@ class Smf extends Software
 				{
 					throw new \IPS\convert\Exception( sprintf( Member::loggedIn()->language()->get( 'could_not_count_rows' ), $table ) );
 				}
-				break;
 			
 			default:
 				return parent::countRows( $table, $where, $recache );
-				break;
 		}
 	}
 	
 	/**
 	 * Get More Information
 	 *
-	 * @param	string	$method	Conversion method
-	 * @return	array
+	 * @param string $method	Conversion method
+	 * @return    array|null
 	 */
-	public function getMoreInfo( $method )
+	public function getMoreInfo( string $method ): ?array
 	{
 		$return = array();
 		switch( $method )
@@ -306,9 +304,9 @@ class Smf extends Software
 	/**
 	 * Finish - Adds everything it needs to the queues and clears data store
 	 *
-	 * @return	array		Messages to display
+	 * @return    array        Messages to display
 	 */
-	public function finish()
+	public function finish(): array
 	{
 		/* Search Index Rebuild */
 		Index::i()->rebuild();
@@ -337,9 +335,9 @@ class Smf extends Software
 	/**
 	 * Pre-process content for the Invision Community text parser
 	 *
-	 * @param	string			The post
-	 * @param	string|null		Content Classname passed by post-conversion rebuild
-	 * @param	int|null		Content ID passed by post-conversion rebuild
+	 * @param	string			$post	The post
+	 * @param	string|null		$className Classname passed by post-conversion rebuild
+	 * @param	int|null		$contentId ID passed by post-conversion rebuild
 	 * @return	string			The converted post
 	 */
 	public static function fixPostData( string $post, ?string $className=null, ?int $contentId=null ): string
@@ -364,7 +362,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertBanfilters()
+	public function convertBanfilters() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -406,7 +404,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertEmoticons()
+	public function convertEmoticons() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -435,7 +433,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertPrivateMessages()
+	public function convertPrivateMessages() : void
 	{
 		$libraryClass = $this->getLibrary();
 
@@ -493,7 +491,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertPrivateMessageReplies()
+	public function convertPrivateMessageReplies() : void
 	{
 		$libraryClass = $this->getLibrary();
 
@@ -518,7 +516,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertProfileFields()
+	public function convertProfileFields() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -580,7 +578,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertGroups()
+	public function convertGroups() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -627,7 +625,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertMembers()
+	public function convertMembers() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -866,7 +864,7 @@ class Smf extends Software
 	 *
 	 * @return 	void
 	 */
-	public function convertIgnoredUsers()
+	public function convertIgnoredUsers() : void
 	{
 		$libraryClass = $this->getLibrary();
 		
@@ -900,10 +898,10 @@ class Smf extends Software
 	/**
 	 * Check if we can redirect the legacy URLs from this software to the new locations
 	 *
-	 * @return	NULL|Url
+	 * @return    Url|NULL
 	 * @note	Current profile URL format: /index.php?action=profile;u=123
 	 */
-	public function checkRedirects()
+	public function checkRedirects(): ?Url
 	{
 		/* If we can't access profiles, don't bother trying to redirect */
 		if( !Member::loggedIn()->canAccessModule( Module::get( 'core', 'members' ) ) )
@@ -954,7 +952,7 @@ class Smf extends Software
 	 * @param	string			$password		Password from form
 	 * @return	bool
 	 */
-	public static function login( $member, $password )
+	public static function login( Member $member, string $password ) : bool
 	{
 		if ( Login::compareHashes( $member->conv_password, sha1( mb_strtolower( $member->name ) . html_entity_decode( $password ) ) ) )
 		{