You are here

filefield.token.inc in FileField 6.3

Token hook implementations. Included if token.module is installed.

File

filefield.token.inc
View source
<?php

/**
 * @file
 * Token hook implementations. Included if token.module is installed.
 */

/**
 * Implementation of hook_token_list().
 *
 * Provide a user readable list of FileField tokens.
 */
function filefield_token_list($type = 'all') {
  if ($type == 'field' || $type == 'all') {
    $tokens = array();
    $tokens['file']['filefield-fid'] = t('File ID');
    $tokens['file']['filefield-description'] = t('File description');
    $tokens['file']['filefield-filename'] = t('File name');
    $tokens['file']['filefield-filepath'] = t('File path');
    $tokens['file']['filefield-fileurl'] = t('File URL');
    $tokens['file']['filefield-filemime'] = t('File MIME type');
    $tokens['file']['filefield-filesize'] = t('File size (in bytes)');
    $tokens['file']['filefield-filesize_formatted'] = t('File size (pretty printed)');
    $tokens['file']['filefield-view'] = t('Fully formatted HTML file tag');
    $tokens['file']['filefield-onlyname'] = t('File name without extension');
    $tokens['file']['filefield-extension'] = t('File extension');
    return $tokens;
  }
}

/**
 * Implementation of hook_token_values().
 *
 * Provide the token values for a given file item.
 */
function filefield_token_values($type, $object = NULL) {
  $tokens = array();
  if ($type == 'field' && isset($object[0]['fid'])) {
    $item = $object[0];
    $tokens['filefield-fid'] = $item['fid'];
    $tokens['filefield-description'] = isset($item['data']['description']) ? check_plain($item['data']['description']) : '';
    $tokens['filefield-filename'] = check_plain($item['filename']);
    $tokens['filefield-filepath'] = check_plain($item['filepath']);
    $tokens['filefield-fileurl'] = file_create_url($item['filepath']);
    $tokens['filefield-filemime'] = $item['filemime'];
    $tokens['filefield-filesize'] = $item['filesize'];
    $tokens['filefield-filesize_formatted'] = format_size($item['filesize']);
    $tokens['filefield-view'] = $item['view'];
    $double_extensions = array(
      'tar.gz',
      'tar.bz2',
    );
    foreach ($double_extensions as $ext) {
      $length = strlen($ext) + 1;
      $filename = drupal_strtolower($item['filename']);
      $pos = strrpos($filename, '.' . $ext);
      if ($pos !== FALSE && strlen($filename) - $pos == $length) {
        $tokens['filefield-onlyname'] = substr($item['filename'], 0, $pos);
        $tokens['filefield-extension'] = $ext;
        break;
      }
    }
    if (!isset($tokens['filefield-extension'])) {
      $info = pathinfo($item['filename']);
      $tokens['filefield-onlyname'] = basename($info['basename'], '.' . $info['extension']);
      $tokens['filefield-extension'] = $info['extension'];
    }
  }
  return $tokens;
}

Functions

Namesort descending Description
filefield_token_list Implementation of hook_token_list().
filefield_token_values Implementation of hook_token_values().