system.views.inc

<?php


/**
 * @file
 * Provide views data and handlers for system.module.
 *
 * @ingroup views_module_handlers
 */

/**
 * Implements hook_views_data().
 */
function system_views_data() {
    $data = array();
    // ----------------------------------------------------------------------
    // 'file_managed' table.
    $data['files']['moved to'] = 'file_managed';
    $data['file_managed']['table']['group'] = t('File');
    // Advertise this table as a possible base table.
    $data['file_managed']['table']['base'] = array(
        'field' => 'fid',
        'title' => t('File'),
        'help' => t("Files maintained by Drupal and various modules."),
        'defaults' => array(
            'field' => 'filename',
        ),
    );
    $data['file_managed']['table']['entity type'] = 'file';
    // File ID / 'fid'.
    $data['file_managed']['fid'] = array(
        'title' => t('File ID'),
        'help' => t('The ID of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_file_fid',
            'name field' => 'filename',
            // The field to display in the summary.
'numeric' => TRUE,
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_numeric',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // Filename.
    $data['file_managed']['filename'] = array(
        'title' => t('Name'),
        'help' => t('The name of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_string',
        ),
    );
    // URI.
    $data['file_managed']['uri'] = array(
        'title' => t('Path'),
        'help' => t('The path of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file_uri',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_string',
        ),
    );
    // The file's MIME Type.
    $data['file_managed']['filemime'] = array(
        'title' => t('Mime type'),
        'help' => t('The mime type of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file_filemime',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_string',
        ),
    );
    // Extension.
    $data['file_managed']['extension'] = array(
        'title' => t('Extension'),
        'help' => t('The extension of the file.'),
        'real field' => 'uri',
        'field' => array(
            'handler' => 'views_handler_field_file_extension',
            'click sortable' => FALSE,
        ),
    );
    // Filesize.
    $data['file_managed']['filesize'] = array(
        'title' => t('Size'),
        'help' => t('The size of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file_size',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_numeric',
        ),
    );
    // Status.
    $data['file_managed']['status'] = array(
        'title' => t('Status'),
        'help' => t('The status of the file.'),
        'field' => array(
            'handler' => 'views_handler_field_file_status',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_file_status',
        ),
    );
    // Timestamp field.
    $data['file_managed']['timestamp'] = array(
        'title' => t('Upload date'),
        'help' => t('The date the file was uploaded.'),
        'field' => array(
            'handler' => 'views_handler_field_date',
            'click sortable' => TRUE,
        ),
        'sort' => array(
            'handler' => 'views_handler_sort_date',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_date',
        ),
    );
    // User ID / 'uid'.
    $data['file_managed']['uid'] = array(
        'title' => t('User who uploaded'),
        'help' => t('The user that uploaded the file.'),
        'relationship' => array(
            'title' => t('User who uploaded'),
            'label' => t('User who uploaded'),
            'base' => 'users',
            'base field' => 'uid',
        ),
    );
    // ----------------------------------------------------------------------
    // file_usage table.
    $data['file_usage']['table']['group'] = t('File Usage');
    // Provide field-type-things to several base tables; on the core files table
    // ("file_managed") so that we can create relationships from files to
    // entities, and then on each core entity type base table so that we can
    // provide general relationships between entities and files.
    $data['file_usage']['table']['join'] = array(
        // Link ourself to the {file_managed} table so we can provide file->entity
        // relationships.
'file_managed' => array(
            'field' => 'fid',
            'left_field' => 'fid',
        ),
        // Link ourself to the {node} table so we can provide node->file
        // relationships.
'node' => array(
            'field' => 'id',
            'left_field' => 'nid',
            'extra' => array(
                array(
                    'field' => 'type',
                    'value' => 'node',
                ),
            ),
        ),
        // Link ourself to the {users} table so we can provide user->file
        // relationships.
'users' => array(
            'field' => 'id',
            'left_field' => 'uid',
            'extra' => array(
                array(
                    'field' => 'type',
                    'value' => 'user',
                ),
            ),
        ),
        // Link ourself to the {comment} table so we can provide comment->file
        // relationships.
'comment' => array(
            'field' => 'id',
            'left_field' => 'cid',
            'extra' => array(
                array(
                    'field' => 'type',
                    'value' => 'comment',
                ),
            ),
        ),
        // Link ourself to the {taxonomy_term_data} table so we can provide
        // taxonomy_term->file relationships.
'taxonomy_term_data' => array(
            'field' => 'id',
            'left_field' => 'tid',
            'extra' => array(
                array(
                    'field' => 'type',
                    'value' => 'taxonomy_term',
                ),
            ),
        ),
        // Link ourself to the {taxonomy_vocabulary} table so we can provide
        // taxonomy_vocabulary->file relationships.
'taxonomy_vocabulary' => array(
            'field' => 'id',
            'left_field' => 'vid',
            'extra' => array(
                array(
                    'field' => 'type',
                    'value' => 'taxonomy_vocabulary',
                ),
            ),
        ),
    );
    // Provide a relationship between the files table and each entity type, and
    // between each entity type and the files table. Entity->file relationships
    // are type-restricted in the joins declared above, and file->entity
    // relationships are type-restricted in the relationship declarations below.
    // Relationships between files and nodes.
    $data['file_usage']['file_to_node'] = array(
        'title' => t('Content'),
        'help' => t('Content that is associated with this file, usually because this file is in a field on the content.'),
        // Only provide this field/relationship/etc. when the 'file_managed' base
        // table is present.
'skip base' => array(
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'id',
        'relationship' => array(
            'title' => t('Content'),
            'label' => t('Content'),
            'base' => 'node',
            'base field' => 'nid',
            'relationship field' => 'id',
            'extra' => array(
                array(
                    'table' => 'file_usage',
                    'field' => 'type',
                    'operator' => '=',
                    'value' => 'node',
                ),
            ),
        ),
    );
    $data['file_usage']['node_to_file'] = array(
        'title' => t('File'),
        'help' => t('A file that is associated with this node, usually because it is in a field on the node.'),
        // Only provide this field/relationship/etc. when the 'node' base table is
        // present.
'skip base' => array(
            'file_managed',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'fid',
        'relationship' => array(
            'title' => t('File'),
            'label' => t('File'),
            'base' => 'file_managed',
            'base field' => 'fid',
            'relationship field' => 'fid',
        ),
    );
    // Relationships between files and users.
    $data['file_usage']['file_to_user'] = array(
        'title' => t('User'),
        'help' => t('A user that is associated with this file, usually because this file is in a field on the user.'),
        // Only provide this field/relationship/etc. when the 'file_managed' base
        // table is present.
'skip base' => array(
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'id',
        'relationship' => array(
            'title' => t('User'),
            'label' => t('User'),
            'base' => 'users',
            'base field' => 'uid',
            'relationship field' => 'id',
            'extra' => array(
                array(
                    'table' => 'file_usage',
                    'field' => 'type',
                    'operator' => '=',
                    'value' => 'user',
                ),
            ),
        ),
    );
    $data['file_usage']['user_to_file'] = array(
        'title' => t('File'),
        'help' => t('A file that is associated with this user, usually because it is in a field on the user.'),
        // Only provide this field/relationship/etc. when the 'users' base table is
        // present.
'skip base' => array(
            'file_managed',
            'node',
            'node_revision',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'fid',
        'relationship' => array(
            'title' => t('File'),
            'label' => t('File'),
            'base' => 'file_managed',
            'base field' => 'fid',
            'relationship field' => 'fid',
        ),
    );
    // Relationships between files and comments.
    $data['file_usage']['file_to_comment'] = array(
        'title' => t('Comment'),
        'help' => t('A comment that is associated with this file, usually because this file is in a field on the comment.'),
        // Only provide this field/relationship/etc. when the 'file_managed' base
        // table is present.
'skip base' => array(
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'id',
        'relationship' => array(
            'title' => t('Comment'),
            'label' => t('Comment'),
            'base' => 'comment',
            'base field' => 'cid',
            'relationship field' => 'id',
            'extra' => array(
                array(
                    'table' => 'file_usage',
                    'field' => 'type',
                    'operator' => '=',
                    'value' => 'comment',
                ),
            ),
        ),
    );
    $data['file_usage']['comment_to_file'] = array(
        'title' => t('File'),
        'help' => t('A file that is associated with this comment, usually because it is in a field on the comment.'),
        // Only provide this field/relationship/etc. when the 'comment' base table
        // is present.
'skip base' => array(
            'file_managed',
            'node',
            'node_revision',
            'users',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'fid',
        'relationship' => array(
            'title' => t('File'),
            'label' => t('File'),
            'base' => 'file_managed',
            'base field' => 'fid',
            'relationship field' => 'fid',
        ),
    );
    // Relationships between files and taxonomy_terms.
    $data['file_usage']['file_to_taxonomy_term'] = array(
        'title' => t('Taxonomy Term'),
        'help' => t('A taxonomy term that is associated with this file, usually because this file is in a field on the taxonomy term.'),
        // Only provide this field/relationship/etc. when the 'file_managed' base
        // table is present.
'skip base' => array(
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'id',
        'relationship' => array(
            'title' => t('Taxonomy Term'),
            'label' => t('Taxonomy Term'),
            'base' => 'taxonomy_term_data',
            'base field' => 'tid',
            'relationship field' => 'id',
            'extra' => array(
                array(
                    'table' => 'file_usage',
                    'field' => 'type',
                    'operator' => '=',
                    'value' => 'taxonomy_term',
                ),
            ),
        ),
    );
    $data['file_usage']['taxonomy_term_to_file'] = array(
        'title' => t('File'),
        'help' => t('A file that is associated with this taxonomy term, usually because it is in a field on the taxonomy term.'),
        // Only provide this field/relationship/etc. when the 'taxonomy_term_data'
        // base table is present.
'skip base' => array(
            'file_managed',
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_vocabulary',
        ),
        'real field' => 'fid',
        'relationship' => array(
            'title' => t('File'),
            'label' => t('File'),
            'base' => 'file_managed',
            'base field' => 'fid',
            'relationship field' => 'fid',
        ),
    );
    // Relationships between files and taxonomy_vocabulary items.
    $data['file_usage']['file_to_taxonomy_vocabulary'] = array(
        'title' => t('Taxonomy Vocabulary'),
        'help' => t('A taxonomy vocabulary that is associated with this file, usually because this file is in a field on the taxonomy vocabulary.'),
        // Only provide this field/relationship/etc. when the 'file_managed' base
        // table is present.
'skip base' => array(
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
            'taxonomy_vocabulary',
        ),
        'real field' => 'id',
        'relationship' => array(
            'title' => t('Taxonomy Vocabulary'),
            'label' => t('Taxonomy Vocabulary'),
            'base' => 'taxonomy_vocabulary',
            'base field' => 'vid',
            'relationship field' => 'id',
            'extra' => array(
                array(
                    'table' => 'file_usage',
                    'field' => 'type',
                    'operator' => '=',
                    'value' => 'taxonomy_vocabulary',
                ),
            ),
        ),
    );
    $data['file_usage']['taxonomy_vocabulary_to_file'] = array(
        'title' => t('File'),
        'help' => t('A file that is associated with this taxonomy vocabulary, usually because it is in a field on the taxonomy vocabulary.'),
        // Only provide this field/relationship/etc. when the 'taxonomy_vocabulary'
        // base table is present.
'skip base' => array(
            'file_managed',
            'node',
            'node_revision',
            'users',
            'comment',
            'taxonomy_term_data',
        ),
        'real field' => 'fid',
        'relationship' => array(
            'title' => t('File'),
            'label' => t('File'),
            'base' => 'file_managed',
            'base field' => 'fid',
            'relationship field' => 'fid',
        ),
    );
    // Provide basic fields from the {file_usage} table to all of the base tables
    // we've declared joins to (because there is no 'skip base' property on these
    // fields).
    $data['file_usage']['module'] = array(
        'title' => t('Module'),
        'help' => t('The module managing this file relationship.'),
        'field' => array(
            'handler' => 'views_handler_field',
            'click sortable' => TRUE,
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_string',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    $data['file_usage']['type'] = array(
        'title' => t('Entity type'),
        'help' => t('The type of entity that is related to the file.'),
        'field' => array(
            'handler' => 'views_handler_field',
            'click sortable' => TRUE,
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_string',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    $data['file_usage']['id'] = array(
        'title' => t('Entity ID'),
        'help' => t('The ID of the entity that is related to the file.'),
        'field' => array(
            'handler' => 'views_handler_field_numeric',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            'handler' => 'views_handler_argument_numeric',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_numeric',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    $data['file_usage']['count'] = array(
        'title' => t('Use count'),
        'help' => t('The number of times the file is used by this entity.'),
        'field' => array(
            'handler' => 'views_handler_field_numeric',
            'click sortable' => TRUE,
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_numeric',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // ----------------------------------------------------------------------
    // System table.
    $data['system']['table']['group'] = t('System');
    // Advertise this table as a possible base table.
    $data['system']['table']['base'] = array(
        'field' => 'filename',
        'title' => t('Module/Theme/Theme engine'),
        'help' => t('Modules/Themes/Theme engines in your codebase.'),
    );
    // Fields.
    // - filename.
    $data['system']['filename'] = array(
        'title' => t('Module/Theme/Theme engine filename'),
        'help' => t('The path of the primary file for this item, relative to the Drupal root; e.g. modules/node/node.module.'),
        'field' => array(
            'handler' => 'views_handler_field',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            // The field to display in the summary.
'handler' => 'views_handler_argument_string',
            'name field' => 'filename',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // - name.
    $data['system']['name'] = array(
        'title' => t('Module/Theme/Theme engine name'),
        'help' => t('The name of the item; e.g. node.'),
        'field' => array(
            'handler' => 'views_handler_field',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            // The field to display in the summary.
'handler' => 'views_handler_argument_string',
            'name field' => 'name',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_string',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // - type.
    $data['system']['type'] = array(
        'title' => t('Type'),
        'help' => t('The type of the item, either module, theme, or theme_engine.'),
        'field' => array(
            'handler' => 'views_handler_field',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            // The field to display in the summary.
'handler' => 'views_handler_argument_string',
            'name field' => 'type',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_system_type',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // - status.
    $data['system']['status'] = array(
        'title' => t('Status'),
        'help' => t('Boolean indicating whether or not this item is enabled.'),
        'field' => array(
            'handler' => 'views_handler_field_boolean',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            // The field to display in the summary.
'handler' => 'views_handler_argument_numeric',
            'name field' => 'status',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_boolean_operator',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    // - schema version.
    $data['system']['schema_version'] = array(
        'title' => t('Schema version'),
        'help' => t("The module's database schema version number. -1 if the module is not installed (its tables do not exist); 0 or the largest N of the module's hook_update_N() function that has either been run or existed when the module was first installed."),
        'field' => array(
            'handler' => 'views_handler_field_numeric',
            'click sortable' => TRUE,
        ),
        'argument' => array(
            // The field to display in the summary.
'handler' => 'views_handler_argument_numeric',
            'name field' => 'schema_version',
        ),
        'filter' => array(
            'handler' => 'views_handler_filter_numeric',
        ),
        'sort' => array(
            'handler' => 'views_handler_sort',
        ),
    );
    return $data;
}

/**
 * Obtain a human readable label for a file's status.
 *
 * @param int $choice
 *   Indicate the file's status, expected to be either '0' for a temporary file
 *   or the value of FILE_STATUS_PERMANENT for a permanent file; any other value
 *   will be indicated as being 'Unknown'.
 *
 * @return string
 *   A string representing the file's status.
 */
function _views_file_status($choice = NULL) {
    $status = array(
        0 => t('Temporary'),
        FILE_STATUS_PERMANENT => t('Permanent'),
    );
    if (isset($choice)) {
        return isset($status[$choice]) ? $status[$choice] : t('Unknown');
    }
    return $status;
}