next »

[kylej]

I have been going through my list of things to add to Wayfinder and decided to release an early beta for testing.  There are still some things I need to work out and more I would like to add before an initial release, but this should be good for testing.

So here is a list of things I have changed so far:

• &hereClass assigned to weblink if an internal link - http://modxcms.com/forums/index.php/topic,28461.0.html
• &lastClass is assigned correctly when only one menu item - Julian Warren
• odd & even classes - http://modxcms.com/forums/index.php/topic,31895.msg193726.html#msg193726
• MySql 5.0.51 sorting bug fix (should work fine with multi doc groups due to distinct) - http://modxcms.com/forums/index.php/topic,31895.msg193988.html#msg193988
• new templates firstRowTpl, lastRowTpl - http://modxcms.com/forums/index.php/topic,31895.msg193726.html#msg193726
• Add alias placeholder - Kristian Rasmussen
• PHx support - its finally here, this needs major testing.  The wrapper placholders cannot use Phx due to errors I was having with the nesting.  All other tags should work.

New in beta 2:

• Debug console ala Ditto
• Fix TV inherit issue & add tv placeholder usage to wrapper templates - Bungo & netProphET - http://modxcms.com/forums/index.php/topic,27890.msg169487.html#msg169487
• Ability to show secure docs even if user not logged in &ignoreSecurity - http://modxcms.com/forums/index.php/topic,34007.0.html
• Level placeholder [+wf.level+]
• Iterator placeholder [+wf.iterator+]

A big thanks to dflock for his additions, the others listed above and anyone else I forgot.

Leave any comments here on things that might be broken or other things you would like to see added.

To install:

• extract the contents of the zip file into your assets/snippets folder
• copy the contents of the file wayfinder.snippet.2.5.php into a new snippet (I named mine wayfiner2.5)
• call the snippet with the name of the snippet you created

[kongondo]

Brilliant!

Good job Kyle. Will test as soon as possible

cheers/k

[rthrash]

Well gee Kyle, welcome back!

[zi]

Brilliant stuff Kyle! Welcome back

[dev_cw]

This is great. I can't wait to try it out 

[pixelchutes]

Thanks Kyle! Looks like your page has been given a nice makeover, too! http://www.muddydogpaws.com/development/wayfinder/parameters.html (I frequently reference this page!)

[mrhaw]

WF + PHx = 

[Perrine]

Hi,

I'm getting this error :

Code:

Parse error: syntax error, unexpected '=', expecting ')' in /xxx/assets/snippets/wayfinder2.5/wayfinder.inc.php on line 245

Li 245 is

Code:

    function setItemClass($classType, &$resource = null) {

PHP version for this project is 4.4.9... maybe the problem ?

[dev_cw]

Feature request: view private documents in menu or limit to specific document group.
http://modxcms.com/forums/index.php/topic,28082.0.html

[dflock]

Hi Kyle,
I'm not sure if you've done this in 2.5 or not, but I've got an unreleased version of my WF 2.01 which fixes an issue with lastTpl not bing applied to singleton menu items.

This is the version with the fix:

Code:

<?php
/*
::::::::::::::::::::::::::::::::::::::::
 Snippet name: Wayfinder
 Short Desc: builds site navigation
 Version: 2.0.2
 Authors: 
Kyle Jaebker (muddydogpaws.com)
Ryan Thrash (vertexworks.com)
 Date: February 27, 2006
 
 19 January 2009 - Modified by dunc@codeistry.com & tom@twinhelix.org - fixed lastRowTpl bug with single item menu's
 06 January 2009 - Modified by dunc@codeistry.com : added lastRowTpl and weblinks here patch.
 15 July 2008 - Modified by dunc@codeistry.com - added odd & even classes
::::::::::::::::::::::::::::::::::::::::
*/

class Wayfinder {
var $_config;
var $_templates;
var $_css;
var $docs = array();
var $parentTree = array();
var $hasChildren = array();
var $placeHolders = array(
'rowLevel' => array('[+wf.wrapper+]','[+wf.classes+]','[+wf.classnames+]','[+wf.link+]','[+wf.title+]','[+wf.linktext+]','[+wf.id+]','[+wf.attributes+]','[+wf.docid+]','[+wf.introtext+]','[+wf.description+]','[+wf.subitemcount+]'),
'wrapperLevel' => array('[+wf.wrapper+]','[+wf.classes+]','[+wf.classnames+]'),
'tvs' => array(),
);
var $tvList = array();
var $debugInfo = array();

function run() {
global $modx;
//setup here checking array
$this->parentTree = $modx->getParentIds($modx->documentIdentifier);
$this->parentTree[] = $modx->documentIdentifier;

if ($this->_config['debug']) {
$this->addDebugInfo("settings","Settings","Settings","Settings used to create this menu.",$this->_config);
$this->addDebugInfo("settings","CSS","CSS Settings","Available CSS options.",$this->_css);
}
//Load the templates
$this->checkTemplates();
//Register any scripts
if ($this->_config['cssTpl'] || $this->_config['jsTpl']) {
$this->regJsCss();
}
//Get all of the documents
$this->docs = $this->getData();
if (!empty($this->docs)) {
//Sort documents by level for proper wrapper substitution
ksort($this->docs);
//build the menu
return $this->buildMenu();
} else {
$noneReturn = $this->_config['debug'] ? '<p style="color:red">No documents found for menu.</p>' : '';
return $noneReturn;
}
}

function buildMenu() {
global $modx;
//Loop through all of the menu levels
foreach ($this->docs as $level => $subDocs) {
//Loop through each document group (grouped by parent doc)
foreach ($subDocs as $parentId => $docs) {
//only process document group, if starting at root, hidesubmenus is off, or is in current parenttree
if (!$this->_config['hideSubMenus'] || $this->isHere($parentId) || $level <= 1) {
//Build the output for the group of documents
$menuPart = $this->buildSubMenu($docs,$level);
//If we are at the top of the menu start the output, otherwise replace the wrapper with the submenu
if (($level == 1 && (!$this->_config['displayStart'] || $this->_config['id'] == 0)) || ($level == 0 && $this->_config['displayStart'])) {
$output = $menuPart;
} else {
$output = str_replace("[+wf.wrapper.{$parentId}+]",$menuPart,$output);
}
}
}
}
//Return the final Menu
return $output;
}

function buildSubMenu($menuDocs,$level) {
global $modx;
$subMenuOutput = '';
$firstItem = 1;
$counter = 1;
$numSubItems = count($menuDocs);
//Loop through each document to render output
foreach ($menuDocs as $docId => $docInfo) {
$docInfo['level'] = $level;
$docInfo['first'] = $firstItem;
$docInfo['counter'] = $counter;
$docInfo['siblingCount'] = $numSubItems;
$firstItem = 0;
//Determine if last item in group
if ($counter == ($numSubItems) && $numSubItems > 1) {
$docInfo['last'] = 1;
} else {
$docInfo['last'] = 0;
}
//Determine if document has children
$docInfo['hasChildren'] = in_array($docInfo['id'],$this->hasChildren) ? 1 : 0;
$numChildren = $docInfo['hasChildren'] ? count($this->docs[$level+1][$docInfo['id']]) : 0;
//Render the row output
$subMenuOutput .= $this->renderRow($docInfo,$numChildren);
//Update counter for last check
$counter++;
}

if ($level > 0) {
//Determine which wrapper template to use
if ($this->_templates['innerTpl'] && $level > 1) {
$useChunk = $this->_templates['innerTpl'];
$usedTemplate = 'innerTpl';
} else {
$useChunk = $this->_templates['outerTpl'];
$usedTemplate = 'outerTpl';
}
//Determine wrapper class
if ($level > 1) {
$wrapperClass = 'innercls';
} else {
$wrapperClass = 'outercls';
}
//Get the class names for the wrapper
$classNames = $this->setItemClass($wrapperClass);
if ($classNames) $useClass = ' class="' . $classNames . '"';
$phArray = array($subMenuOutput,$useClass,$classNames);
//Process the wrapper
$subMenuOutput = str_replace($this->placeHolders['wrapperLevel'],$phArray,$useChunk);
//Debug
if ($this->_config['debug']) {
$debugParent = $docInfo['parent'];
$debugDocInfo = array();
$debugDocInfo['template'] = $usedTemplate;
foreach ($this->placeHolders['wrapperLevel'] as $n => $v) {
if ($v !== '[+wf.wrapper+]')
$debugDocInfo[$v] = $phArray[$n];
}
$this->addDebugInfo("wrapper","{$debugParent}","Wrapper for items with parent {$debugParent}.","These fields were used when processing the wrapper for the following documents.",$debugDocInfo);
}
}
//Return the submenu
return $subMenuOutput;
}

//render each rows output
function renderRow(&$resource,$numChildren) {
global $modx;
$output = '';
//Determine which template to use
if ($this->_config['displayStart'] && $resource['level'] == 0) {
$usedTemplate = 'startItemTpl';
} elseif ($resource['id'] == $modx->documentObject['id'] && $resource['isfolder'] && $this->_templates['parentRowHereTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $numChildren) {
$usedTemplate = 'parentRowHereTpl';
} elseif ($resource['id'] == $modx->documentObject['id'] && $this->_templates['innerHereTpl'] && $resource['level'] > 1) {
$usedTemplate = 'innerHereTpl';
} elseif ($resource['id'] == $modx->documentObject['id'] && $this->_templates['hereTpl']) {
$usedTemplate = 'hereTpl';
} elseif ($resource['isfolder'] && $this->_templates['activeParentRowTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $this->isHere($resource['id'])) {
$usedTemplate = 'activeParentRowTpl';
} elseif ($resource['isfolder'] && ($resource['template']=="0" || is_numeric(strpos($resource['link_attributes'],'rel="category"'))) && $this->_templates['categoryFoldersTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0)) {
$usedTemplate = 'categoryFoldersTpl';
} elseif ($resource['isfolder'] && $this->_templates['parentRowTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $numChildren) {
$usedTemplate = 'parentRowTpl';
} elseif ($resource['level'] > 1 && $this->_templates['innerRowTpl']) {
$usedTemplate = 'innerRowTpl';
} else {
if ($resource['first'] == 1 && $this->_templates['lastRowTpl'] && $resource['siblingCount'] == 1) {
// Singleton

$usedTemplate = 'lastRowTpl';

} elseif($resource['last'] == 1 && $this->_templates['lastRowTpl']){
// Last item in level

$usedTemplate = 'lastRowTpl';

} else {
// Normal case.

$usedTemplate = 'rowTpl';

}
}
//Get the template
$useChunk = $this->_templates[$usedTemplate];
//Setup the new wrapper name and get the class names
$useSub = $resource['hasChildren'] ? "[+wf.wrapper.{$resource['id']}+]" : "";
$classNames = $this->setItemClass('rowcls',$resource['id'],$resource['first'],$resource['last'],$resource['level'],$resource['isfolder'],$resource['type'],$resource['counter']);
if ($classNames) $useClass = ' class="' . $classNames . '"';
//Setup the row id if a prefix is specified
if ($this->_config['rowIdPrefix']) {
$useId = ' id="' . $this->_config['rowIdPrefix'] . $resource['id'] . '"';
} else {
$useId = '';
}
//Load row values into placholder array
$phArray = array($useSub,$useClass,$classNames,$resource['link'],$resource['title'],$resource['linktext'],$useId,$resource['link_attributes'],$resource['id'],$resource['introtext'],$resource['description'],$numChildren);
//If tvs are used add them to the placeholder array
if (!empty($this->tvList)) {
$usePlaceholders = array_merge($this->placeHolders['rowLevel'],$this->placeHolders['tvs']);
foreach ($this->tvList as $tvName) {
$phArray[] = $resource[$tvName];
}
} else {
$usePlaceholders = $this->placeHolders['rowLevel'];
}
//Debug
if ($this->_config['debug']) {
$debugDocInfo = array();
$debugDocInfo['template'] = $usedTemplate;
foreach ($usePlaceholders as $n => $v) {
$debugDocInfo[$v] = $phArray[$n];
}
$this->addDebugInfo("row","{$resource['parent']}:{$resource['id']}","Doc: #{$resource['id']}","The following fields were used when processing this document.",$debugDocInfo);
$this->addDebugInfo("rowdata","{$resource['parent']}:{$resource['id']}","Doc: #{$resource['id']}","The following fields were retrieved from the database for this document.",$resource);
}
//Process the row
$output .= str_replace($usePlaceholders,$phArray,$useChunk);
//Return the row
return $output . $this->_config['nl'];
}

//determine style class for current item being processed
function setItemClass($classType, $docId = 0, $first = 0, $last = 0, $level = 0, $isFolder = 0, $type = 'document', $counter =  '') {
global $modx;
$returnClass = '';
$hasClass = 0;

if ($classType === 'outercls' && !empty($this->_css['outer'])) {
//Set outer class if specified
$returnClass .= $this->_css['outer'];
$hasClass = 1;
} elseif ($classType === 'innercls' && !empty($this->_css['inner'])) {
//Set inner class if specified
$returnClass .= $this->_css['inner'];
$hasClass = 1;
} elseif ($classType === 'rowcls') {
//Set row class if specified
if (!empty($this->_css['row'])) {
$returnClass .= $this->_css['row'];
$hasClass = 1;
}
//Set first class if specified
if ($first && !empty($this->_css['first'])) {
$returnClass .= $hasClass ? ' ' . $this->_css['first'] : $this->_css['first'];
$hasClass = 1;
}
//Set last class if specified
if ($last && !empty($this->_css['last'])) {
$returnClass .= $hasClass ? ' ' . $this->_css['last'] : $this->_css['last'];
$hasClass = 1;
}
//Set level class if specified
if (!empty($this->_css['level'])) {
$returnClass .= $hasClass ? ' ' . $this->_css['level'] . $level : $this->_css['level'] . $level;
$hasClass = 1;
}
//Set parentFolder class if specified
if ($isFolder && !empty($this->_css['parent']) && ($level < $this->_config['level'] || $this->_config['level'] == 0)) {
$returnClass .= $hasClass ? ' ' . $this->_css['parent'] : $this->_css['parent'];
$hasClass = 1;
}
//Set here class if specified
if (!empty($this->_css['here']) && $this->isHere($docId, $type)) {
$returnClass .= $hasClass ? ' ' . $this->_css['here'] : $this->_css['here'];
$hasClass = 1;
}
//Set self class if specified
if (!empty($this->_css['self']) && $docId == $modx->documentIdentifier) {
$returnClass .= $hasClass ? ' ' . $this->_css['self'] : $this->_css['self'];
$hasClass = 1;
}
//Set class for weblink
if (!empty($this->_css['weblink']) && $type == 'reference') {
$returnClass .= $hasClass ? ' ' . $this->_css['weblink'] : $this->_css['weblink'];
$hasClass = 1;
}
//Set class for even items
if (!empty($this->_css['even'])) {
if (($counter) && !($counter % 2)) {
$returnClass .= $hasClass ? ' ' . $this->_css['even'] : $this->_css['even'];
$hasClass = 1;
}
}
//Set class for odd items
if (!empty($this->_css['odd'])) {
if (($counter) && ($counter % 2)) {
$returnClass .= $hasClass ? ' ' . $this->_css['odd'] : $this->_css['odd'];
$hasClass = 1;
}
}
}

return $returnClass;
}

//determine "you are here"
function isHere($did, $type='document') {
// begin weblink 'here' patch
if ($type == 'reference') {
global $modx;
$doc = $modx->getDocumentObject('id', $did);
$did = $doc['content'];
}
// end weblink 'here' patch
return in_array($did,$this->parentTree);
}

//Add the specified css & javascript chunks to the page
function regJsCss() {
global $modx;
//Debug
if ($this->_config['debug']) {
$jsCssDebug = array('js' => 'None Specified.', 'css' => 'None Specified.');
}
//Check and load the CSS 
if ($this->_config['cssTpl']) {
$cssChunk = $this->fetch($this->_config['cssTpl']);
if ($cssChunk) {
$modx->regClientCSS($cssChunk);
if ($this->_config['debug']) {$jsCssDebug['css'] = "The CSS in {$this->_config['cssTpl']} was registered.";}
} else {
if ($this->_config['debug']) {$jsCssDebug['css'] = "The CSS in {$this->_config['cssTpl']} was not found.";}
}
}
//Check and load the Javascript
if ($this->_config['jsTpl']) {
$jsChunk = $this->fetch($this->_config['jsTpl']);
if ($jsChunk) {
$modx->regClientStartupScript($jsChunk);
if ($this->_config['debug']) {$jsCssDebug['js'] = "The Javascript in {$this->_config['jsTpl']} was registered.";}
} else {
if ($this->_config['debug']) {$jsCssDebug['js'] = "The Javascript in {$this->_config['jsTpl']} was not found.";}
}
}
//Debug
if ($this->_config['debug']) {$this->addDebugInfo("settings","JSCSS","JS/CSS Includes","Results of CSS & Javascript includes.",$jsCssDebug);}
}

//Get all of the documents from the database
function getData() {
global $modx;
$ids = array();
$ids = $modx->getChildIds($this->_config['id'],$this->_config['level']);
//Get all of the ids for processing
if ($this->_config['displayStart'] && $this->_config['id'] !== 0) {
$ids[] = $this->_config['id'];
}
if (!empty($ids)) {
//Setup the fields for the query
$fields = "sc.id, sc.menutitle, sc.pagetitle, sc.introtext, sc.menuindex, sc.published, sc.hidemenu, sc.parent, sc.isfolder, sc.description, sc.alias, sc.longtitle, sc.type,if(sc.type='reference',sc.content,'') as content, sc.template, sc.link_attributes";
//Get the table names
$tblsc = $modx->getFullTableName("site_content");
$tbldg = $modx->getFullTableName("document_groups");
//Add the ignore hidden option to the where clause
if ($this->_config['ignoreHidden']) {
$menuWhere = '';
} else {
$menuWhere = ' AND sc.hidemenu=0';
}
//add the include docs to the where clause
if ($this->_config['includeDocs']) {
$menuWhere .= " AND sc.id IN ({$this->_config['includeDocs']})";
}
//add the exclude docs to the where clause
if ($this->_config['excludeDocs']) {
$menuWhere .= " AND (sc.id NOT IN ({$this->_config['excludeDocs']}))";
}
//add the limit to the query
if ($this->_config['limit']) {
$sqlLimit = " LIMIT 0, {$this->_config['limit']}";
} else {
$sqlLimit = '';
}
//Determine sorting
if (strtolower($this->_config['sortBy']) == 'random') {
$sort = 'rand()';
$dir = '';
} else {
// modify field names to use sc. table reference
$sort = 'sc.'.implode(',sc.',preg_replace("/^\s/i","",explode(',',$this->_config['sortBy'])));
}

// get document groups for current user
if($docgrp = $modx->getUserDocGroups()) $docgrp = implode(",",$docgrp);
// build query
$access = ($modx->isFrontend() ? "sc.privateweb=0" : "1='{$_SESSION['mgrRole']}' OR sc.privatemgr=0").(!$docgrp ? "" : " OR dg.document_group IN ({$docgrp})");
$sql = "SELECT DISTINCT {$fields} FROM {$tblsc} sc LEFT JOIN {$tbldg} dg ON dg.document = sc.id WHERE sc.published=1 AND sc.deleted=0 AND ({$access}){$menuWhere} AND sc.id IN (".implode(',',$ids).") GROUP BY sc.id ORDER BY {$sort} {$this->_config['sortOrder']} {$sqlLimit};";
//run the query
$result = $modx->dbQuery($sql);
$resourceArray = array();
$numResults = @$modx->recordCount($result);
$level = 1;
$prevParent = -1;
//Setup startlevel for determining each items level
if ($this->_config['id'] == 0) {
$startLevel = 0;
} else {
$startLevel = count($modx->getParentIds($this->_config['id']));
$startLevel = $startLevel ? $startLevel+1 : 1;
}
$resultIds = array();
//loop through the results
for($i=0;$i<$numResults;$i++)  {
$tempDocInfo = $modx->fetchRow($result);
$resultIds[] = $tempDocInfo['id'];
//Create the link
$linkScheme = $this->_config['fullLink'] ? 'full' : '';
if ($this->_config['useWeblinkUrl'] !== 'FALSE' && $tempDocInfo['type'] == 'reference') {
if (is_numeric($tempDocInfo['content'])) {
$tempDocInfo['link'] = $modx->makeUrl(intval($tempDocInfo['content']),'','',$linkScheme);
} else {
$tempDocInfo['link'] = $tempDocInfo['content'];
}
} elseif ($tempDocInfo['id'] == $modx->config['site_start']) {
$tempDocInfo['link'] = $modx->config['site_url'];
} else {
$tempDocInfo['link'] = $modx->makeUrl($tempDocInfo['id'],'','',$linkScheme);
}
//determine the level, if parent has changed
if ($prevParent !== $tempDocInfo['parent']) {
$level = count($modx->getParentIds($tempDocInfo['id'])) + 1 - $startLevel;
}
//add parent to hasChildren array for later processing
if (($level > 1 || $this->_config['displayStart']) && !in_array($tempDocInfo['parent'],$this->hasChildren)) {
$this->hasChildren[] = $tempDocInfo['parent'];
}
//set the level
$tempDocInfo['level'] = $level;
$prevParent = $tempDocInfo['parent'];
//determine other output options
$useTextField = (empty($tempDocInfo[$this->_config['textOfLinks']])) ? 'pagetitle' : $this->_config['textOfLinks'];
$tempDocInfo['linktext'] = $tempDocInfo[$useTextField];
$tempDocInfo['title'] = $tempDocInfo[$this->_config['titleOfLinks']];
//If tvs were specified keep array flat otherwise array becomes level->parent->doc
if (!empty($this->tvList)) {
$tempResults[] = $tempDocInfo;
} else {
$resourceArray[$tempDocInfo['level']][$tempDocInfo['parent']][] = $tempDocInfo;
}
}
//Process the tvs
if (!empty($this->tvList) && !empty($resultIds)) {
$tvValues = array();
//loop through all tvs and get their values for each document
foreach ($this->tvList as $tvName) {
$tvValues = array_merge_recursive($this->appendTV($tvName,$resultIds),$tvValues);
}
//loop through the document array and add the tvar values to each document
foreach ($tempResults as $tempDocInfo) {
if (array_key_exists("#{$tempDocInfo['id']}",$tvValues)) {
foreach ($tvValues["#{$tempDocInfo['id']}"] as $tvName => $tvValue) {
$tempDocInfo[$tvName] = $tvValue;
}
}
$resourceArray[$tempDocInfo['level']][$tempDocInfo['parent']][] = $tempDocInfo;
}
}
}
//return final docs
return $resourceArray;
}

// ---------------------------------------------------
// Function: appendTV taken from Ditto (thanks Mark)
// Apeend a TV to the documents array
// ---------------------------------------------------

function appendTV($tvname,$docIDs){
global $modx;

$baspath= $modx->config["base_path"] . "manager/includes";
include_once $baspath . "/tmplvars.format.inc.php";
include_once $baspath . "/tmplvars.commands.inc.php";

$tb1 = $modx->getFullTableName("site_tmplvar_contentvalues");
$tb2 = $modx->getFullTableName("site_tmplvars");

$query = "SELECT stv.name,stc.tmplvarid,stc.contentid,stv.type,stv.display,stv.display_params,stc.value";
$query .= " FROM ".$tb1." stc LEFT JOIN ".$tb2." stv ON stv.id=stc.tmplvarid ";
$query .= " WHERE stv.name='".$tvname."' AND stc.contentid IN (".implode($docIDs,",").") ORDER BY stc.contentid ASC;";
$rs = $modx->db->query($query);
$tot = $modx->db->getRecordCount($rs);
$resourceArray = array();
for($i=0;$i<$tot;$i++)  {
$row = @$modx->fetchRow($rs);
$resourceArray["#{$row['contentid']}"][$row['name']] = getTVDisplayFormat($row['name'], $row['value'], $row['display'], $row['display_params'], $row['type'],$row['contentid']);   
}

if ($tot != count($docIDs)) {
$query = "SELECT name,type,display,display_params,default_text";
$query .= " FROM $tb2";
$query .= " WHERE name='".$tvname."' LIMIT 1";
$rs = $modx->db->query($query);
$row = @$modx->fetchRow($rs);
$defaultOutput = getTVDisplayFormat($row['name'], $row['default_text'], $row['display'], $row['display_params'], $row['type']);
foreach ($docIDs as $id) {
if (!isset($resourceArray["#{$id}"])) {
$resourceArray["#{$id}"][$tvname] = $defaultOutput;
}
}
}
return $resourceArray;
}

// ---------------------------------------------------
// Get a list of all available TVs
// ---------------------------------------------------

function getTVList() {
global $modx;
$table = $modx->getFullTableName("site_tmplvars");
$tvs = $modx->db->select("name", $table);
// TODO: make it so that it only pulls those that apply to the current template
$dbfields = array();
while ($dbfield = $modx->db->getRow($tvs))
$dbfields[] = $dbfield['name'];
return $dbfields;
}

//debugging to check for valid chunks
function checkTemplates() {
global $modx;
$nonWayfinderFields = array();

foreach ($this->_templates as $n => $v) {
$templateCheck = $this->fetch($v);
if (empty($v) || !$templateCheck) {
if ($n === 'outerTpl') {
$this->_templates[$n] = '<ul[+wf.classes+]>[+wf.wrapper+]</ul>';
} elseif ($n === 'rowTpl' || $n === 'lastRowTpl') {
$this->_templates[$n] = '<li[+wf.id+][+wf.classes+]><a href="[+wf.link+]" title="[+wf.title+]" [+wf.attributes+]>[+wf.linktext+]</a>[+wf.wrapper+]</li>';
} elseif ($n === 'startItemTpl') {
$this->_templates[$n] = '<h2[+wf.id+][+wf.classes+]>[+wf.linktext+]</h2>[+wf.wrapper+]';
} else {
$this->_templates[$n] = FALSE;
}
if ($this->_config['debug']) { $this->addDebugInfo('template',$n,$n,"No template found, using default.",array($n => $this->_templates[$n])); }
} else {
$this->_templates[$n] = $templateCheck;
$check = $this->findTemplateVars($templateCheck);
if (is_array($check)) {
$nonWayfinderFields = array_merge($check, $nonWayfinderFields);
}
if ($this->_config['debug']) { $this->addDebugInfo('template',$n,$n,"Template Found.",array($n => $this->_templates[$n])); }
}
}

if (!empty($nonWayfinderFields)) {
$nonWayfinderFields = array_unique($nonWayfinderFields);
$allTvars = $this->getTVList();

foreach ($nonWayfinderFields as $field) {
if (in_array($field, $allTvars)) {
$this->placeHolders['tvs'][] = "[+{$field}+]";
$this->tvList[] = $field;
}
}
if ($this->_config['debug']) { $this->addDebugInfo('tvars','tvs','Template Variables',"The following template variables were found in your templates.",$this->tvList); }
}
}

function fetch($tpl){
// based on version by Doze at http://modxcms.com/forums/index.php/topic,5344.msg41096.html#msg41096
global $modx;
$template = "";
if ($modx->getChunk($tpl) != "") {
$template = $modx->getChunk($tpl);
} else if(substr($tpl, 0, 6) == "@FILE:") {
$template = $this->get_file_contents(substr($tpl, 6));
} else if(substr($tpl, 0, 6) == "@CODE:") {
$template = substr($tpl, 6);
} else {
$template = FALSE;
}
return $template;
}

function get_file_contents($filename) {
// Function written at http://www.nutt.net/2006/07/08/file_get_contents-function-for-php-4/#more-210
// Returns the contents of file name passed
if (!function_exists('file_get_contents')) {
$fhandle = fopen($filename, "r");
$fcontents = fread($fhandle, filesize($filename));
fclose($fhandle);
} else {
$fcontents = file_get_contents($filename);
}
return $fcontents;
}

function findTemplateVars($tpl) {
preg_match_all('~\[\+(.*?)\+\]~', $tpl, $matches);
$cnt = count($matches[1]);

$tvnames = array ();
for ($i = 0; $i < $cnt; $i++) {
if (strpos($matches[1][$i], "wf.") === FALSE) {
$tvnames[] =  $matches[1][$i];
}
}

if (count($tvnames) >= 1) {
return array_unique($tvnames);
} else {
return false;
}
}

function addDebugInfo($group,$groupkey,$header,$message,$info) {
$infoString = '<table border="1" cellpadding="3px">';
$numInfo = count($info);
$count = 0;

foreach ($info as $key => $value) {
$key = $this->modxPrep($key);
if ($value === TRUE || $value === FALSE) {
$value = $value ? 'TRUE' : 'FALSE';
} else {
$value = $this->modxPrep($value);
}
if ($count == 2) { $infoString .= '</tr>'; $count = 0; }
if ($count == 0) { $infoString .= '<tr>'; }
$value = empty($value) ? '&nbsp;' : $value;
$infoString .= "<td><strong>{$key}</strong></td><td>{$value}</td>";
$count++;
}
$infoString .= '</tr></table>';

$this->debugInfo[$group][$groupkey] = array(
'header' => $this->modxPrep($header),
'message' => $this->modxPrep($message),
'info' => $infoString,
);
}

function renderDebugOutput() {
$output = '<table border="1" cellpadding="3px" width="100%">';
foreach ($this->debugInfo as $group => $item) {
switch ($group) {
case 'template':
$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Template Processing</th></tr>";
foreach ($item as $parentId => $info) {
$output .= "
<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>
<tr><td>{$info['info']}</td></tr>";
}
break;
case 'wrapper':
$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Document Processing</th></tr>";

foreach ($item as $parentId => $info) {
$output .= "<tr><table border=\"1\" cellpadding=\"3px\" style=\"margin-bottom: 10px;\" width=\"100%\">
<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>
<tr><td>{$info['info']}</td></tr>
<tr style=\"background:#336699;color:#fff;\"><th>Documents included in this wrapper:</th></tr>";
foreach ($this->debugInfo['row'] as $key => $value) {
$keyParts = explode(':',$key);
if ($parentId == $keyParts[0]) {
$output .= "<tr style=\"background:#eee;\"><th>{$value['header']}</th></tr>
<tr><td><div style=\"float:left;margin-right:1%;\">{$value['message']}<br />{$value['info']}</div><div style=\"float:left;\">{$this->debugInfo['rowdata'][$key]['message']}<br />{$this->debugInfo['rowdata'][$key]['info']}</div></td></tr>";
}
}

$output .= '</table></tr>';
}

break;
case 'settings':
$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Settings</th></tr>";
foreach ($item as $parentId => $info) {
$output .= "
<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>
<tr><td>{$info['info']}</td></tr>";
}
break;
default:

break;
}
}
$output .= '</table>';
return $output;
}

function modxPrep($value) {
$value = (strpos($value,"<") !== FALSE) ? htmlentities($value) : $value;
$value = str_replace("[","&#38;#091;",$value);
$value = str_replace("]","&#38;#093;",$value);
$value = str_replace("{","&#38;#123;",$value);
$value = str_replace("}","&#38;#125;",$value);
return $value;
}
}

?>

If you diff against my released WF 2.01 you can see what's changed and maybe merge that into 2.5, if you haven't already fixed this?

Thanks!
Dunc

[kylej]

I think I have that fixed already.  If you look at line 99 in your code, I have changed it to this:

Code:

if ($counter == ($numSubItems) && $numSubItems > 0) {

So it sets the last item flag correctly if there is only 1 item in the menu.  This then works with your original code for grabbing the lastTpl when there is only one item.

Thanks again for your help, I am going to try and get a final beta out today.

[kylej]

I have just added beta2 to the first post with some more additional features.

Test away and let me know if you find any issues.  I would like to wrap up this version asap, so some fast testing would be great.

[Frisco]

Hi,

I've tested WF2.5beta2, works like a charm with TVs in the chunks and @INHERIT, for details look here:

http://modxcms.com/forums/index.php/topic,34321.msg208759.html#msg208759

Keep up the great work, you made my day with this release!

Cheers, Frisco

[POINT84]

Pretty sure this going to be super. Just wondering if there has been any way to sort wayfinder by pub date, or if there are any good hacks for this.

[farinas]

Thanks for this developpement, I am interested in parsing protected pages.

I have a problem in the installation of this beta version. Could you point to a page that explain how to install this beta version?

I have first tried to declare a Wayfnder2.5 snippet, in order to not remove my 2.0 version installed with MODx 0.9.6.3. I have this error message:
Fatal error: Cannot redeclare class Wayfinder in /MY_HOME/assets/snippets/wayfinder2.5/Wayfinder.class.php on line 10

I think calling both 2.0 and 2.5 version in page is impossible. So I have tried to rename 2.0 version in Wayfinder.old and rename Wayfinder2.5 in Wayfinder, and now I have this one:
Fatal error: Cannot redeclare class prePHx in /MY_HOME/assets/snippets/wayfinder2.5/includes/phx/phx.pre.class.inc.php on line 11

Did I do something wrong?

Thanks in advance.

I have been going through my list of things to add to Wayfinder and decided to release an early beta for testing.  There are still some things I need to work out and more I would like to add before an initial release, but this should be good for testing.

[rthrash]

Since protected pages can now be shown, in menus even if they're not accessible, maybe a couple of new classes are in order:

&inaccessibleClass - pages that need proper auth/login to which you're not a member
&protectedClass - protected pages that you can in fact access (you've logged in)

[kylej]

Ryan,

I did add a class called &secureClass and this gets set only if the page has the privateweb flag set in the database.  I am not checking any user permissions (so your suggestions will not currently work), but I will look into what it might take to add some user checking like you said.

[rthrash]

&secureClass is perfectly adequate I'd think. There's always future versions.

[MadeMyDay]

The new feature of adding the active class to the weblink is great. But I think you forgot the self class. In line 416:

Code:

if (!empty($this->css['self']) && $resource['id'] == $this->modx->documentIdentifier) {
                $returnClass .= $hasClass ? ' ' . $this->css['self'] : $this->css['self'];
                $hasClass = 1;
            }

change to

Code:

if (!empty($this->css['self']) && ($resource['id'] == $this->modx->documentIdentifier || $resource['content'] == $this->modx->documentIdentifier)) {
                $returnClass .= $hasClass ? ' ' . $this->css['self'] : $this->css['self'];
                $hasClass = 1;
            }

did it for me. Could be a bit less dirty, but works ;-)

[kongondo]

is WF beta 2.5 phx clashing with ditto's phx.pre.class..?

When navigating my site, I am getting this error after installed WF2.5 beta (sorry couldn't test this earlier)

Fatal error: Cannot redeclare class prePHx in C:\wamp\www\modxtests\assets\snippets\ditto\classes\phx.pre.class.inc.php on line 11

How do I deal with this please? Thanks

cheers/k

modx 0963
server wamp