drupal7 新建模块annotate

模块文件结构：

1. annotate.info
2. annotate.module
3. annotate.admin.inc
4. annotate.install

---

 

1. 在drupal目录 sites/all/modules/custom 下新建文件夹annotate.(如果custom不存在，请自行建立)

2.新建文件annotate.info（模块描述文件）:

name = Annotate
description = "Allows users to annotate nodes."
package = Pro Drupal Development
core = 7.x
files[] = annotate.module
files[] = annotate.install
files[] = annotate.admin.inc
configure=admin/config/content/annotate/settings

 

 

3.新建文件annotate.module。(模块主文件):

<?php
/**
 * @file
 * Lets users add private annotations to nodes.
 *
 * Adds a text field when a node is displayed
 * so that authenticated users may make notes.
 */

/**
 * Implementation of hook_menu().
 */
function annotate_menu()
{
    $items['admin/config/annotate']          = array(
        'title' => 'Node annotation',
        'description' => 'Adjust node annotation options.',
        'position' => 'right',
        'weight' => -5,
        'page callback' => 'system_admin_menu_block_page',
        'access arguments' => array(
            'administer site configuration'
        ),
        'file' => 'system.admin.inc',
        'file path' => drupal_get_path('module', 'system')
    );
    $items['admin/config/annotate/settings'] = array(
        'title' => 'Annotation settings',
        'description' => 'Change how annotations behave.',
        'page callback' => 'drupal_get_form',
        'page arguments' => array(
            'annotate_admin_settings'
        ),
        'access arguments' => array(
            'administer site configuration'
        ),
        'type' => MENU_NORMAL_ITEM,
        'file' => 'annotate.admin.inc'
    );
    return $items;
}

/**
 * Implements hook_node_load()
 */
function annotate_node_load($nodes, $types)
{
    global $user;
    // Check to see if the person viewing the node is the author. If not then
    // hide the annotation.
    foreach ($nodes as $node) {
        if ($user->uid != $node->uid) {
            unset($node->annotation);
        }
    }
}

 

   

4.新建文件annotate.admin.inc.(annotate.module中定义的file的文件)：

<?php
/**
 * @file
 * Administration page callbacks for the annotate module.
 */
/**
 * Form builder. Configure annotations.
 *
 * @ingroup forms
 * @see system_settings_form().
 */
function annotate_admin_settings()
{
    // Get an array of node types with internal names as keys and
    // "friendly names" as values. E.g.,
    // array('page' => ’Basic Page, 'article' => 'Articles')
    $types = node_type_get_types();
    foreach ($types as $node_type) {
        $options[$node_type->type] = $node_type->name;
    }
    $form['annotate_node_types'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Users may annotate these content types'),
        '#options' => $options,
        '#default_value' => variable_get('annotate_node_types', array(
            'page'
        )),
        '#description' => t('A text field will be available on these content types to
make user-specific notes.')
    );
    $form['#submit'][]           = 'annotate_admin_settings_submit';
    return system_settings_form($form);
}

/**
 * Process annotation settings submission.
 */
function annotate_admin_settings_submit($form, $form_state)
{
    dd("wangkangluo1");
    // Loop through each of the content type checkboxes shown on the form.
    foreach ($form_state['values']['annotate_node_types'] as $key => $value) {
        // If the check box for a content type is unchecked, look to see whether
        // this content type has the annotation field attached to it using the
        // field_info_instance function. If it does then we need to remove the
        // annotation field as the administrator has unchecked the box.
        if (!$value) {
            $instance = field_info_instance('node', 'annotation', $key);
            if (!empty($instance)) {
                field_delete_instance($instance);
                watchdog("Annotation", 'Deleted annotation field from content type:
%key', array(
                    '%key' => $key
                ));
            }
        } else {
            // If the check box for a content type is checked, look to see whether
            // the field is associated with that content type. If not then add the
            // annotation field to the content type.
            $instance = field_info_instance('node', 'annotation', $key);
            if (empty($instance)) {
                $instance = array(
                    'field_name' => 'annotation',
                    'entity_type' => 'node',
                    'bundle' => $key,
                    'label' => t('Annotation'),
                    'widget_type' => 'text_textarea_with_summary',
                    'settings' => array(
                        'display_summary' => TRUE
                    ),
                    'display' => array(
                        'default' => array(
                            'type' => 'text_default'
                        ),
                        'teaser' => array(
                            'type' => 'text_summary_or_trimmed'
                        )
                    )
                );
                $instance = field_create_instance($instance);
                watchdog('Annotation', 'Added annotation field to content type: %key', array(
                    '%key' => $key
                ));
            }
        }
    } // End foreach loop.
}

 

 

 5.新建文件annotate.install（数据相关文件)

<?php
/**
 * Implements hook_install()
 */
function annotate_install()
{
    // Check to see if annotation field exists.
    $field = field_info_field('annotation');
    // if the annotation field does not exist then create it
    if (empty($field)) {
        $field = array(
            'field_name' => 'annotation',
            'type' => 'text_with_summary',
            'entity_types' => array(
                'node'
            ),
            'translatable' => TRUE
        );
        $field = field_create_field($field);
    }
}

/**
 * Implements hook_uninstall()
 */
function annotate_uninstall()
{
    watchdog("Annotate Module", "Uninstalling module and deleting fields");
    $types = node_type_get_types();
    foreach ($types as $type) {
        annotate_delete_annotation($type);
    }
    $field = field_info_field('annotation');
    if ($field) {
        field_delete_field('annotation');
    }
}
function annotate_delete_annotation($type)
{
    $instance = field_info_instance('node', 'annotation', $type->type);
    if ($instance) {
        field_delete_instance($instance);
    }
}
  

 

  完