View source for Help:$smwgQSortFeatures

{{Configuration
|lang=en
|title=$smwgQSortFeatures
|display=$smwg&shy;QSort&shy;Features
|description=Sets the behaviour for the sorting features of the [[Help:Semantic search|semantic search]]
|default=see below
|introducedwith=3.0.0
|configuration=Query settings
|keyword=query; sorting; semantic search
}}
<code>'''$smwgQSortFeatures'''</code> is a [[Help:Configuration|configuration parameter]] that sets behaviour for the sorting features of the [[Help:Semantic search|semantic search]]. The configuration parameter was introduced in {{Release|3.0.0}}[[CiteRef::gh:smw:2821]] and deprecated the configuration parameters as indicated in the section on [[#Available options|available options]] below.

{{Callout
 |The deprecated configuration settings as indicated in the section on [[#Available options|available options]] should be migrated to this configuration setting in "LocalSettings.php" since they will be removed with the release of {{Release|3.1.0}} in 2019.[[CiteRef::gh:smw:2821]]
}}

== Default setting ==
<syntaxhighlight lang="php">
$smwgQSortFeatures = SMW_QSORT | SMW_QSORT_RANDOM;
</syntaxhighlight>
This means that the two respective features, as explained in the following sections on [[#Available options|available options]], are enabled.

== Available options ==
{{Callout
 |The options enabled by default are highlighted bold.
 |info
}}
* <code>SMW_QSORT_NONE</code> – Disables sorting features of the [[Help:Semantic search|semantic search]]
* '''<code>SMW_QSORT</code>''' – Sets that sorting of [[Help:Semantic search|query results]] is possible
: {{Note|This option replaces {{Config|$smwgQSortingSupport}}. }}
* '''<code>SMW_QSORT_RANDOM</code>''' – Sets that random sorting of [[Help:Semantic search|query results]] is possible
: {{Note|This option replaces {{Config|$smwgQRandSortingSupport}}. }}
* <code>SMW_QSORT_UNCONDITIONAL</code> – Sets that sorting by a property will work unconditionally even if the respective property was not set to all pages [[Help:Selecting pages|selected]], i.e. all pages will be shown[[CiteRef::gh:smw:2823]]
: {{Note|This option is currently considered experimental and not available to [[Help:Using SPARQL and RDF stores|<code>SPARQLStore</code> stores]] and [[Help:ElasticStore|<code>SMWElasticStore</code> store.]] }}

{{Callout
 |For further information on the available options listed above see the documentation pages of the respective deprecated configuration parameters as stated above.
 |info
}}

== Changing the default setting ==
To modify the setting to this configuration parameter, add one of the following lines to your "LocalSettings.php" file after the [[Help:EnableSemantics|<code>enableSemantics()</code> call]]:
{{Spacer|30}}
; Removing a specific query sorting feature
To disable a specific feature e.g. random sorting of [[Help:Semantic search|query results]] just redefine the configuration parameter by defining it without the corresponding constant as shown in the above section on [[#Available options|available options]]:
<syntaxhighlight lang="php">
$smwgQSortFeatures = SMW_QSORT;
</syntaxhighlight>
or alternatively remove the option from the existing definition of the configuration parameter like e.g.
<syntaxhighlight lang="php">
$smwgQSortFeatures = ( $smwgQSortFeatures & ~SMW_QSORT_RANDOM );
</syntaxhighlight>
{{Note|Please use parentheses[[CiteRef::php:manual:bitoperators]] when combining different bit-operations to avoid a possible mismatch.}}
{{Spacer|30}}
; Adding a specific query sorting feature
To add a specific feature e.g. unconditional sorting of [[Help:Semantic search|query results]] just redefine the configuration parameter by defining it including the corresponding constant as shown in the above section on [[#Available options|available options]]:
<syntaxhighlight lang="php">
$smwgQSortFeatures = $smwgQSortFeatures | SMW_QSORT_UNCONDITIONAL;
</syntaxhighlight>
{{Spacer|30}}
; Disabling all query sorting features
To disable all browse features just remove all constants as shown in the above section on [[#Available options|available options]]:
<syntaxhighlight lang="php">
$smwgQSortFeatures = '';
</syntaxhighlight>
or add the constant for disabling all query sorting features
<syntaxhighlight lang="php">
$smwgQSortFeatures = SMW_QSORT_NONE;
</syntaxhighlight>
{{Spacer|30}}
== See also ==
* Help page on [[Help:Semantic search|semantic search]]
* Help page on {{Config|$smwgQSortingSupport}}
* Help page on {{Config|$smwgQRandSortingSupport}}
<div style="display: none">
{{#scite:gh:smw:2821
 |type=pullrequest
 |url=https://github.com/SemanticMediaWiki/SemanticMediaWiki/pull/2821
}}
{{#scite:gh:smw:2823
 |type=pullrequest
 |url=https://github.com/SemanticMediaWiki/SemanticMediaWiki/pull/2823
}}
{{doc.info
 |master page=Help:$smwgQSortFeatures
 |status=effective
 |progress=100
 |priority=2
 |minversion=3.0.0
}}
</div>