Module:WikidataIB/sandbox1/doc: Difference between revisions

Revision as of 17:57, 24 May 2018

Revision as of 18:32, 24 May 2018

Line 282:

=== Function getQualifierValue ===

The getQualifierValue function is for use when we want to fetch the value of a qualifier. We need to know the property and the value of the property that itthe qualifiesqualifier relates to. The parameters are:

* The property ID passed in the unnamed parameter (or {{para|1}})

* The target value for that property in {{para|pval}}

* The qualifier ID for that target value in {{para|qual}}

* The namesame of the field where its called fromparameters to implement whitelisting and blacklisting of the property as in getValue

* The list of fields to be fetched ("whitelist") in {{para|fetchwikidata}} - accepts {{para|fetchwikidata|ALL}} to fetch all fields

* Optional list of fields not to be displayed ("blacklist") in {{para|suppressfields}}

* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}

* Optional item ID for arbitrary access (expensive call!) in {{para|qid}}

* The same parameters to format output as in getValue

==== Example of getQualifierValue ====

Line 297 ⟶ 296:

In [[South Pole Telescope]] it returns:

* {{#invoke:WikidataIB |getQualifierValue |P793 |pval=Q385378 |qual=P580 |name=xyz |fetchwikidata=ALL |qid=Q1513315}}

=== Function getValueByQual ===

The getValueByQual function returns the value of a property which has a qualifier with a given entity value. The parameters are:

* The property ID passed in the unnamed parameter (or {{para|1}})

* The property ID for a qualifier (or "ALL" or "DATES") in {{para|qualID}}

* The Wikibase-entity ID of a value for that qualifier in {{para|qvalue}}

* The same parameters to implement whitelisting and blacklisting of the property as in getValue

* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}

* Optional item ID for arbitrary access in {{para|qid}}

* The same parameters to format output as in getValue

==== Example of getValueByQual ====

In {{Q|Q10990}} there is a property {{Q|P443}} that has multiple values, each of which has a qualifier {{Q|P407}}. We can return the property value whose qualifier has the value {{Q|Q7979}}

* <code><nowiki>{{#invoke:WikidataIB |getValueByQual |qid=Q10990 |P443 |qualID=P407 |qvalue=Q7979 |fwd=ALL |osd=no |noicon=true}}</nowiki></code> → {{#invoke:WikidataIB/sandbox |getValueByQual |qid=Q10990 |P443 |qualID=P407 |qvalue=Q7979 |fwd=ALL |osd=no |noicon=true}}

=== Function getValueByLang ===

The getValueByLang function returns the value of a property which has a qualifier {{Q|P407}} whose value has the given language code. The parameters are:

* The property ID passed in the unnamed parameter (or {{para|1}})

* The MediaWiki language code to match the language whose code is given by {{para|lang|xx[-yy]}}. If no code is supplied, it uses the default language.

* The same parameters to implement whitelisting and blacklisting of the property as in getValue

* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}

* Optional item ID for arbitrary access in {{para|qid}}

* The same parameters to format output as in getValue

== Utility functions ==