Skip to the content
Documentation

exp:notificationsubscriptions

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

List the subtree notification subscriptions per user and subtree, or remove those whose content is gone (dry run unless --apply)

Usage

./console exp:notificationsubscriptions [options]
php bin/php/notificationsubscriptions.php [options]
./console exp:notification:subscriptions [options]
./console exp:notify:subscriptions [options]

Aliases

exp:notification:subscriptions, exp:notify:subscriptions

Help

The output of ./console help exp:notificationsubscriptions (the script run with --help), without the standard options:

Usage: bin/php/notificationsubscriptions.php [OPTION]...
Notification subscriptions
  list                      the subtree subscriptions: user, node, path, class, last change below the node
  remove-missing            remove the subscriptions whose node no longer exists (lists them; --apply removes)

remove-missing without --apply removes nothing: it lists what it would remove. --dry-run is still
accepted and means the same as no flag; --apply together with --dry-run is a usage error (exit 2).

./console exp:notification:subscriptions list --user=editor --limit=20
./console exp:notification:subscriptions list --missing
./console exp:notification:subscriptions remove-missing
./console exp:notification:subscriptions remove-missing --apply


Options:
  --user=VALUE    only this user: a login or the user's content object id
  --class=VALUE   only nodes of this class identifier
  --missing       only subscriptions whose node is gone
  --limit=VALUE   how many (default 50)
  --offset=VALUE  skip this many
  --addresses     also show the user's e-mail address (hidden by default)
  --apply         remove-missing: remove the subscriptions (the default lists them and removes nothing)
  --dry-run       remove-missing: the default, kept for scripts that pass it: list, remove nothing
  --json          list: JSON

Options

Option Value Description
--user required only this user: a login or the user's content object id
-q required only nodes whose name contains this
--class required only nodes of this class identifier
--missing - only subscriptions whose node is gone
--limit required how many (default 50)
--offset required skip this many
--addresses - also show the user's e-mail address (hidden by default)
--apply - remove-missing: remove the subscriptions (the default lists them and removes nothing)
--dry-run - remove-missing: the default, kept for scripts that pass it: list, remove nothing
--json - list: JSON

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/notificationsubscriptions.php, kernel/private/classes/commands/notificationsubscriptions.php

See also

Generated example: exp:notificationsubscriptions

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.