PageRenderTime 47ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 0ms

/assets/snippets/wayfinder/wayfinder.inc.php

https://github.com/good-web-master/modx.evo.custom
PHP | 686 lines | 535 code | 47 blank | 104 comment | 183 complexity | 41554b7fb711a7e015b4a5278d52d9f6 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-1.0, GPL-2.0, MIT, BSD-3-Clause 
    

  1. <?php

    2. 

  2. /*

    3. 

  3. ::::::::::::::::::::::::::::::::::::::::

    4. 

  4.  Snippet name: Wayfinder

    5. 

  5.  Short Desc: builds site navigation

    6. 

  6.  Version: 2.0.1

    7. 

  7.  Authors: 

    8. 

  8. 	Kyle Jaebker (muddydogpaws.com)

    9. 

  9. 	Ryan Thrash (vertexworks.com)

    10. 

  10.  Date: February 27, 2006

    11. 

  11. ::::::::::::::::::::::::::::::::::::::::

    12. 

  12. */

    13. 

  13. 

    14. 

  14. class Wayfinder {

    15. 

  15. 	var $_config;

    16. 

  16. 	var $_templates;

    17. 

  17. 	var $_css;

    18. 

  18. 	var $docs = array();

    19. 

  19. 	var $parentTree = array();

    20. 

  20. 	var $hasChildren = array();

    21. 

  21. 	var $placeHolders = array(

    22. 

  22. 		'rowLevel' => array('[+wf.wrapper+]','[+wf.classes+]','[+wf.classnames+]','[+wf.link+]','[+wf.title+]','[+wf.linktext+]','[+wf.id+]','[+wf.alias+]','[+wf.attributes+]','[+wf.docid+]','[+wf.introtext+]','[+wf.description+]','[+wf.subitemcount+]'),

    23. 

  23. 		'wrapperLevel' => array('[+wf.wrapper+]','[+wf.classes+]','[+wf.classnames+]'),

    24. 

  24. 		'tvs' => array(),

    25. 

  25. 	);

    26. 

  26. 	var $tvList = array();

    27. 

  27. 	var $debugInfo = array();

    28. 

  28. 	

    29. 

  29. 	function run() {

    30. 

  30. 		global $modx;

    31. 

  31. 		//setup here checking array

    32. 

  32. 		$this->parentTree = $modx->getParentIds($modx->documentIdentifier);

    33. 

  33. 		$this->parentTree[] = $modx->documentIdentifier;

    34. 

  34. 		

    35. 

  35. 		if ($this->_config['debug']) {

    36. 

  36. 			$this->addDebugInfo("settings","Settings","Settings","Settings used to create this menu.",$this->_config);

    37. 

  37. 			$this->addDebugInfo("settings","CSS","CSS Settings","Available CSS options.",$this->_css);

    38. 

  38. 		}

    39. 

  39. 		//Load the templates

    40. 

  40. 		$this->checkTemplates();

    41. 

  41. 		//Register any scripts

    42. 

  42. 		if ($this->_config['cssTpl'] || $this->_config['jsTpl']) {

    43. 

  43. 		    $this->regJsCss();

    44. 

  44. 		}

    45. 

  45. 		//Get all of the documents

    46. 

  46. 		$this->docs = $this->getData();

    47. 

  47. 		if (!empty($this->docs)) {

    48. 

  48. 			//Sort documents by level for proper wrapper substitution

    49. 

  49. 			ksort($this->docs);

    50. 

  50. 			//build the menu

    51. 

  51. 			return $this->buildMenu();

    52. 

  52. 		} else {

    53. 

  53. 			$noneReturn = $this->_config['debug'] ? '<p style="color:red">No documents found for menu.</p>' : '';

    54. 

  54. 			return $noneReturn;

    55. 

  55. 		}

    56. 

  56. 	}

    57. 

  57. 	

    58. 

  58. 	function buildMenu() {

    59. 

  59. 		global $modx;

    60. 

  60. 		//Loop through all of the menu levels

    61. 

  61. 		foreach ($this->docs as $level => $subDocs) {

    62. 

  62. 			//Loop through each document group (grouped by parent doc)

    63. 

  63. 			foreach ($subDocs as $parentId => $docs) {

    64. 

  64. 				//only process document group, if starting at root, hidesubmenus is off, or is in current parenttree

    65. 

  65. 				if (!$this->_config['hideSubMenus'] || $this->isHere($parentId) || $level <= 1) {

    66. 

  66. 					//Build the output for the group of documents

    67. 

  67. 					$menuPart = $this->buildSubMenu($docs,$level);

    68. 

  68. 					//If we are at the top of the menu start the output, otherwise replace the wrapper with the submenu

    69. 

  69. 					if (($level == 1 && (!$this->_config['displayStart'] || $this->_config['id'] == 0)) || ($level == 0 && $this->_config['displayStart'])) {

    70. 

  70. 						$output = $menuPart;

    71. 

  71. 					} else {

    72. 

  72. 						$output = str_replace("[+wf.wrapper.{$parentId}+]",$menuPart,$output);

    73. 

  73. 					}

    74. 

  74. 				}

    75. 

  75. 			}

    76. 

  76. 		}

    77. 

  77. 		//Return the final Menu

    78. 

  78. 		return $output;

    79. 

  79. 	}

    80. 

  80. 

    81. 

  81. 	function buildSubMenu($menuDocs,$level) {

    82. 

  82. 		global $modx;

    83. 

  83. 		$subMenuOutput = '';

    84. 

  84. 		$firstItem = 1;

    85. 

  85. 		$counter = 1;

    86. 

  86. 		$numSubItems = count($menuDocs);

    87. 

  87. 		//Loop through each document to render output

    88. 

  88. 		foreach ($menuDocs as $docId => $docInfo) {

    89. 

  89. 			$docInfo['level'] = $level;

    90. 

  90. 			$docInfo['first'] = $firstItem;

    91. 

  91. 			$firstItem = 0;

    92. 

  92. 			//Determine if last item in group

    93. 

  93. 			if ($counter == ($numSubItems) && $numSubItems > 1) {

    94. 

  94. 				$docInfo['last'] = 1;

    95. 

  95. 			} else {

    96. 

  96. 				$docInfo['last'] = 0;

    97. 

  97. 			}

    98. 

  98. 			//Determine if document has children

    99. 

  99. 			$docInfo['hasChildren'] = in_array($docInfo['id'],$this->hasChildren) ? 1 : 0;

    100. 

  100. 			$numChildren = $docInfo['hasChildren'] ? count($this->docs[$level+1][$docInfo['id']]) : 0;

    101. 

  101. 			//Render the row output

    102. 

  102. 			$subMenuOutput .= $this->renderRow($docInfo,$numChildren);

    103. 

  103. 			//Update counter for last check

    104. 

  104. 			$counter++;

    105. 

  105. 		}

    106. 

  106. 		

    107. 

  107. 		if ($level > 0) {

    108. 

  108. 			//Determine which wrapper template to use

    109. 

  109. 			if ($this->_templates['innerTpl'] && $level > 1) {

    110. 

  110. 				$useChunk = $this->_templates['innerTpl'];

    111. 

  111. 				$usedTemplate = 'innerTpl';

    112. 

  112. 			} else {

    113. 

  113. 				$useChunk = $this->_templates['outerTpl'];

    114. 

  114. 				$usedTemplate = 'outerTpl';

    115. 

  115. 			}

    116. 

  116. 			//Determine wrapper class

    117. 

  117. 			if ($level > 1) {

    118. 

  118. 				$wrapperClass = 'innercls';

    119. 

  119. 			} else {

    120. 

  120. 				$wrapperClass = 'outercls';

    121. 

  121. 			}

    122. 

  122. 			//Get the class names for the wrapper

    123. 

  123. 			$classNames = $this->setItemClass($wrapperClass);

    124. 

  124. 			if ($classNames) $useClass = ' class="' . $classNames . '"';

    125. 

  125. 			$phArray = array($subMenuOutput,$useClass,$classNames);

    126. 

  126. 			//Process the wrapper

    127. 

  127. 			$subMenuOutput = str_replace($this->placeHolders['wrapperLevel'],$phArray,$useChunk);

    128. 

  128. 			//Debug

    129. 

  129. 			if ($this->_config['debug']) {

    130. 

  130. 				$debugParent = $docInfo['parent'];

    131. 

  131. 				$debugDocInfo = array();

    132. 

  132. 				$debugDocInfo['template'] = $usedTemplate;

    133. 

  133. 				foreach ($this->placeHolders['wrapperLevel'] as $n => $v) {

    134. 

  134. 					if ($v !== '[+wf.wrapper+]')

    135. 

  135. 						$debugDocInfo[$v] = $phArray[$n];

    136. 

  136. 				}	

    137. 

  137. 				$this->addDebugInfo("wrapper","{$debugParent}","Wrapper for items with parent {$debugParent}.","These fields were used when processing the wrapper for the following documents.",$debugDocInfo);

    138. 

  138. 			}

    139. 

  139. 		}

    140. 

  140. 		//Return the submenu

    141. 

  141. 		return $subMenuOutput;

    142. 

  142. 	}

    143. 

  143. 	

    144. 

  144. 	//render each rows output

    145. 

  145.     function renderRow(&$resource,$numChildren) {

    146. 

  146.         global $modx;

    147. 

  147.         $output = '';

    148. 

  148. 		//Determine which template to use

    149. 

  149.         if ($this->_config['displayStart'] && $resource['level'] == 0) {

    150. 

  150. 			$usedTemplate = 'startItemTpl';

    151. 

  151. 		} elseif ($resource['id'] == $modx->documentObject['id'] && $resource['isfolder'] && $this->_templates['parentRowHereTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $numChildren) {

    152. 

  152.             $usedTemplate = 'parentRowHereTpl';

    153. 

  153.         } elseif ($resource['id'] == $modx->documentObject['id'] && $this->_templates['innerHereTpl'] && $resource['level'] > 1) {

    154. 

  154.             $usedTemplate = 'innerHereTpl';

    155. 

  155.         } elseif ($resource['id'] == $modx->documentObject['id'] && $this->_templates['hereTpl']) {

    156. 

  156.             $usedTemplate = 'hereTpl';

    157. 

  157.         } elseif ($resource['isfolder'] && $this->_templates['activeParentRowTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $this->isHere($resource['id'])) {

    158. 

  158.             $usedTemplate = 'activeParentRowTpl';

    159. 

  159.         } 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)) {

    160. 

  160.             $usedTemplate = 'categoryFoldersTpl';

    161. 

  161.         } elseif ($resource['isfolder'] && $this->_templates['parentRowTpl'] && ($resource['level'] < $this->_config['level'] || $this->_config['level'] == 0) && $numChildren) {

    162. 

  162.             $usedTemplate = 'parentRowTpl';

    163. 

  163.         } elseif ($resource['level'] > 1 && $this->_templates['innerRowTpl']) {

    164. 

  164.             $usedTemplate = 'innerRowTpl';

    165. 

  165.         } else {

    166. 

  166.             $usedTemplate = 'rowTpl';

    167. 

  167.         }

    168. 

  168.         //Get the template

    169. 

  169.         $useChunk = $this->_templates[$usedTemplate];

    170. 

  170. 		//Setup the new wrapper name and get the class names

    171. 

  171.         $useSub = $resource['hasChildren'] ? "[+wf.wrapper.{$resource['id']}+]" : "";

    172. 

  172.         $classNames = $this->setItemClass('rowcls',$resource['id'],$resource['first'],$resource['last'],$resource['level'],$resource['isfolder'],$resource['type']);

    173. 

  173.         if ($classNames) $useClass = ' class="' . $classNames . '"';

    174. 

  174.         //Setup the row id if a prefix is specified

    175. 

  175.         if ($this->_config['rowIdPrefix']) {

    176. 

  176.             $useId = ' id="' . $this->_config['rowIdPrefix'] . $resource['id'] . '"';

    177. 

  177.         } else {

    178. 

  178.             $useId = '';

    179. 

  179.         }

    180. 

  180. 		//Load row values into placholder array

    181. 

  181.         $phArray = array($useSub,$useClass,$classNames,$resource['link'],$resource['title'],$resource['linktext'],$useId,$resource['alias'],$resource['link_attributes'],$resource['id'],$resource['introtext'],$resource['description'],$numChildren);

    182. 

  182. 		//If tvs are used add them to the placeholder array

    183. 

  183. 		if (!empty($this->tvList)) {

    184. 

  184. 			$usePlaceholders = array_merge($this->placeHolders['rowLevel'],$this->placeHolders['tvs']);

    185. 

  185. 			foreach ($this->tvList as $tvName) {

    186. 

  186. 				$phArray[] = $resource[$tvName];

    187. 

  187. 			}

    188. 

  188. 		} else {

    189. 

  189. 			$usePlaceholders = $this->placeHolders['rowLevel'];

    190. 

  190. 		}

    191. 

  191. 		//Debug

    192. 

  192. 		if ($this->_config['debug']) {

    193. 

  193. 			$debugDocInfo = array();

    194. 

  194. 			$debugDocInfo['template'] = $usedTemplate;

    195. 

  195. 			foreach ($usePlaceholders as $n => $v) {

    196. 

  196. 				$debugDocInfo[$v] = $phArray[$n];

    197. 

  197. 			}		

    198. 

  198. 			$this->addDebugInfo("row","{$resource['parent']}:{$resource['id']}","Doc: #{$resource['id']}","The following fields were used when processing this document.",$debugDocInfo);

    199. 

  199. 			$this->addDebugInfo("rowdata","{$resource['parent']}:{$resource['id']}","Doc: #{$resource['id']}","The following fields were retrieved from the database for this document.",$resource);

    200. 

  200. 		}

    201. 

  201. 		//Process the row

    202. 

  202.         $output .= str_replace($usePlaceholders,$phArray,$useChunk);

    203. 

  203. 		//Return the row

    204. 

  204.         return $output . $this->_config['nl'];

    205. 

  205.     }

    206. 

  206. 	

    207. 

  207. 	//determine style class for current item being processed

    208. 

  208.     function setItemClass($classType, $docId = 0, $first = 0, $last = 0, $level = 0, $isFolder = 0, $type = 'document') {

    209. 

  209.         global $modx;

    210. 

  210.         $returnClass = '';

    211. 

  211.         $hasClass = 0;

    212. 

  212. 

    213. 

  213.         if ($classType === 'outercls' && !empty($this->_css['outer'])) {

    214. 

  214.             //Set outer class if specified

    215. 

  215.             $returnClass .= $this->_css['outer'];

    216. 

  216.             $hasClass = 1;

    217. 

  217.         } elseif ($classType === 'innercls' && !empty($this->_css['inner'])) {

    218. 

  218.             //Set inner class if specified

    219. 

  219.             $returnClass .= $this->_css['inner'];

    220. 

  220.             $hasClass = 1;

    221. 

  221.         } elseif ($classType === 'rowcls') {

    222. 

  222.             //Set row class if specified

    223. 

  223.             if (!empty($this->_css['row'])) {

    224. 

  224.                 $returnClass .= $this->_css['row'];

    225. 

  225.                 $hasClass = 1;

    226. 

  226.             }

    227. 

  227.             //Set first class if specified

    228. 

  228.             if ($first && !empty($this->_css['first'])) {

    229. 

  229.                 $returnClass .= $hasClass ? ' ' . $this->_css['first'] : $this->_css['first'];

    230. 

  230.                 $hasClass = 1;

    231. 

  231.             }

    232. 

  232.             //Set last class if specified

    233. 

  233.             if ($last && !empty($this->_css['last'])) {

    234. 

  234.                 $returnClass .= $hasClass ? ' ' . $this->_css['last'] : $this->_css['last'];

    235. 

  235.                 $hasClass = 1;

    236. 

  236.             }

    237. 

  237.             //Set level class if specified

    238. 

  238.             if (!empty($this->_css['level'])) {

    239. 

  239.                 $returnClass .= $hasClass ? ' ' . $this->_css['level'] . $level : $this->_css['level'] . $level;

    240. 

  240.                 $hasClass = 1;

    241. 

  241.             }

    242. 

  242.             //Set parentFolder class if specified

    243. 

  243.             if ($isFolder && !empty($this->_css['parent']) && ($level < $this->_config['level'] || $this->_config['level'] == 0)) {

    244. 

  244.                 $returnClass .= $hasClass ? ' ' . $this->_css['parent'] : $this->_css['parent'];

    245. 

  245.                 $hasClass = 1;

    246. 

  246.             }

    247. 

  247.             //Set here class if specified

    248. 

  248.             if (!empty($this->_css['here']) && $this->isHere($docId)) {

    249. 

  249.                 $returnClass .= $hasClass ? ' ' . $this->_css['here'] : $this->_css['here'];

    250. 

  250.                 $hasClass = 1;

    251. 

  251.             }

    252. 

  252.             //Set self class if specified

    253. 

  253.             if (!empty($this->_css['self']) && $docId == $modx->documentIdentifier) {

    254. 

  254.                 $returnClass .= $hasClass ? ' ' . $this->_css['self'] : $this->_css['self'];

    255. 

  255.                 $hasClass = 1;

    256. 

  256.             }

    257. 

  257.             //Set class for weblink

    258. 

  258.             if (!empty($this->_css['weblink']) && $type == 'reference') {

    259. 

  259.                 $returnClass .= $hasClass ? ' ' . $this->_css['weblink'] : $this->_css['weblink'];

    260. 

  260.                 $hasClass = 1;

    261. 

  261.             }

    262. 

  262.         }

    263. 

  263. 

    264. 

  264.         return $returnClass;

    265. 

  265.     }

    266. 

  266. 	

    267. 

  267. 	//determine "you are here"

    268. 

  268.     function isHere($did) {

    269. 

  269.         return in_array($did,$this->parentTree);

    270. 

  270.     }

    271. 

  271. 	

    272. 

  272. 	//Add the specified css & javascript chunks to the page

    273. 

  273.     function regJsCss() {

    274. 

  274.         global $modx;

    275. 

  275.         //Debug

    276. 

  276.         if ($this->_config['debug']) {

    277. 

  277.             $jsCssDebug = array('js' => 'None Specified.', 'css' => 'None Specified.');

    278. 

  278.         }

    279. 

  279.         //Check and load the CSS 

    280. 

  280.         if ($this->_config['cssTpl']) {

    281. 

  281. 			$cssChunk = $this->fetch($this->_config['cssTpl']);

    282. 

  282.             if ($cssChunk) {

    283. 

  283.                 $modx->regClientCSS($cssChunk);

    284. 

  284.                 if ($this->_config['debug']) {$jsCssDebug['css'] = "The CSS in {$this->_config['cssTpl']} was registered.";}

    285. 

  285.             } else {

    286. 

  286.                 if ($this->_config['debug']) {$jsCssDebug['css'] = "The CSS in {$this->_config['cssTpl']} was not found.";}

    287. 

  287.             }

    288. 

  288.         }

    289. 

  289.         //Check and load the Javascript

    290. 

  290.         if ($this->_config['jsTpl']) {

    291. 

  291. 			$jsChunk = $this->fetch($this->_config['jsTpl']);

    292. 

  292.             if ($jsChunk) {

    293. 

  293.                 $modx->regClientStartupScript($jsChunk);

    294. 

  294.                 if ($this->_config['debug']) {$jsCssDebug['js'] = "The Javascript in {$this->_config['jsTpl']} was registered.";}

    295. 

  295.             } else {

    296. 

  296.                 if ($this->_config['debug']) {$jsCssDebug['js'] = "The Javascript in {$this->_config['jsTpl']} was not found.";}

    297. 

  297.             }

    298. 

  298.         }

    299. 

  299. 		//Debug

    300. 

  300. 		if ($this->_config['debug']) {$this->addDebugInfo("settings","JSCSS","JS/CSS Includes","Results of CSS & Javascript includes.",$jsCssDebug);}

    301. 

  301.     }

    302. 

  302. 	

    303. 

  303. 	//Get all of the documents from the database

    304. 

  304. 	function getData() {

    305. 

  305. 		global $modx;

    306. 

  306. 		$depth = !empty($this->_config['level']) ? $this->_config['level'] : 10;

    307. 

  307. 		$ids = array();

    308. 

  308. 		if (!$this->_config['hideSubMenus']) {

    309. 

  309. 			$ids = $modx->getChildIds($this->_config['id'],$depth);

    310. 

  310. 		} else { // then hideSubMenus is checked, we don`t need all children

    311. 

  311. 			// first we always included the chilren of startId document

    312. 

  312. 			// this fix problem with site root chidrens,

    313. 

  313. 			// because site root not included in $modx->getParentIds

    314. 

  314. 			$ids = $modx->getChildIds($this->_config['id'], 1, $ids);

    315. 

  315. 

    316. 

  316. 			$parents = array($modx->documentIdentifier);

    317. 

  317. 			$parents += $modx->getParentIds($modx->documentIdentifier);

    318. 

  318. 

    319. 

  319. 			// if startId not in parents, only show children of startId

    320. 

  320. 			if ($this->_config['id'] == 0 || in_array($this->_config['id'], $parents)){

    321. 

  321. 

    322. 

  322. 				//remove parents higher than startId(including startId)

    323. 

  323. 				$startId_parents = array($this->_config['id']);

    324. 

  324. 				$startId_parents += $modx->getParentIds($this->_config['id']);

    325. 

  325. 				$parents = array_diff($parents, $startId_parents);

    326. 

  326. 

    327. 

  327. 				//remove parents lower than level of startId + level depth

    328. 

  328. 				$parents = array_slice(array_reverse($parents), 0, $depth-1);

    329. 

  329. 

    330. 

  330. 				foreach($parents as $p)

    331. 

  331. 					$ids = $modx->getChildIds($p, 1, $ids);

    332. 

  332. 			}

    333. 

  333. 		}

    334. 

  334. 		//Get all of the ids for processing

    335. 

  335. 		if ($this->_config['displayStart'] && $this->_config['id'] !== 0) {

    336. 

  336. 			$ids[] = $this->_config['id'];

    337. 

  337. 		}

    338. 

  338. 		if (!empty($ids)) {

    339. 

  339. 			//Setup the fields for the query

    340. 

  340. 			$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";

    341. 

  341. 	        //Get the table names

    342. 

  342. 	        $tblsc = $modx->getFullTableName("site_content");

    343. 

  343. 	        $tbldg = $modx->getFullTableName("document_groups");

    344. 

  344. 	        //Add the ignore hidden option to the where clause

    345. 

  345. 	        if ($this->_config['ignoreHidden']) {

    346. 

  346. 	            $menuWhere = '';

    347. 

  347. 	        } else {

    348. 

  348. 	            $menuWhere = ' AND sc.hidemenu=0';

    349. 

  349. 	        }

    350. 

  350. 			//add the include docs to the where clause

    351. 

  351. 			if ($this->_config['includeDocs']) {

    352. 

  352. 				$menuWhere .= " AND sc.id IN ({$this->_config['includeDocs']})";

    353. 

  353. 			}

    354. 

  354. 			//add the exclude docs to the where clause

    355. 

  355. 			if ($this->_config['excludeDocs']) {

    356. 

  356. 				$menuWhere .= " AND (sc.id NOT IN ({$this->_config['excludeDocs']}))";

    357. 

  357. 			}

    358. 

  358. 			//add the limit to the query

    359. 

  359. 			if ($this->_config['limit']) {

    360. 

  360. 				$sqlLimit = " LIMIT 0, {$this->_config['limit']}";

    361. 

  361. 			} else {

    362. 

  362. 				$sqlLimit = '';

    363. 

  363. 			}

    364. 

  364. 			//Determine sorting

    365. 

  365. 			if (strtolower($this->_config['sortBy']) == 'random') {

    366. 

  366. 				$sort = 'rand()';

    367. 

  367. 				$dir = '';

    368. 

  368. 			} else {

    369. 

  369. 				// modify field names to use sc. table reference

    370. 

  370. 				$sort = 'sc.'.implode(',sc.',preg_replace("/^\s/i","",explode(',',$this->_config['sortBy'])));

    371. 

  371. 			}

    372. 

  372. 			

    373. 

  373. 	        // get document groups for current user

    374. 

  374. 	        if($docgrp = $modx->getUserDocGroups()) $docgrp = implode(",",$docgrp);

    375. 

  375. 	        // build query

    376. 

  376. 	        $access = ($modx->isFrontend() ? "sc.privateweb=0" : "1='{$_SESSION['mgrRole']}' OR sc.privatemgr=0").(!$docgrp ? "" : " OR dg.document_group IN ({$docgrp})");

    377. 

  377. 			$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};";

    378. 

  378. 			//run the query

    379. 

  379. 			$result = $modx->dbQuery($sql);

    380. 

  380. 	        $resourceArray = array();

    381. 

  381. 			$numResults = @$modx->recordCount($result);

    382. 

  382. 			$level = 1;

    383. 

  383. 			$prevParent = -1;

    384. 

  384. 			//Setup startlevel for determining each items level

    385. 

  385. 			if ($this->_config['id'] == 0) {

    386. 

  386. 				$startLevel = 0;

    387. 

  387. 			} else {

    388. 

  388. 				$startLevel = count($modx->getParentIds($this->_config['id']));

    389. 

  389. 				$startLevel = $startLevel ? $startLevel+1 : 1;

    390. 

  390. 			}

    391. 

  391. 			$resultIds = array();

    392. 

  392. 			//loop through the results

    393. 

  393. 			for($i=0;$i<$numResults;$i++)  {

    394. 

  394. 				$tempDocInfo = $modx->fetchRow($result);

    395. 

  395. 				$resultIds[] = $tempDocInfo['id'];

    396. 

  396. 				//Create the link

    397. 

  397. 				$linkScheme = $this->_config['fullLink'] ? 'full' : '';

    398. 

  398. 				if ($this->_config['useWeblinkUrl'] !== 'FALSE' && $tempDocInfo['type'] == 'reference') {

    399. 

  399. 					if (is_numeric($tempDocInfo['content'])) {

    400. 

  400. 						$tempDocInfo['link'] = $modx->makeUrl(intval($tempDocInfo['content']),'','',$linkScheme);

    401. 

  401. 					} else {

    402. 

  402. 						$tempDocInfo['link'] = $tempDocInfo['content'];

    403. 

  403. 					}

    404. 

  404. 				} elseif ($tempDocInfo['id'] == $modx->config['site_start']) {

    405. 

  405. 					$tempDocInfo['link'] = $modx->config['site_url'];

    406. 

  406. 				} else {

    407. 

  407. 					$tempDocInfo['link'] = $modx->makeUrl($tempDocInfo['id'],'','',$linkScheme);

    408. 

  408. 				}

    409. 

  409. 				//determine the level, if parent has changed

    410. 

  410. 				if ($prevParent !== $tempDocInfo['parent']) {

    411. 

  411. 					$level = count($modx->getParentIds($tempDocInfo['id'])) + 1 - $startLevel;

    412. 

  412. 				}

    413. 

  413. 				//add parent to hasChildren array for later processing

    414. 

  414. 				if (($level > 1 || $this->_config['displayStart']) && !in_array($tempDocInfo['parent'],$this->hasChildren)) {

    415. 

  415. 					$this->hasChildren[] = $tempDocInfo['parent'];

    416. 

  416. 				}

    417. 

  417. 				//set the level

    418. 

  418. 				$tempDocInfo['level'] = $level;

    419. 

  419. 				$prevParent = $tempDocInfo['parent'];

    420. 

  420. 				//determine other output options

    421. 

  421. 				$useTextField = (empty($tempDocInfo[$this->_config['textOfLinks']])) ? 'pagetitle' : $this->_config['textOfLinks'];

    422. 

  422. 				$tempDocInfo['linktext'] = $tempDocInfo[$useTextField];

    423. 

  423. 				$tempDocInfo['title'] = $tempDocInfo[$this->_config['titleOfLinks']];

    424. 

  424. 				//If tvs were specified keep array flat otherwise array becomes level->parent->doc

    425. 

  425. 				if (!empty($this->tvList)) {

    426. 

  426. 					$tempResults[] = $tempDocInfo;

    427. 

  427. 				} else {

    428. 

  428. 					$resourceArray[$tempDocInfo['level']][$tempDocInfo['parent']][] = $tempDocInfo;

    429. 

  429. 				}

    430. 

  430. 	        }

    431. 

  431. 			//Process the tvs

    432. 

  432. 			if (!empty($this->tvList) && !empty($resultIds)) {

    433. 

  433. 				$tvValues = array();

    434. 

  434. 				//loop through all tvs and get their values for each document

    435. 

  435. 				foreach ($this->tvList as $tvName) {

    436. 

  436. 					$tvValues = array_merge_recursive($this->appendTV($tvName,$resultIds),$tvValues);

    437. 

  437. 				}

    438. 

  438. 				//loop through the document array and add the tvar values to each document

    439. 

  439. 				foreach ($tempResults as $tempDocInfo) {

    440. 

  440. 					if (array_key_exists("#{$tempDocInfo['id']}",$tvValues)) {

    441. 

  441. 						foreach ($tvValues["#{$tempDocInfo['id']}"] as $tvName => $tvValue) {

    442. 

  442. 							$tempDocInfo[$tvName] = $tvValue;

    443. 

  443. 						}

    444. 

  444. 					}

    445. 

  445. 					$resourceArray[$tempDocInfo['level']][$tempDocInfo['parent']][] = $tempDocInfo;

    446. 

  446. 				}

    447. 

  447. 			}

    448. 

  448. 		}

    449. 

  449. 		//return final docs

    450. 

  450.         return $resourceArray;

    451. 

  451. 	}

    452. 

  452. 	

    453. 

  453. 	// ---------------------------------------------------

    454. 

  454. 	// Function: appendTV taken from Ditto (thanks Mark)

    455. 

  455. 	// Apeend a TV to the documents array

    456. 

  456. 	// ---------------------------------------------------	

    457. 

  457. 		

    458. 

  458. 	function appendTV($tvname,$docIDs){

    459. 

  459. 		global $modx;

    460. 

  460. 		

    461. 

  461. 		$baspath= $modx->config["base_path"] . "manager/includes";

    462. 

  462. 	    include_once $baspath . "/tmplvars.format.inc.php";

    463. 

  463. 	    include_once $baspath . "/tmplvars.commands.inc.php";

    464. 

  464. 

    465. 

  465. 		$tb1 = $modx->getFullTableName("site_tmplvar_contentvalues");

    466. 

  466. 		$tb2 = $modx->getFullTableName("site_tmplvars");

    467. 

  467. 

    468. 

  468. 		$query = "SELECT stv.name,stc.tmplvarid,stc.contentid,stv.type,stv.display,stv.display_params,stc.value";

    469. 

  469. 		$query .= " FROM ".$tb1." stc LEFT JOIN ".$tb2." stv ON stv.id=stc.tmplvarid ";

    470. 

  470. 		$query .= " WHERE stv.name='".$tvname."' AND stc.contentid IN (".implode($docIDs,",").") ORDER BY stc.contentid ASC;";

    471. 

  471. 		$rs = $modx->db->query($query);

    472. 

  472. 		$tot = $modx->db->getRecordCount($rs);

    473. 

  473. 		$resourceArray = array();

    474. 

  474. 		for($i=0;$i<$tot;$i++)  {

    475. 

  475. 			$row = @$modx->fetchRow($rs);

    476. 

  476. 			$resourceArray["#{$row['contentid']}"][$row['name']] = getTVDisplayFormat($row['name'], $row['value'], $row['display'], $row['display_params'], $row['type'],$row['contentid']);   

    477. 

  477. 		}

    478. 

  478. 

    479. 

  479. 		if ($tot != count($docIDs)) {

    480. 

  480. 			$query = "SELECT name,type,display,display_params,default_text";

    481. 

  481. 			$query .= " FROM $tb2";

    482. 

  482. 			$query .= " WHERE name='".$tvname."' LIMIT 1";

    483. 

  483. 			$rs = $modx->db->query($query);

    484. 

  484. 			$row = @$modx->fetchRow($rs);

    485. 

  485. 			$defaultOutput = getTVDisplayFormat($row['name'], $row['default_text'], $row['display'], $row['display_params'], $row['type']);

    486. 

  486. 			foreach ($docIDs as $id) {

    487. 

  487. 				if (!isset($resourceArray["#{$id}"])) {

    488. 

  488. 					$resourceArray["#{$id}"][$tvname] = $defaultOutput;

    489. 

  489. 				}

    490. 

  490. 			}

    491. 

  491. 		}

    492. 

  492. 		return $resourceArray;

    493. 

  493. 	}

    494. 

  494. 	

    495. 

  495. 	// ---------------------------------------------------

    496. 

  496. 	// Get a list of all available TVs

    497. 

  497. 	// ---------------------------------------------------

    498. 

  498. 		

    499. 

  499. 	function getTVList() {

    500. 

  500. 		global $modx;

    501. 

  501. 		$table = $modx->getFullTableName("site_tmplvars");

    502. 

  502. 		$tvs = $modx->db->select("name", $table);

    503. 

  503. 			// TODO: make it so that it only pulls those that apply to the current template

    504. 

  504. 		$dbfields = array();

    505. 

  505. 		while ($dbfield = $modx->db->getRow($tvs))

    506. 

  506. 			$dbfields[] = $dbfield['name'];

    507. 

  507. 		return $dbfields;

    508. 

  508. 	}

    509. 

  509. 	

    510. 

  510. 	//debugging to check for valid chunks

    511. 

  511.     function checkTemplates() {

    512. 

  512.         global $modx;

    513. 

  513. 		$nonWayfinderFields = array();

    514. 

  514. 

    515. 

  515.         foreach ($this->_templates as $n => $v) {

    516. 

  516.             $templateCheck = $this->fetch($v);

    517. 

  517.             if (empty($v) || !$templateCheck) {

    518. 

  518.                 if ($n === 'outerTpl') {

    519. 

  519.                     $this->_templates[$n] = '<ul[+wf.classes+]>[+wf.wrapper+]</ul>';

    520. 

  520.                 } elseif ($n === 'rowTpl') {

    521. 

  521.                     $this->_templates[$n] = '<li[+wf.id+][+wf.classes+]><a href="[+wf.link+]" title="[+wf.title+]" [+wf.attributes+]>[+wf.linktext+]</a>[+wf.wrapper+]</li>';

    522. 

  522. 				} elseif ($n === 'startItemTpl') {

    523. 

  523. 					$this->_templates[$n] = '<h2[+wf.id+][+wf.classes+]>[+wf.linktext+]</h2>[+wf.wrapper+]';

    524. 

  524.                 } else {

    525. 

  525.                     $this->_templates[$n] = FALSE;

    526. 

  526.                 }

    527. 

  527. 				if ($this->_config['debug']) { $this->addDebugInfo('template',$n,$n,"No template found, using default.",array($n => $this->_templates[$n])); }

    528. 

  528.             } else {

    529. 

  529.                 $this->_templates[$n] = $templateCheck;

    530. 

  530. 				$check = $this->findTemplateVars($templateCheck);

    531. 

  531. 				if (is_array($check)) {

    532. 

  532. 					$nonWayfinderFields = array_merge($check, $nonWayfinderFields);

    533. 

  533. 				}

    534. 

  534. 				if ($this->_config['debug']) { $this->addDebugInfo('template',$n,$n,"Template Found.",array($n => $this->_templates[$n])); }

    535. 

  535.             }			

    536. 

  536.         }

    537. 

  537. 		

    538. 

  538. 		if (!empty($nonWayfinderFields)) {

    539. 

  539. 			$nonWayfinderFields = array_unique($nonWayfinderFields);

    540. 

  540. 			$allTvars = $this->getTVList();

    541. 

  541. 

    542. 

  542. 			foreach ($nonWayfinderFields as $field) {

    543. 

  543. 				if (in_array($field, $allTvars)) {

    544. 

  544. 					$this->placeHolders['tvs'][] = "[+{$field}+]";

    545. 

  545. 					$this->tvList[] = $field;

    546. 

  546. 				}

    547. 

  547. 			}

    548. 

  548. 			if ($this->_config['debug']) { $this->addDebugInfo('tvars','tvs','Template Variables',"The following template variables were found in your templates.",$this->tvList); }

    549. 

  549. 		}

    550. 

  550.     }

    551. 

  551. 	

    552. 

  552. 	function fetch($tpl){

    553. 

  553. 		// based on version by Doze at http://modxcms.com/forums/index.php/topic,5344.msg41096.html#msg41096

    554. 

  554. 		global $modx;

    555. 

  555. 		$template = "";

    556. 

  556. 		if ($modx->getChunk($tpl) != "") {

    557. 

  557. 			$template = $modx->getChunk($tpl);

    558. 

  558. 		} else if(substr($tpl, 0, 6) == "@FILE:") {

    559. 

  559. 			$template = $this->get_file_contents(substr($tpl, 6));

    560. 

  560. 		} else if(substr($tpl, 0, 6) == "@CODE:") {

    561. 

  561. 			$template = substr($tpl, 6);

    562. 

  562. 		} else {

    563. 

  563. 			$template = FALSE;

    564. 

  564. 		}

    565. 

  565. 		return $template;

    566. 

  566. 	}

    567. 

  567. 

    568. 

  568. 	function get_file_contents($filename) {

    569. 

  569. 		// Function written at http://www.nutt.net/2006/07/08/file_get_contents-function-for-php-4/#more-210

    570. 

  570. 		// Returns the contents of file name passed

    571. 

  571. 		if (!function_exists('file_get_contents')) {

    572. 

  572. 			$fhandle = fopen($filename, "r");

    573. 

  573. 			$fcontents = fread($fhandle, filesize($filename));

    574. 

  574. 			fclose($fhandle);

    575. 

  575. 		} else	{

    576. 

  576. 			$fcontents = file_get_contents($filename);

    577. 

  577. 		}

    578. 

  578. 		return $fcontents;

    579. 

  579. 	}

    580. 

  580. 	

    581. 

  581. 	function findTemplateVars($tpl) {

    582. 

  582. 		preg_match_all('~\[\+(.*?)\+\]~', $tpl, $matches);

    583. 

  583. 		$cnt = count($matches[1]);

    584. 

  584. 				

    585. 

  585. 		$tvnames = array ();

    586. 

  586. 		for ($i = 0; $i < $cnt; $i++) {

    587. 

  587. 			if (strpos($matches[1][$i], "wf.") === FALSE) {

    588. 

  588. 				$tvnames[] =  $matches[1][$i];

    589. 

  589. 			}

    590. 

  590. 		}

    591. 

  591. 

    592. 

  592. 		if (count($tvnames) >= 1) {

    593. 

  593. 			return array_unique($tvnames);

    594. 

  594. 		} else {

    595. 

  595. 			return false;

    596. 

  596. 		}

    597. 

  597. 	}

    598. 

  598. 	

    599. 

  599. 	function addDebugInfo($group,$groupkey,$header,$message,$info) {

    600. 

  600. 		$infoString = '<table border="1" cellpadding="3px">';

    601. 

  601. 		$numInfo = count($info);

    602. 

  602. 		$count = 0;

    603. 

  603. 		

    604. 

  604. 		foreach ($info as $key => $value) {

    605. 

  605. 			$key = $this->modxPrep($key);

    606. 

  606. 			if ($value === TRUE || $value === FALSE) {

    607. 

  607. 				$value = $value ? 'TRUE' : 'FALSE';

    608. 

  608. 			} else {

    609. 

  609. 				$value = $this->modxPrep($value);

    610. 

  610. 			}

    611. 

  611. 			if ($count == 2) { $infoString .= '</tr>'; $count = 0; }

    612. 

  612. 			if ($count == 0) { $infoString .= '<tr>'; }

    613. 

  613. 			$value = empty($value) ? '&nbsp;' : $value;

    614. 

  614. 			$infoString .= "<td><strong>{$key}</strong></td><td>{$value}</td>";

    615. 

  615. 			$count++;

    616. 

  616. 		}	

    617. 

  617. 		$infoString .= '</tr></table>';

    618. 

  618. 	

    619. 

  619. 		$this->debugInfo[$group][$groupkey] = array(

    620. 

  620. 			'header' => $this->modxPrep($header),

    621. 

  621. 			'message' => $this->modxPrep($message),

    622. 

  622. 			'info' => $infoString,

    623. 

  623. 		);

    624. 

  624. 	}

    625. 

  625. 	

    626. 

  626. 	function renderDebugOutput() {

    627. 

  627. 		$output = '<table border="1" cellpadding="3px" width="100%">';

    628. 

  628. 		foreach ($this->debugInfo as $group => $item) {

    629. 

  629. 			switch ($group) {

    630. 

  630. 				case 'template':

    631. 

  631. 					$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Template Processing</th></tr>";

    632. 

  632. 					foreach ($item as $parentId => $info) {

    633. 

  633. 						$output .= "

    634. 

  634. 							<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>

    635. 

  635. 							<tr><td>{$info['info']}</td></tr>";

    636. 

  636. 					}

    637. 

  637. 					break;

    638. 

  638. 				case 'wrapper':

    639. 

  639. 					$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Document Processing</th></tr>";

    640. 

  640. 					

    641. 

  641. 					foreach ($item as $parentId => $info) {

    642. 

  642. 						$output .= "<tr><table border=\"1\" cellpadding=\"3px\" style=\"margin-bottom: 10px;\" width=\"100%\">

    643. 

  643. 									<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>

    644. 

  644. 									<tr><td>{$info['info']}</td></tr>

    645. 

  645. 									<tr style=\"background:#336699;color:#fff;\"><th>Documents included in this wrapper:</th></tr>";

    646. 

  646. 															

    647. 

  647. 						foreach ($this->debugInfo['row'] as $key => $value) {

    648. 

  648. 							$keyParts = explode(':',$key);

    649. 

  649. 							if ($parentId == $keyParts[0]) {

    650. 

  650. 								$output .= "<tr style=\"background:#eee;\"><th>{$value['header']}</th></tr>

    651. 

  651. 									<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>";

    652. 

  652. 							}

    653. 

  653. 						}

    654. 

  654. 						

    655. 

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

    656. 

  656. 					}

    657. 

  657. 					

    658. 

  658. 					break;

    659. 

  659. 				case 'settings':

    660. 

  660. 					$output .= "<tr><th style=\"background:#C3D9FF;font-size:200%;\">Settings</th></tr>";

    661. 

  661. 					foreach ($item as $parentId => $info) {

    662. 

  662. 						$output .= "

    663. 

  663. 							<tr style=\"background:#336699;color:#fff;\"><th>{$info['header']} - <span style=\"font-weight:normal;\">{$info['message']}</span></th></tr>

    664. 

  664. 							<tr><td>{$info['info']}</td></tr>";

    665. 

  665. 					}

    666. 

  666. 					break;

    667. 

  667. 				default:

    668. 

  668. 				

    669. 

  669. 					break;

    670. 

  670. 			}

    671. 

  671. 		}

    672. 

  672. 		$output .= '</table>';

    673. 

  673. 		return $output;

    674. 

  674. 	}

    675. 

  675. 	

    676. 

  676. 	function modxPrep($value) {

    677. 

  677. 		$value = (strpos($value,"<") !== FALSE) ? htmlentities($value) : $value;

    678. 

  678. 		$value = str_replace("[","&#091;",$value);

    679. 

  679. 		$value = str_replace("]","&#093;",$value);

    680. 

  680. 		$value = str_replace("{","&#123;",$value);

    681. 

  681. 		$value = str_replace("}","&#125;",$value);

    682. 

  682. 		return $value;

    683. 

  683. 	}

    684. 

  684. }

    685. 

  685. 

    686. 

  686. ?>
    687.