Commit acff3d11 authored by Frédéric G. Marand's avatar Frédéric G. Marand
Browse files

Issue #2805453: Documented the extension process.

parent e14611b6
Loading
Loading
Loading
Loading
+36 −0
Changes for README.md: 36 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -22,6 +22,42 @@ changed often.
- configure your RSS reader to read the appropriate page


# Extending the module: additional Views

## Requirements

The module will automatically extend support for Views added to the site, as
long as they meet a few requirements:

- the view is tagged `AdminRSS`
- it contains at least one feed display, with the following requirements
  - its access handler is the AdminRSS handler
  - its path contains the `%adminrss_token` parameter

## Additional features

- the Display name (labeled Administrative name in the UI popup) is used to link
  to the feed
- its Administrative description (in the UI popup) is used as the title for the
  link to the feed

## Suggestions

In most cases, the goal of this module is to list normally unaccessible content,
without real-time emergency, so when adding new Views, set the following query
settings in the Advanced/Other pane in the Views UI

- Disable SQL rewriting: to access inaccessible content
- Use secondary server: to avoid filtering out yet unpublished content.

When in doubt, check how the supplied Views are built.


# License

This module is licensed under the General Public License version 2.0 or later.


# Credit

- Originally created by:
+1 −0
Changes for adminrss.info.yml: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -4,3 +4,4 @@ package: 'Administration'
core: 8.x
type: 'module'
configure: adminrss.admin_rss_settings_form
php: 7.0
+4 −1
Changes for src/ViewsManager.php: 4 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -89,8 +89,11 @@ class ViewsManager {
      $routes = reset($routeCollection);
      $routeName = key($routes);

      $title = $display['display_title'];
      // ID is always present so no need to check.
      $title = $display['display_title'] ?? $display['id'];
      if (isset($display['display_options']['display_description'])) {
        $options['attributes']['title'] = $display['display_options']['display_description'];
      }

      $link = Link::createFromRoute($title, $routeName, $tokenParam, $options);
    }