Upgrades to ProcessPageEditLink with most notable addition being support for using link classes specified in the TinyMCE/CKEditor rather having to also add them to the ProcessPageEditLink module configuration

wire/modules/Process/ProcessPageEditLink/ProcessPageEditLink.js

@@ -1,16 +1,21 @@
 $(document).ready(function() {
 	
+	if(!ProcessWire.config.ProcessPageEditLink) return;
+	
+	var cfg = ProcessWire.config.ProcessPageEditLink;
+
 	var options = {
-		selectStartLabel: ProcessWire.config.ProcessPageEditLink.selectStartLabel,
+		selectStartLabel: cfg.selectStartLabel,
-		selectSelectLabel: ProcessWire.config.ProcessPageEditLink.selectStartLabel,
+		selectSelectLabel: cfg.selectStartLabel,
-		langID: ProcessWire.config.ProcessPageEditLink.langID
+		langID: cfg.langID
 		// openPageIDs: config.ProcessPageEditLink.openPageIDs
 	};
+	
 	var options2 = {
 		selectStartLabel: options.selectStartLabel,
 		selectSelectLabel: options.selectStartLabel,
 		langID: options.langID,
-		rootPageID: ProcessWire.config.ProcessPageEditLink.pageID
+		rootPageID: cfg.pageID
 	};
 
 	var selectedPageData = {
@@ -45,7 +50,7 @@ $(document).ready(function() {
 	}
 
 	function absoluteToRelativePath(path) {
-		if(ProcessWire.config.ProcessPageEditLink.urlType == 0) return path;
+		if(cfg.urlType == 0) return path;
 
 		function slashesToRelative(url) {
 			url = url.replace(/\//g, '../'); 
@@ -55,36 +60,36 @@ $(document).ready(function() {
 		
 		var url;
 
-		if(path === ProcessWire.config.ProcessPageEditLink.pageUrl) {
+		if(path === cfg.pageUrl) {
 			// account for the link to self
 			path = './'; 
-			if(!ProcessWire.config.ProcessPageEditLink.slashUrls) path += ProcessWire.config.ProcessPageEditLink.pageName;
+			if(!cfg.slashUrls) path += cfg.pageName;
 
-		} else if(path.indexOf(ProcessWire.config.ProcessPageEditLink.pageUrl) === 0) { 
+		} else if(path.indexOf(cfg.pageUrl) === 0) { 
 			// linking to child of current page
-			path = path.substring(ProcessWire.config.ProcessPageEditLink.pageUrl.length); 
+			path = path.substring(cfg.pageUrl.length); 
-			if(!ProcessWire.config.ProcessPageEditLink.slashUrls) path = ProcessWire.config.ProcessPageEditLink.pageName + path;
+			if(!cfg.slashUrls) path = cfg.pageName + path;
 
-		} else if(ProcessWire.config.ProcessPageEditLink.pageUrl.indexOf(path) === 0) {
+		} else if(cfg.pageUrl.indexOf(path) === 0) {
 			// linking to a parent of the current page
-			url = ProcessWire.config.ProcessPageEditLink.pageUrl.substring(path.length); 
+			url = cfg.pageUrl.substring(path.length); 
 			if(url.indexOf('/') != -1) {
 				url = slashesToRelative(url); 
 			} else {
 				url = './';
 			}
 			path = url;
-		} else if(path.indexOf(ProcessWire.config.ProcessPageEditLink.rootParentUrl) === 0) {
+		} else if(path.indexOf(cfg.rootParentUrl) === 0) {
 			// linking to a sibling or other page in same branch (but not a child)
-			url = path.substring(ProcessWire.config.ProcessPageEditLink.rootParentUrl.length); 
+			url = path.substring(cfg.rootParentUrl.length); 
 			var url2 = url;
 			url = slashesToRelative(url) + url2; 	
 			path = url;
 			
-		} else if(ProcessWire.config.ProcessPageEditLink.urlType == 2) { // 2=relative for all
+		} else if(cfg.urlType == 2) { // 2=relative for all
 			// page in a different tree than current
 			// traverse back to root
-			url = ProcessWire.config.ProcessPageEditLink.pageUrl.substring(config.urls.root.length); 
+			url = cfg.pageUrl.substring(ProcessWire.config.urls.root.length); 
 			url = slashesToRelative(url); 
 			path = path.substring(ProcessWire.config.urls.root.length); 
 			path = url + path; 
@@ -154,7 +159,7 @@ $(document).ready(function() {
 			$link.attr('title', val); 
 		}
 		
-		if(ProcessWire.config.ProcessPageEditLink.noLinkTextEdit) {
+		if(cfg.noLinkTextEdit) {
 			// link text editing disabled
 		} else if($linkText.length && $linkText.val().length) {
 			$link.text($linkText.val());
@@ -259,15 +264,15 @@ $(document).ready(function() {
 			if (!$this.hasClass('external-link')) {
 				icon().removeClass(allIcons).addClass(extLinkIcon);
 				$this.addClass('external-link');
-				var extLinkTarget = ProcessWire.config.ProcessPageEditLink.extLinkTarget;
+				var extLinkTarget = cfg.extLinkTarget;
 				if (extLinkTarget.length > 0) {
 					$("#link_target").val(extLinkTarget);
 				}
-				var extLinkRel = ProcessWire.config.ProcessPageEditLink.extLinkRel;
+				var extLinkRel = cfg.extLinkRel;
 				if (extLinkRel.length > 0) {
 					$("#link_rel").val(extLinkRel);
 				}
-				var extLinkClass = ProcessWire.config.ProcessPageEditLink.extLinkClass;
+				var extLinkClass = cfg.extLinkClass;
 				if (extLinkClass.length > 0) {
 					extLinkClass = extLinkClass.split(' ');
 					for(n = 0; n < extLinkClass.length; n++) {
@@ -342,10 +347,13 @@ $(document).ready(function() {
 		return true; 
 	});
 
-	$('#ProcessPageEditLinkForm').WireTabs({
+	var $form = $('#ProcessPageEditLinkForm'); 
+	if($form.length) {
+		$form.WireTabs({
 			items: $(".WireTab"),
 			id: 'PageEditLinkTabs'
 		});
+	}
 
 	setTimeout(function() {
 		$('#link_page_url_input').focus();

wire/modules/Process/ProcessPageEditLink/ProcessPageEditLink.module

@@ -25,7 +25,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		return array(
 			'title' => 'Page Edit Link',          
 			'summary' => 'Provides a link capability as used by some Fieldtype modules (like rich text editors).', 
-			'version' => 110, 
+			'version' => 111, 
 			'permanent' => true, 
 			'permission' => 'page-edit',
 			'icon' => 'link', 
@@ -72,6 +72,14 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 	 */
 	protected $langID = 0;
 
+	/**
+	 * Has init method been called?
+	 * 
+	 * @var bool 
+	 * 
+	 */
+	protected $init = false;
+
 	/**
 	 * Get default configuration settings
 	 * 
@@ -97,22 +105,48 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 	 */
 	public function __construct() {
 		parent::__construct();
-		foreach(self::getDefaultSettings() as $key => $value) {
+		$this->setArray(self::getDefaultSettings());
-			$this->set($key, $value); 
 	}
+	
+	public function init() {
+		$this->init = true;
+		parent::init();
 	}
 
 	/**
-	 * Init
+	 * Set
 	 * 
-	 * @throws WireException
+	 * @param string $key
+	 * @param string|int|array $value
+	 * @return self
 	 *
 	 */
-	public function init() {
+	public function set($key, $value) {
-		$input = $this->wire()->input;
+		if(!$this->init) return parent::set($key, $value);
-		$pages = $this->wire()->pages;
+		if($key === 'classOptions' || $key === 'relOptions' || $key === 'targetOptions') {
-		$modules = $this->wire()->modules;
+			$value = $this->wire()->sanitizer->htmlClasses($value, true);
+			$value = implode("\n", $value);
+		} else if($key === 'extLinkRel' || $key === 'extLinkClass') {
+			$value = $this->wire()->sanitizer->htmlClasses($value);
+		} else if($key === 'extLinkTarget') {
+			$value = $this->wire()->sanitizer->htmlClass($value);
+		}
+		return parent::set($key, $value);
+	}
+
+	/**
+	 * Primary execute
+	 * 
+	 * @return string
+	 * 
+	 */
+	public function ___execute() {
+
 		$sanitizer = $this->wire()->sanitizer;
+		$modules = $this->wire()->modules;
+		$config = $this->wire()->config;
+		$pages = $this->wire()->pages;
+		$input = $this->wire()->input;
 		
 		$this->startLabel = $this->_('Choose page');
 		$modules->get('ProcessPageList');
@@ -139,22 +173,6 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 			'noLinkTextEdit' => (int) $this->noLinkTextEdit
 		));
 
-		parent::init();
-	}
-
-	/**
-	 * Primary execute
-	 * 
-	 * @return string
-	 * 
-	 */
-	public function ___execute() {
-
-		$sanitizer = $this->wire()->sanitizer;
-		$modules = $this->wire()->modules;
-		$config = $this->wire()->config;
-		$input = $this->wire()->input;
-	
 		if($input->get('href')) {
 			$currentValue = $sanitizer->url($input->get('href'), array(
 				'stripQuotes' => false,
@@ -269,7 +287,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$field->label = $this->_('Title'); 
 		$field->description = $this->_('Additional text to describe link.');
 		if($input->get('title')) {
-			$field->attr('value', $sanitizer->text($input->get('title')));
+			$field->attr('value', $sanitizer->unentities($sanitizer->text($input->get('title'))));
 		}
 		$fieldset->add($field);
 		
@@ -295,14 +313,15 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 			$fieldset->add($field); 
 		}
 	
-		if($this->classOptions) {
+		$classOptions = $this->getClassOptions();
+		if($classOptions) {
 			/** @var InputfieldCheckboxes $field */
 			$field = $modules->get('InputfieldCheckboxes');
 			$field->attr('id+name', 'link_class');
 			$field->label = $this->_('Class');
 			$field->description = $this->_('Additional classes that can affect the look or behavior of the link.'); 
 			$field->optionColumns = 1; 
-			$this->addSelectOptions($field, 'class', $this->classOptions); 
+			$this->addSelectOptions($field, 'class', $classOptions);
 			$fieldset->add($field);
 		}
 		
@@ -315,6 +334,28 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		return $form->render() . "<p class='detail ui-priority-secondary'><code id='link_markup'></code></p>";
 	}
 
+	/**
+	 * Get class options string
+	 * 
+	 * This gets class options specified with module and those specified in input.get[class].
+	 * 
+	 * @return string Newline separated string of class options
+	 * @since 3.0.212
+	 * 
+	 */
+	protected function getClassOptions() {
+		
+		$sanitizer = $this->wire()->sanitizer;
+		$class = $this->wire()->input->get->text('class');
+		if(!$class) return $this->classOptions;
+		
+		$classOptions = $this->classOptions ? explode("\n", trim("$this->classOptions")) : array();
+		$classOptions = array_merge($classOptions, explode(' ', $class));
+		$classOptions = $sanitizer->htmlClasses($classOptions, true);
+		
+		return count($classOptions) ? implode("\n", $classOptions) : '';
+	}
+
 	/**
 	 * @param InputfieldSelect $field
 	 * @param $attrName
@@ -460,14 +501,15 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 
 	}
 
-	public function getModuleConfigInputfields(array $data) {
+	/**
+	 * Module configuration
+	 * 
+	 * @param InputfieldWrapper $inputfields
+	 * 
+	 */
+	public function getModuleConfigInputfields(InputfieldWrapper $inputfields) {
 		
 		$modules = $this->wire()->modules;
-		$sanitizer = $this->wire()->sanitizer;
-	
-		$data = array_merge(self::getDefaultSettings(), $data); 
-		/** @var InputfieldWrapper $inputfields */
-		$inputfields = $this->wire(new InputfieldWrapper());
 	
 		/** @var InputfieldFieldset $fieldset */
 		$fieldset = $modules->get('InputfieldFieldset'); 
@@ -485,7 +527,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f = $modules->get('InputfieldTextarea');
 		$f->attr('name', 'classOptions');
 		$f->label = 'class';
-		$f->attr('value', $data['classOptions']);
+		$f->attr('value', $this->classOptions);
 		$f->columnWidth = 34; 
 		$fieldset->add($f);
 
@@ -493,7 +535,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f = $modules->get('InputfieldTextarea');
 		$f->attr('name', 'relOptions');
 		$f->label = 'rel';
-		$f->attr('value', $data['relOptions']);
+		$f->attr('value', $this->relOptions);
 		$f->columnWidth = 33; 
 		$fieldset->add($f);
 
@@ -501,7 +543,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f = $modules->get('InputfieldTextarea');
 		$f->attr('name', 'targetOptions');
 		$f->label = 'target';
-		$f->attr('value', $data['targetOptions']);
+		$f->attr('value', $this->targetOptions);
 		$f->columnWidth = 33; 
 		$fieldset->add($f);
 		$inputfields->add($fieldset); 
@@ -518,7 +560,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f = $modules->get('InputfieldText');
 		$f->attr('name', 'extLinkClass');
 		$f->label = 'class';
-		$f->attr('value', $sanitizer->names($data['extLinkClass']));
+		$f->attr('value', $this->extLinkClass);
 		$f->required = false;
 		$f->columnWidth = 34;
 		$fieldset->add($f);
@@ -529,7 +571,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f->notes = $this->_('Example: Specifying **nofollow** would make external links default to be not followed by search engines.');
 		$f->label = 'rel';
 		$f->required = false; 
-		$f->attr('value', $sanitizer->names($data['extLinkRel']));
+		$f->attr('value', $this->extLinkRel);
 		$f->columnWidth = 33; 
 		$fieldset->add($f);
 
@@ -538,7 +580,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f->attr('name', 'extLinkTarget');
 		$f->label = 'target';
 		$f->notes = $this->_('Example: Specifying **_blank** would make external links default to open in a new window.'); 
-		$f->attr('value', $data['extLinkTarget']);
+		$f->attr('value', $this->extLinkTarget);
 		$f->required = false; 
 		$f->columnWidth = 33; 
 		$fieldset->add($f);
@@ -551,7 +593,7 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f->addOption(self::urlTypeAbsolute, $this->_('Full/absolute path from root (default)')); 
 		$f->addOption(self::urlTypeRelativeBranch, $this->_('Relative URLs in the same branches only') . '*'); 
 		$f->addOption(self::urlTypeRelativeAll, $this->_('Relative URLs always') . '*'); 
-		$f->attr('value', isset($data['urlType']) ? $data['urlType'] : self::urlTypeAbsolute); 
+		$f->attr('value', $this->urlType ? $this->urlType : self::urlTypeAbsolute); 
 		$f->notes = $this->_('*Currently experimental'); 
 		$f->collapsed = Inputfield::collapsedYes;
 		$inputfields->add($f);
@@ -561,14 +603,12 @@ class ProcessPageEditLink extends Process implements ConfigurableModule {
 		$f->attr('name', 'noLinkTextEdit');
 		$f->label = $this->_('Disable link text edit feature?');
 		$f->description = $this->_('Disables the “Edit Link Text” feature, enabling you to support links that can contain existing markup.');
-		if(empty($data['noLinkTextEdit'])) {
+		if($this->noLinkTextEdit) {
-			$f->collapsed = Inputfield::collapsedYes;
-		} else {
 			$f->attr('checked', 'checked');
+		} else {
+			$f->collapsed = Inputfield::collapsedYes;
 		}
 		$inputfields->add($f);
-		
-		return $inputfields; 
 	}
 }