W3TPL/archive/code/smw-links.php: Difference between revisions
(Created page with "==History== * '''2013-02-11''' partially-working version, so I have a record of the commented-out code I'm about to hack off ==Code== <php> <?php /* PURPOSE: SMW listing man...") |
(latest version - works) |
||
Line 7: | Line 7: | ||
PURPOSE: SMW listing management functions for w3tpl | PURPOSE: SMW listing management functions for w3tpl | ||
REQUIRES: filed-links.php | REQUIRES: filed-links.php | ||
TODO: w3f_SiteGroupListing() is currently hard-wired for Google+ | |||
HISTORY: | HISTORY: | ||
2011-10-16 w3tpl code started to get too ugly, so pushing out some functionality into callable modules. | 2011-10-16 w3tpl code started to get too ugly, so pushing out some functionality into callable modules. | ||
2012-01-24 split off SMW stuff from filed-links.php to smw-links.php | 2012-01-24 split off SMW stuff from filed-links.php to smw-links.php | ||
2013-02-14 w3f_SiteGroupListing() now works for G+ | |||
*/ | */ | ||
//require(kfpMWLib.'/smw/smw-base.php'); | //require(kfpMWLib.'/smw/smw-base.php'); | ||
Line 19: | Line 21: | ||
class w3tpl_module_SMWLinks extends w3tpl_module { | class w3tpl_module_SMWLinks extends w3tpl_module { | ||
/*---- | |||
RETURNS: Wzl data object for the MW/SMW database | |||
TODO: this should eventually be an override | |||
*/ | |||
public function Engine() { | |||
$dbr =& wfGetDB( DB_SLAVE ); | |||
$db = new W3Site_Data($dbr); | |||
return $db; | |||
} | |||
// TAG-CALLABLE FUNCTIONS | // TAG-CALLABLE FUNCTIONS | ||
public function w3f_SiteGroupListing(array $iArgs) { | |||
$dbx = $this->Engine(); | |||
$ar = $dbx->GetPages_forPropVal('thing type','site-group'); | |||
/* | |||
$out = '<pre>'; | |||
foreach ($ar as $key => $arRow) { | |||
$out .= print_r($arRow,TRUE); | |||
} | |||
$out .= '</pre>'; | |||
*/ | |||
$out = '<ul>'; | |||
$objPage = new w3smwPage($this); | |||
foreach ($ar as $key => $arRow) { | |||
$idSMW = $arRow['s_id']; // for future coding reference; not currently used | |||
$idNSpace = $arRow['s_namespace']; | |||
$sTitle = $arRow['s_title']; | |||
$objPage->Use_Title_Keyed($sTitle,$idNSpace); | |||
$sName = $objPage->GetPropData('name'); | |||
$sSub = $objPage->GetPropData('subtitle'); | |||
$ftSub = is_null($sSub)?'':" - <i>$sSub</i>"; | |||
$sSumm = $objPage->GetPropData('summary'); | |||
$idSG = $objPage->GetPropData('ID'); | |||
$htIdx = $objPage->PageLink('idx'); | |||
$htLink = '<a href="https://plus.google.com/communities/'.$idSG.'">'.$sName.'</a>'; | |||
$out .= "<li>[$htIdx] <b>$htLink</b>$ftSub: $sSumm"; | |||
} | |||
$out .= '</ul>'; | |||
return $out; | |||
} | |||
/*---- | /*---- | ||
INPUT: | INPUT: | ||
Line 73: | Line 117: | ||
//$out .= '<pre>'.print_r($smwReq,TRUE).'</pre>'; | //$out .= '<pre>'.print_r($smwReq,TRUE).'</pre>'; | ||
} | } | ||
return $out; | return $out; | ||
Line 222: | Line 130: | ||
*/ | */ | ||
protected function SMW_Query($iFilt,array $arCols) { | protected function SMW_Query($iFilt,array $arCols) { | ||
$strAsk = $iFilt; | $strAsk = $iFilt; | ||
$strQry = NULL; | $strQry = NULL; | ||
Line 242: | Line 140: | ||
// $arPrint contains an array of PrintRequest objects | // $arPrint contains an array of PrintRequest objects | ||
$arParams['order'] = array(); | $arParams['order'] = array(); | ||
$arParams['sort'] = array(); | $arParams['sort'] = array(); | ||
Line 365: | Line 252: | ||
return $dv; | return $dv; | ||
} | } | ||
} | |||
class W3Site_Data extends clsSMWData { | |||
} | } | ||
</php> | </php> |
Revision as of 19:22, 14 February 2013
History
- 2013-02-11 partially-working version, so I have a record of the commented-out code I'm about to hack off
Code
<php> <?php /*
PURPOSE: SMW listing management functions for w3tpl REQUIRES: filed-links.php TODO: w3f_SiteGroupListing() is currently hard-wired for Google+ HISTORY: 2011-10-16 w3tpl code started to get too ugly, so pushing out some functionality into callable modules. 2012-01-24 split off SMW stuff from filed-links.php to smw-links.php 2013-02-14 w3f_SiteGroupListing() now works for G+
- /
//require(kfpMWLib.'/smw/smw-base.php'); if (!defined('WZL_SMW')) { die(__FILE__.' requires smw-base.php.'); }
new w3tpl_module_SMWLinks(); // class will self-register
class w3tpl_module_SMWLinks extends w3tpl_module {
/*---- RETURNS: Wzl data object for the MW/SMW database TODO: this should eventually be an override */ public function Engine() {
$dbr =& wfGetDB( DB_SLAVE ); $db = new W3Site_Data($dbr); return $db;
}
// TAG-CALLABLE FUNCTIONS
public function w3f_SiteGroupListing(array $iArgs) {
$dbx = $this->Engine(); $ar = $dbx->GetPages_forPropVal('thing type','site-group'); /*
$out = '
'; foreach ($ar as $key => $arRow) { $out .= print_r($arRow,TRUE); } $out .= '
';
- /
$out = '
- ';
$objPage = new w3smwPage($this);
foreach ($ar as $key => $arRow) {
$idSMW = $arRow['s_id']; // for future coding reference; not currently used
$idNSpace = $arRow['s_namespace'];
$sTitle = $arRow['s_title'];
$objPage->Use_Title_Keyed($sTitle,$idNSpace);
$sName = $objPage->GetPropData('name');
$sSub = $objPage->GetPropData('subtitle');
$ftSub = is_null($sSub)?:" - $sSub";
$sSumm = $objPage->GetPropData('summary');
$idSG = $objPage->GetPropData('ID');
$htIdx = $objPage->PageLink('idx');
$htLink = '<a href="https://plus.google.com/communities/'.$idSG.'">'.$sName.'</a>';
$out .= "
- [$htIdx] $htLink$ftSub: $sSumm"; } $out .= '
';
return $out;
} /*---- INPUT:
site: name of site whose users should be listed filt: additional SMW terms to include in the filter
USAGE:
example: <exec module=smw-links func=SiteUserListing_with_xrefs site="Google+" />
*/ public function w3f_SiteUserListing_with_xrefs(array $iArgs) {
$strSite = $iArgs['site']; $strFilt = NzArray($iArgs,'filt'); $smwFilt = "thing type::site-accountsite::$strSite$strFilt";
$dbr =& wfGetDB( DB_SLAVE ); $db = new clsSMWData($dbr);
$arFilt = array( 'PropName' => '="Thing type"', 'Value' => '="site-account"', ); $rs = $db->GetPages_forProps($arFilt);
$out = 'blah'; while ($rs->NextRow()) {
$out .= '
'.print_r($rs->Values(),TRUE).'
';
} echo 'got to here'; return $out;
} /*---- INPUT:
site: name of site whose users should be listed filt: additional SMW terms to include in the filter
THIS IS THE OLD VERSION. Delete it when the new one is working. */ public function w3f_SiteUserListing_with_xrefs_OLD(array $iArgs) {
$strSite = $iArgs['site']; $strFilt = NzArray($iArgs,'filt'); $smwFilt = "thing type::site-accountsite::$strSite$strFilt";
// there's probably a more direct way to pass the column names so they don't need "?"s... working on that. $arCols = array('?userid','?username','?employer','?job project','?job title','?legal name', '?note'); $smwRes = $this->SMW_Query($smwFilt,$arCols); // returns SMWQueryResult
$out = ;
$arPR = $smwRes->getPrintRequests();
foreach ($arPR as $smwReq) { $out .= '['.$smwReq->getLabel().']='.$smwReq->getHTMLText().' / ';
//$out .= '
'.print_r($smwReq,TRUE).'
';
} return $out;
}
// SUB-FUNCTIONS
/*---- INPUT:m
filt: filter string formatted in {{#ask:}} syntax property::value, etc. cols: list of columns to retrieve in \prefix\demarcated\string format
RETURNS: SMWResultArray */ protected function SMW_Query($iFilt,array $arCols) {
$strAsk = $iFilt;
$strQry = NULL; $arPrint = NULL; SMWQueryProcessor::processFunctionParams($arCols,$strQry,$arParams,$arPrint); // each PrintRequest is approximately equivalent to a column without data // OUTPUT: // $arParams -- not sure; may be incomplete // $arPrint contains an array of PrintRequest objects
$arParams['order'] = array();
$arParams['sort'] = array();
$arParams['mainlabel'] = 'The Main Label';
$arParams['format'] = 'template';
$smwQry = SMWQueryProcessor::createQuery($strAsk,$arParams); // createQuery( $querystring, array $params, $context = SMWQueryProcessor::INLINE_QUERY, $format = , $extraprintouts = array() ) $smwQry->setExtraPrintouts( $arPrint ); // $objQry = SMWQueryProcessor::createQuery($strAsk,$arCols); $smwStore = smwfGetStore(); // default store (what are the options?) $res = $smwStore->getQueryResult($smwQry); // returns SMWQueryResult
//echo '
'.print_r($res,TRUE).'
';
return $res;
/* Leaving this here for now as sample code
// $out .= '
'; while ( $row = $res->getNext() ) { // returns array of SMWResultArray or false // $out .= "\n"; foreach ( $row as $field ) { // $field is SMWResultArray (see SMW_QueryResult.php) // $out .= ""; } // $out .= ''; } // $out .= '";
$objCol = $field->getPrintRequest();
$out .= ' '.print_r($objCol,TRUE).''; // a property can have multiple values for a given page -- usually just one, but there may be more while ( ( $obj = $field->getNextObject() ) !== false ) { // $obj is SMWWikiPageValue $htVal = $obj->getLongText(SMW_OUTPUT_HTML); $out .= ' ['.$htVal.'] '; // $out .= ''.print_r($obj,TRUE).''; } // $out .= " |
';
- /
} /*---- RETURNS: same data as SMW_Query(), but formatted in an array[key]=array{values...} */ protected function SMW_Query_asArray($iFilt,array $arCols,$iKeyCol) {
$objRes = $this->SMW_Query($iFilt,$arCols);
$arOut = NULL; while ( $row = $objRes->getNext() ) { // returns array of SMWResultArray or false $arRow = array(); $strIdx = NULL; foreach ( $row as $field ) { // $field is SMWResultArray (see SMW_QueryResult.php) $objCol = $field->getPrintRequest(); $strKey = $objCol->getLabel();
// a property can have multiple values for a given page -- usually just one, but there may be more $arVals = NULL; while ( ( $obj = $field->getNextObject() ) !== false ) { // $obj is SMWWikiPageValue $htVal = $obj->getLongText(SMW_OUTPUT_HTML); $arVals[] = $htVal; } $arRow[$strKey] = $arVals; if ($strKey == $iKeyCol) { $strIdx = $htVal; } } if (is_null($strIdx)) { $arOut[] = $arRow; } else { $arOut[$strIdx] = $arRow; } } return $arOut;
}
}
// HELPER CLASSES
/*
PURPOSE: extends functionality of smwDataItem ...which currently (no longer?) exists
- /
class w3smwDataItem {
protected $smwObj;
public function __construct(smwDataItem $iItem) {
$this->smwObj = $iItem;
} public function Object() {
return $this->smwObj;
} /*---- BASED ON: smwDataItem::getNextDataValue() */
public function getDataValue() {
$obj = $this->Object(); if ( $obj === false ) { return false; } if ( $obj->mPrintRequest->getMode() == SMWPrintRequest::PRINT_PROP ) { $diProperty = $obj->mPrintRequest->getData()->getDataItem(); } else { $diProperty = null; } $dv = SMWDataValueFactory::newDataItemValue( $obj, $diProperty ); if ( $obj->mPrintRequest->getOutputFormat() ) { $dv->setOutputFormat( $obj->mPrintRequest->getOutputFormat() ); } return $dv;
}
} class W3Site_Data extends clsSMWData { } </php>