W3TPL/archive/code/smw-links.php

History

• 2013-02-11 partially-working version, so I have a record of the commented-out code I'm about to hack off

Code

/*
  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 <b>smw-base.php</b>.');
}

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 = '<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:
	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-account]][[site::$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 .= '<pre>'.print_r($rs->Values(),TRUE).'</pre>';
	}
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-account]][[site::$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 .= '<pre>'.print_r($smwReq,TRUE).'</pre>';
	}
	return $out;

    }

    // SUB-FUNCTIONS

    /*----
      INPUT:m
	filt: filter string formatted in {{#ask:}} syntax [[category:whatever]] [[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 '<pre>'.print_r($res,TRUE).'</pre>';
	return $res;

/* Leaving this here for now as sample code	
//	$out .= '<table>';
	while ( $row = $res->getNext() ) {	// returns array of SMWResultArray or false
//	    $out .= "\n<tr>";
	    foreach ( $row as $field ) {	// $field is SMWResultArray (see SMW_QueryResult.php)
//		$out .= "<td>";
		$objCol = $field->getPrintRequest();
		$out .= '<br>'.$objCol->getLabel().' =';
		//$out .= '<pre>'.print_r($objCol,TRUE).'</pre>';

		// 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 .= '<pre>'.print_r($obj,TRUE).'</pre>';
		}

//		$out .= "</td>";
	    }
//	    $out .= '</tr>';
	}
//	$out .= '</table>';
*/
    }
    /*----
      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 {
}