Con­figu­ration para­meter "$smwg­Remote­Req­Features"

From semantic-mediawiki.org
Configuration parameter details:
Name $smwgRemoteReqFeatures
Description Sets the behaviour of the features provided for remote requests
Default setting See below
Software Semantic MediaWiki
Since version
Until version still available
Configuration Query settings
Keyword query routing · query settings · remote query · remote request · remote source
Referenced by SMWQueryProcessor


$smwgRemoteReqFeatures is a configuration parameter that sets the behaviour of the features provided for remote requests. The configuration parameter was introduced in Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x.1.

This configuration parameter only takes effect if a remote source was configured via configuration parameter $smwgQuerySourcesSets a list of sources, i.e. query back-ends that can return query results.

Default setting[edit]

$smwgRemoteReqFeatures = SMW_REMOTE_REQ_SEND_RESPONSE | SMW_REMOTE_REQ_SHOW_NOTE;

This means that special page "Ask"Provides an interface that assists users with creating and executing semantic queries can be used to query remote sources. Moreover a note is shown to the user when a remote request is done.

Available options[edit]

The options enabled by default are highlighted bold.
  • SMW_REMOTE_REQ_SEND_RESPONSE − Allows special page "Ask"Provides an interface that assists users with creating and executing semantic queries to respond to remote requests in combination with a source defined in configuration parameter $smwgQuerySourcesSets a list of sources, i.e. query back-ends that can return query results and the request to it.
  • SMW_REMOTE_REQ_SHOW_NOTE − Shows a note for each remote request so users are aware that results retrieved from an external source.

Changing the default setting[edit]

To modify the setting to this configuration parameter, add one of the following lines to your "LocalSettings.php" file after the enableSemantics() call:

Disable remote requests on special page "Ask"Provides an interface that assists users with creating and executing semantic queries

To disable a specific feature just redefine the configuration parameter by defining it without including the corresponding constant as shown in the above section on available options:

$smwgRemoteReqFeatures = SMW_REMOTE_REQ_SHOW_NOTE;

or alternatively remove the option from the existing definition of the configuration parameter like e.g.

$smwgRemoteReqFeatures = ( $smwgRemoteReqFeatures & ~SMW_REMOTE_REQ_SEND_RESPONSE );
NoteNote: Please use parentheses2 when combining different bit-operations to avoid a possible mismatch.
Disable the notification to the user about a remote request being done

To disable a specific feature just redefine the configuration parameter by defining it without including the corresponding constant as shown in the above section on available options:

$smwgRemoteReqFeatures = SMW_REMOTE_REQ_SEND_RESPONSE;

or alternatively remove the option from the existing definition of the configuration parameter like e.g.

$smwgRemoteReqFeatures = ( $smwgRemoteReqFeatures & ~SMW_REMOTE_REQ_SHOW_NOTE );
NoteNote: Please use parentheses2 when combining different bit-operations to avoid a possible mismatch.
Disable remote requests on special page "Ask"Provides an interface that assists users with creating and executing semantic queries and the notification to the user about remote requests being done
$smwgRemoteReqFeatures = '';

See also[edit]

References

  1. ^  Semantic MediaWiki: GitHub pull request gh:smw:3167
  2. a b  Bitwise Operators to use parentheses to ensure the desired precedence ...