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

/public_html/wire/core/WireMarkupRegions.php

https://bitbucket.org/thomas1151/mats
PHP | 1556 lines | 1371 code | 47 blank | 138 comment | 51 complexity | 595600e6b16d58214db6b5b2ed87ad8f MD5 | raw file
Possible License(s): Apache-2.0, BSD-3-Clause, LGPL-2.1, MPL-2.0-no-copyleft-exception

Large files files are truncated, but you can click here to view the full file

    

  1. <?php namespace ProcessWire;
    2. 

  2. 

  3. /**
    4. 

  4.  * ProcessWire Markup Regions
    5. 

  5.  * 
    6. 

  6.  * Supportings finding and manipulating of markup regions in an HTML document. 
    7. 

  7.  *
    8. 

  8.  * ProcessWire 3.x, Copyright 2017 by Ryan Cramer
    9. 

  9.  * https://processwire.com
    10. 

  10.  *
    11. 

  11.  */
    12. 

  12. 

  13. class WireMarkupRegions extends Wire {
    14. 

  14. 

  15. 	/**
    16. 

  16. 	 * Debug during development of this class
    17. 

  17. 	 * 
    18. 

  18. 	 */
    19. 

  19. 	const debug = false;
    20. 

  20. 

  21. 	/**
    22. 

  22. 	 * @var array
    23. 

  23. 	 * 
    24. 

  24. 	 */
    25. 

  25. 	protected $debugNotes = array();
    26. 

  26. 	
    27. 

  27. 	/**
    28. 

  28. 	 * HTML tag names that require no closing tag
    29. 

  29. 	 * 
    30. 

  30. 	 * @var array
    31. 

  31. 	 * 
    32. 

  32. 	 */
    33. 

  33. 	protected $selfClosingTags = array(
    34. 

  34. 		'link',
    35. 

  35. 		'area',
    36. 

  36. 		'base',
    37. 

  37. 		'br',
    38. 

  38. 		'col',
    39. 

  39. 		'command',
    40. 

  40. 		'embed',
    41. 

  41. 		'hr',
    42. 

  42. 		'img',
    43. 

  43. 		'input',
    44. 

  44. 		'keygen',
    45. 

  45. 		'link',
    46. 

  46. 		'meta',
    47. 

  47. 		'param',
    48. 

  48. 		'source',
    49. 

  49. 		'track',
    50. 

  50. 		'wbr',
    51. 

  51. 	);
    52. 

  52. 

  53. 	/**
    54. 

  54. 	 * Supported markup region actions
    55. 

  55. 	 * 
    56. 

  56. 	 * @var array
    57. 

  57. 	 * 
    58. 

  58. 	 */
    59. 

  59. 	protected $actions = array(
    60. 

  60. 		'prepend',
    61. 

  61. 		'append',
    62. 

  62. 		'before',
    63. 

  63. 		'after',
    64. 

  64. 		'replace',
    65. 

  65. 		'remove',
    66. 

  66. 	);
    67. 

  67. 

  68. 	/**
    69. 

  69. 	 * Locate and return all regions of markup having the given attribute
    70. 

  70. 	 * 
    71. 

  71. 	 * @param string $selector Specify one of the following:
    72. 

  72. 	 *  - Name of an attribute that must be present, i.e. "data-region", or "attribute=value" or "tag[attribute=value]".
    73. 

  73. 	 *  - Specify `#name` to match a specific `id='name'` attribute.
    74. 

  74. 	 *  - Specify `.name` or `tag.name` to match a specific `class='name'` attribute (class can appear anywhere in class attribute).
    75. 

  75. 	 *  - Specify `.name*` to match class name starting with a name prefix. 
    76. 

  76. 	 *  - Specify `<tag>` to match all of those HTML tags (i.e. `<head>`, `<body>`, `<title>`, `<footer>`, etc.)
    77. 

  77. 	 * @param string $markup HTML document markup to perform the find in.
    78. 

  78. 	 * @param array $options Optional options to modify default behavior: 
    79. 

  79. 	 *  - `single` (bool): Return just the markup from the first matching region (default=false).
    80. 

  80. 	 *  - `verbose` (bool): Specify true to return array of verbose info detailing what was found (default=false). 
    81. 

  81. 	 *  - `wrap` (bool): Include wrapping markup? Default is false for id or attribute matches, and true for class matches.
    82. 

  82. 	 *  - `max` (int): Maximum allowed regions to return (default=500).
    83. 

  83. 	 *  - `exact` (bool): Return region markup exactly as-is? (default=false). Specify true when using return values for replacement.
    84. 

  84. 	 *  - `leftover` (bool): Specify true if you want to return a "leftover" key in return value with leftover markup. 
    85. 

  85. 	 * @return array Returns one of the following: 
    86. 

  86. 	 *  - Associative array of [ 'id' => 'markup' ] when finding specific attributes or #id attributes. 
    87. 

  87. 	 *  - Regular array of markup regions when finding regions having a specific class attribute. 
    88. 

  88. 	 *  - Associative array of verbose information when the verbose option is used. 
    89. 

  89. 	 * @throws WireException if given invalid $find string
    90. 

  90. 	 * 
    91. 

  91. 	 */
    92. 

  92. 	public function find($selector, $markup, array $options = array()) {
    93. 

  93. 	
    94. 

  94. 		if(strpos($selector, ',')) return $this->findMulti($selector, $markup, $options);
    95. 

  95. 		
    96. 

  96. 		$defaults = array(
    97. 

  97. 			'single' => false, 
    98. 

  98. 			'verbose' => false, 
    99. 

  99. 			'wrap' => null,
    100. 

  100. 			'max' => 500, 
    101. 

  101. 			'exact' => false, 
    102. 

  102. 			'leftover' => false,
    103. 

  103. 		);
    104. 

  104. 

  105. 		$options = array_merge($defaults, $options);
    106. 

  106. 		$selectorInfo = $this->parseFindSelector($selector); 
    107. 

  107. 		$tests = $selectorInfo['tests'];
    108. 

  108. 		$findTag = $selectorInfo['findTag'];
    109. 

  109. 		$hasClass = $selectorInfo['hasClass'];
    110. 

  110. 		$regions = array();
    111. 

  111. 		$_markup = self::debug ? $markup : '';
    112. 

  112. 		
    113. 

  113. 		if(self::debug) {
    114. 

  114. 			$options['debugNote'] = (empty($options['debugNote']) ? "" : "$options[debugNote] => ") . "find($selector)";
    115. 

  115. 		}
    116. 

  116. 		
    117. 

  117. 		// strip out comments if markup isn't required to stay the same
    118. 

  118. 		if(!$options['exact']) $markup = $this->stripRegions('<!--', $markup);
    119. 

  119. 		
    120. 

  120. 		// determine auto value for wrap option
    121. 

  121. 		if(is_null($options['wrap'])) $options['wrap'] = $hasClass ? true : false;
    122. 

  122. 

  123. 		$startPos = 0;
    124. 

  124. 		$whileCnt = 0; // number of do-while loop completions
    125. 

  125. 		$iterations = 0; // total number of iterations, including continue statements
    126. 

  126. 

  127. 		do {
    128. 

  128. 			if(++$iterations >= $options['max'] * 2) break;
    129. 

  129. 			
    130. 

  130. 			// find all the positions where each test appears
    131. 

  131. 			$positions = array();
    132. 

  132. 			foreach($tests as $str) {
    133. 

  133. 				$pos = stripos($markup, $str, $startPos);
    134. 

  134. 				if($pos === false) continue;
    135. 

  135. 				if($selector === '.pw-*') {
    136. 

  136. 					// extra validation for .pw-* selectors to confirm they match a pw-[action] (legacy support)
    137. 

  137. 					$testAction = '';
    138. 

  138. 					$testPW = substr($markup, $pos, 20);
    139. 

  139. 					foreach($this->actions as $testAction) {
    140. 

  140. 						if(strpos($testPW, $testAction) !== false) {
    141. 

  141. 							$testAction = true;
    142. 

  142. 							break;
    143. 

  143. 						}
    144. 

  144. 					}	
    145. 

  145. 					if($testAction !== true) continue; // if not a pw-[action] then skip
    146. 

  146. 				}
    147. 

  147. 				if($str[0] == '<') $pos++; // HTML tag match, bump+1 to enable match
    148. 

  148. 				$positions[$pos] = $pos;
    149. 

  149. 			}
    150. 

  150. 			
    151. 

  151. 			// if no tests matched, we can abort now
    152. 

  152. 			if(empty($positions)) break;
    153. 

  153. 			
    154. 

  154. 			// sort the matching test positions closest to furthest and get the first match
    155. 

  155. 			ksort($positions);
    156. 

  156. 			$pos = reset($positions);	
    157. 

  157. 			$startPos = $pos;
    158. 

  158. 			$markupBefore = substr($markup, 0, $pos);
    159. 

  159. 			$markupAfter = substr($markup, $pos);
    160. 

  160. 			$openTagPos = strrpos($markupBefore, '<');
    161. 

  161. 			$closeOpenTagPos = strpos($markupAfter, '>');
    162. 

  162. 			$startPos += $closeOpenTagPos; // for next iteration, if a continue occurs
    163. 

  163. 		
    164. 

  164. 			// if the orders of "<" and ">" aren't what's expected in our markupBefore and markupAfter, then abort
    165. 

  165. 			$testPos = strpos($markupAfter, '<');
    166. 

  166. 			if($testPos !== false && $testPos < $closeOpenTagPos) continue;
    167. 

  167. 			if(strrpos($markupBefore, '>') > $openTagPos) continue; 
    168. 

  168. 	
    169. 

  169. 			// build the HTML tag by combining the halfs from markupBefore and markupAfter
    170. 

  170. 			$tag = substr($markupBefore, $openTagPos) . substr($markupAfter, 0, $closeOpenTagPos + 1);
    171. 

  171. 			$tagInfo = $this->getTagInfo($tag);
    172. 

  172. 		
    173. 

  173. 			// pre-checks to make sure this iteration is allowed
    174. 

  174. 			if($findTag && $tagInfo['name'] !== $findTag) continue;
    175. 

  175. 			if(!$tagInfo['action'] && $hasClass && !$this->hasClass($hasClass, $tagInfo['classes'])) continue;
    176. 

  176. 

  177. 			// build the region (everything in $markupAfter that starts after the ">")
    178. 

  178. 			$regionMarkup = empty($tagInfo['close']) ? '' : substr($markupAfter, $closeOpenTagPos + 1);
    179. 

  179. 			$region = $this->getTagRegion($regionMarkup, $tagInfo, $options);
    180. 

  180. 

  181. 			if($options['single']) {
    182. 

  182. 				// single mode means we just return the markup
    183. 

  183. 				$regions = $region;
    184. 

  184. 				break;
    185. 

  185. 				
    186. 

  186. 			} else {
    187. 

  187. 				while(isset($regions[$pos])) $pos++;
    188. 

  188. 				$regions[$pos] = $region;
    189. 

  189. 			}
    190. 

  190. 

  191. 			$replaceQty = 0;
    192. 

  192. 			$markup = str_replace($region['html'], '', $markup, $replaceQty);
    193. 

  193. 			if(!$replaceQty) {
    194. 

  194. 				// region html was not present, try replacement without closing tag (which might be missing)
    195. 

  195. 				$markup = str_replace($region['open'] . $region['region'], '', $markup, $replaceQty);
    196. 

  196. 				if($replaceQty) {
    197. 

  197. 					$this->debugNotes[] = "ERROR: missing closing tag for: $region[open]";
    198. 

  198. 				} else {
    199. 

  199. 					$this->debugNotes[] = "ERROR: unable to populate: $region[open]";
    200. 

  200. 				}
    201. 

  201. 			}
    202. 

  202. 

  203. 			if($replaceQty) $startPos = 0;
    204. 

  204. 			$markup = trim($markup);
    205. 

  205. 			if(empty($markup)) break;
    206. 

  206. 			
    207. 

  207. 		} while(++$whileCnt < $options['max']);
    208. 

  208. 

  209. 		/*
    210. 

  210. 		foreach($regions as $regionKey => $region) {
    211. 

  211. 			foreach($regions as $rk => $r) {
    212. 

  212. 				if($rk === $regionKey) continue;
    213. 

  213. 				if(strpos($region['html'], $r['html']) !== false) {
    214. 

  214. 					$regions[$regionKey]['region'] = str_replace($r['html'], '', $region['region']); 
    215. 

  215. 					//$k = 'html';
    216. 

  216. 					//$this->debugNotes[] = 
    217. 

  217. 					//	"\nREPLACE “" . htmlentities($r[$k]) . "”". 
    218. 

  218. 					//	"\nIN      “" . htmlentities($region[$k]) . "”" . 
    219. 

  219. 					//	"\nRESULT  “" . htmlentities($regions[$regionKey][$k]) . "”";
    220. 

  220. 				}
    221. 

  221. 			}
    222. 

  222. 		}
    223. 

  223. 		*/
    224. 

  224. 		
    225. 

  225. 		if($options['leftover']) $regions["leftover"] = trim($markup);
    226. 

  226. 		
    227. 

  227. 		if(self::debug && $options['verbose']) {
    228. 

  228. 			$debugNote = "$options[debugNote] in [sm]" . $this->debugNoteStr($_markup, 50) . " …[/sm] => ";
    229. 

  229. 			$numRegions = 0;
    230. 

  230. 			foreach($regions as $key => $region) {
    231. 

  231. 				if($key == 'leftover') continue;
    232. 

  232. 				$details = empty($region['details']) ? '' : " ($region[details]) ";
    233. 

  233. 				$debugNote .= "$region[name]#$region[pwid]$details, ";
    234. 

  234. 				$numRegions++;
    235. 

  235. 			}
    236. 

  236. 			if(!$numRegions) $debugNote .= 'NONE';
    237. 

  237. 			$this->debugNotes[] = rtrim($debugNote, ", ") . " [sm](iterations=$iterations)[/sm]";
    238. 

  238. 		}
    239. 

  239. 

  240. 		return $regions;
    241. 

  241. 	}
    242. 

  242. 	
    243. 

  243. 	/**
    244. 

  244. 	 * Multi-selector version of find(), where $selector contains CSV
    245. 

  245. 	 *
    246. 

  246. 	 * @param string $selector
    247. 

  247. 	 * @param string $markup
    248. 

  248. 	 * @param array $options
    249. 

  249. 	 * @return array
    250. 

  250. 	 *
    251. 

  251. 	 */
    252. 

  252. 	protected function findMulti($selector, $markup, array $options = array()) {
    253. 

  253. 		
    254. 

  254. 		$regions = array();
    255. 

  255. 		$o = $options;
    256. 

  256. 		$o['leftover'] = true;
    257. 

  257. 		$leftover = '';
    258. 

  258. 		
    259. 

  259. 		foreach(explode(',', $selector) as $s) {
    260. 

  260. 			foreach($this->find(trim($s), $markup, $o) as $key => $region) {
    261. 

  261. 				if($key === 'leftover') {
    262. 

  262. 					$leftover .= $region;
    263. 

  263. 				} else {
    264. 

  264. 					while(isset($regions[$key])) $key++;
    265. 

  265. 					$regions[$key] = $region;
    266. 

  266. 				}
    267. 

  267. 			}
    268. 

  268. 			$markup = $leftover;
    269. 

  269. 		}
    270. 

  270. 		
    271. 

  271. 		if(!empty($options['leftover'])) {
    272. 

  272. 			if(!empty($leftover)) {
    273. 

  273. 				foreach($regions as $key => $region) {
    274. 

  274. 					if(strpos($leftover, $region['html']) !== false) {
    275. 

  275. 						$leftover = str_replace($region['html'], '', $leftover);	
    276. 

  276. 					}
    277. 

  277. 				}
    278. 

  278. 			}
    279. 

  279. 			$regions['leftover'] = $leftover;
    280. 

  280. 		}
    281. 

  281. 		
    282. 

  282. 		ksort($regions);
    283. 

  283. 		
    284. 

  284. 		return $regions;
    285. 

  285. 	}
    286. 

  286. 

  287. 

  288. 	/**
    289. 

  289. 	 * Does the given class exist in given $classes array?
    290. 

  290. 	 * 
    291. 

  291. 	 * @param string $class May be class name, or class prefix if $class has "*" at end. 
    292. 

  292. 	 * @param array $classes
    293. 

  293. 	 * @return bool|string Returns false if no match, or class name if matched
    294. 

  294. 	 * 
    295. 

  295. 	 */
    296. 

  296. 	protected function hasClass($class, array $classes) {
    297. 

  297. 		$has = false;
    298. 

  298. 		if(strpos($class, '*')) {
    299. 

  299. 			// partial class match
    300. 

  300. 			$class = rtrim($class, '*');
    301. 

  301. 			foreach($classes as $c) {
    302. 

  302. 				if(strpos($c, $class) === 0) {
    303. 

  303. 					$has = $c;
    304. 

  304. 					break;
    305. 

  305. 				}
    306. 

  306. 			}
    307. 

  307. 		} else {
    308. 

  308. 			// exact class match
    309. 

  309. 			$key = array_search($class, $classes);
    310. 

  310. 			if($key !== false) $has = $classes[$key];
    311. 

  311. 		}
    312. 

  312. 		return $has; 
    313. 

  313. 	}
    314. 

  314. 	
    315. 

  315. 	/**
    316. 

  316. 	 * Given a $find selector return array with tests and other meta info
    317. 

  317. 	 * 
    318. 

  318. 	 * @param string $find
    319. 

  319. 	 * @return array Returns array of [
    320. 

  320. 	 *   'tests' => [ 0 => '', 1 => '', ...], 
    321. 

  321. 	 *   'find' => '', 
    322. 

  322. 	 *   'findTag' => '', 
    323. 

  323. 	 *   'hasClass' => '',
    324. 

  324. 	 * ] 
    325. 

  325. 	 * 
    326. 

  326. 	 */
    327. 

  327. 	protected function parseFindSelector($find) {
    328. 

  328. 		
    329. 

  329. 		$findTag = '';
    330. 

  330. 		$hasClass = '';
    331. 

  331. 		$finds = array();
    332. 

  332. 		
    333. 

  333. 		if(strpos($find, '.') > 0) {
    334. 

  334. 			// i.e. "div.myclass"
    335. 

  335. 			list($findTag, $_find) = explode('.', $find, 2);
    336. 

  336. 			if($this->wire('sanitizer')->alphanumeric($findTag) === $findTag) {
    337. 

  337. 				$find = ".$_find";
    338. 

  338. 			} else {
    339. 

  339. 				$findTag = '';
    340. 

  340. 			}
    341. 

  341. 		}
    342. 

  342. 		
    343. 

  343. 		$c = substr($find, 0, 1); 
    344. 

  344. 		$z = substr($find, -1);
    345. 

  345. 		
    346. 

  346. 		if($c === '#') {
    347. 

  347. 			// match an id, pw-id or data-pw-id attribute
    348. 

  348. 			$find = trim($find, '# ');
    349. 

  349. 			foreach(array('pw-id', 'data-pw-id', 'id') as $attr) {
    350. 

  350. 				$finds[] = " $attr=\"$find\"";
    351. 

  351. 				$finds[] = " $attr='$find'";
    352. 

  352. 				$finds[] = " $attr=$find ";
    353. 

  353. 				$finds[] = " $attr=$find>";
    354. 

  354. 			}
    355. 

  355. 

  356. 		} else if($find === '[pw-action]') {
    357. 

  357. 			// find pw-[action] boolean attributes
    358. 

  358. 			foreach($this->actions as $action) {
    359. 

  359. 				$finds[] = " data-pw-$action ";
    360. 

  360. 				$finds[] = " data-pw-$action>";
    361. 

  361. 				$finds[] = " data-pw-$action=";
    362. 

  362. 				$finds[] = " pw-$action ";
    363. 

  363. 				$finds[] = " pw-$action>";
    364. 

  364. 				$finds[] = " pw-$action=";
    365. 

  365. 			}
    366. 

  366. 

  367. 		/*	
    368. 

  368. 		} else if($c === '[' && $z === ']') {
    369. 

  369. 			// find any attribute (not currently used by markup regions)
    370. 

  370. 			
    371. 

  371. 			if(strpos($find, '=') === false) {
    372. 

  372. 				// match an attribute only
    373. 

  373. 				$attr = trim($find, '[]*+');
    374. 

  374. 				$tail = substr($find, -2);
    375. 

  375. 				if($tail === '*]') {
    376. 

  376. 					// match an attribute prefix
    377. 

  377. 					$finds = array(" $attr");
    378. 

  378. 				} else {
    379. 

  379. 					// match a whole attribute name
    380. 

  380. 					$finds = array(
    381. 

  381. 						" $attr ",
    382. 

  382. 						" $attr>",
    383. 

  383. 						" $attr=",
    384. 

  384. 					);
    385. 

  385. 				}
    386. 

  386. 			} else {
    387. 

  387. 				// match attribute and value (not yet implemented)
    388. 

  388. 			}
    389. 

  389. 		*/
    390. 

  390. 			
    391. 

  391. 		} else if($c === '.' && $z === '*') {
    392. 

  392. 			// match a class name prefix or action prefix
    393. 

  393. 			$find = trim($find, '.*');
    394. 

  394. 			$finds = array(
    395. 

  395. 				' class="' . $find,
    396. 

  396. 				" class='$find",
    397. 

  397. 				" class=$find",
    398. 

  398. 				" $find",
    399. 

  399. 				"'$find",
    400. 

  400. 				"\"$find",
    401. 

  401. 			);
    402. 

  402. 			if(strpos($find, 'pw-') !== false) $finds[] = " data-$find";
    403. 

  403. 			$hasClass = "$find*";
    404. 

  404. 

  405. 		} else if($c === '.') {
    406. 

  406. 			// match a class name or action
    407. 

  407. 			$find = trim($find, '.');
    408. 

  408. 			$finds = array(
    409. 

  409. 				' class="' . $find . '"',
    410. 

  410. 				" class='$find'",
    411. 

  411. 				" class=$find ",
    412. 

  412. 				" class=$find>",
    413. 

  413. 				" $find'",
    414. 

  414. 				"'$find ",
    415. 

  415. 				" $find\"",
    416. 

  416. 				"\"$find ",
    417. 

  417. 				" $find ",
    418. 

  418. 			);
    419. 

  419. 			if(strpos($find, 'pw-') !== false) $finds[] = " data-$find";
    420. 

  420. 			$hasClass = $find;
    421. 

  421. 			
    422. 

  422. 		} else if($c === '<') {
    423. 

  423. 			// matching a single-use HTML tag
    424. 

  424. 			$finds = array(
    425. 

  425. 				$find,
    426. 

  426. 				rtrim($find, '>') . ' ',
    427. 

  427. 			);
    428. 

  428. 			
    429. 

  429. 		} else if(strpos($find, '=') !== false) {
    430. 

  430. 			// some other specified attribute in attr=value format
    431. 

  431. 			if(strpos($find, '[') !== false && $z === ']') {
    432. 

  432. 				// i.e. div[attr=value]
    433. 

  433. 				list($findTag, $find) = explode('[', $find, 2);
    434. 

  434. 				$find = rtrim($find, ']');
    435. 

  435. 			}
    436. 

  436. 			list($attr, $val) = explode('=', $find);
    437. 

  437. 			if(strlen($val)) {
    438. 

  438. 				$finds = array(
    439. 

  439. 					" $attr=\"$val\"",
    440. 

  440. 					" $attr='$val'",
    441. 

  441. 					" $attr=$val",
    442. 

  442. 					" $attr=$val>"
    443. 

  443. 				);
    444. 

  444. 			} else {
    445. 

  445. 				$finds = array(" $attr=");
    446. 

  446. 			}
    447. 

  447. 			
    448. 

  448. 			if(strpos($find, 'id=') === 0) {
    449. 

  449. 				// when finding an id attribute, also allow for "pw-id=" and "data-pw-id="
    450. 

  450. 				foreach($finds as $find) {
    451. 

  451. 					$find = ltrim($find);
    452. 

  452. 					$finds[] = " pw-id=";
    453. 

  453. 					$finds[] = " data-pw-id=";
    454. 

  454. 				}
    455. 

  455. 			}
    456. 

  456. 

  457. 		} else if($z === '*') {
    458. 

  458. 			// data-pw-* matches non-value attribute starting with a prefix
    459. 

  459. 			$finds = array(
    460. 

  460. 				" $find",
    461. 

  461. 			);
    462. 

  462. 

  463. 		} else {
    464. 

  464. 			// "data-something" matches attributes with no value, like "<div data-something>"
    465. 

  465. 			$finds = array(
    466. 

  466. 				" $find ",
    467. 

  467. 				" $find>",
    468. 

  468. 				" $find"
    469. 

  469. 			);
    470. 

  470. 		}
    471. 

  471. 		
    472. 

  472. 		return array(
    473. 

  473. 			'tests' => $finds, 
    474. 

  474. 			'selector' => $find,
    475. 

  475. 			'findTag' => $findTag, 
    476. 

  476. 			'hasClass' => $hasClass
    477. 

  477. 		);
    478. 

  478. 	}
    479. 

  479. 

  480. 	/**
    481. 

  481. 	 * Given all markup after a tag, return just the portion that is the tag body/region
    482. 

  482. 	 * 
    483. 

  483. 	 * @param string $region Markup that occurs after the ">" of the tag you want to get the region of.
    484. 

  484. 	 * @param array $tagInfo Array returned by getTagInfo method.
    485. 

  485. 	 * @param array $options Options to modify behavior, see getMarkupRegions $options argument. 
    486. 

  486. 	 *  - `verbose` (bool): Verbose mode (default=false)
    487. 

  487. 	 *  - `wrap` (bool): Whether or not wrapping markup should be included (default=false)
    488. 

  488. 	 * @return array|string Returns string except when verbose mode enabled it returns array.
    489. 

  489. 	 * 
    490. 

  490. 	 */
    491. 

  491. 	protected function getTagRegion($region, array $tagInfo, array $options) {
    492. 

  492. 		
    493. 

  493. 		// options
    494. 

  494. 		$verbose = empty($options['verbose']) ? false : true;
    495. 

  495. 		$wrap = empty($options['wrap']) ? false : $options['wrap'];
    496. 

  496. 		
    497. 

  497. 		if($verbose) $verboseRegion = array(
    498. 

  498. 			'name' => "$tagInfo[name]",
    499. 

  499. 			'pwid' => "$tagInfo[pwid]", 
    500. 

  500. 			'open' => "$tagInfo[src]", 
    501. 

  501. 			'close' => "$tagInfo[close]",
    502. 

  502. 			'attrs' => $tagInfo['attrs'], 
    503. 

  503. 			'classes' => $tagInfo['classes'], 
    504. 

  504. 			'action' => $tagInfo['action'],
    505. 

  505. 			'actionType' => $tagInfo['actionType'], 
    506. 

  506. 			'actionTarget' => $tagInfo['actionTarget'],
    507. 

  507. 			'error' => false, 
    508. 

  508. 			'details' => '',
    509. 

  509. 			'region' => '', // region without wrapping tags
    510. 

  510. 			'html' => '', // region with wrapping tags
    511. 

  511. 		);
    512. 

  512. 	
    513. 

  513. 		if($tagInfo['pwid']) $tagID = $tagInfo['pwid'];
    514. 

  514. 			else if(!empty($tagInfo['id'])) $tagID = $tagInfo['id'];
    515. 

  515. 			else if(!empty($tagInfo['attrs']['id'])) $tagID = $tagInfo['attrs']['id']; 
    516. 

  516. 			else if(!empty($tagInfo['actionTarget'])) $tagID = $tagInfo['actionTarget'];	
    517. 

  517. 			else $tagID = '';
    518. 

  518. 	
    519. 

  519. 		$selfClose = empty($tagInfo['close']);
    520. 

  520. 		$closeHint = "$tagInfo[close]<!--#$tagID-->";
    521. 

  521. 		$closeQty = $selfClose ? 1 : substr_count($region, $tagInfo['close']);
    522. 

  522. 

  523. 		if(!$closeQty) {
    524. 

  524. 			// there is no close tag, meaning all of markupAfter is the region
    525. 

  525. 			if($verbose) $verboseRegion['details'] = 'No closing tag, matched rest of document';
    526. 

  526. 			
    527. 

  527. 		} else if($selfClose) {
    528. 

  528. 			$region = '';
    529. 

  529. 			if($verbose) $verboseRegion['details'] = 'Self closing tag (empty region)';
    530. 

  530. 			
    531. 

  531. 		} else if($tagID && false !== ($pos = strpos($region, $closeHint))) {
    532. 

  532. 			// close tag indicates what it closes, i.e. “</div><!--#content-->”
    533. 

  533. 			$region = substr($region, 0, $pos);
    534. 

  534. 			$tagInfo['close'] = $closeHint;
    535. 

  535. 			if($verbose) $verboseRegion['details'] = "Fast match with HTML comment hint";
    536. 

  536. 			
    537. 

  537. 		} else if($closeQty === 1) {
    538. 

  538. 			// just one close tag present, making our job easy
    539. 

  539. 			$region = substr($region, 0, strrpos($region, $tagInfo['close']));
    540. 

  540. 			if($verbose) $verboseRegion['details'] = "Only 1 possible closing tag: $tagInfo[close]";
    541. 

  541. 

  542. 		} else {
    543. 

  543. 			// multiple close tags present, must figure out which is the right one
    544. 

  544. 			$testStart = 0;
    545. 

  545. 			$doCnt = 0;
    546. 

  546. 			$maxDoCnt = 100000;
    547. 

  547. 			$openTag1 = "<$tagInfo[name]>";
    548. 

  548. 			$openTag2 = "<$tagInfo[name] ";
    549. 

  549. 			$fail = false;
    550. 

  550. 			
    551. 

  551. 			do {
    552. 

  552. 				$doCnt++;
    553. 

  553. 				$testPos = stripos($region, $tagInfo['close'], $testStart);
    554. 

  554. 				if($testPos === false) {
    555. 

  555. 					$fail = true;
    556. 

  556. 					break;
    557. 

  557. 				}
    558. 

  558. 				$test = substr($region, 0, $testPos);
    559. 

  559. 				$openCnt = substr_count($test, $openTag1) + substr_count($test, $openTag2);
    560. 

  560. 				$closeCnt = substr_count($test, $tagInfo['close']);
    561. 

  561. 				if($openCnt == $closeCnt) {
    562. 

  562. 					// open and close tags balance, meaning we've found our region
    563. 

  563. 					$region = $test;
    564. 

  564. 					break;
    565. 

  565. 				} else {
    566. 

  566. 					// tags within don't balance, so try again
    567. 

  567. 					$testStart = $testPos + strlen($tagInfo['close']);
    568. 

  568. 				}
    569. 

  569. 			} while($doCnt < $maxDoCnt && $testStart < strlen($region));
    570. 

  570. 			
    571. 

  571. 			if($fail) {
    572. 

  572. 				if($verbose) {
    573. 

  573. 					$verboseRegion['error'] = true;
    574. 

  574. 					$verboseRegion['details'] = "Failed to find closing tag $tagInfo[close] after $doCnt iterations";
    575. 

  575. 				} else {
    576. 

  576. 					$region = 'error';
    577. 

  577. 				}
    578. 

  578. 			} else if($doCnt >= $maxDoCnt) {
    579. 

  579. 				if($verbose) {
    580. 

  580. 					$verboseRegion['error'] = true;
    581. 

  581. 					$verboseRegion['details'] = "Failed region match after $doCnt tests for <$tagInfo[name]> tag(s)";
    582. 

  582. 				} else {
    583. 

  583. 					$region = 'error';
    584. 

  584. 				}
    585. 

  585. 			} else if($verbose) {
    586. 

  586. 				$verboseRegion['details'] = "Matched region after testing $doCnt <$tagInfo[name]> tag(s)";
    587. 

  587. 			}
    588. 

  588. 		}
    589. 

  589. 	
    590. 

  590. 		// region with wrapping tag
    591. 

  591. 		$wrapRegion = $selfClose ? "$tagInfo[src]" : "$tagInfo[src]$region$tagInfo[close]";
    592. 

  592. 		
    593. 

  593. 		if($verbose) {
    594. 

  594. 			$verboseRegion['region'] = $region;
    595. 

  595. 			$verboseRegion['html'] = $wrapRegion;
    596. 

  596. 			/*
    597. 

  597. 			if(self::debug) {
    598. 

  598. 				$debugNote = (isset($options['debugNote']) ? "$options[debugNote] => " : "") . 
    599. 

  599. 					"getTagRegion() => $verboseRegion[name]#$verboseRegion[pwid] " . 
    600. 

  600. 					"[sm]$verboseRegion[details][/sm]";
    601. 

  601. 				$this->debugNotes[] = $debugNote;
    602. 

  602. 			}
    603. 

  603. 			*/
    604. 

  604. 			return $verboseRegion;
    605. 

  605. 		}
    606. 

  606. 		
    607. 

  607. 		// include wrapping markup if asked for
    608. 

  608. 		if($wrap) $region = $wrapRegion;
    609. 

  609. 

  610. 		return $region;
    611. 

  611. 	}
    612. 

  612. 

  613. 	/**
    614. 

  614. 	 * Given HTML tag like “<div id='foo' class='bar baz'>” return associative array of info about it
    615. 

  615. 	 * 
    616. 

  616. 	 * Returned info includes:
    617. 

  617. 	 *  - `name` (string): Tag name
    618. 

  618. 	 *  - `id` (string): Value of id attribute
    619. 

  619. 	 *  - `pwid` (string): PW region ID from 'pw-id' or 'data-pw-id', or if not present, then same as 'id'
    620. 

  620. 	 *  - `action` (string): Action for this region, without “pw-” prefix.
    621. 

  621. 	 *  - `actionTarget` (string): Target id for the action, if applicable.
    622. 

  622. 	 *  - `actionType` (string): "class" if action specified as class name, "attr" if specified as a pw- or data-pw attribute.
    623. 

  623. 	 *  - `classes` (array): Array of class names (from class attribute). 
    624. 

  624. 	 *  - `attrs` (array): Associative array of all attributes, all values are strings.
    625. 

  625. 	 *  - `attrStr` (string): All attributes in a string
    626. 

  626. 	 *  - `tag` (string): The entire tag as given
    627. 

  627. 	 *  - `close` (string): The HTML string that would close this tag
    628. 

  628. 	 * 
    629. 

  629. 	 * @param string $tag Must be a tag in format “<tag attrs>”
    630. 

  630. 	 * @return array
    631. 

  631. 	 * 
    632. 

  632. 	 */
    633. 

  633. 	public function getTagInfo($tag) {
    634. 

  634. 		
    635. 

  635. 		$attrs = array();
    636. 

  636. 		$attrStr = '';
    637. 

  637. 		$name = '';
    638. 

  638. 		$tagName = '';
    639. 

  639. 		$val = '';
    640. 

  640. 		$inVal = false;
    641. 

  641. 		$inTagName = true;
    642. 

  642. 		$inQuote = '';
    643. 

  643. 		$originalTag = $tag;
    644. 

  644. 	
    645. 

  645. 		// normalize tag to include only what's between "<" and ">" and remove unnecessary whitespace 
    646. 

  646. 		$tag = str_replace(array("\r", "\n", "\t"), ' ', $tag); 
    647. 

  647. 		$tag = trim($tag, '</> ');
    648. 

  648. 		$pos = strpos($tag, '>'); 
    649. 

  649. 		if($pos) $tag = substr($tag, 0, $pos);
    650. 

  650. 		while(strpos($tag, '  ') !== false) $tag = str_replace('  ', ' ', $tag); 
    651. 

  651. 		$tag = str_replace(array(' =', '= '), '=', $tag); 
    652. 

  652. 		$tag .= ' '; // extra space for loop below
    653. 

  653. 

  654. 		// iterate through each character in the tag
    655. 

  655. 		for($n = 0; $n < strlen($tag); $n++) {
    656. 

  656. 			
    657. 

  657. 			$c = $tag[$n];
    658. 

  658. 			
    659. 

  659. 			if($c == '"' || $c == "'") {
    660. 

  660. 				if($inVal) {
    661. 

  661. 					// building a value
    662. 

  662. 					if($inQuote === $c) {
    663. 

  663. 						// end of value, populate to attrs and reset val
    664. 

  664. 						$attrs[$name] = $val;
    665. 

  665. 						$inQuote = false;
    666. 

  666. 						$inVal = false;
    667. 

  667. 						$name = '';
    668. 

  668. 						$val = '';
    669. 

  669. 					} else if(!strlen($val)) {
    670. 

  670. 						// starting a value
    671. 

  671. 						$inQuote = $c;
    672. 

  672. 					} else {
    673. 

  673. 						// continue appending value
    674. 

  674. 						$val .= $c;
    675. 

  675. 					}
    676. 

  676. 				} else {
    677. 

  677. 					// not building a value, but found a quote, not sure what it's for, so skip it
    678. 

  678. 				}
    679. 

  679. 				
    680. 

  680. 			} else if($c === ' ') {
    681. 

  681. 				// space can either separate attributes or be part of a quoted value
    682. 

  682. 				if($inVal) {
    683. 

  683. 					if($inQuote) {
    684. 

  684. 						// quoted space is part of value
    685. 

  685. 						$val .= $c;
    686. 

  686. 					} else {
    687. 

  687. 						// unquoted space ends the attribute value
    688. 

  688. 						if($name) $attrs[$name] = $val;
    689. 

  689. 						$inVal = false;
    690. 

  690. 						$name = '';
    691. 

  691. 						$val = '';
    692. 

  692. 					}
    693. 

  693. 				} else {
    694. 

  694. 					if($name && !isset($attrs[$name])) {
    695. 

  695. 						// attribute without a value
    696. 

  696. 						$attrs[$name] = true;
    697. 

  697. 					}
    698. 

  698. 					// start of a new attribute name
    699. 

  699. 					$name = '';
    700. 

  700. 					$inTagName = false;
    701. 

  701. 				}
    702. 

  702. 				
    703. 

  703. 			} else if($c === '=') {
    704. 

  704. 				// equals separates attribute names from values, or can appear in an attribute value
    705. 

  705. 				if($inVal && $inQuote) {
    706. 

  706. 					// part of a value
    707. 

  707. 					$val .= $c;
    708. 

  708. 				} else {
    709. 

  709. 					// start new value
    710. 

  710. 					$inVal = true;
    711. 

  711. 				}
    712. 

  712. 			} else if($inVal) {
    713. 

  713. 				// append attribute value
    714. 

  714. 				$val .= $c; 
    715. 

  715. 			} else if(trim($c)) {
    716. 

  716. 				// tag name or attribute name
    717. 

  717. 				if($inTagName) {
    718. 

  718. 					$tagName .= $c;
    719. 

  719. 				} else {
    720. 

  720. 					$name .= $c;
    721. 

  721. 				}
    722. 

  722. 			}
    723. 

  723. 		
    724. 

  724. 			if(!$inTagName) $attrStr .= $c;	
    725. 

  725. 		}
    726. 

  726. 		
    727. 

  727. 		if($name && !isset($attrs[$name])) $attrs[$name] = $val;
    728. 

  728. 		$tag = rtrim($tag); // remove extra space we added
    729. 

  729. 		$tagName = strtolower($tagName);
    730. 

  730. 		$selfClosing = in_array($tagName, $this->selfClosingTags);
    731. 

  731. 		$classes = isset($attrs['class']) ? explode(' ', $attrs['class']) : array();
    732. 

  732. 		$id = isset($attrs['id']) ? $attrs['id'] : '';
    733. 

  733. 		$pwid = '';
    734. 

  734. 		$action = '';
    735. 

  735. 		$actionTarget = '';
    736. 

  736. 		$actionType = '';
    737. 

  737. 

  738. 		// determine action and action target from attributes
    739. 

  739. 		foreach($attrs as $name => $value) {
    740. 

  740. 			$pwpos = strpos($name, 'pw-');
    741. 

  741. 			if($pwpos === false) continue;
    742. 

  742. 			if($name === 'pw-id' || $name === 'data-pw-id') {
    743. 

  743. 				// id attribute
    744. 

  744. 				if(!$pwid) $pwid = $value; 
    745. 

  745. 				unset($attrs[$name]);
    746. 

  746. 			} else if($pwpos === 0) {
    747. 

  747. 				// action attribute
    748. 

  748. 				list($prefix, $action) = explode('-', $name, 2); 
    749. 

  749. 				if($prefix) {} // ignore
    750. 

  750. 			} else if(strpos($name, 'data-pw-') === 0) {
    751. 

  751. 				// action data attribute
    752. 

  752. 				list($ignore, $prefix, $action) = explode('-', $name, 3); 
    753. 

  753. 				if($ignore && $prefix) {} // ignore
    754. 

  754. 			}
    755. 

  755. 			if($action && !$actionTarget) {
    756. 

  756. 				if(strpos($action, '-')) {
    757. 

  757. 					list($action, $actionTarget) = explode('-', $action, 2);
    758. 

  758. 				} else {
    759. 

  759. 					$actionTarget = $value;
    760. 

  760. 				}
    761. 

  761. 				if($actionTarget && in_array($action, $this->actions)) {
    762. 

  762. 					// found a valid action and target
    763. 

  763. 					unset($attrs[$name]);
    764. 

  764. 					$actionType = $actionTarget === true ? 'bool' : 'attr';
    765. 

  765. 				} else {
    766. 

  766. 					// unrecognized action
    767. 

  767. 					$action = '';
    768. 

  768. 					$actionTarget = '';
    769. 

  769. 				}
    770. 

  770. 			}
    771. 

  771. 		}
    772. 

  772. 		
    773. 

  773. 		// if action was not specified as an attribute, see if action is specified as a class name
    774. 

  774. 		if(!$action) foreach($classes as $key => $class) {
    775. 

  775. 			if(strpos($class, 'pw-') !== 0) continue;
    776. 

  776. 			list($prefix, $action) = explode('-', $class, 2);
    777. 

  777. 			if(strpos($action, '-')) list($action, $actionTarget) = explode('-', $action, 2);
    778. 

  778. 			if($prefix && $actionTarget) {} // ignore
    779. 

  779. 			if(in_array($action, $this->actions)) {
    780. 

  780. 				// valid action, remove action from classes and class attribute
    781. 

  781. 				unset($classes[$key]); 
    782. 

  782. 				$attrs['class'] = implode(' ', $classes);	
    783. 

  783. 				$actionType = 'class';
    784. 

  784. 				break;
    785. 

  785. 			} else {
    786. 

  786. 				// unrecognized action
    787. 

  787. 				$action = '';
    788. 

  788. 				$actionTarget = '';
    789. 

  789. 			}
    790. 

  790. 		}
    791. 

  791. 	
    792. 

  792. 		if(!$pwid) $pwid = $id;
    793. 

  793. 

  794. 		// if there's an action, but no target, the target is assumed to be the pw-id or id
    795. 

  795. 		if($action && (!$actionTarget || $actionTarget === true)) $actionTarget = $pwid; 
    796. 

  796. 		
    797. 

  797. 		$info = array(
    798. 

  798. 			'id' => $id,
    799. 

  799. 			'pwid' => $pwid ? $pwid : $id, 
    800. 

  800. 			'name' => $tagName, 
    801. 

  801. 			'classes' => $classes,
    802. 

  802. 			'attrs' => $attrs, 
    803. 

  803. 			'attrStr' => $attrStr,
    804. 

  804. 			'src' => $originalTag,
    805. 

  805. 			'tag' => "<$tag>", 
    806. 

  806. 			'close' => $selfClosing ? "" : "</$tagName>",
    807. 

  807. 			'action' => $action,
    808. 

  808. 			'actionTarget' => $actionTarget,
    809. 

  809. 			'actionType' => $actionType, 
    810. 

  810. 		);
    811. 

  811. 	
    812. 

  812. 		return $info;
    813. 

  813. 	}
    814. 

  814. 

  815. 	/**
    816. 

  816. 	 * Strip the given region non-nested tags from the document
    817. 

  817. 	 * 
    818. 

  818. 	 * Note that this only works on non-nested tags like HTML comments, script or style tags. 
    819. 

  819. 	 * 
    820. 

  820. 	 * @param string $tag Specify "<!--" to remove comments or "<script" to remove scripts, or "<tag" for any other tags.
    821. 

  821. 	 * @param string $markup Markup to remove the tags from
    822. 

  822. 	 * @param bool $getRegions Specify true to return array of the strip regions rather than the updated markup
    823. 

  823. 	 * @return string|array
    824. 

  824. 	 * 
    825. 

  825. 	 */
    826. 

  826. 	public function stripRegions($tag, $markup, $getRegions = false) {
    827. 

  827. 		
    828. 

  828. 		$startPos = 0;
    829. 

  829. 		$regions = array();
    830. 

  830. 		
    831. 

  831. 		$open = strpos($tag, '<') === 0 ? $tag : "<$tag";
    832. 

  832. 		$close = $tag == '<!--' ? '-->' : '</' . trim($tag, '<>') . '>';
    833. 

  833. 	
    834. 

  834. 		// keep comments that start with <!--#
    835. 

  835. 		if($tag == "<!--" && strpos($markup, "<!--#") !== false) {
    836. 

  836. 			$hasHints = true;
    837. 

  837. 			$markup = str_replace("<!--#", "<!~~#", $markup);
    838. 

  838. 			$markup = preg_replace('/<!--#([-_.a-zA-Z0-9]+)-->/', '<!~~$1~~>', $markup);
    839. 

  839. 		} else {
    840. 

  840. 			$hasHints = false;
    841. 

  841. 		}
    842. 

  842. 		
    843. 

  843. 		do {
    844. 

  844. 			$pos = stripos($markup, $open, $startPos);
    845. 

  845. 			if($pos === false) break;	
    846. 

  846. 			$endPos = stripos($markup, $close, $pos); 		
    847. 

  847. 			if($endPos === false) {
    848. 

  848. 				$endPos = strlen($markup);
    849. 

  849. 			} else {
    850. 

  850. 				$endPos += strlen($close);
    851. 

  851. 			}
    852. 

  852. 			$regions[] = substr($markup, $pos, $endPos - $pos);
    853. 

  853. 			$startPos = $endPos; 
    854. 

  854. 		} while(1);
    855. 

  855. 		
    856. 

  856. 		if($getRegions) return $regions;
    857. 

  857. 		if(count($regions)) $markup = str_replace($regions, '', $markup); 
    858. 

  858. 		
    859. 

  859. 		if($hasHints) {
    860. 

  860. 			// keep comments that start with <!--#
    861. 

  861. 			$markup = str_replace(array("<!~~#", "~~>"), array("<!--#", "-->"), $markup); 
    862. 

  862. 		}
    863. 

  863. 		
    864. 

  864. 		return $markup;
    865. 

  865. 	}
    866. 

  866. 	
    867. 

  867. 	/**
    868. 

  868. 	 * Merge attributes from one HTML tag to another
    869. 

  869. 	 * 
    870. 

  870. 	 * - Attributes (except class) that appear in $mergeTag replace those in $htmlTag.
    871. 

  871. 	 * - Attributes in $mergeTag not already present in $htmlTag are added to it.
    872. 

  872. 	 * - Class attribute is combined with all classes from $htmlTag and $mergeTag.
    873. 

  873. 	 * - The tag name from $htmlTag is used, and the one from $mergeTag is ignored.
    874. 

  874. 	 *
    875. 

  875. 	 * @param string $htmlTag HTML tag string, optionally containing attributes
    876. 

  876. 	 * @param array|string $mergeTag HTML tag to merge (or attributes array)
    877. 

  877. 	 * @return string Updated HTML tag string with merged attributes
    878. 

  878. 	 *
    879. 

  879. 	 */
    880. 

  880. 	public function mergeTags($htmlTag, $mergeTag) {
    881. 

  881. 

  882. 		if(is_string($mergeTag)) {
    883. 

  883. 			$mergeTagInfo = $this->getTagInfo($mergeTag);
    884. 

  884. 			$mergeAttrs = $mergeTagInfo['attrs'];
    885. 

  885. 		} else {
    886. 

  886. 			$mergeAttrs = $mergeTag;
    887. 

  887. 		}
    888. 

  888. 

  889. 		$tagInfo = $this->getTagInfo($htmlTag);
    890. 

  890. 		$attrs = $tagInfo['attrs'];
    891. 

  891. 		$changes = 0;
    892. 

  892. 

  893. 		foreach($mergeAttrs as $name => $value) {
    894. 

  894. 			if(isset($attrs[$name])) {
    895. 

  895. 				// attribute is already present
    896. 

  896. 				if($attrs[$name] === $value) continue;
    897. 

  897. 				if($name === 'class') {
    898. 

  898. 					// merge classes
    899. 

  899. 					$classes = explode(' ', $value);
    900. 

  900. 					$classes = array_merge($tagInfo['classes'], $classes);
    901. 

  901. 					$classes = array_unique($classes);
    902. 

  902. 					// identify remove classes
    903. 

  903. 					foreach($classes as $key => $class) {
    904. 

  904. 						if(strpos($class, '-') !== 0) continue;
    905. 

  905. 						$removeClass = ltrim($class, '-');
    906. 

  906. 						unset($classes[$key]);
    907. 

  907. 						while(false !== ($k = array_search($removeClass, $classes))) unset($classes[$k]);
    908. 

  908. 					}
    909. 

  909. 					$attrs['class'] = implode(' ', $classes);
    910. 

  910. 				} else {
    911. 

  911. 					// replace
    912. 

  912. 					$attrs[$name] = $value;
    913. 

  913. 				}
    914. 

  914. 			} else {
    915. 

  915. 				// add attribute not already present
    916. 

  916. 				$attrs[$name] = $value;
    917. 

  917. 			}
    918. 

  918. 			$changes++;
    919. 

  919. 		}
    920. 

  920. 

  921. 		if($changes) {
    922. 

  922. 			$htmlTag = "<$tagInfo[name] " . $this->renderAttributes($attrs, false);
    923. 

  923. 			$htmlTag = trim($htmlTag) . '>';
    924. 

  924. 		}
    925. 

  925. 

  926. 		return $htmlTag;
    927. 

  927. 	}
    928. 

  928. 

  929. 	/**
    930. 

  930. 	 * Given an associative array of “key=value” attributes, render an HTML attribute string of them
    931. 

  931. 	 * 
    932. 

  932. 	 * - For boolean attributes without value (like "checked" or "selected") specify boolean true as the value. 
    933. 

  933. 	 * - If value of any attribute is an array, it will be converted to a space-separated string. 
    934. 

  934. 	 * - Values get entity encoded, unless you specify false for the second argument. 
    935. 

  935. 	 *
    936. 

  936. 	 * @param array $attrs Associative array of attributes. 
    937. 

  937. 	 * @param bool $encode Entity encode attribute values? Default is true, so if they are already encoded, specify false.
    938. 

  938. 	 * @param string $quote Quote style, specify double quotes, single quotes, or blank for none except when required (default=")
    939. 

  939. 	 * @return string
    940. 

  940. 	 *
    941. 

  941. 	 */
    942. 

  942. 	public function renderAttributes(array $attrs, $encode = true, $quote = '"') {
    943. 

  943. 		
    944. 

  944. 		$str = '';
    945. 

  945. 		
    946. 

  946. 		foreach($attrs as $name => $value) {
    947. 

  947. 			
    948. 

  948. 			if(!ctype_alnum($name)) {
    949. 

  949. 				// only allow [-_a-zA-Z] attribute names
    950. 

  950. 				$name = $this->wire('sanitizer')->name($name);
    951. 

  951. 			}
    952. 

  952. 			
    953. 

  953. 			// convert arrays to space separated string
    954. 

  954. 			if(is_array($value)) $value = implode(' ', $value);
    955. 

  955. 			
    956. 

  956. 			if($value === true) {
    957. 

  957. 				// attribute without value, i.e. "checked" or "selected" or "data-uk-grid", etc. 
    958. 

  958. 				$str .= "$name ";
    959. 

  959. 				continue;
    960. 

  960. 			} else if($name == 'class' && !strlen($value)) {
    961. 

  961. 				continue;
    962. 

  962. 			}
    963. 

  963. 				
    964. 

  964. 			$q = $quote;
    965. 

  965. 			if(!$q && !ctype_alnum($value)) $q = '"';
    966. 

  966. 			
    967. 

  967. 			if($encode) {
    968. 

  968. 				// entity encode value
    969. 

  969. 				$value = $this->wire('sanitizer')->entities($value);
    970. 

  970. 				
    971. 

  971. 			} else if(strpos($value, '"') !== false && strpos($value, "'") === false) {
    972. 

  972. 				// if value has a quote in it, use single quotes rather than double quotes
    973. 

  973. 				$q = "'";
    974. 

  974. 			}
    975. 

  975. 			
    976. 

  976. 			$str .= "$name=$q$value$q ";
    977. 

  977. 		}
    978. 

  978. 		
    979. 

  979. 		return trim($str);
    980. 

  980. 	}
    981. 

  981. 

  982. 	/**
    983. 

  983. 	 * Does the given attribute name and value appear somewhere in the given html?
    984. 

  984. 	 * 
    985. 

  985. 	 * @param string $name
    986. 

  986. 	 * @param string|bool $value Value to find, or specify boolean true for boolean attribute without value
    987. 

  987. 	 * @param string $html
    988. 

  988. 	 * @return bool Returns false if it doesn't appear, true if it does
    989. 

  989. 	 * 
    990. 

  990. 	 */
    991. 

  991. 	public function hasAttribute($name, $value, &$html) {
    992. 

  992. 

  993. 		$pos = null;
    994. 

  994. 		
    995. 

  995. 		if($value === true) {
    996. 

  996. 			$tests = array(
    997. 

  997. 				" $name ",
    998. 

  998. 				" $name>", 
    999. 

  999. 				" $name=", 
    1000. 

  1000. 				" $name/", 
    1001. 

  1001. 			);
    1002. 

  1002. 			
    1003. 

  1003. 		} else {
    1004. 

  1004. 			$tests = array(
    1005. 

  1005. 				" $name=\"$value\"",
    1006. 

  1006. 				" $name='$value'",
    1007. 

  1007. 			);
    1008. 

  1008. 			
    1009. 

  1009. 			// if there's no space in value, we also check non-quoted values
    1010. 

  1010. 			if(strpos($value, ' ') === false) {
    1011. 

  1011. 				$tests[] = " $name=$value ";
    1012. 

  1012. 				$tests[] = " $name=$value>";
    1013. 

  1013. 			}
    1014. 

  1014. 		}
    1015. 

  1015. 		
    1016. 

  1016. 		if($name == 'id') {
    1017. 

  1017. 			foreach($tests as $test) {
    1018. 

  1018. 				$test = ltrim($test);
    1019. 

  1019. 				$tests[] = " pw-id-$test";
    1020. 

  1020. 				$tests[] = " data-pw-id-$test";
    1021. 

  1021. 			}
    1022. 

  1022. 		}
    1023. 

  1023. 	
    1024. 

  1024. 		foreach($tests as $test) {
    1025. 

  1025. 			$pos = stripos($html, $test);
    1026. 

  1026. 			if($pos === false) continue;
    1027. 

  1027. 			// if another tag starts before the one in the attribute closes
    1028. 

  1028. 			// then the matched attribute is apparently not part of an HTML tag
    1029. 

  1029. 			$close = strpos($html, '>', $pos);
    1030. 

  1030. 			$open = strpos($html, '<', $pos);
    1031. 

  1031. 			if($close > $open) $pos = false; 
    1032. 

  1032. 			if($pos !== false) break;
    1033. 

  1033. 		}
    1034. 

  1034. 		
    1035. 

  1035. 		if($pos === false && stripos($html, $name) !== false && stripos($html, $value) !== false) {
    1036. 

  1036. 			// maybe doesn't appear due to some whitespace difference, check again using a regex
    1037. 

  1037. 			if($name == 'id') {
    1038. 

  1038. 				$names = '(id|pw-id|data-pw-id)';
    1039. 

  1039. 			} else {
    1040. 

  1040. 				$names = preg_quote($name); 
    1041. 

  1041. 			}
    1042. 

  1042. 			if($value === true) {
    1043. 

  1043. 				$regex = '!<[^<>]*\s' . $names . '[=\s/>]!i';
    1044. 

  1044. 			} else {
    1045. 

  1045. 				$regex = '/<[^<>]*\s' . $names . '\s*=\s*["\']?' . preg_quote($value) . '(?:["\']|[\s>])/i';
    1046. 

  1046. 			}
    1047. 

  1047. 			if(preg_match($regex, $html)) $pos = true;
    1048. 

  1048. 		}
    1049. 

  1049. 		
    1050. 

  1050. 		return $pos !== false;
    1051. 

  1051. 	}
    1052. 

  1052. 

  1053. 	/**
    1054. 

  1054. 	 * Update the region(s) that match the given $selector with the given $content (markup/text)
    1055. 

  1055. 	 * 
    1056. 

  1056. 	 * @param string $selector Specify one of the following:
    1057. 

  1057. 	 *  - Name of an attribute that must be present, i.e. "data-region", or "attribute=value" or "tag[attribute=value]".
    1058. 

  1058. 	 *  - Specify `#name` to match a specific `id='name'` attribute.
    1059. 

  1059. 	 *  - Specify `.name` or `tag.name` to match a specific `class='name'` attribute (class can appear anywhere in class attribute).
    1060. 

  1060. 	 *  - Specify `<tag>` to match all of those HTML tags (i.e. `<head>`, `<body>`, `<title>`, `<footer>`, etc.)
    1061. 

  1061. 	 * @param string $content Markup/text to update with
    1062. 

  1062. 	 * @param string $markup Document markup where region(s) exist
    1063. 

  1063. 	 * @param array $options Specify any of the following:
    1064. 

  1064. 	 *  - `action` (string): May be 'replace', 'append', 'prepend', 'before', 'after', 'remove', or 'auto'.
    1065. 

  1065. 	 *  - `mergeAttr` (array): Array of attrs to add/merge to the wrapping element, or HTML tag with attrs to merge.
    1066. 

  1066. 	 * @return string
    1067. 

  1067. 	 * 
    1068. 

  1068. 	 */
    1069. 

  1069. 	public function update($selector, $content, $markup, array $options = array()) {
    1070. 

  1070. 		
    1071. 

  1071. 		$defaults = array(
    1072. 

  1072. 			'action' => 'auto',
    1073. 

  1073. 			'mergeAttr' => array(), 
    1074. 

  1074. 		);
    1075. 

  1075. 		
    1076. 

  1076. 		$options = array_merge($defaults, $options);
    1077. 

  1077. 		
    1078. 

  1078. 		$findOptions = array(
    1079. 

  1079. 			'verbose' => true,
    1080. 

  1080. 			'exact' => true, 
    1081. 

  1081. 		);
    1082. 

  1082. 		
    1083. 

  1083. 		if(self::debug) {
    1084. 

  1084. 			$findOptions['debugNote'] = "update.$options[action]($selector)";
    1085. 

  1085. 		}
    1086. 

  1086. 		
    1087. 

  1087. 		$findRegions = $this->find($selector, $markup, $findOptions);
    1088. 

  1088. 		
    1089. 

  1089. 		foreach($findRegions as $region) {
    1090. 

  1090. 	
    1091. 

  1091. 			$action = $options['action'];
    1092. 

  1092. 			
    1093. 

  1093. 			if(count($options['mergeAttr'])) {
    1094. 

  1094. 				$region['open'] = $this->mergeTags($region['open'], $options['mergeAttr']); 
    1095. 

  1095. 			}
    1096. 

  1096. 			
    1097. 

  1097. 			if($action == 'auto') {
    1098. 

  1098. 				// auto mode delegates to the region action
    1099. 

  1099. 				$action = '';
    1100. 

  1100. 				if(in_array($region['action'], $this->actions)) $action = $region['action'];
    1101. 

  1101. 			}
    1102. 

  1102. 			
    1103. 

  1103. 			switch($action) {
    1104. 

  1104. 				case 'append':
    1105. 

  1105. 					$replacement = $region['open'] . $region['region'] . $content . $region['close'];
    1106. 

  1106. 					break;
    1107. 

  1107. 				case 'prepend':
    1108. 

  1108. 					$replacement = $region['open'] . $content . $region['region'] . $region['close'];
    1109. 

  1109. 					break;
    1110. 

  1110. 				case 'before':
    1111. 

  1111. 					$replacement = $content . $region['html'];
    1112. 

  1112. 					break;
    1113. 

  1113. 				case 'after':
    1114. 

  1114. 					$replacement = $region['html'] . $content;
    1115. 

  1115. 					break;
    1116. 

  1116. 				case 'remove': 
    1117. 

  1117. 					$replacement = '';
    1118. 

  1118. 					break;
    1119. 

  1119. 				default:
    1120. 

  1120. 					// replace
    1121. 

  1121. 					$replacement = $region['open'] . $content . $region['close']; 
    1122. 

  1122. 			}
    1123. 

  1123. 	
    1124. 

  1124. 			$markup = str_replace($region['html'], $replacement, $markup); 
    1125. 

  1125. 		}
    1126. 

  1126. 		
    1127. 

  1127. 		return $markup; 
    1128. 

  1128. 	}
    1129. 

  1129. 	
    1130. 

  1130. 	/**
    1131. 

  1131. 	 * Replace the region(s) that match the given $selector with the given $replace markup
    1132. 

  1132. 	 *
    1133. 

  1133. 	 * @param string $selector See the update() method $selector argument for supported formats
    1134. 

  1134. 	 * @param string $replace Markup to replace with
    1135. 

  1135. 	 * @param string $markup Document markup where region(s) exist
    1136. 

  1136. 	 * @param array $options See $options argument for update() method
    1137. 

  1137. 	 * @return string
    1138. 

  1138. 	 *
    1139. 

  1139. 	 */
    1140. 

  1140. 	public function replace($selector, $replace, $markup, array $options = array()) {
    1141. 

  1141. 		$options['action'] = 'replace';
    1142. 

  1142. 		return $this->replace($selector, $replace, $markup, $options);
    1143. 

  1143. 	}
    1144. 

  1144. 

  1145. 	/**
    1146. 

  1146. 	 * Append the region(s) that match the given $selector with the given $content markup
    1147. 

  1147. 	 *
    1148. 

  1148. 	 * @param string $selector See the update() method $selector argument for details
    1149. 

  1149. 	 * @param string $content Markup to append
    1150. 

  1150. 	 * @param string $markup Document markup where region(s) exist
    1151. 

  1151. 	 * @param array $options See the update() method $options argument for details
    1152. 

  1152. 	 * @return string
    1153. 

  1153. 	 *
    1154. 

  1154. 	 */
    1155. 

  1155. 	public function append($selector, $content, $markup, array $options = array()) {
    1156. 

  1156. 		$options['action'] = 'append';
    1157. 

  1157. 		return $this->replace($selector, $content, $markup, $options);
    1158. 

  1158. 	}
    1159. 

  1159. 

  1160. 	/**
    1161. 

  1161. 	 * Prepend the region(s) that match the given $selector with the given $content markup
    1162. 

  1162. 	 *
    1163. 

  1163. 	 * @param string $selector See the update() method for details
    1164. 

  1164. 	 * @param string $content Markup to prepend
    1165. 

  1165. 	 * @param string $markup Document markup where region(s) exist
    1166. 

  1166. 	 * @param array $options See the update() method for details
    1167. 

  1167. 	 * @return string
    1168. 

  1168. 	 *
    1169. 

  1169. 	 */
    1170. 

  1170. 	public function prepend($selector, $content, $markup, array $options = array()) {
    1171. 

  1171. 		$options['action'] = 'prepend';
    1172. 

  1172. 		return $this->replace($selector, $content, $markup, $options);
    1173. 

  1173. 	}
    1174. 

  1174. 	
    1175. 

  1175. 	/**
    1176. 

  1176. 	 * Insert region(s) that match the given $selector before the given $content markup
    1177. 

  1177. 	 *
    1178. 

  1178. 	 * @param string $selector See the update() method for details
    1179. 

  1179. 	 * @param string $content Markup to prepend
    1180. 

  1180. 	 * @param string $markup Document markup where region(s) exist
    1181. 

  1181. 	 * @param array $options See the update() method for details
    1182. 

  1182. 	 * @return string
    1183. 

  1183. 	 *
    1184. 

  1184. 	 */
    1185. 

  1185. 	public function before($selector, $content, $markup, array $options = array()) {
    1186. 

  1186. 		$options['action'] = 'before';
    1187. 

  1187. 		return $this->replace($selector, $content, $markup, $options);
    1188. 

  1188. 	}
    1189. 

  1189. 	
    1190. 

  1190. 	/**
    1191. 

  1191. 	 * Insert the region(s) that match the given $selector after the given $content markup
    1192. 

  1192. 	 *
    1193. 

  1193. 	 * @param string $selector See the update() method for details
    1194. 

  1194. 	 * @param string $content Markup to prepend
    1195. 

  1195. 	 * @param string $markup Document markup where region(s) exist
    1196. 

  1196. 	 * @param array $options See the update() method for details
    1197. 

  1197. 	 * @return string
    1198. 

  1198. 	 *
    1199. 

  1199. 	 */
    1200. 

  1200. 	public function after($selector, $content, $markup, array $options = array()) {
    1201. 

  1201. 		$options['action'] = 'after';
    1202. 

  1202. 		return $this->replace($selector, $content, $markup, $options);
    1203. 

  1203. 	}
    1204. 

  1204. 	
    1205. 

  1205. 	/**
    1206. 

  1206. 	 * Remove the region(s) that match the given $selector 
    1207. 

  1207. 	 *
    1208. 

  1208. 	 * @param string $selector See the update() method for details
    1209. 

  1209. 	 * @param string $markup Document markup where region(s) exist
    1210. 

  1210. 	 * @param array $options See the update() method for details
    1211. 

  1211. 	 * @return string
    1212. 

  1212. 	 *
    1213. 

  1213. 	 */
    1214. 

  1214. 	public function remove($selector, $markup, array $options = array()) {
    1215. 

  1215. 		$options['action'] = 'after'; // after intended
    1216. 

  1216. 		return $this->replace($selector, '', $markup, $options);
    1217. 

  1217. 	}
    1218. 

  1218. 	
    1219. 

  1219. 	/**
    1220. 

  1220. 	 * Identify and populate markup regions in given HTML
    1221. 

  1221. 	 *
    1222. 

  1222. 	 * To use this, you must set `$config->useMarkupRegions = true;` in your /site/config.php file.
    1223. 

  1223. 	 * In the future it may be enabled by default for any templates with text/html content-type.
    1224. 

  1224. 	 *
    1225. 

  1225. 	 * This takes anything output before the opening `<!DOCTYPE` and connects it to the right places
    1226. 

  1226. 	 * within the `<html>` that comes after it. For instance, if there's a `<div id='content'>` in the
    1227. 

  1227. 	 * document, then a #content element output prior to the doctype will replace it during page render.
    1228. 

  1228. 	 * This enables one to use delayed output as if it’s direct output. It also makes every HTML element
    1229. 

  1229. 	 * in the output with an “id” attribute a region that can be populated from any template file. It’s
    1230. 

  1230. 	 * a good pairing with a `$config->appendTemplateFile` that contains the main markup and region
    1231. 

  1231. 	 * definitions, though can be used with or without it.
    1232. 

  1232. 	 *
    1233. 

  1233. 	 * Beyond replacement of elements, append, prepend, insert before, insert after, and remove are also
    1234. 

  1234. 	 * supported via “pw-” prefix attributes that you can add. The attributes do not appear in the final output
    1235. 

  1235. 	 * markup. When performing replacements or modifications to elements, PW will merge the attributes
    1236. 

  1236. 	 * so that attributes present in the final output are present, plus any that were added by the markup
    1237. 

  1237. 	 * regions. See the examples for more details.
    1238. 

  1238. 	 *
    1239. 

  1239. 	 * Examples
    1240. 

  1240. 	 * ========
    1241. 

  1241. 	 * Below are some examples. Note that “main” is used as an example “id” attribute of an element that
    1242. 

  1242. 	 * appears in the main document markup, and the examples below focus on manipulating it. The examples
    1243. 

  1243. 	 * assume there is a `<div id=main>` in the _main.php file (appendTemplateFile), and the lines in the
    1244. 

  1244. 	 * examples would be output from a template file, which manipulates what would ultimately be output
    1245. 

  1245. 	 * when the page is rendered.
    1246. 

  1246. 	 * 
    1247. 

  1247. 	 * In the examples, a “pw-id” or “data-pw-id” attribute may be used instead of an “id” attribute, when
    1248. 

  1248. 	 * or if preferred. In addition, any “pw-” attribute may be specified as a “data-pw-” attribute if you
    1249. 

  1249. 	 * prefer it. 
    1250. 

  1250. 	 * ~~~~~~
    1251. 

  1251. 	 * Replacing and removing elements
    1252. 

  1252. 	 * 
    1253. 

  1253. 	 *   <div id='main'>This replaces the #main div and merges any attributes</div>
    1254. 

  1254. 	 *   <div pw-replace='main'>This does the same as above</div>
    1255. 

  1255. 	 *   <div id='main' pw-replace>This does the same as above</div>
    1256. 

  1256. 	 *   <div pw-remove='main'>This removes the #main div</div>
    1257. 

  1257. 	 *   <div id='main' pw-remove>This removes the #main div (same as above)</div>
    1258. 

  1258. 	 *
    1259. 

  1259. 	 * Prepending and appending elements
    1260. 

  1260. 	 * 
    1261. 

  1261. 	 *   <div id='main' class='pw-prepend'><p>This prepends #main with this p tag</p></div>
    1262. 

  1262. 	 *   <p pw-prepend='main'>This does the same as above</p>
    1263. 

  1263. 	 *   <div id='main' pw-append><p>This appends #main with this p tag</p></div>
    1264. 

  1264. 	 *   <p pw-append='main'>Removes the #main div</p>
    1265. 

  1265. 	 * 
    1266. 

  1266. 	 * Modifying attributes on an existing element
    1267. 

  1267. 	 * 
    1268. 

  1268. 	 *   <div id='main' class='bar' pw-prepend><p>This prepends #main and adds "bar" class to main</p></div>
    1269. 

  1269. 	 *   <div id='main' class='foo' pw-append><p>This appends #main and adds a "foo" class to #main</p></div>
    1270. 

  1270. 	 *   <div id='main' title='hello' pw-append>Appends #main with this text + adds title attribute to #main</div>
    1271. 

  1271. 	 *   <div id='main' class='-baz' pw-append>Appends #main with this text + removes class “baz” from #main</div>
    1272. 

  1272. 	 *
    1273. 

  1273. 	 * Inserting new elements
    1274. 

  1274. 	 * 
    1275. 

  1275. 	 *   <h2 pw-before='main'>This adds an h2 headline with this text before #main</h2>
    1276. 

  1276. 	 *   <footer pw-after='main'><p>This adds a footer element with this text after #main</p></footer>
    1277. 

  1277. 	 *   <div pw-append='main' class='foo'>This appends a div.foo to #main with this text</div>
    1278. 

  1278. 	 *   <div pw-prepend='main' class='bar'>This prepends a div.bar to #main with this text</div>
    1279. 

  1279. 	 * 
    1280. 

  1280. 	 * ~~~~~~
    1281. 

  1281. 	 *
    1282. 

  1282. 	 * @param string $htmlDocument Document to populate regions to
    1283. 

  1283. 	 * @param string|array $htmlRegions Markup containing regions (or regions array from a find call)
    1284. 

  1284. 	 * @param array $options Options to modify behavior: 
    1285. 

  1285. 	 *  - `useClassActions` (bool): Allow "pw-*" actions to be specified in class names? Per original/legacy spec. (default=false)
    1286. 

  1286. 	 * @return int Number of updates made to $htmlDocument
    1287. 

  1287. 	 *
    1288. 

  1288. 	 */
    1289. 

  1289. 	public function populate(&$htmlDocument, $htmlRegions, array $options = array()) {
    1290. 

  1290. 		
    1291. 

  1291. 		static $recursionLevel = 0;
    1292. 

  1292. 		static $callQty = 0;
    1293. 

  1293. 		
    1294. 

  1294. 		$recursionLevel++;
    1295. 

  1295. 		$callQty++;
    1296. 

  1296. 

  1297. 		$defaults = array(
    1298. 

  1298. 			'useClassActions' => false // allow use of "pw-*" class actions? (legacy)
    1299. 

  1299. 		);
    1300. 

  1300. 		
    1301. 

  1301. 		$options = array_merge($defaults, $options);
    1302. 

  1302. 		$leftoverMarkup = '';
    1303. 

  1303. 		$debugLandmark = "<!--PW-REGION-DEBUG-->";
    1304. 

  1304. 		$hasDebugLandmark = strpos($htmlDocument, $debugLandmark) !== false;
    1305. 

  1305. 		$debug = $hasDebugLandmark && $this->wire('config')->debug;
    1306. 

  1306. 		$debugTimer = $debug ? Debug::timer() : 0;
    1307. 

  1307. 		
    1308. 

  1308. 		if(is_array($htmlRegions)) {
    1309. 

  1309. 			$regions = $htmlRegions;
    1310. 

  1310. 			$leftoverMarkup = '';
    1311. 

  1311. 			
    1312. 

  1312. 		} else if($this->hasRegions($htmlRegions)) {
    1313. 

  1313. 			$htmlRegions = $this->stripRegions('<!--', $htmlRegions);
    1314. 

  1314. 			$selector = $options['useClassActions'] ? ".pw-*, id=" : "[pw-action], id=";
    1315. 

  1315. 			$regions = $this->find($selector, $htmlRegions, array(
    1316. 

  1316. 				'verbose' => true,
    1317. 

  1317. 				'leftover' => true,
    1318. 

  1318. 				'debugNote' => (isset($options['debugNote']) ? "$options[debugNote] => " : "") . "populate($callQty)", 
    1319. 

  1319. 			));
    1320. 

  1320. 			$leftoverMarkup = trim($regions["leftover"]);
    1321. 

  1321. 			unset($regions["leftover"]);
    1322. 

  1322. 			
    1323. 

  1323. 		} else {
    1324. 

  1324. 			$regions = array();
    1325. 

  1325. 		}
    1326. 

  1326. 

  1327. 		if(!count($regions)) {
    1328. 

  1328. 			if($debug) $htmlDocument = str_replace($debugLandmark, "<pre>No regions</pre>$debugLandmark", $htmlDocument);
    1329. 

  1329. 			$recursionLevel--;
    1330. 

  1330. 			if(!$recursionLevel) $this->removeRegionTags($htmlDocument); 
    1331. 

  1331. 			return 0;
    1332. 

  1332. 		}
    1333. 

  1333. 

  1334. 		$xregions = array(); // regions that weren't populated
    1335. 

  1335. 		$populatedNotes = array();
    1336. 

  1336. 		$rejectedNotes = array();
    1337. 

  1337. 		$updates = array();
    1338. 

  1338. 		$numUpdates = 0;
    1339. 

  1339. 

  1340. 		foreach($regions as $regionKey => $region) {
    1341. 

  1341. 

  1342. 			if(empty($region['action'])) $region['action'] = 'auto'; // replace
    1343. 

  1343. 			if(empty($region['actionTarget'])) $region['actionTarget'] = $region['pwid']; // replace
    1344. 

  1344. 			
    1345. 

  1345. 			// $xregion = $region;
    1346. 

  1346. 			$action = $region['action'];
    1347. 

  1347. 			$actionTarget = $region['actionTarget'];
    1348. 

  1348. 			$regionHTML = $region['region'];
    1349. 

  1349. 			$mergeAttr = $region['attrs'];
    1350. 

  1350. 			
    1351. 

  1351. 			unset($mergeAttr['id']);
    1352. 

  1352. 			$documentHasTarget = $this->hasAttribute('id', $actionTarget, $htmlDocument); 
    1353. 

  1353. 			$isNew = ($region['actionType'] == 'attr' && $region['action'] != 'replace'); 
    1354. 

  1354. 			if(!$isNew) $isNew = $action == 'before' || $action == 'after';
    1355. 

  1355. 

  1356. 			if($isNew) {
    1357. 

  1357. 				// element is newly added element not already present
    1358. 

  1358. 				$mergeAttr = array();
    1359. 

  1359. 				$regionHTML = $region['html'];
    1360. 

  1360. 				$attrs = $region['attrs'];
    1361. 

  1361. 				$attrStr = count($attrs) ? ' ' . $this->renderAttributes($attrs, false) : '';
    1362. 

  1362. 				if(!strlen(trim($attrStr))) $attrStr = '';
    1363. 

  1363. 				if($region['actionType'] == 'bool') {
    1364. 

  1364. 					$regionHTML = $region['region'];
    1365. 

  1365. 				} else {
    1366. 

  1366. 					$regionHTML = str_replace($region['open'], "<$region[name]$attrStr>", $regionHTML);
    1367. 

  1367. 				}
    1368. 

  1368. 			}
    1369. 

  1369. 			
    1370. 

  1370. 			if($debug) {
    1371. 

  1371. 				$debugAction = $region['action'];
    1372. 

  1372. 				if($debugAction == 'auto') $debugAction = $isNew ? 'insert' : 'replace';
    1373. 

  1373. 				if($debugAction == 'replace' && empty($region['close'])) $debugAction = 'attr-update';
    1374. 

  1374. 				$pwid = empty($region['pwid']) ? $region['actionTarget'] : $region['pwid']; 
    1375. 

  1375. 				$open = $region['open'];
    1376. 

  1376. 				$openLen = strlen($open);
    1377. 

  1377. 				if($openLen > 50) $open = substr($open, 0, 30) . '[sm]... +' . ($openLen - 30) . ' bytes[/sm]>';
    1378. 

  1378. 				$debugRegionStart = "[sm]" . trim(substr($region['region'], 0, 80));  
    1379. 

  1379. 				$pos = strrpos($debugRegionStart, '>');
    1380. 

  1380. 				if($pos) $debugRegionStart = substr($debugRegionStart, 0, $pos+1);
    1381. 

  1381. 				$debugRegionStart .= " … [b]" . strlen($region['region']) . " bytes[/b][/sm]";
    1382. 

  1382. 				//$debugRegionEnd = substr($region['region'], -30); 
    1383. 

  1383. 				//$pos = strpos($debugRegionEnd, '</'); 
    1384. 

  1384. 				//if($pos !== false) $debugRegionEnd = substr($debugRegionEnd, $pos);
    1385. 

  1385. 				$region['note'] = strtoupper($debugAction) . " [b]#{$pwid}[/b] " .
    1386. 

  1386. 					($region['actionTarget'] != $pwid ? "(target=$region[actionTarget])" : "") . 
    1387. 

  1387. 					"[sm]with[/sm] $open"; 
    1388. 

  1388. 				if($region['close']) {
    1389. 

  1389. 					$region['note'] .= $this->debugNoteStr($debugRegionStart) . $region['close'];
    1390. 

  1390. 				}
    1391. 

  1391. 				$regionNote = $region['note'];  // [sm](position=$regionKey)[/sm]";
    1392. 

  1392. 				
    1393. 

  1393. 			} else {
    1394. 

  1394. 				$regionNote = '';
    1395. 

  1395. 			}	
    1396. 

  1396. 

  1397. 			if(!$documentHasTarget) {
    1398. 

  1398. 				// if the id attribute doesn't appear in the html, skip it
    1399. 

  1399. 				// $xregions[$regionKey] = $xregion;
    1400. 

  1400. 				if(self::debug) $rejectedNotes[] = $regionNote;
    1401. 

  1401. 				
    1402. 

  1402. 			} else {
    1403. 

  1403. 				// update the markup
    1404. 

  1404. 				$updates[] = array(
    1405. 

  1405. 					'actionTarget' => "#$actionTarget", 
    1406. 

  1406. 					'regionHTML' => $regionHTML, 
    1407. 

  1407. 					'action' => $action, 
    1408. 

  1408. 					'mergeAttr' => $mergeAttr,
    1409. 

  1409. 				);
    1410. 

  1410. 				if(is_string($htmlRegions)) {
    1411. 

  1411. 					// remove region markup from $htmlRegions so we can later determine what’s left
    1412. 

  1412. 					$htmlRegions = str_replace($region['html'], '', $htmlRegions);
    1413. 

  1413. 				}
    1414. 

  1414. 				$populatedNotes[] = $regionNote;
    1415. 

  1415. 				$numUpdates++;
    1416. 

  1416. 			}
    1417. 

  1417. 		}
    1418. 

  1418. 

  1419. 		foreach($updates as $u) {
    1420. 

  1420. 			$htmlDocument = $this->update($u['actionTarget'], $u['regionHTML'], $htmlDocument, array(
    1421. 

  1421. 				'action' => $u['action'],
    1422. 

  1422. 				'mergeAttr' => $u['mergeAttr'],
    1423. 

  1423. 			));
    1424. 

  1424. 		}
    1425. 

  1425. 

  1426. 		$htmlRegions = trim($htmlRegions);
    1427. 

  1427. 			
    1428. 

  1428. 		if($debug) {
    1429. 

  1429. 			$leftoverBytes = strlen($leftoverMarkup);
    1430. 

  1430. 			$htmlRegionsLen = strlen($htmlRegions); 
    1431. 

  1431. 			$debugNotes = array(); 
    1432. 

  1432. 			if($recursionLevel > 1) $debugNotes[] = "PASS: $recursionLevel";
    1433. 

  1433. 			if(count($populatedNotes)) $debugNotes = array_merge($debugNotes, $populatedNotes); // implode($bull, $populatedNotes);
    1434. 

  1434. 			if(count($rejectedNotes)) foreach($rejectedNotes as $note) $debugNotes[] = "SKIPPED: $note";
    1435. 

  1435. 			if($leftoverBytes) $debugNotes[] = "$leftoverBytes non-region bytes skipped: [sm]{$leftoverMarkup}[/sm]";
    1436. 

  1436. 			if($htmlRegionsLen) {
    1437. 

  1437. 				if($recursionLevel > 1) {
    1438. 

  1438. 					$debugNotes[] = "$htmlRegionsLen HTML-region bytes found no home after 2nd pass: [sm]{$htmlRegions}[/sm]";
    1439. 

  1439. 				} else if($this->hasRegions($htmlRegions)) {
    1440. 

  1440. 					$debugNotes[] = "$htmlRegionsLen HTML-region bytes remaining for 2nd pass: [sm]{$htmlRegions}[/sm]";
    1441. 

  1441. 				} else {
    1442. 

  1442. 					$debugNotes[] = "$htmlRegionsLen HTML bytes remaining, but no regions present: [sm]{$htmlRegions}[/sm]";
    1443. 

  1443. 				}
    1444. 

  1444. 			}
    1445. 

  1445. 			if(count($this->debugNotes)) {
    1446. 

  1446. 				$this->debugNotes = array_unique($this->debugNotes); 
    1447. 

  1447. 				$debugNotes[] = "---------------";
    1448. 

  1448. 				foreach($this->debugNotes as $n => $s) {
    1449. 

  1449. 					$debugNotes[] = $this->debugNoteStr($s);
    1450. 

  1450. 				}
    1451. 

  1451. 			}
    1452. 

  1452. 			if(!count($debugNotes)) $debugNotes[] = "Nothing found";
    1453. 

  1453. 			$debugNotes = "• " . implode("\n• ", $debugNotes);
    1454. 

  1454. 			$debugNotes = $this->wire('sanitizer')->entities($debugNotes);
    1455. 

  1455. 			$debugNotes .= "\n[sm]" . Debug::timer($debugTimer) . " seconds[/sm]";
    1456. 

  1456. 			$debugNotes = str_replace(array('[sm]', '[/sm]'), array('<small style="opacity:0.7">', '</small>'), $debugNotes);
    1457. 

  1457. 			$debugNotes = str_replace(array('[b]', '[/b]'), array('<strong>', '</strong>'), $debugNotes);
    1458. 

  1458. 			$debugNotes = "<pre class='pw-debug pw-region-debug'>$debugNotes</pre>$debugLandmark";
    1459. 

  1459. 			$htmlDocument = str_replace($debugLandmark, $debugNotes, $htmlDocument); 
    1460. 

  1460. 		} else if($hasDebugLandmark) {
    1461. 

  1461. 			$htmlDocument = str_replace($debugLandmark, '', $htmlDocument); 
    1462. 

  1462. 		}
    1463. 

  1463. 		
    1464. 

  1464. 		if(count($xregions) && $recursionLevel < 3) {
    1465. 

  1465. 			// see if they can be populated now
    1466. 

  1466. 			$numUpdates += $this->populate($htmlDocument, $xregions, $options);
    1467. 

  1467. 		}
    1468. 

  1468. 		
    1469. 

  1469. 		if($recursionLevel === 1 && strlen($htmlRegions) && $this->hasRegions($htmlRegions)) {
    1470. 

  1470. 			// see if more regions can be pulled from leftover $htmlRegions
    1471. 

  1471. 			$numUpdates += $this->populate($htmlDocument, $htmlRegions, $options);
    1472. 

  1472. 		}
    1473. 

  1473. 

  1474. 		// remove region tags and pw-id attributes
    1475. 

  1475. 		if($recursionLevel === 1 && $this->removeRegionTags($htmlDocument)) $numUpdates++;
    1476. 

  1476. 	
    1477. 

  1477. 		// if there is any leftover markup, place it above the HTML where it would usually go
    1478. 

  1478. 		if(strlen($leftoverMarkup)) {
    1479. 

  1479. 			$htmlDocument = $leftoverMarkup . $htmlDocument;
    1480. 

  1480. 			$numUpdates++;
    1481. 

  1481. 		}
    1482. 

  1482. 		
    1483. 

  1483. 		$recursionLevel--;
    1484. 

  1484. 

  1485. 		return $numUpdates; 
    1486. 

  1486. 	}
    1487. 

  1487. 

  1488. 	/**
    1489. 

  1489. 	 * Remove any <region> or <pw-region> tags present in the markup, leaving their innerHTML contents
    1490. 

  1490. 	 * 
    1491. 

  1491. 	 * Also removes data-pw-id and pw-id attributes
    1492. 

  1492. 	 * 
    1493. 

  1493. 	 * @param string $html
    1494. 

  1494. 	 * @return bool True if tags or attributes were removed, false if not
    1495. 

  1495. 	 * 
    1496. 

  1496. 	 */
    1497. 

  1497. 	public function removeRegionTags(&$html) {
    1498. 

  1498. 		
    1499. 

  1499. 		$updated = false;
    1500. 

  1500. 		
    1501. 

  1501. 		if(stripos($html, '</region>') !== false || strpos($html, '</pw-region>') !== false) {
    1502. 

  1502. 			$html = preg_replace('!</?(?:region|pw-region)(?:\s[^>]*>|>)!i', '', $html);
    1503. 

  1503. 			$updated = true;
    1504. 

  1504. 		}
    1505. 

  1505. 		
    1506. 

  1506. 		if(stripos($html, ' data-pw-id=') || stripos($html, ' pw-id=…
    1507.

Large files files are truncated, but you can click here to view the full file