BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
SMW\QueryPage Class Reference
Inheritance diagram for SMW\QueryPage:
Collaboration diagram for SMW\QueryPage:

Public Member Functions

 getResults ($requestoptions)
 
 recache ($limit, $ignoreErrors=true)
 
 isExpensive ()
 
 isSyndicated ()
 
 linkParameters ()
 
 getMessageFormatter ()
 
 getLinker ()
 
 getSearchForm ($property= '', $cacheDate= '')
 
 doQuery ($offset=false, $limit=false, $property=false)
 
- Public Member Functions inherited from QueryPage
 setListoutput ($bool)
 
 getQueryInfo ()
 
 getSQL ()
 
 getOrderFields ()
 
 usesTimestamps ()
 
 sortDescending ()
 
 isExpensive ()
 
 isCacheable ()
 
 isCached ()
 
 isSyndicated ()
 
 formatResult ($skin, $result)
 
 getPageHeader ()
 
 linkParameters ()
 
 tryLastResult ()
 
 recache ($limit, $ignoreErrors=true)
 
 getRecacheDB ()
 
 reallyDoQuery ($limit, $offset=false)
 
 doQuery ($offset=false, $limit=false)
 
 fetchFromCache ($limit, $offset=false)
 
 getCachedTimestamp ()
 
 execute ($par)
 
 openList ($offset)
 
 closeList ()
 
 preprocessResults ($db, $res)
 
 feedResult ($row)
 
 feedItemDesc ($row)
 
 feedItemAuthor ($row)
 
 feedTitle ()
 
 feedDesc ()
 
 feedUrl ()
 
- Public Member Functions inherited from SpecialPage
 __construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
 
 getName ()
 
 getRestriction ()
 
 isListed ()
 
 setListed ($listed)
 
 listed ($x=null)
 
 isIncludable ()
 
 including ($x=null)
 
 getLocalName ()
 
 isExpensive ()
 
 isCached ()
 
 isRestricted ()
 
 userCanExecute (User $user)
 
 displayRestrictionError ()
 
 checkPermissions ()
 
 checkReadOnly ()
 
 requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
 
 prefixSearchSubpages ($search, $limit, $offset)
 
 setHeaders ()
 
 run ($subPage)
 
 execute ($subPage)
 
 outputHeader ($summaryMessageKey= '')
 
 getDescription ()
 
 getTitle ($subpage=false)
 
 getPageTitle ($subpage=false)
 
 setContext ($context)
 
 getContext ()
 
 getRequest ()
 
 getOutput ()
 
 getUser ()
 
 getSkin ()
 
 getLanguage ()
 
 getConfig ()
 
 getFullTitle ()
 
 msg ()
 
 addHelpLink ($to, $overrideBaseUrl=false)
 
 getFinalGroupName ()
 
 doesWrites ()
 

Protected Attributes

 $msgFormatter
 
 $linker = null
 
 $selectOptions = array()
 
 $useSerchForm = false
 
- Protected Attributes inherited from QueryPage
 $listoutput = false
 
 $offset = 0
 
 $limit = 0
 
 $numRows
 
 $cachedTimestamp = null
 
 $shownavigation = true
 
- Protected Attributes inherited from SpecialPage
 $mName
 
 $mRestriction
 
 $mIncluding
 
 $mIncludable
 
 $mContext
 

Additional Inherited Members

- Static Public Member Functions inherited from QueryPage
static getPages ()
 
- Static Public Member Functions inherited from SpecialPage
static getTitleFor ($name, $subpage=false, $fragment= '')
 
static getSafeTitleFor ($name, $subpage=false)
 
- Protected Member Functions inherited from QueryPage
 showEmptyText ()
 
 getLimitOffset ()
 
 getDBLimit ($uiLimit, $uiOffset)
 
 getMaxResults ()
 
 outputResults ($out, $skin, $dbr, $res, $num, $offset)
 
- Protected Member Functions inherited from SpecialPage
 getLoginSecurityLevel ()
 
 checkLoginSecurityLevel ($level=null)
 
 getSubpagesForPrefixSearch ()
 
 prefixSearchString ($search, $limit, $offset)
 
 beforeExecute ($subPage)
 
 afterExecute ($subPage)
 
 getRobotPolicy ()
 
 addFeedLinks ($params)
 
 getGroupName ()
 
 useTransactionalTimeLimit ()
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ($search, $limit, array $subpages, $offset)
 

Detailed Description

An abstract query page base class that supports array-based data retrieval instead of the SQL-based access used by MW.

GNU GPL v2+

Since
??
Author
Markus Krötzsch Abstract base class for SMW's variant of the MW QueryPage. Subclasses must implement getResults() and formatResult(), as well as some other standard functions of QueryPage.

Member Function Documentation

SMW\QueryPage::doQuery (   $offset = false,
  $limit = false,
  $property = false 
)

This is the actual workhorse. It does everything needed to make a real, honest-to-gosh query page. Alas, we need to overwrite the whole beast since we do not assume an SQL-based storage backend.

Parameters
$offsetdatabase query offset
$limitdatabase query limit
$propertydatabase string query
SMW\QueryPage::getLinker ( )

Returns a Linker object

Since
1.9
Returns
Linker
SMW\QueryPage::getMessageFormatter ( )

Returns a MessageFormatter object

Since
1.9
Returns
MessageFormatter
SMW\QueryPage::getResults (   $requestoptions)
abstract

Implemented by subclasses to provide concrete functions.

SMW\QueryPage::getSearchForm (   $property = '',
  $cacheDate = '' 
)

Generates a search form

Since
1.9
Parameters
string$property
Returns
string
SMW\QueryPage::linkParameters ( )
See Also
QueryPage::linkParameters
Since
1.9
Returns
array
SMW\QueryPage::recache (   $limit,
  $ignoreErrors = true 
)

Clear the cache and save new results

Todo:
Implement caching for SMW query pages

TODO


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