function TokenHooks::tokenInfo

Implements hook_token_info().

File

core/modules/file/src/Hook/TokenHooks.php, line 119

Class

TokenHooks

Hook implementations for file tokens.

Namespace

Code

public function tokenInfo() : array {
    $types['file'] = [
        'name' => t("Files"),
        'description' => t("Tokens related to uploaded files."),
        'needs-data' => 'file',
    ];
    // File related tokens.
    $file['fid'] = [
        'name' => t("File ID"),
        'description' => t("The unique ID of the uploaded file."),
    ];
    $file['uuid'] = [
        'name' => t('UUID'),
        'description' => t('The UUID of the uploaded file.'),
    ];
    $file['name'] = [
        'name' => t("File name"),
        'description' => t("The name of the file on disk."),
    ];
    $file['path'] = [
        'name' => t("Path"),
        'description' => t("The location of the file relative to Drupal root."),
    ];
    $file['mime'] = [
        'name' => t("MIME type"),
        'description' => t("The MIME type of the file."),
    ];
    $file['size'] = [
        'name' => t("File size"),
        'description' => t("The size of the file."),
    ];
    $file['url'] = [
        'name' => t("URL"),
        'description' => t("The web-accessible URL for the file."),
    ];
    $file['created'] = [
        'name' => t("Created"),
        'description' => t("The date the file created."),
        'type' => 'date',
    ];
    $file['changed'] = [
        'name' => t("Changed"),
        'description' => t("The date the file was most recently changed."),
        'type' => 'date',
    ];
    $file['owner'] = [
        'name' => t("Owner"),
        'description' => t("The user who originally uploaded the file."),
        'type' => 'user',
    ];
    return [
        'types' => $types,
        'tokens' => [
            'file' => $file,
        ],
    ];
}