SemanticMediaWiki / SemanticMediaWiki

src/Query/Language/ClassDescription.php

Doc Comments +4 added lines

@@ -99,6 +99,10 @@
 		return SMW_CATEGORY_QUERY;
 	}
 
+	/**
+	 * @param integer $maxsize
+	 * @param integer $maxdepth
+	 */
 	public function prune( &$maxsize, &$maxdepth, &$log ) {
 
 		if ( $maxsize >= $this->getSize() ) {

src/Query/PrintRequest.php

Doc Comments +5 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 	 * @param integer $mode a constant defining what to printout
 	 * @param string $label the string label to describe this printout
 	 * @param mixed $data optional data for specifying some request, might be a property object, title, or something else; interpretation depends on $mode
-	 * @param mixed $outputformat optional string for specifying an output format, e.g. an output unit
+	 * @param string $outputformat optional string for specifying an output format, e.g. an output unit
 	 * @param array|null $params optional array of further, named parameters for the print request
 	 */
 	public function __construct( $mode, $label, $data = null, $outputformat = false, array $params = null ) {
@@ -129,6 +129,8 @@ 
 
 	/**
 	 * Convenience method for accessing the text in either HTML or Wiki format.
+	 * @param integer $outputmode
+	 * @return string
 	 */
 	public function getText( $outputmode, $linker = null ) {
 		switch ( $outputmode ) {
@@ -266,7 +268,7 @@ 
 	/**
 	 * Returns the value of a named parameter.
 	 *
-	 * @param $key string the name of the parameter key
+	 * @param string $key string the name of the parameter key
 	 *
 	 * @return string Value of the paramer, if set (else FALSE)
 	 */
@@ -286,7 +288,7 @@ 
 	/**
 	 * Sets a print request parameter.
 	 *
-	 * @param $key string Name of the parameter
+	 * @param string $key string Name of the parameter
 	 * @param $value string Value for the parameter
 	 */
 	public function setParameter( $key, $value ) {

src/Query/ProfileAnnotator/NullProfileAnnotator.php

Doc Comments +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @return array
+	 * @return DIProperty
 	 */
 	public function getProperty() {
 		return new DIProperty( '_ASK' );
@@ -59,7 +59,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @return SemanticData
+	 * @return \SMWDIContainer
 	 */
 	public function getContainer() {
 		return $this->subobject->getContainer();
@@ -70,7 +70,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @return SemanticData
+	 * @return \SMWContainerSemanticData
 	 */
 	public function getSemanticData() {
 		return $this->subobject->getSemanticData();

src/SPARQLStore/QueryEngine/CompoundConditionBuilder.php

Doc Comments +3 added lines, -1 removed lines

@@ -442,7 +442,6 @@ 
 	 * Extend the given SPARQL condition by a suitable order by variable,
 	 * possibly adding conditions if required for the type of data.
 	 *
-	 * @param Condition $sparqlCondition condition to modify
 	 * @param string $mainVariable the variable that represents the value to be ordered
 	 * @param integer $diType DataItem type id
 	 */
@@ -487,6 +486,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $propertyKey
+	 */
 	private function addOrderForUnknownPropertyKey( Condition &$condition, $propertyKey ) {
 
 		if ( $propertyKey === '' ) { // order by result page sortkey

Unused Use Statements -3 removed lines

@@ -8,14 +8,12 @@ 
 use SMW\DIWikiPage;
 use SMW\CircularReferenceGuard;
 use SMW\PropertyHierarchyLookup;
-use SMW\SPARQLStore\HierarchyFinder;
 use SMW\Query\Language\Description;
 use SMW\Query\Language\SomeProperty;
 use SMW\Query\Language\ThingDescription;
 use SMW\SPARQLStore\QueryEngine\Condition\Condition;
 use SMW\SPARQLStore\QueryEngine\Condition\SingletonCondition;
 use SMW\SPARQLStore\QueryEngine\Condition\TrueCondition;
-
 use SMW\SPARQLStore\QueryEngine\Interpreter\DispatchingDescriptionInterpreter;
 use SMW\SPARQLStore\QueryEngine\Interpreter\ClassDescriptionInterpreter;
 use SMW\SPARQLStore\QueryEngine\Interpreter\ThingDescriptionInterpreter;
@@ -25,7 +23,6 @@ 
 use SMW\SPARQLStore\QueryEngine\Interpreter\NamespaceDescriptionInterpreter;
 use SMW\SPARQLStore\QueryEngine\Interpreter\ValueDescriptionInterpreter;
 use SMW\SPARQLStore\QueryEngine\Interpreter\ConceptDescriptionInterpreter;
-
 use SMWDataItem as DataItem;
 use SMWExpElement as ExpElement;
 use SMWExpNsResource as ExpNsResource;

src/SPARQLStore/QueryEngine/Interpreter/ClassDescriptionInterpreter.php

Doc Comments +6 added lines

@@ -82,6 +82,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function mapCategoriesToConditionElements( array $categories, $joinVariable ) {
 
 		$condition = '';
@@ -109,6 +112,9 @@ 
 		return array( $condition, $namespaces );
 	}
 
+	/**
+	 * @param string $categoryExpName
+	 */
 	private function tryToAddClassHierarchyPattern( $category, &$categoryExpName ) {
 
 		if ( !$this->compoundConditionBuilder->canUseQFeature( SMW_SPARQL_QF_SUBC ) ) {

src/SPARQLStore/QueryEngine/Interpreter/ConjunctionInterpreter.php

Doc Comments +10 added lines

@@ -100,6 +100,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doPreliminarySubDescriptionCheck( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		$count = count( $subDescriptions );
@@ -126,6 +130,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function doResolveSubDescriptionsRecursively( $subDescriptions, $joinVariable ) {
 
 		// Using a stdClass as data container for simpler handling in follow-up tasks
@@ -195,6 +202,9 @@ 
 		return $subConditionElements;
 	}
 
+	/**
+	 * @param \stdClass $subConditionElements
+	 */
 	private function createConditionFromSubConditionElements( $subConditionElements ) {
 
 		if ( $subConditionElements->singletonMatchElement instanceof ExpElement ) {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMW\Query\Language\Description;
 use SMW\Query\Language\Disjunction;
 use SMW\SPARQLStore\QueryEngine\CompoundConditionBuilder;
-use SMW\SPARQLStore\QueryEngine\Condition\Condition;
 use SMW\SPARQLStore\QueryEngine\Condition\FalseCondition;
 use SMW\SPARQLStore\QueryEngine\Condition\FilterCondition;
 use SMW\SPARQLStore\QueryEngine\Condition\SingletonCondition;

src/SPARQLStore/QueryEngine/Interpreter/DisjunctionInterpreter.php

Doc Comments +11 added lines

@@ -107,6 +107,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doPreliminarySubDescriptionCheck( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		$count = count( $subDescriptions );
@@ -131,6 +135,10 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doResolveSubDescriptionsRecursively( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		// Using a stdClass as data container for simpler handling in follow-up tasks
@@ -213,6 +221,9 @@ 
 		return $subConditionElements;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function createConditionFromSubConditionElements( $subConditionElements, $joinVariable ) {
 
 		if ( $subConditionElements->unionCondition === '' ) {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMW\Query\Language\Description;
 use SMW\Query\Language\Disjunction;
 use SMW\SPARQLStore\QueryEngine\CompoundConditionBuilder;
-use SMW\SPARQLStore\QueryEngine\Condition\Condition;
 use SMW\SPARQLStore\QueryEngine\Condition\FalseCondition;
 use SMW\SPARQLStore\QueryEngine\Condition\FilterCondition;
 use SMW\SPARQLStore\QueryEngine\Condition\SingletonCondition;

src/SPARQLStore/QueryEngine/Interpreter/SomePropertyInterpreter.php

Doc Comments +8 added lines

@@ -150,6 +150,9 @@ 
 		return array( $innerOrderByProperty, $innerCondition, $innerJoinVariable );
 	}
 
+	/**
+	 * @param string $innerJoinVariable
+	 */
 	private function findObjectNameFromInnerCondition( $innerCondition, $innerJoinVariable, &$namespaces ) {
 
 		if ( !$innerCondition instanceof SingletonCondition ) {
@@ -201,6 +204,10 @@ 
 		return TurtleSerializer::getTurtleNameForExpElement( $propertyExpElement );
 	}
 
+	/**
+	 * @param string $objectName
+	 * @param string $joinVariable
+	 */
 	private function doExchangeForWhenInversePropertyIsUsed( DIProperty $property, $objectName, $joinVariable ) {
 
 		$subjectName = '?' . $joinVariable;
@@ -239,6 +246,7 @@ 
 	 * can be found using the "zero or more" will resolve the complete path
 	 *
 	 * @see http://www.w3.org/TR/sparql11-query/#propertypath-arbitrary-length
+	 * @param string $propertyName
 	 */
 	private function tryToAddPropertyPathForSaturatedHierarchy( &$condition, DIProperty $property, &$propertyName ) {
 

src/SPARQLStore/QueryEngine/Interpreter/ValueDescriptionInterpreter.php

Doc Comments +19 added lines

@@ -104,10 +104,18 @@ 
 		);
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param DIProperty|null $orderByProperty
+	 */
 	private function createConditionForEmptyComparator( $joinVariable, $orderByProperty ) {
 		return $this->compoundConditionBuilder->newTrueCondition( $joinVariable, $orderByProperty );
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param DIProperty|null $orderByProperty
+	 */
 	private function createConditionForEqualityComparator( $dataItem, $property, $joinVariable, $orderByProperty ) {
 
 		$expElement = $this->exporter->getDataItemHelperExpElement( $dataItem );
@@ -153,6 +161,11 @@ 
 		return $condition;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param DIProperty|null $orderByProperty
+	 * @param string $comparator
+	 */
 	private function createConditionForRegexComparator( $dataItem, $joinVariable, $orderByProperty, $comparator ) {
 
 		if ( !$dataItem instanceof DIBlob && !$dataItem instanceof DIWikiPage && !$dataItem instanceof DIUri ) {
@@ -196,6 +209,9 @@ 
 		return $condition;
 	}
 
+	/**
+	 * @param string $comparator
+	 */
 	private function createFilterConditionForAnyOtherComparator( $dataItem, $joinVariable, $orderByProperty, $comparator ) {
 
 		$result = new FilterCondition( '', array() );
@@ -228,6 +244,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $pattern
+	 */
 	private function createFilterConditionToMatchRegexPattern( $dataItem, &$joinVariable, $comparator, $pattern ) {
 
 		if ( $dataItem instanceof DIBlob ) {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMW\SPARQLStore\QueryEngine\QueryEngine;
 use SMW\SPARQLStore\QueryEngine\EngineOptions;
 use SMW\SPARQLStore\QueryEngine\QueryResultFactory;
-use SMW\DIProperty;
 use SMWQuery as Query;
 
 /**