diff --git a/README.txt b/README.txt index 4fc242d..dd6aeee 100644 --- a/README.txt +++ b/README.txt @@ -1,6 +1,5 @@ CONTENTS OF THIS FILE --------------------- - * Introduction * Requirements * Installation @@ -9,7 +8,7 @@ CONTENTS OF THIS FILE INTRODUCTION ------------ -The Sharethis module provides the social bookmarking utility on selected node types. +The Sharethis module provides social bookmarking utility on selected node types. REQUIREMENTS ------------ diff --git a/js/sharethis.form.js b/js/sharethis.form.js index a26559c..3de3d47 100644 --- a/js/sharethis.form.js +++ b/js/sharethis.form.js @@ -3,7 +3,7 @@ * This file contains most of the code for the configuration page. */ -(function ($, window) { +(function ($, window, drupalSettings, stlib_picker) { 'use strict'; @@ -11,64 +11,61 @@ window.drupal_st = { // These are handlerd for updating the widget pic class. multiW: function () { - $(".st_widgetPic").addClass("st_multi"); + $('.st_widgetPic').addClass('st_multi'); }, classicW: function () { - $(".st_widgetPic").removeClass("st_multi"); + $('.st_widgetPic').removeClass('st_multi'); }, // These are the handlers for updating the button pic class (stbc = sharethisbuttonclass). smallChicklet: function () { drupal_st.removeButtonClasses(); - $("#stb_sprite").addClass("stbc_"); + $('#stb_sprite').addClass('stbc_'); }, largeChicklet: function () { drupal_st.removeButtonClasses(); - $("#stb_sprite").addClass("stbc_large"); + $('#stb_sprite').addClass('stbc_large'); }, hcount: function () { drupal_st.removeButtonClasses(); - $("#stb_sprite").addClass("stbc_hcount"); + $('#stb_sprite').addClass('stbc_hcount'); }, vcount: function () { drupal_st.removeButtonClasses(); - $("#stb_sprite").addClass("stbc_vcount"); + $('#stb_sprite').addClass('stbc_vcount'); }, button: function () { drupal_st.removeButtonClasses(); - $("#stb_sprite").addClass("stbc_button"); + $('#stb_sprite').addClass('stbc_button'); }, // This is a helper function for updating button pictures. removeButtonClasses: function () { - var toRemove = $("#stb_sprite"); - toRemove.removeClass("stbc_"); - toRemove.removeClass("stbc_large"); - toRemove.removeClass("stbc_hcount"); - toRemove.removeClass("stbc_vcount"); - toRemove.removeClass("stbc_button"); + var toRemove = $('#stb_sprite'); + toRemove.removeClass('stbc_'); + toRemove.removeClass('stbc_large'); + toRemove.removeClass('stbc_hcount'); + toRemove.removeClass('stbc_vcount'); + toRemove.removeClass('stbc_button'); }, // Write helper functions for saving: getWidget: function () { - return $(".st_widgetPic").hasClass("st_multiW") ? '5x' : '4x'; + return $('.st_widgetPic').hasClass('st_multiW') ? '5x' : '4x'; }, getButtons: function () { var selectedButton = 'large'; - var buttonButtons = $(".st_wIm"); + var buttonButtons = $('.st_wIm'); buttonButtons.each(function () { - if ($(this).hasClass("st_select")) { - selectedButton = $(this).attr("id").substring(3); + if ($(this).hasClass('st_select')) { + selectedButton = $(this).attr('id').substring(3); } }); - console.log(selectedButton); return selectedButton; }, setupServiceText: function () { - $("#edit-service-option").css({display: "none"}); + $('#edit-service-option').css({display: 'none'}); - if ($('input[name=sharethis_callesi]').val() == 1) { + if ($('input[name=sharethis_callesi]').val() === 1) { drupal_st.getGlobalCNSConfig(); } - else { - } }, odjs: function (scriptSrc, callBack) { this.head = document.getElementsByTagName('head')[0]; @@ -78,7 +75,7 @@ this.script.setAttribute('src', this.scriptSrc); this.script.onload = callBack; this.script.onreadystatechange = function () { - if (this.readyState == "complete" || (scriptSrc.indexOf("checkOAuth.esi") != -1 && this.readyState == "loaded")) { + if (this.readyState === 'complete' || (scriptSrc.indexOf('checkOAuth.esi') !== -1 && this.readyState === 'loaded')) { callBack(); } }; @@ -86,7 +83,7 @@ }, getGlobalCNSConfig: function () { try { - drupal_st.odjs((("https:" == document.location.protocol) ? "https://wd-edge.sharethis.com/button/getDefault.esi?cb=drupal_st.cnsCallback" : "http://wd-edge.sharethis.com/button/getDefault.esi?cb=drupal_st.cnsCallback")); + drupal_st.odjs(('https:' === document.location.protocol) ? 'https://wd-edge.sharethis.com/button/getDefault.esi?cb=drupal_st.cnsCallback' : 'http://wd-edge.sharethis.com/button/getDefault.esi?cb=drupal_st.cnsCallback'); } catch (err) { drupal_st.cnsCallback(err); @@ -97,36 +94,36 @@ }, // Function to add various events to our html form elements. addEvents: function () { - $("#edit-widget-option-st-multi").click(drupal_st.multiW); - $("#edit-widget-option-st-direct").click(drupal_st.classicW); + $('#edit-widget-option-st-multi').click(drupal_st.multiW); + $('#edit-widget-option-st-direct').click(drupal_st.classicW); - $("#edit-button-option-stbc-").click(drupal_st.smallChicklet); - $("#edit-button-option-stbc-large").click(drupal_st.largeChicklet); - $("#edit-button-option-stbc-hcount").click(drupal_st.hcount); - $("#edit-button-option-stbc-vcount").click(drupal_st.vcount); - $("#edit-button-option-stbc-button").click(drupal_st.button); + $('#edit-button-option-stbc-').click(drupal_st.smallChicklet); + $('#edit-button-option-stbc-large').click(drupal_st.largeChicklet); + $('#edit-button-option-stbc-hcount').click(drupal_st.hcount); + $('#edit-button-option-stbc-vcount').click(drupal_st.vcount); + $('#edit-button-option-stbc-button').click(drupal_st.button); - $(".st_formButtonSave").click(drupal_st.updateOptions); + $('.st_formButtonSave').click(drupal_st.updateOptions); $('#st_cns_settings').find('input').on('click', drupal_st.updateDoNotHash); }, serviceCallback: function () { - var services = stlib_picker.getServices("myPicker"); - var outputString = ""; + var services = stlib_picker.getServices('myPicker'); + var outputString = ''; for (var i = 0; i < services.length; i++) { - outputString += "\"" + _all_services[services[i]].title + ":" - outputString += services[i] + "\"," + outputString += '\'' + _all_services[services[i]].title + ':'; + outputString += services[i] + '\','; } outputString = outputString.substring(0, outputString.length - 1); - $("#edit-service-option").attr("value", outputString); + $('#edit-service-option').attr('value', outputString); }, to_boolean: function (str) { return str === true || $.trim(str).toLowerCase() === 'true'; }, cnsCallback: function (response) { - if ((response instanceof Error) || (response == "" || (typeof(response) == "undefined"))) { + if ((response instanceof Error) || (response === '' || (typeof response == 'undefined'))) { // Setting default config. - response = '{"doNotHash": true, "doNotCopy": true, "hashAddressBar": false}'; + response = "{'doNotHash': true, 'doNotCopy': true, 'hashAddressBar': false}"; response = $.parseJSON(response); } @@ -136,32 +133,34 @@ hashAddressBar: drupal_st.to_boolean(response.hashAddressBar) }; - if (obj.doNotHash == false || obj.doNotHash === "false") { - if (obj.doNotCopy === true || obj.doNotCopy == "true") { - $($('#st_cns_settings').find('input')[0]).removeAttr("checked"); + if (obj.doNotHash === false || obj.doNotHash === false) { + if (obj.doNotCopy === true || obj.doNotCopy === true) { + $($('#st_cns_settings').find('input')[0]).removeAttr('checked'); } else { - $($('#st_cns_settings').find('input')[0]).attr("checked", true); + $($('#st_cns_settings').find('input')[0]).attr('checked', true); } - if (obj.hashAddressBar === true || obj.hashAddressBar == "true") { - $($('#st_cns_settings').find('input')[1]).attr("checked", true); + if (obj.hashAddressBar === true || obj.hashAddressBar === true) { + $($('#st_cns_settings').find('input')[1]).attr('checked', true); } else { - $($('#st_cns_settings').find('input')[1]).removeAttr("checked"); + $($('#st_cns_settings').find('input')[1]).removeAttr('checked'); } } else { $('#st_cns_settings').find('input').each(function (index) { - $(this).removeAttr("checked"); + $(this).removeAttr('checked'); }); } } }; - $(document).ready(function(){ - stlib_picker.setupPicker(jQuery("#myPicker"), drupalSettings.sharethis.service_string_markup, drupal_st.serviceCallback); - drupal_st.addEvents(); - drupal_st.setupServiceText(); + Drupal.behaviors.shareThisForm = { + attach: function (context) { + stlib_picker.setupPicker(jQuery('#myPicker'), drupalSettings.sharethis.service_string_markup, drupal_st.serviceCallback); + drupal_st.addEvents(); + drupal_st.setupServiceText(); + } + }; - }); -})(jQuery, window); +})(jQuery, window, drupalSettings, stlib_picker); diff --git a/js/sharethis.js b/js/sharethis.js index 625ebaf..3f7b8b1 100644 --- a/js/sharethis.js +++ b/js/sharethis.js @@ -4,12 +4,12 @@ */ (function ($, drupalSettings) { - 'use strict'; - $(document).ready(function(){ - var switchTo5x = true;var __st_loadLate = true; - if (stLight !== undefined) { - stLight.options(drupalSettings.sharethis); + 'use strict'; + Drupal.behaviors.shareThis = { + attach: function (context) { + if (typeof stLight !== 'undefined') { + stLight.options(drupalSettings.sharethis); } - - }); + } + }; })(jQuery, drupalSettings); diff --git a/js/stlib_picker.js b/js/stlib_picker.js index 097199e..e591ba8 100644 --- a/js/stlib_picker.js +++ b/js/stlib_picker.js @@ -8,127 +8,133 @@ // Styling can be found in stlib_picker.css and should be linked in the page. // To get selected services as an array of strings: (ie ["twitter", "sharethis", "facebook"] ) // Call: var answer = stlib_picker.pickerList[uniqueID]["getServices"]();. -var stlib_picker = {}, isSecure = ("https:" == document.location.protocol) ? true : false; -stlib_picker.pickerList = []; -stlib_picker.defaultServices = ["sharethis", "tumblr", "bebo"]; -stlib_picker.getServices = function (id) { - var func = stlib_picker.pickerList[id]["getServices"]; - return func(); -} +(function ($, drupalSettings) { + 'use strict'; -// Creates the picker - make sure it has a unique ID. -stlib_picker.setupPicker = function(jQElement, newDefaults, callback) { - console.log("setting up picker"); - console.log(jQElement); - // Make an array to store any needed options. - var optionsArray = []; - optionsArray["El"] = jQElement; - optionsArray["isSelect"] = false; - optionsArray["getServices"] = function() { - var answer = []; - var lis = jQElement.children(".stp_pickerLeft").find(".stp_li"); - lis.each(function() { - answer.push(jQuery(this).attr("id").substring(6)); - }); - return answer; + var stlib_picker = {}; + var isSecure = ('https:' == document.location.protocol) ? true : false; + stlib_picker.pickerList = []; + stlib_picker.defaultServices = ['sharethis', 'tumblr', 'bebo']; + stlib_picker.getServices = function (id) { + var func = stlib_picker.pickerList[id]['getServices']; + return func(); }; - // Append the three divs that are needed: - jQElement.append("
Selected Service
"); - jQElement.append("
" + - "
" + - "
" + - "
" + - "
"); - jQElement.append("
Possible Services
"); - jQElement.append("
"); + // Creates the picker - make sure it has a unique ID. + stlib_picker.setupPicker = function (jQElement, newDefaults, callback) { - // Add default Services. - var pickerDefaults = []; - if (newDefaults) { - pickerDefaults = newDefaults; - } - else { - pickerDefaults = stlib_picker.defaultServices; - } + // Make an array to store any needed options. + var optionsArray = []; + optionsArray['El'] = jQElement; + optionsArray['isSelect'] = false; + optionsArray['getServices'] = function () { + var answer = []; + var lis = jQElement.children('.stp_pickerLeft').find('.stp_li'); + lis.each(function () { + answer.push($(this).attr('id').substring(6)); + }); + return answer; + }; - // Add all the services to the picker: - jQuery.each(_all_services, function(key, value) { - if (jQuery.inArray(key, pickerDefaults) == -1) { - var ul = jQElement.children(".stp_pickerRight").children(".stp_ulRight"); - if (isSecure) { - ul.append("
  • " + value.title + "
    • "); - } - else { - ul.append("
  • " + value.title + "
    • "); - } + // Append the three divs that are needed: + jQElement.append("
    " + Drupal.t('Selected Service') + "
    "); + jQElement.append("
    " + + "
    " + + "
    " + + "
    " + + "
    " + + '
    '); + jQElement.append("
    " + Drupal.t('Possible Services') + "
    "); + jQElement.append("
    "); - } - }); - for (i = 0; i < pickerDefaults.length; i++) { - var ul = jQElement.children(".stp_pickerLeft").children(".stp_ulLeft"); - if (isSecure) { - ul.append("
  • " + _all_services[pickerDefaults[i]].title + "
    • "); + // Add default Services. + var pickerDefaults = []; + if (newDefaults) { + pickerDefaults = newDefaults; } else { - ul.append("
  • " + _all_services[pickerDefaults[i]].title + "
    • "); + pickerDefaults = stlib_picker.defaultServices; } - } - // Add the various Event handlers - // Need to make sure that we don't get confused when there are multiple pickers. - jQElement.find(".stp_li").click(function() { - jQElement.find(".stp_select").removeClass("stp_select"); - jQuery(this).addClass("stp_select"); - stlib_picker.pickerList[jQElement.attr("id")]["isSelect"] = true; - }); + // Add all the services to the picker: + $.each(_all_services, function (key, value) { + if ($.inArray(key, pickerDefaults) === -1) { + var ul = jQElement.children('.stp_pickerRight').children('.stp_ulRight'); + if (isSecure) { + ul.append('
  • ' + value.title + '
    • '); + } + else { + ul.append('
  • ' + value.title + '
    • '); + } - var arrowDiv = jQElement.children(".stp_pickerArrow").children(".stp_arrow"); - arrowDiv.children(".stp_up").click(function() { - if (stlib_picker.pickerList[jQElement.attr("id")]["isSelect"]) { - var li = jQElement.find(".stp_select"); - var prev = li.prev(); - if (prev.length != 0) { - prev.before(li); } - if (callback) { - callback(); + }); + for (var i = 0; i < pickerDefaults.length; i++) { + var ul = jQElement.children('.stp_pickerLeft').children('.stp_ulLeft'); + if (isSecure) { + ul.append('
  • ' + _all_services[pickerDefaults[i]].title + '
    • '); } - } - }); - arrowDiv.children(".stp_left").click(function() { - if (stlib_picker.pickerList[jQElement.attr("id")]["isSelect"]) { - var li = jQElement.find(".stp_select"); - var ul = jQElement.children(".stp_pickerLeft").children(".stp_ulLeft"); - ul.prepend(li); - if (callback) { - callback(); + else { + ul.append('
  • ' + _all_services[pickerDefaults[i]].title + '
    • '); } } - }); - arrowDiv.children(".stp_right").click(function() { - if (stlib_picker.pickerList[jQElement.attr("id")]["isSelect"]) { - var li = jQElement.find(".stp_select"); - var ul = jQElement.children(".stp_pickerRight").children(".stp_ulRight"); - ul.prepend(li); - if (callback) { - callback(); + + // Add the various Event handlers + // Need to make sure that we don't get confused when there are multiple pickers. + jQElement.find('.stp_li').click(function () { + jQElement.find('.stp_select').removeClass('stp_select'); + $(this).addClass('stp_select'); + stlib_picker.pickerList[jQElement.attr('id')]['isSelect'] = true; + }); + + var arrowDiv = jQElement.children('.stp_pickerArrow').children('.stp_arrow'); + arrowDiv.children('.stp_up').click(function () { + if (stlib_picker.pickerList[jQElement.attr('id')]['isSelect']) { + var li = jQElement.find('.stp_select'); + var prev = li.prev(); + if (prev.length !== 0) { + prev.before(li); + } + if (callback) { + callback(); + } } - } - }); - arrowDiv.children(".stp_down").click(function() { - if (stlib_picker.pickerList[jQElement.attr("id")]["isSelect"]) { - var li = jQElement.find(".stp_select"); - var next = li.next(); - if (next.length != 0) { - next.after(li); + }); + arrowDiv.children('.stp_left').click(function () { + if (stlib_picker.pickerList[jQElement.attr('id')]['isSelect']) { + var li = jQElement.find('.stp_select'); + var ul = jQElement.children('.stp_pickerLeft').children('.stp_ulLeft'); + ul.prepend(li); + if (callback) { + callback(); + } } - if (callback) { - callback(); + }); + arrowDiv.children('.stp_right').click(function () { + if (stlib_picker.pickerList[jQElement.attr('id')]['isSelect']) { + var li = jQElement.find('.stp_select'); + var ul = jQElement.children('.stp_pickerRight').children('.stp_ulRight'); + ul.prepend(li); + if (callback) { + callback(); + } } - } - }); + }); + arrowDiv.children('.stp_down').click(function () { + if (stlib_picker.pickerList[jQElement.attr('id')]['isSelect']) { + var li = jQElement.find('.stp_select'); + var next = li.next(); + if (next.length !== 0) { + next.after(li); + } + if (callback) { + callback(); + } + } + }); + + // Save the options (and the picker) globally. + stlib_picker.pickerList[jQElement.attr('id')] = optionsArray; + }; - // Save the options (and the picker) globally. - stlib_picker.pickerList[jQElement.attr("id")] = optionsArray; -} +})(jQuery, drupalSettings); diff --git a/sharethis.module b/sharethis.module index 718e126..a2cb321 100644 --- a/sharethis.module +++ b/sharethis.module @@ -36,9 +36,9 @@ function sharethis_theme($existing, $type, $theme, $path) { return array( 'sharethis_block' => array( 'variables' => array( - 'content' => [ + 'content' => array( 'st_spans' => NULL, - ], + ), ), 'function' => 'theme_sharethis_block', ), diff --git a/src/Form/SharethisConfigurationForm.php b/src/Form/SharethisConfigurationForm.php index 959961f..317cd78 100644 --- a/src/Form/SharethisConfigurationForm.php +++ b/src/Form/SharethisConfigurationForm.php @@ -107,7 +107,7 @@ class SharethisConfigurationForm extends ConfigFormBase { // Create the variables related to services chosen. $service_string = $current_options_array['services']; $service_string_markup = ""; - foreach (explode(",", $service_string) as $name => $string) { + foreach (explode(",", $service_string) as $string) { $key = explode(":", Unicode::substr($string, 0, -1)); $key = $key[1]; $service_string_markup[] = $key; @@ -151,10 +151,10 @@ class SharethisConfigurationForm extends ConfigFormBase { '#title' => $this->t('Extra services'), '#description' => $this->t('Select additional services which will be available. These are not officially supported by ShareThis, but are available.'), '#type' => 'checkboxes', - '#options' => [ + '#options' => array( 'Google Plus One:plusone' => $this->t('Google Plus One'), 'Facebook Like:fblike' => $this->t('Facebook Like'), - ], + ), '#default_value' => $config->get('option_extras'), ); diff --git a/src/SharethisManager.php b/src/SharethisManager.php index f173901..de8e7d8 100644 --- a/src/SharethisManager.php +++ b/src/SharethisManager.php @@ -77,7 +77,6 @@ class SharethisManager implements SharethisManagerInterface { ]; } - /** * {@inheritdoc} */ @@ -105,6 +104,7 @@ class SharethisManager implements SharethisManagerInterface { } } + /** * {@inheritdoc} */ @@ -191,17 +191,18 @@ class SharethisManager implements SharethisManagerInterface { $data_options['services'] .= ',"' . $service . '"'; } - // The share buttons are simply spans of the form class='st_SERVICE_BUTTONTYPE' -- "st" stands for ShareThis. + // Share buttons are simply spans of the form class='st_SERVICE_BUTTONTYPE' + // where -- "st" stands for ShareThis. $type = Unicode::substr($data_options['buttons'], 4); $type = $type == "_" ? "" : Html::escape($type); $service_array = explode(",", $data_options['services']); $st_spans = ""; foreach ($service_array as $service_full) { - // Strip the quotes from the element in the array (They are there for javascript). + // Strip the quotes from element in array (They are there for javascript). $service = explode(":", $service_full); - // Service names are expected to be parsed by Name:machine_name. If only one - // element in the array is given, it's an invalid service. + // Service names are expected to be parsed by Name:machine_name. If only + // one element in the array is given, it's an invalid service. if (count($service) < 2) { continue; } diff --git a/src/SharethisManagerInterface.php b/src/SharethisManagerInterface.php index ac1046c..1d87819 100644 --- a/src/SharethisManagerInterface.php +++ b/src/SharethisManagerInterface.php @@ -15,7 +15,7 @@ interface SharethisManagerInterface { /** * Determine if connection should be refreshed. * - * @return [] + * @return array * Returns the list of options that sharethis provides. */ public function getOptions(); @@ -24,15 +24,18 @@ interface SharethisManagerInterface { * Custom html block. * * @return array + * Return array renderable by renderSpans(). */ public function blockContents(); /** * Custom html markup for widget. * - * @param $array + * @param array $array + * Settings array. * * @return array + * Return array renderable by renderSpans(). */ public function widgetContents($array); @@ -43,11 +46,13 @@ interface SharethisManagerInterface { /** - * function is creating options to be passed to stLight. + * Function is creating options to be passed to stLight. * * @param array $data_options * The settings selected by publisher in admin panel. * + * @return array + * An array of options. */ public function getShareThisLightOptions($data_options); @@ -55,10 +60,11 @@ interface SharethisManagerInterface { /** * Converts given value to boolean. * - * @param $val - * Which value to convert to boolean + * @param string $val + * Which value to convert to boolean. * * @return bool + * Return TRUE or FALSE. * * @todo To be replaced with bool */ @@ -68,10 +74,14 @@ interface SharethisManagerInterface { * Custom html block. * * @param array $array + * Settings array. * @param string $title + * Title string. * @param string $string + * Sharethis path. * * @return array + * Array with options, title and path. */ public function renderSpans($array, $title, $string); diff --git a/src/Tests/SharethisBlockTest.php b/src/Tests/SharethisBlockTest.php index 81d8677..acf5089 100644 --- a/src/Tests/SharethisBlockTest.php +++ b/src/Tests/SharethisBlockTest.php @@ -45,7 +45,7 @@ class SharethisBlockTest extends NodeTestBase { $edit['location'] = 'block'; $this->drupalPostForm('admin/config/services/sharethis', $edit, t('Save configuration')); $this->assertText(t('The configuration options have been saved.'), t('Saved configuration')); - // Test availability of the sharethis block in the admin "Place blocks" list. + // Test availability of sharethis block in the admin "Place blocks" list. \Drupal::service('theme_handler')->install(['bartik', 'seven', 'stark']); $theme_settings = $this->config('system.theme'); foreach (['bartik', 'seven', 'stark'] as $theme) { diff --git a/src/Tests/Views/SharethisViewsPluginTest.php b/src/Tests/Views/SharethisViewsPluginTest.php index f92958e..8024bd2 100644 --- a/src/Tests/Views/SharethisViewsPluginTest.php +++ b/src/Tests/Views/SharethisViewsPluginTest.php @@ -51,9 +51,8 @@ class SharethisViewsPluginTest extends ViewTestBase { * Tests the handlers. */ public function testHandlers() { - $nodes = array(); - $nodes[] = $this->drupalCreateNode(); - $nodes[] = $this->drupalCreateNode(); + $this->drupalCreateNode(); + $this->drupalCreateNode(); // Test the sharethis field. $view = Views::getView('test_sharethis'); $view->setDisplay('page_1');