function flag_token_info in Flag 8.4

Same name and namespace in other branches

1. 7.3 flag.tokens.inc \flag_token_info()
2. 7.2 flag.tokens.inc \flag_token_info()

Implements hook_token_info().

File

./flag.tokens.inc, line 13

Flag module tokens support.

Code

function flag_token_info() {
  $types = [];
  $tokens = [];

  // Flag tokens.
  $types['flag'] = [
    'name' => t('Flags'),
    'description' => t('Tokens related to flag data.'),
    'needs-data' => 'flag',
  ];
  $tokens['flag']['name'] = [
    'name' => t('Flag name'),
    'description' => t('The flag machine-readable name.'),
  ];
  $tokens['flag']['title'] = [
    'name' => t('Flag title'),
    'description' => t('The human-readable flag title.'),
  ];

  // Flagging tokens.
  //
  // Attached fields are exposed as tokens via some contrib module, but we
  // need to expose other fields ourselves. Currently, 'date' is the only such
  // field we expose.
  $types['flagging'] = [
    'name' => t('Flaggings'),
    'description' => t('Tokens related to flaggings.'),
    'needs-data' => 'flagging',
  ];
  $tokens['flagging']['date'] = [
    'name' => t('Flagging date'),
    'description' => t('The date an item was flagged.'),
    'type' => 'date',
  ];

  // Flag action tokens.
  $types['flag-action'] = [
    'name' => t('Flag actions'),
    'description' => t('Tokens available in response to a flag action being executed by a user.'),
    'needs-data' => 'flag-action',
  ];
  $tokens['flag-action']['action'] = [
    'name' => t('Flag action'),
    'description' => t('The flagging action taking place, either "flag" or "unflag".'),
  ];
  $tokens['flag-action']['entity-url'] = [
    'name' => t('Flag entity URL'),
    'description' => t('The URL of the entity being flagged.'),
  ];
  $tokens['flag-action']['entity-title'] = [
    'name' => t('Flag entity title'),
    'description' => t('The title of the entity being flagged.'),
  ];
  $tokens['flag-action']['entity-type'] = [
    'name' => t('Flag entity type'),
    'description' => t('The type of entity being flagged, such as <em>node</em> or <em>comment</em>.'),
  ];
  $tokens['flag-action']['entity-id'] = [
    'name' => t('Flag entity ID'),
    'description' => t('The ID of entity being flagged, such as a nid or cid.'),
  ];
  $tokens['flag-action']['count'] = [
    'name' => t('Flag count'),
    'description' => t('The current count total for this flag.'),
  ];

  // Add tokens for the flag count available at the node/comment/user level.

  /** \Drupal\flag\FlagInterface[] $flags */
  $flags = \Drupal::service('flag')
    ->getAllFlags();
  foreach ($flags as $id => $flag) {
    $flag_entity_type_id = $flag
      ->getFlaggableEntityTypeId();
    $tokens[$flag_entity_type_id]['flag-' . str_replace('_', '-', $id) . '-count'] = [
      'name' => t('@flag flag count', [
        '@flag' => $flag
          ->label(),
      ]),
      'description' => t('Total flag count for flag @flag', [
        '@flag' => $flag
          ->label(),
      ]),
    ];
    $tokens[$flag_entity_type_id]['flag-' . str_replace('_', '-', $id) . '-link'] = [
      'name' => t('@flag flag link', [
        '@flag' => $flag
          ->label(),
      ]),
      'description' => t('Flag/unflag link for @flag', [
        '@flag' => $flag
          ->label(),
      ]),
    ];
  }
  return [
    'types' => $types,
    'tokens' => $tokens,
  ];
}