Tokens

Token for the email address of the author of the comment that someone replied to

nikita — Wed, 02 Jul 2008 08:36:06 +0000

Is there a token (or a way to create one) that can be used to notify the author of the comment (not of the node) that someone has replied to it?

Tokens

Does module exist to let site editors maintain own tokens and replacement text?

alaken — Thu, 19 Jun 2008 19:30:58 +0000

I really love token module! I'm especially loving it in pathauto and auto nodetitles - very powerful.

Is there a module to permit site editors to create and maintain their own tokens and corresponding replacement text, either through a UI or in a text file?

The site I'm building needs to let editors store snippets of text which can be reused in many places. For instance we might have this in node content: "McDonalds has sold [num_bugers_sold] in their history". We'd need a way to edit the value for [num_bugers_sold] and have that token update wherever it's used.

I understand that token.module is fully capable of this - just need to know whether a simple module exists for maintaining one's own arbitrary tokens and replacement text.

Tokens

tokens in node body

cwarden — Thu, 29 May 2008 23:27:01 +0000

What's the proper way to replace tokens within a node body?
I've created a simple module that implements hook_token_values and
hook_token_list, but to use my token within a node body, I've had to
implement hook_nodeapi, which doesn't seem right.

<?php
function mymodule_nodeapi(&$node, $op, $a3 = null, $a4 = null) {
   if ($op == 'alter') {
      $node->body = token_replace($node->body);
   }
}
?>

How about within a template? Is this discouraged?

<?= token_replace('[my-token]') ?>

Tokens

Token replacement from specific vocabularies?

alaken — Tue, 27 May 2008 22:36:58 +0000

I've got a content type with a Name field, and 2 taxonomy vocabularies applied, one for "person type" and one for "issue type". I'm using auto node titles module, and I want to to format the titles like this

[name], [person type], on [issue type]

e.g.

Andy Laken, Volunteer, on Governance

But in the replacement pattern list, I find only [term] which is the "Name of top taxonomy term" (not sure what that means.) My question - is there any way to get a replacement pattern to grab the name of the term for a specific vocabularies, when more than one vocab applies to a node?

Many thanks for any help...

Tokens

Replacement Patterns Not Available

gregrenner — Wed, 16 Apr 2008 15:49:48 +0000

Greetings,
I'm new to this group and to the Token module, so forgive my ignorance with this question. Its possible I missed something basic. I am unable to see and replacement patterns anywhere on my site where they should be listed. For example the Auto Nodetitles module provides a fieldset which is supposed to list the available replacement patterns, but there isn't anything in the fieldset (attachment1). Its also not replacing my [field_event-raw] with anything. I have the same issue in the Workflow-ng pages, nothing shows up (attachment2), but my tokens ARE being replaced.

Did I miss something in settings? I've tried removing token and reinstalling it but nothing changed. Any help would be appreciated.

~greg

Tokens

5.x-1.11 Pre-release Bug Tracking Wiki

greggles — Tue, 15 Apr 2008 21:27:06 +0000

Howdy folks,

I think (and karen thinks) that we've hit the time for a 5.x-1.11 release. Are there any major bugs we should fix prior to that release? Can anyone else confirm that the 5.x-1.x-dev release is working well for them (I use it on all my sites, but I don't exercise all of its features...) Post links to the issues in this wiki or as comments on this page. If you think it's ready to go, posting a message saying that would help as well! Thanks!

(note: please don't add features, neither Mike nor Eaton nor I have time for features right now. If you want to get a feature committed, the best way to get it committed is to review the code or have someone else review the code.)

Tokens

Vocabulary Index paths & Token

Xano — Tue, 04 Mar 2008 20:36:36 +0000

Somewhere in fall 2007 I started working on Vocabulary Index. The 1.0 version has been available for some weeks now and I have already started working on 2.0 (although a final won't be released for a few months. It's mostly brainstorming at this time).

A short explanation of what the module does: It provides term listings for the vocabularies you want them provided for. For every vocab you can specify a path at which this term listing (the 'index page') will be accessible. Some kind of a taxonomy browser/business directory module, you might say.

I was a bit curious whether people think it's a good move to implement Tokens for the 2.0 release or not. On the one hand it does make Vocabindex more flexible. After all, creating paths to index pages will become a little easier, especially when vocabulary data changes: If you're using [title] for the path, the path could automatically be updated as soon as the vocab's title is changed. On the other hand all those tokens creates a bit of a mess of the admin pages and I'm trying to make the module as user-friendly as possible as I'm a usability freak.

So, the dilemma: Token implementation or not? I'd like to hear some opinions on this before actually starting development. Do you think it's necessary or do you vote for usability? This is not only a discussion about this module, but perhaps a general discussion about usability versus flexibility as well.

Usability

format_date? which timezone to use?

greggles — Sat, 05 Jan 2008 10:37:09 +0000

There's an issue with some of the dates in tokens that they don't get set to the right values.

Of course, the question is what's the "right" value?

I'm writing here to ask if you'd rather get the server time or the default site time or the user's timezone.

The first person who asks for "configurable by the token admin" will get stabbed with a "work on token2.x where attributes are possible"-spoon. (yes, a spoon, it will hurt more).

Tokens

Arbitary tokens

jredding — Sat, 01 Dec 2007 18:39:46 +0000

In the last two days I whipped up a very quick module that allows you to create arbitrary tokens (i.e. /node/add/token) for use with the token modules. This was primarily created for use with the tokenize module so that through the UI a user could create tokens and select which fields could use those tokens.

The tokens are nodes which could cause some serious performance issues under certain conditions. In our environment there were none (or any anticipated) performance issues as the number of users using the set of modules was low. I used node_load to grab the content of the tokens for replacement which means that the PHP in the token body is executed.

I'll be creating a project page/checking into CVS later this week. I just wanted to post that I created it just in case other were considering doing the same.

Tokens

Token and the Rep[lacement]Tags module

profix898 — Wed, 21 Nov 2007 11:50:00 +0000

I'm author and maintainer of the Rep[lacement]Tags module (http://drupal.org/project/reptag). As mentioned and explained before the reptag module is a regexp-based, node-centric, bigger brother/sister of the Token module. The idea behind both modules is quite similar and even the API is similar on some points. For Drupal 6 I'd really love to see the modules complement each other (or even merge). To achieve that (at least for most of the features) only a few changes to Token and some more to Reptag ;) would be required.

Basically Reptag could provide two things to complement Token:

The UI to manage tags (add/edit/remove) online from the admin pages
A simple (yet powerful) plug-in system, so called .tags modules in reptag

I have posted a request to the issue queue a week ago which explains more details: http://drupal.org/node/141430#comment-619523

For a developers perspective on reptag's api you can read DEVELOPER.txt or try the module yourself to get an impression.

Regards Thilo

Tokens

Modules that Use Token Module

greggles — Sun, 28 Oct 2007 15:23:12 +0000

Here is a list of some of the modules that use token. If you know of another, please add it.

Some of these modules provide tokens, some just use the token_replace mechanism. But if you are looking for something that will integrate nicely with (for example) Auto Node Title, Page Title, or Pathauto (the consumers of tokens) then you should consider these modules which will probably expose their inner data as tokens to other modules.

Tokens

Another token enhancement proposal

cwgordon7@drupal.org — Sun, 21 Oct 2007 01:13:09 +0000

Token should probably provide an easy way for modules to create tokens based on already existing tokens. Let me explain what I mean. For a node, I should be able to pass in 'author-' as a prefix, 'user' as the type, and the node's author as the object. Token would then get all the values for 'user' with the object $user, and would return them as the tokens [author-usertokenpropertyhere]. This could be used by many modules: nodes could create tokens for their organic groups as [og-nodeproperty], buddylist could create tokens for the user's buddies as [buddylist-userproperty], and nodes could create tokens for their terms as [tax-taxonomyproperty].

Token would have to check to make sure that we are not caught in an infinite loop (node calls its organic group, which calls its organic group, which calls its organic group, etc., or node calls its author, which calls its most recent post, which calls its author, etc). In some case recursiveness could be useful (node calls organic group which calls author), but it would have to make sure that the same property isn't being called twice.

Admittedly, this would cause performance declines- however, if it becomes possible to disable certain tokens that are not used, it would stop being a performance problem and start being an optional feature that would increase the power of token and the modules that use it.

This would be a highly useful feature, and many modules would be able to take advantage of this. There are countless ways where nodes, users, taxonomy items, comments, etc. interact, and this property would allow the token module to make use of these interactions.

Tokens

Token enhancement proposal

fago@drupal.org — Tue, 21 Aug 2007 08:48:29 +0000

Token is great, however there are still some problems that need to be solved. Here is a proposal, which tries to do so.

Problems I noticed are:

missing handling of multiple values
no way to get tokens of a certain node type and no more
no way to get token help for only raw values or formatted ones - which might lead to XSS created by unexperienced users
performance: getting all token values for a node takes about 10ms!

I ran over the performance issue while developing workflow-ng. I think 10ms just for replacing a token is far less than ideal. I noticed that user tokens are working quite fast, so I assume that getting and caching all token values takes that long. So I propose to do the replacing in two steps, first off it is determined for each token, if it has been used.Then on the second step, the value for each used token is determined and replaced.
So token needs to get only the values for really use tokens - this should work fast!

Unfortunately, this and the improved formatter handling requires API changes. So consider this as a proposal for token 2.x.

Here are more details:

This is how the token list could look like

<?php
/**
 * Implementation of hook_token_list()
 */
function node_token_list() {
  return array(
    array(
      '#entity' => 'node',
      '#name' => t('content'),
      '#types' => array('page', 'story'),
      'nid' => array('#label' => t('label..')),
      'title' => array('#label' => t('content title'), '#formatter => array('plain')),
      .....
    ),
    array(
      '#entity' => 'my_own',
      'label' => array('#label' => t('label..')),
      ...
    ),
  );
}
?>

A #formatter 'raw' is per default available and has to be supported by each token. Then I thought of this properties for a token:
# label - for the help
# formatter - any further available (except from raw)
# multiple - If there are multiple values, e.g. for CCK multiple fields or user roles.

Note that I've used "entity" instead of object, so it's more clear that arrays are supported too.

Token values

Then the hook_token_values implement needs to be changed. It could look like this:

<?php
/**
 * Simple example implementation of hook_token_values()
 **//
function node_token_values($token_info, $entity = NULL) {
  return $token_info['#formatter'] == 'raw' ? $entity->{$token_info['#name']} : check_plain($entity->{$token_info['#name']});
}
/*
format of $token_info:
$token_info = array(
  '#entity' => 'node',
  '#types' => array('page'),
  '#name' => 'nid',
  '#formatter' => 'raw', /('plain', or whatever specified)
);
 */
?>

Token help

<?php
function theme_token_help($selection = array(), $formatter = 'raw', $prefix = '[', $suffix = ']', ) {
 //get the token lists, merge together the definitions for same entities, cache this -> (in an extra funciton)
 //then go for the selection and render the help
}
?>

e.g. usage theme('token_help', array('global', 'my_own', 'node' => array(#types => array('page'))
or just theme('token_help', array('global', 'my_own', 'node') to get all node tokens.

default tokens would be [content:title] or [my_own:label].
for theme('token_help', array('node')) the tokens would be only like this: [title]

$formatter may be 'raw', 'all' or 'formatted'. 'formatted' means all formatters but raw.
So if multiple formatters are available for one token the replacements would be:
[content:date:year] or [content:date:short]

multiple fields handling

Consider [content:textfield] to be a mutiple textfield.

[content:textfield] should return an appropriate replacement for all textfields, e.g. comma separated.
[content:textfield][2] should return only the second textfield, if exists.

Of course, we would have to add the information of the required field to $token_info, so that the module can return the appropriate value.

enhanced entity handling

Often there are "foreign keys" which point to another entities, e.g. $node->uid or CCK node and user reference fields.
So, if one wants to use the user tokens for an author, currently we have to re-add all the user token definitions.
To avoid this I propose to make it possible to specify related entities.

Example node author:

<?php
/**
 * Implementation of hook_token_list()
 **//
function node_token_list() {
  return array(
    array(
      '#entity' => 'node',
      '#name' => t('content'),
      'nid' => array('#label' => t('label..')),
      'author' => array('#entity' => 'user', '#label' => t('Content author')),
      .....
    ),
  );
}
//When token tries to get the value, it has first to get the node author entity:
//Implementation of hook_token_values()
function node_token_values($token_info, $entity = NULL) {
  if ($token_info['#name'] == 'author') {
    return user_load(array('uid' => $entitiy->uid));
  }
  return $token_info['#formatter'] == 'raw' ? $entity->{$token_info['#name']} : check_plain($entity->{$token_info['#name']});
}

//Then it can get the value as usual. ?>

The token help would have to include all user tokens for a node. They could be used e.g.
by using [content:author:mail].

callbacks

We could also go for callbacks instead of the hook_token_values. I think this way the code could get even a bit more cleaner and we save some time invoking the hook.

<?php
/**
 * Implementation of hook_token_list()
 */
function node_token_list() {
  return array(
    array(
      '#entity' => 'node',
      '#name' => t('content'),
      '#types' => array('page', 'story'),
      'nid' => array('#label' => t('label..'), #callback => 'node_token_values'),
      'title' => array('#label' => t('content title'), '#formatter => array('plain'), #callback => 'node_token_values),
      .....
    ),
  );
}
?>

Opinions?
I could go for implementing the changes, however I think I would need some help converting all the actual token hook implementations.

Tokens

Barcelona Event

greggles — Sat, 04 Aug 2007 14:54:50 +0000

Following Dries' request for more presentations I decided that Token module would be a good topic:

Token Module: How I Learned To Use the Token API and Stop Re-Implementing Dynamic String Replacement

So, if you are headed to Barcelona and want to learn more about using Tokens, this would be a great session to attend. Similarly, we plan to use some of the time to talk about the "future of tokens" which should hopefully be a useful topic.

Tokens

The future of tokens?

eaton@drupal.org — Fri, 27 Apr 2007 04:39:00 +0000

Wow. Pathauto finally made the move!

Token module was conceived when I was writing custom_breadcrumbs and custom_links, and wanted to generate the kind of simple [foo] and [bar] links that had been popularized by Pathauto. I was this close to listing pathauto as a dependency for both modules when I ran into greggles in #drupal and started chatting with him about the need for a centralized 'Just The Tokens' utility that many modules could benefit from.

With the current release of Token module, and the current release of Pathauto, quite a few modules can now plug into "the system."

Now, though, with more modules using the tokens in more scenarios, problems are beginning to appear that we didn't anticipate. Tokens, it appears, are not JUST about a snippet of text and a description. More information, like the current language. Metadata ABOUT tokens (like whether a given token is url-safe, html-safe, completely unfiltered, etc) and so on are all part of the mix. In addition, some ideas that have been kicked around include dynamic generation of tokens -- parsing the substitution text for tokens and replacing only the ones needed, rather than generating ALL tokens and looking to see if they appear. Indeed, the entire 'context' system that token currently uses may be unnecessarily limiting. Should tokens appear as [node:title] and [user:name] rather than simply [title] and [name]?

It's time to start brainstorming. How can token.module's relative simplicity be preserved while supporting the flexibility that more modules will want?

Tokens