Semantic MediaWiki and related extensions
Public Member Functions | List of all members
SMW\Query\ResultPrinterDependency Interface Reference

Public Member Functions

 hasMissingDependency ()
 
 getDependencyError ()
 

Detailed Description

Interface for result printers that require some dependency to be fully functional.

GNU GPL v2+

Since
3.1
Author
mwjames

Member Function Documentation

◆ getDependencyError()

SMW\Query\ResultPrinterDependency::getDependencyError ( )

Returns a desriptive error message in case of an unfulfilled dependency contract to help users to understand as to why the result printer doesn't return any results.

Since
3.1
Returns
string

◆ hasMissingDependency()

SMW\Query\ResultPrinterDependency::hasMissingDependency ( )

For result printers that implement this interface, return whether the dependency contract is fulfilled or is missing something and would impair the functionality of the result printer.

This function will be called before any query execution ensuring that no system resources are depleted while the printer is missing required dependencies.

Since
3.1
Returns
boolean

The documentation for this interface was generated from the following file:

About | General disclaimer | Privacy policy