SMW\EntityLookup Interface Reference

Inheritance diagram for SMW\EntityLookup:

Public Member Functions
	getSemanticData (DIWikiPage $subject, $filter=false)
	getProperties (DIWikiPage $subject, RequestOptions $requestOptions=null)
	getPropertyValues (DIWikiPage $subject=null, DIProperty $property, RequestOptions $requestOptions=null)
	getPropertySubjects (DIProperty $property, DataItem $dataItem=null, RequestOptions $requestOptions=null)
	getAllPropertySubjects (DIProperty $property, RequestOptions $requestOptions=null)
	getInProperties (DataItem $object, RequestOptions $requestOptions=null)

Detailed Description

GNU GPL v2+

Since

2.5

Author

mwjames

Member Function Documentation

getAllPropertySubjects()

SMW\EntityLookup::getAllPropertySubjects	(	DIProperty	$property,
		RequestOptions	$requestOptions = null
	)

Get an array of all subjects that have some value for the given property. The result is an array of DIWikiPage objects.

Since

2.5

Parameters

DIProperty	$property
RequestOptions | null	$requestOptions

Returns

DIWikiPage[]|Iterator

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

getInProperties()

SMW\EntityLookup::getInProperties	(	DataItem	$object,
		RequestOptions	$requestOptions = null
	)

Get an array of all properties for which there is some subject that relates to the given value. The result is an array of DIWikiPage objects.

Note

In some stores, this function might be implemented partially so that only values of type Page (_wpg) are supported.

Since

2.5

Parameters

DataItem	$object
RequestOptions | null	$requestOptions

Returns

DataItem[]|[]

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

getProperties()

SMW\EntityLookup::getProperties	(	DIWikiPage	$subject,
		RequestOptions	$requestOptions = null
	)

Get an array of all properties for which the given subject has some value. The result is an array of DIProperty objects.

Since

2.5

Parameters

DIWikiPage	$subject
RequestOptions | null	$requestOptions

Returns

DataItem[]|[]

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

getPropertySubjects()

SMW\EntityLookup::getPropertySubjects	(	DIProperty	$property,
		DataItem	$dataItem = null,
		RequestOptions	$requestOptions = null
	)

Get an array of all subjects that have the given value for the given property. The result is an array of DIWikiPage objects. If null is given as a value, all subjects having that property are returned.

Since

2.5

Parameters

DIWikiPage | null	$subject
DIProperty	$property
RequestOptions | null	$requestOptions

Returns

DIWikiPage[]|[]|Iterator

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

getPropertyValues()

SMW\EntityLookup::getPropertyValues	(	DIWikiPage	$subject = null,
		DIProperty	$property,
		RequestOptions	$requestOptions = null
	)

Get an array of all property values stored for the given subject and property. The result is an array of DataItem objects.

If called with $subject == null, all values for the given property are returned.

Since

2.5

Parameters

DIWikiPage | null	$subject
DIProperty	$property
RequestOptions | null	$requestOptions

Returns

DataItem[]|[]|Iterator

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

getSemanticData()

SMW\EntityLookup::getSemanticData	(	DIWikiPage	$subject,
			$filter = false
	)

Retrieve all data stored about the given subject and return it as a SemanticData container. There are no options: it just returns all available data as shown in the page's Factbox. $filter is an array of strings that are datatype IDs. If given, the function will avoid any work that is not necessary if only properties of these types are of interest.

Note

There is no guarantee that the store does not retrieve more data than requested when a filter is used. Filtering just ensures that only necessary requests are made, i.e. it improves performance.

Since

2.5

Parameters

DIWikiPage	$subject
	RequestOptions|string[]|bool	$filter

Returns

SemanticData

Implemented in SMW\SQLStore\EntityStore\EntityLookup.

---

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

• EntityLookup.php