Issues in SRF_Hash.php - All Issues - Inspection of "Gallery: Remove feature switch, always use Traditi..." - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b2ed5...981814 )

by Jeroen De

created 2018-10-18 23:07 UTC

formats/array/SRF_Hash.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * Query format for arrays with features for Extensions 'Arrays' and 'HashTables'
 *
 * @file
 * @ingroup SemanticResultFormats
 * @author Daniel Werner < [email protected] >
 *
 * Doesn't require 'Arrays' nor 'HashTables' exytensions but has additional features
 * ('name' parameter in either result format) if they are available.
 *
 * Arrays 2.0+ and HashTables 1.0+ are recommended but not necessary.
 */
class SRFHash extends SRFArray {

	protected $mLastPageTitle;

	protected function deliverPageTitle( $value, $link = false ) {
		$this->mLastPageTitle = $this->deliverSingleValue( $value, $link ); //remember the page title
		return null; //don't add page title into property list
	}

	protected function deliverPageProperties( $perProperty_items ) {
		if ( count( $perProperty_items ) < 1 ) {
			return null;
		}
		return [ $this->mLastPageTitle, implode( $this->mPropSep, $perProperty_items ) ];
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	protected function deliverQueryResultPages( $perPage_items ) {
		$hash = [];
		foreach ( $perPage_items as $page ) {
			$hash[$page[0]] = $page[1];  //name of page as key, Properties as value
		}
		return parent::deliverQueryResultPages( $hash );
	}

	protected function createArray( $hash ) {
		global $wgHashTables;

		$hashId = $this->mArrayName;
		$version = null;
		if ( defined( 'ExtHashTables::VERSION' ) ) {
			$version = ExtHashTables::VERSION;
		}
		if ( $version !== null && version_compare( $version, '0.999', '>=' ) ) {
			// Version 1.0+, doesn't use $wgHashTables anymore
			global $wgParser;
			/** ToDo: is there a way to get the actual parser which has started the query? */
			ExtHashTables::get( $wgParser )->createHash( $hashId, $hash );
		} elseif ( !isset( $wgHashTables ) ) {
			// Hash extension is not installed in this wiki
			return false;
		} elseif ( $version !== null && version_compare( $version, '0.6', '>=' ) ) {
			// HashTables 0.6 to 1.0
			$wgHashTables->createHash( $hashId, $hash );
		} else {
			// old HashTables, dirty way
			$wgHashTables->mHashTables[trim( $hashId )] = $hash;
		}
		return true;
	}

	protected function handleParameters( array $params, $outputmode ) {
		parent::handleParameters( $params, $outputmode );
		$this->mShowPageTitles = true;
	}

	/**
	 * @see SMWResultPrinter::getParamDefinitions
	 *
	 * @since 1.8
	 *
	 * @param IParamDefinition[] $definitions
	 *
	 * @return array of IParamDefinition|array
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		unset( $params['pagetitle'] ); // page title is Hash key, otherwise, just use Array format!
		$params['name']['message'] = 'srf_paramdesc_hashname';

		return $params;
	}

}


1			<?php
2
3			/**
4			* Query format for arrays with features for Extensions 'Arrays' and 'HashTables'
5			*
6			* @file
7			* @ingroup SemanticResultFormats
8			* @author Daniel Werner < [email protected] >
9			*
10			* Doesn't require 'Arrays' nor 'HashTables' exytensions but has additional features
11			* ('name' parameter in either result format) if they are available.
12			*
13			* Arrays 2.0+ and HashTables 1.0+ are recommended but not necessary.
14			*/
15			class SRFHash extends SRFArray {
16
17			protected $mLastPageTitle;
18
19			protected function deliverPageTitle( $value, $link = false ) {
20			$this->mLastPageTitle = $this->deliverSingleValue( $value, $link ); //remember the page title
21			return null; //don't add page title into property list
22			}
23
24			protected function deliverPageProperties( $perProperty_items ) {
25			if ( count( $perProperty_items ) < 1 ) {
26			return null;
27			}
28			return [ $this->mLastPageTitle, implode( $this->mPropSep, $perProperty_items ) ];
			0 ignored issues – show Bug Best Practice introduced 2015-11-28 10:35 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return array($this->mLas..., $perProperty_items));` (`string[]`) is incompatible with the return type of the parent method `SRFArray::deliverPageProperties` of type `null\|string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
29			}
30
31			protected function deliverQueryResultPages( $perPage_items ) {
32			$hash = [];
33			foreach ( $perPage_items as $page ) {
34			$hash[$page[0]] = $page[1]; //name of page as key, Properties as value
35			}
36			return parent::deliverQueryResultPages( $hash );
37			}
38
39			protected function createArray( $hash ) {
40			global $wgHashTables;
41
42			$hashId = $this->mArrayName;
43			$version = null;
44			if ( defined( 'ExtHashTables::VERSION' ) ) {
45			$version = ExtHashTables::VERSION;
46			}
47			if ( $version !== null && version_compare( $version, '0.999', '>=' ) ) {
48			// Version 1.0+, doesn't use $wgHashTables anymore
49			global $wgParser;
50			/** ToDo: is there a way to get the actual parser which has started the query? */
51			ExtHashTables::get( $wgParser )->createHash( $hashId, $hash );
52			} elseif ( !isset( $wgHashTables ) ) {
53			// Hash extension is not installed in this wiki
54			return false;
55			} elseif ( $version !== null && version_compare( $version, '0.6', '>=' ) ) {
56			// HashTables 0.6 to 1.0
57			$wgHashTables->createHash( $hashId, $hash );
58			} else {
59			// old HashTables, dirty way
60			$wgHashTables->mHashTables[trim( $hashId )] = $hash;
61			}
62			return true;
63			}
64
65			protected function handleParameters( array $params, $outputmode ) {
66			parent::handleParameters( $params, $outputmode );
67			$this->mShowPageTitles = true;
68			}
69
70			/**
71			* @see SMWResultPrinter::getParamDefinitions
72			*
73			* @since 1.8
74			*
75			* @param IParamDefinition[] $definitions
76			*
77			* @return array of IParamDefinition\|array
78			*/
79			public function getParamDefinitions( array $definitions ) {
80			$params = parent::getParamDefinitions( $definitions );
81
82			unset( $params['pagetitle'] ); // page title is Hash key, otherwise, just use Array format!
83			$params['name']['message'] = 'srf_paramdesc_hashname';
84
85			return $params;
86			}
87
88			}
89

SemanticMediaWiki / SemanticResultFormats

Push — master ( 9b2ed5...981814 )

formats/array/SRF_Hash.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like