Inital port to Backdrop CMS

Author: yorkshire-pudding

LICENSE.txt

@@ -0,0 +1,76 @@
+# Views Delimited List
+<!--
+The first paragraph of this file should be kept short as it will be used as the
+project summary on BackdropCMS.org. Aim for about 240 characters (three lines at
+80 characters each).
+
+All lines in this file should be no more than 80 characters long for legibility,
+unless including a URL or example that requires the line to not wrap.
+|<- - - - - - - This line is exactly 80 characters for reference - - - - - - ->|
+
+Detail in READMEs should be limited to the minimum required for installation and
+getting started. More detailed documentation should be moved to a GitHub wiki
+page; for example: https://github.com/backdrop-contrib/setup/wiki/Documentation.
+-->
+Views Delimited List allows you to format the row results of a view as a comma
+(or other delimiter) separated list. You can additionally define a different
+final delimiter and configure how it behaves with smaller result sets.
+
+The module adds a new display style with configuration for the delimiter, final
+delimiter and optional prefix/suffix. Each row should have a single line to work
+well so combine fields inline. No additional white space is added so add
+whitespace to the field and/or to the configured delimiters.
+
+With a 'HTML list' display, the results might have looked like:
+- Item 1
+- Item 2
+- Item 3
+
+But with the module, the results can look like:
+`Item 1, Item 2 and Item 3`
+
+## Installation
+<!--
+List the steps needed to install and configure the module. Add/remove steps as
+necessary.
+-->
+- Install this module using the official Backdrop CMS instructions at
+  https://docs.backdropcms.org/documentation/extend-with-modules.
+
+## Issues
+<!--
+Link to the repo's issue queue.
+-->
+Bugs and Feature Requests should be reported in the Issue Queue:
+https://github.com/backdrop-contrib/views_delimited_list/issues.
+
+## Current Maintainers
+<!--
+List the current maintainer(s) of the module, and note if this module needs
+new/additional maintainers.
+-->
+- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk)
+- Collaboration and co-maintainers welcome!
+
+## Credits
+<!--
+Give credit where credit's due.
+If this is a Drupal port, state who ported it, and who wrote the original Drupal
+module. If this module is based on another project, or uses third-party
+libraries, list them here. You can also mention any organisations/companies who
+sponsored the module's development.
+-->
+- Ported to Backdrop CMS by - [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk).
+- Port and ongoing development sponsored by [System Horizons Ltd](https://www.systemhorizons.co.uk).
+- Original [module for Drupal](https://www.drupal.org/project/views_delimited_list):
+  - Written, ported to Drupal 7 and maintained for Drupal 7 by
+  [Jason Zhang (zhangtaihao)](https://www.drupal.org/user/858312)
+
+## License
+<!--
+Mention what license this module is released under, and where people can find
+it.
+-->
+
+This project is GPL v2 software.
+See the LICENSE.txt file in this directory for complete text.

README.md

@@ -1,19 +1,22 @@
 <?php
 /**
  * @file views-delimited-list-fields.tpl.php
- * Default simple view template to all the fields as a row. This template overrides
- * the original template from Views to output no extra whitespace.
+ * Default simple view template to all the fields as a row. This template
+ * overrides the original template from Views to output no extra whitespace.
  *
  * - $view: The view in use.
  * - $fields: an array of $field objects. Each one contains:
  *   - $field->content: The output of the field.
- *   - $field->raw: The raw data for the field, if it exists. This is NOT output safe.
+ *   - $field->raw: The raw data for the field, if it exists. This is NOT
+ *     output safe.
  *   - $field->class: The safe class id to use.
- *   - $field->handler: The Views field handler object controlling this field. Do not use
+ *   - $field->handler: The Views field handler object controlling this field.
+ *     Do not use
  *     var_export to dump this object, as it can't handle the recursion.
  *   - $field->inline: Whether or not the field should be inline.
  *   - $field->inline_html: either div or span based on the above flag.
- *   - $field->wrapper_prefix: A complete wrapper containing the inline_html to use.
+ *   - $field->wrapper_prefix: A complete wrapper containing the inline_html to
+ *     use.
  *   - $field->wrapper_suffix: The closing tag for the wrapper.
  *   - $field->separator: an optional separator that may appear before a field.
  *   - $field->label: The wrap label text to use.

views-delimited-list-fields.tpl.php

@@ -6,19 +6,21 @@
  * @ingroup views_templates
  */
 
-// Prepare variables
+// Prepare variables.
 $count = count($rows);
 $separator = ($count == 2 && $count != $options['long_count']) ? $options['separator_two'] : $options['separator_long'];
 $last_delimiter = $separator == 'both' || $separator == 'delimiter';
 $last_conjunctive = $separator == 'both' || $separator == 'conjunctive';
 
 ?>
-<?php if (!empty($title)): ?>
-<h3><?php print $title; ?></h3>
+<?php if (!empty($title)) : ?>
+  <h3>
+    <?php print $title; ?>
+  </h3>
 <?php endif; ?>
 <div class="views-delimited-list">
 <?php
-// Prefix
+// Prefix.
 if (!empty($options['prefix'])) {
   print '<span class="views-delimited-list-prefix">';
   print $options['prefix'];
@@ -28,27 +30,27 @@
 foreach ($rows as $i => $row) {
   $index = $i + 1;
 
-  // Row
+  // Row.
   print '<span class="' . $classes_array[$i] . '">';
   print trim($row);
   print '</span>';
 
-  // Delimiter
+  // Delimiter.
   if ($index < $count - 1 || $index == $count - 1 && $last_delimiter) {
     print '<span class="views-row-delimiter">' . $options['delimiter'] . '</span>';
   }
 
-  // Conjunctive
+  // Conjunctive.
   if ($index == $count - 1 && $last_conjunctive && is_string($options['conjunctive']) && $options['conjunctive'] !== '') {
     print '<span class="views-row-conjunctive">' . $options['conjunctive'] . '</span>';
   }
 }
 
-// Suffix
+// Suffix.
 if (!empty($options['suffix'])) {
   print '<span class="views-delimited-list-suffix">';
   print $options['suffix'];
   print '</span>';
 }
 ?>
-</div>
+</div>

views-view-delimited-list.tpl.php

@@ -1,6 +1,10 @@
 name = Views Delimited List
 description = Displays the results of a view as a delimited text list.
+backdrop = 1.x
+type = module
+
 dependencies[] = views
-files[] = views_plugin_style_delimited_list.inc
-core = 7.x
-package = Views
+
+package = Views
+tags[] = Content
+tags[] = Structure

views_delimited_list.info

@@ -30,16 +30,27 @@ function views_delimited_list_theme_registry_alter(&$hooks) {
 function views_delimited_list_views_api() {
   return array(
     'api' => 3,
+    'path' => backdrop_get_path('module', 'views_delimited_list'),
   );
 }
 
+/**
+ * Implements hook_autoload_info().
+ */
+function views_delimited_list_autoload_info() {
+  return array(
+    'views_plugin_style_delimited_list' => 'views_plugin_style_delimited_list.inc',
+  );
+}
+
+
 /**
  * Implements template_preprocess_HOOK().
  */
 function template_preprocess_views_view_delimited_list(&$vars) {
   $view = $vars['view'];
 
-  // Process row classes
+  // Process row classes.
   $vars['classes_array'] = array();
   foreach ($vars['rows'] as $id => $_) {
     $vars['classes_array'][$id] = 'views-row';
@@ -51,7 +62,8 @@ function template_preprocess_views_view_delimited_list(&$vars) {
  */
 function views_delimited_list_preprocess_views_view_fields(&$vars) {
   if (class_exists('views_plugin_style_delimited_list') && $vars['view']->style_plugin instanceof views_plugin_style_delimited_list) {
-    // Inject the view template name to dispose Drupal towards using our template
+    // Inject the view template name to dispose Backdrop towards using our
+    // template.
     array_unshift($vars['theme_hook_suggestions'], 'views_delimited_list_fields');
   }
 }

views_delimited_list.module

@@ -8,14 +8,15 @@
  * Implements hook_views_plugins().
  */
 function views_delimited_list_views_plugins() {
-  $path = drupal_get_path('module', 'views_delimited_list');
+  $path = backdrop_get_path('module', 'views_delimited_list');
   $plugins = array(
     'style' => array(
       'views_delimited_list' => array(
         'title'           => t('Delimited text list'),
         'path'            => $path,
         'help'            => ('Display rows as an inline, delimited list of text.'),
         'handler'         => 'views_plugin_style_delimited_list',
+        'theme path'      => $path,
         'theme'           => 'views_view_delimited_list',
         'uses row plugin' => TRUE,
         'uses fields'     => TRUE,

views_delimited_list.views.inc

@@ -6,7 +6,7 @@ class views_plugin_style_delimited_list extends views_plugin_style {
   /**
    * Default options.
    */
-  function option_definition() {
+  public function option_definition() {
     $options = parent::option_definition();
     $options['delimiter'] = array('default' => ', ');
     $options['conjunctive'] = array('default' => ' and ');
@@ -21,7 +21,7 @@ class views_plugin_style_delimited_list extends views_plugin_style {
   /**
    * Add widgets for selecting fields for the feature rotator.
    */
-  function options_form(&$form, &$form_state) {
+  public function options_form(&$form, &$form_state) {
     parent::options_form($form, $form_state);
 
     $form['delimiter'] = array(
@@ -97,4 +97,4 @@ class views_plugin_style_delimited_list extends views_plugin_style {
       '#description' => t('Text to insert inline after the delimited list.'),
     );
   }
-}
+}