Semantic MediaWiki and related extensions
Public Member Functions | Protected Member Functions | List of all members
SMW\MediaWiki\Api\BrowseBySubject Class Reference
Collaboration diagram for SMW\MediaWiki\Api\BrowseBySubject:
Collaboration graph
[legend]

Public Member Functions

 execute ()
 
 getAllowedParams ()
 
 getParamDescription ()
 
 getDescription ()
 
 getVersion ()
 

Protected Member Functions

 getHtmlFormat ($params)
 
 getRawFormat ($params)
 
 doFormat ($serialized)
 
 addIndexTags (&$serialized)
 
 getExamples ()
 

Detailed Description

Browse a subject api module

Note
To browse a particular subobject use the 'subobject' parameter because MW's WebRequest (responsible for handling request data sent by a browser) will eliminate any fragments (marked by "#") therefore using something like '"Lorem_ipsum::Foo' is not going to work but '&subject=Lorem_ipsum&subobject=Foo' will return results for the selected subobject

GNU GPL v2+

Since
1.9
Author
mwjames

Member Function Documentation

SMW\MediaWiki\Api\BrowseBySubject::addIndexTags ( $serialized)
protected
SMW\MediaWiki\Api\BrowseBySubject::doFormat (   $serialized)
protected
SMW\MediaWiki\Api\BrowseBySubject::execute ( )
See also
ApiBase::execute
SMW\MediaWiki\Api\BrowseBySubject::getAllowedParams ( )
See also
ApiBase::getAllowedParams
Returns
array
SMW\MediaWiki\Api\BrowseBySubject::getDescription ( )
See also
ApiBase::getDescription
Returns
array
SMW\MediaWiki\Api\BrowseBySubject::getExamples ( )
protected
See also
ApiBase::getExamples
Returns
array
SMW\MediaWiki\Api\BrowseBySubject::getHtmlFormat (   $params)
protected
SMW\MediaWiki\Api\BrowseBySubject::getParamDescription ( )
See also
ApiBase::getParamDescription
Returns
array
SMW\MediaWiki\Api\BrowseBySubject::getRawFormat (   $params)
protected
SMW\MediaWiki\Api\BrowseBySubject::getVersion ( )
See also
ApiBase::getVersion
Returns
string

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