it-swarm-ja.com

プログラムでフィールドを作成する方法は?

Drupal 7に以下を実装する方法を教えてください。

私がする必要があるのは、「Company」という新しいフィールド化可能なエンティティを定義するモジュールを作成することです。たとえば、各Companyインスタンスで入力する必要がある20のフィールドのリストがあります。これらの質問は事前定義されており、一部にはカスタム検証が含まれる場合があります。

現在、私はCompanyエンティティに新しいフィールドを追加できる段階にあります。これは現時点では正常に機能します。私の問題は、モジュールがインストールされるとすぐにこれらすべてのフィールドが存在する必要があるため、インターフェースを介してフィールドを追加することはできません。

私はこれにどのように取り組むことができるのかと思っていましたか?プログラムで「フィールドの管理」UIを使用して実行できることを実行できるようになったことが原因だと思います。

56
NRaf

field_create_field() を使用してフィールド自体を作成し、 field_create_instance() を使用して特定のエンティティバンドルのインスタンスを作成します。

カスタムモジュールの一部としてフィールドを作成する場合、モジュールがアンインストールされたときにフィールドを削除したい場合としない場合があります。これを行うには、フィールドとすべてのフィールドインスタンスを削除する場合は field_delete_field() を使用できます。特定のインスタンスを削除する場合は field_delete_instance() を使用できます。 。

41
tamasd

プログラムによってユーザープロファイルにフィールドを追加する方法と、ユーザー登録フォームにフィールドを追加する方法としない方法の例。


function MYMODULE_enable() {
  // Check if our field is not already created.
  if (!field_info_field('field_myField')) {

    // Create the field base.
    $field = array(
      'field_name' => 'field_myField', 
      'type' => 'text', 
    );
    field_create_field($field);

    // Create the field instance on the bundle.
    $instance = array(
      'field_name' => 'field_myField', 
      'entity_type' => 'user', 
      'label' => 'My Field Name', 
      'bundle' => 'user', 
      // If you don't set the "required" property then the field wont be required by default.
      'required' => TRUE,
      'settings' => array(
        // Here you inform either or not you want this field showing up on the registration form.
        'user_register_form' => 1,
      ),
      'widget' => array(
        'type' => 'textfield',
      ), 
    );
    field_create_instance($instance);
  }
}
9
Francisco Luz

UIもプログラミングも使用せずに、既存のコンテンツタイプまたはエンティティからフィールドをすばやく作成または削除する必要がある場合は、次のようなあまり知られていないDrushコマンドを使用できます。

drush field-create <bundle(for nodes)> <field_name>,<field_type>,[widget_name] --entity_type:エンティティのタイプ(ノード、ユーザー、コメントなど)。デフォルトはノードです。

例:記事の2つの新しいフィールドを作成します。

drush field-create article city,text,text_textfield subtitle,text,text_textfield

その他のコマンド:

drush field-delete <field_name> [--bundle] [--entity_type]
drush field-info [field | types]
drush field-update <field_name> Return URL for field editing web page.
drush field-clone <source_field_name> <dst_field_name>
8
Interdruper

他の人が指摘したように、モジュールの hook_install() 実装の Field API functions を使用して、コンテンツタイプのフィールドとそのインスタンスを作成できます。関数の使用例については、 node_example_install() を参照してください。

別の解決策は Features モジュールを使用することです。機能は、さまざまなサイトコンポーネントをモジュールのコードにエクスポートできます。コンテンツタイプとフィールドは、これらのエクスポート可能なものの1つです。 Featuresモジュールを生成して既存のコードを上書きすることができます。Featuresは、コードを壊さないように最善を尽くします。または、ダミーのモジュールを生成して、フィールド関連のコードをコピーしてモジュールに貼り付けることもできます。これには、機能がどのように機能するかの基本的な理解が必要です。

4
Pierre Buyle

インストールファイルでは、「hook_install」と「hook_uninstall」の両方を定義する必要があります。例は含まれていますが、APIリファレンスの追加キーについてすべて読んでいます(コードはテストされていないため、そこにタイプミスがある可能性があります)。

hook_installでは、次を使用してフィールドを追加できます。

field_create_field 、この関数は、フィールドのテンプレートを作成します。

field_create_instance フィールドを作成した後、content_types(バンドルとも呼ばれる)に追加するために使用できます。

注さまざまなフィールドタイプの名前は、それらを生成するモジュールで見つけることができます(これは、hook_field_infoの配列項目のキーです)。すべてのコアフィールド実装モジュールは、modules/field/modulesフォルダーにあります。

設定はフィールドモジュールから取得することもできます。 field_create_fieldで設定した設定は、サイト全体の設定です。 field_instance_createで設定するのは、node_type固有のものです。

    MY_MODULE_install(){
      // Generate the base for the field
      $field = array( 
        'field_name' => 'FIELD_MACHINE_NAME', 
        'type' => 'FIELD_TYPE' // See note above for what to put here
      );
      // Instance 
      $instance = array(
        'field_name' => 'FIELD_MACHINE_NAME', 
        'entity_type' => 'node', 
      ); 

      // Create instances of the field and add them to the content_types
      $node_types = node_type_get_types(); 
      foreach($node_types as $node_type){
         $instance['bundle'] = $node_type->type; 
         field_create_instance($instance); 
      }
    }

hook_uninstall

field_delete_instance および field_delete_field を使用して再度削除できます。最後のインスタンスを削除すると(通常)、field_delete_fieldが自動的に呼び出されます。

    MY_MODULE_uninstall(){
      $node_types = node_type_get_types(); 
      foreach($node_types as $node_type){
        if($instance = field_info_instance('node', 'FIELD_MACHINE_NAME', $node_type->type)) {
          field_delete_instance($instance);
        }
      }
    }

私は最近、同様のプロジェクトの必要性がありました、これが私がそれに取り組んだ方法です、それが誰かを助けることを願っています。

基本的に、フィールドUIを使用して必要なフィールドを作成し、それらをコードにエクスポートして、カスタムモジュールに含めます。 Develモジュールを有効にする必要があります。

この情報で Gist も作成しました。

さあ行こう....

  1. 通常のDrupal UIを使用して、必要なフィールドを作成します。
  2. 同じサイトで、example.com/devel/phpにアクセスします
  3. 次のコードを[実行するPHPコード]テキストボックスに貼り付けます。
  4. 最初の3つの変数を設定し、[実行]をクリックします

    $entity_type = 'node';    
    $field_name = 'body';    
    $bundle_name = 'article'; 
    
    $info_config = field_info_field($field_name);
    $info_instance = field_info_instance($entity_type, $field_name, $bundle_name);
    unset($info_config['id']);
    unset($info_instance['id'], $info_instance['field_id']);
    include_once DRUPAL_ROOT . '/includes/utility.inc';
    $output = "\$fields['" . $field_name . "'] = " . drupal_var_export($info_config) . ";\n";
    $output .= "\$instances['" . $field_name . "'] = " . drupal_var_export($info_instance) . ";";
    drupal_set_message("<textarea rows=30 style=\"width: 100%;\">" . $output . '</textarea>');
    
  5. このように、すべてのプロパティが入力された2つの配列が表示されます。

$fields['field_some_field'] = array(
  'properties of the field'
);

$instances['field_some_field'] = array(
  'properties of the instance'
);

次のコードを.installファイルに追加します。 mymoduleのすべてのインスタンスを実際のモジュール名に置き換えます。以下のそれぞれの関数に記載されているように、コードを開発出力から_mymodule_field_dataおよび_mymodule_instance_dataに貼り付けます。これは、好きなだけ多くのフィールドに対して行うことができ、すべての$ fields配列を_mymodule_field_data関数に入れ、すべての$ instancesを_mymodule_instance_data関数に入れます。

function mymodule_install() {

  // Create all the fields we are adding to our entity type.
  // http://api.drupal.org/api/function/field_create_field/7
  foreach (_mymodule_field_data() as $field) {
    field_create_field($field);
  }

  // Create all the instances for our fields.
  // http://api.drupal.org/api/function/field_create_instance/7
  foreach (_mymodule_instance_data() as $instance) {
    field_create_instance($instance);
  }
}

// Create the array of information about the fields we want to create.
function _mymodule_field_data() {
  $fields = array();
  // Paste $fields data from devel ouput here.
  return $fields;
  }

// Create the array of information about the instances we want to create.
function _mymodule_instance_data() {
  $instances = array();
  // Paste $instances data from devel output here.
  return $instances;
}
2
John Laine

また、機能モジュールを使用して、インストール時にフィールドを作成することもできます。

機能はフィールドのコードを生成するため、オプションは、機能モジュールを使用してコードをダミーモジュールに生成し、モジュールの.installファイルにコピーして貼り付けることです。

利点は、モジュールがターゲット環境の機能モジュールに依存しないことです。

0

以下に示すcustomcompanymoduleコードを使用して、さまざまなフィールドを持つコンテンツタイプをプログラムで作成できます。

このコードは、カスタムモジュールの.installファイルに追加できます。 「company」と呼ばれるコンテンツタイプとそのさまざまなタイプのフィールド(テキスト、数値、日付(注:日付フィールドはデフォルトでは提供されないため、日付モジュールをインストールする必要があります)、画像、リスト)をプログラムで追加します。

「customcompanymodule」モジュールをアンインストールするときに、コンテンツタイプ「company」をすべてのフィールドとデータとともに削除するアンインストールコードも追加しました。

必要に応じて、これらのフィールドを変更/削除できます。

function customcompanymodule_install() {
     $t = get_t();
     node_types_rebuild();
     $company = array(
    'type' => 'company',
    'name' => $t('Company'),
    'base' => 'node_content',
    'module' => 'node',
    'description' => $t('Content type to handle companys.'),
    'body_label' => $t('Company Description'),
    'title_label' => $t('Company Title'),
    'promote' => 0,
    'status' => 1,
    'comment' => 0,
);
$content_type = node_type_set_defaults($company);

node_type_save($content_type);

foreach (_company_installed_fields() as $field) {
    field_create_field($field);
}

foreach (_company_installed_instances() as $instance) {
    $instance['entity_type'] = 'node';
    $instance['bundle'] = 'company';
    field_create_instance($instance);
}

$weight = db_query("SELECT weight FROM {system} WHERE name = :name",    array(':name' => 'categories'))->fetchField();
db_update('system')->fields(array(
            'weight' => $weight + 1,
        ))
        ->condition('name', 'company')
        ->execute();
}

function _company_installed_fields() {
$t = get_t();
$fields = array(
    'company_startdate' => array(
        'field_name' => 'company_startdate',
        'label' => $t('Company Start Date'),
        'cardinality' => 1,
        'type' => 'datetime',
        'module' => 'date',
        'settings' => array(
            'granularity' => array(
                'month' => 'month',
                'day' => 'day',
                'hour' => 'hour',
                'minute' => 'minute',
                'year' => 'year',
                'second' => 0,
            ),
            'tz_handling' => 'site',
            'timezone_db' => 'UTC',
            'cache_enabled' => 0,
            'cache_count' => '4',
            'todate' => 'required',
        ),
    ),
    'company_totalwinners' => array(
        'field_name' => 'company_totalwinners',
        'label' => $t('Maximum Company Winners'),
        'cardinality' => 1,
        'type' => 'number_integer',
        'module' => 'number',
        'settings' => array(
            'max_length' => 10000,
        ),
    ),
    'company_minwinner' => array(
        'field_name' => 'company_minwinner',
        'label' => $t('Minimum Entries for Company to Activate'),
        'cardinality' => 1,
        'type' => 'number_integer',
        'module' => 'number',
        'settings' => array(
            'max_length' => 10000,
        ),
    ),
    'company_totalentries' => array(
        'field_name' => 'company_totalentries',
        'label' => $t('Company Total Entries'),
        'cardinality' => 1,
        'type' => 'number_integer',
        'module' => 'number',
        'settings' => array(
            'max_length' => 10000,
        ),
    ),
    'company_points' => array(
        'field_name' => 'company_points',
        'label' => $t('Company Points'),
        'cardinality' => 1,
        'type' => 'number_integer',
        'module' => 'number',
        'settings' => array(
            'max_length' => 10000,
        ),
    ),
    'company_image' => array(
        'field_name' => 'company_image',
        'label' => $t('Image'),
        'cardinality' => 1,
        'type' => 'image',
        'settings' => array(
            'default_image' => 0,
            'uri_scheme' => 'public',
        ),
    ),
    'company_description' => array(
        'field_name' => 'company_description',
        'label' => $t('Company Description'),
        'cardinality' => 1,
        'type' => 'text',
        'module' => 'text',
        'length' => '255'
    ),
    'company_winner' => array(
        'field_name' => 'company_winner',
        'label' => $t('Company Description'),
        'cardinality' => 1,
        'type' => 'text',
        'module' => 'text',
        'length' => '255'
    ),
    'field_autowinnerselection' => array(
        'field_name' => 'field_autowinnerselection',
        'label' => $t('Auto Company Winner Selection'),
        'type' => 'list_boolean',
        'module' => 'list',
        'active' => '1',
        'locked' => '0',
        'cardinality' => '1',
        'deleted' => '0'
    ),
);
return $fields;
}

function _company_installed_instances() {
$t = get_t();
$instances = array(
    'company_startdate' => array(
        'field_name' => 'company_startdate',
        'label' => $t('Company Lifespan'),
        'cardinality' => 1,
        'widget' => array(
            'type' => 'date_popup',
            'module' => 'date',
            'settings' => array(
                'input_format' => 'm/d/Y - H:i:s',
                'input_format_custom' => '',
                'year_range' => '-3:+3',
                'increment' => '15',
                'label_position' => 'above',
                'text_parts' => array(),
            ),
        ),
    ),
    'company_totalwinners' => array(
        'field_name' => 'company_totalwinners',
        'label' => $t('Maximum Company Winners'),
        'cardinality' => 1,
        'widget' => array(
            'type' => 'number',
            'module' => 'number',
            'settings' => array('size' => 60),
        ),
    ),
    'company_minwinner' => array(
        'field_name' => 'company_minwinner',
        'label' => $t('Minimum Number of Entries for Company to Activate'),
        'cardinality' => 1,
        'required' => 1,
        'widget' => array(
            'type' => 'number',
            'module' => 'number',
            'settings' => array('size' => 60),
        ),
    ),
    'company_totalentries' => array(
        'field_name' => 'company_totalentries',
        'label' => $t('Company Total Entries'),
        'cardinality' => 1,
        'required' => 1,
        'widget' => array(
            'type' => 'number',
            'module' => 'number',
            'settings' => array('size' => 60),
        ),
    ),
    'company_points' => array(
        'field_name' => 'company_points',
        'label' => $t('Company Points'),
        'cardinality' => 1,
        'required' => 1,
        'widget' => array(
            'type' => 'number',
            'module' => 'number',
            'settings' => array('size' => 60),
        ),
    ),
    'company_image' => array(
        'field_name' => 'company_image',
        'label' => $t('Image'),
        'cardinality' => 1,
        'required' => 1,
        'type' => 'company_image',
        'settings' => array(
            'max_filesize' => '',
            'max_resolution' => '213x140',
            'min_resolution' => '213x140',
            'alt_field' => 1,
            'default_image' => 0
        ),
        'widget' => array(
            'settings' => array(
                'preview_image_style' => 'thumbnail',
                'progress_indicator' => 'throbber',
            ),
        ),
        'display' => array(
            'default' => array(
                'label' => 'hidden',
                'type' => 'image',
                'settings' => array('image_style' => 'medium', 'image_link' => ''),
                'weight' => -1,
            ),
            'teaser' => array(
                'label' => 'hidden',
                'type' => 'image',
                'settings' => array('image_style' => 'thumbnail', 'image_link' => 'content'),
                'weight' => -1,
            ),
        ),
    ),
    'company_description' => array(
        'field_name' => 'company_description',
        'label' => $t('Company Description'),
        'cardinality' => 1,
        'widget' => array(
            'weight' => '-3',
            'type' => 'text_textfield',
            'module' => 'text',
            'active' => 1,
            'settings' => array(
                'size' => '1000',
            ),
        ),
    ),
    'company_winner' => array(
        'field_name' => 'company_winner',
        'label' => $t('Company Winner'),
        'cardinality' => 1,
        'widget' => array(
            'weight' => '-3',
            'type' => 'text_textfield',
            'module' => 'text',
            'active' => 1,
            'settings' => array(
                'size' => '60',
            ),
        ),
    ),
    'field_autowinnerselection' => array(
        'field_name' => 'field_autowinnerselection',
        'required' => 1,
        'label' => $t('Auto Company Winner Selection'),
        'widget' => array(
            'weight' => '-3',
            'type' => 'options_buttons',
            'module' => 'options',
            'active' => 1,
            'settings' => array(),
        ),
    ),
);
return $instances;
}

function customcompanymodule_uninstall() {
$content_types = array(
    'name1' => 'company',
);
$sql = 'SELECT nid FROM {node} n WHERE n.type = :type1';
$result = db_query($sql, array(':type1' => $content_types['name1']));
$nids = array();
foreach ($result as $row) {
    $nids[] = $row->nid;
}
node_delete_multiple($nids);
node_type_delete($content_types['name1']);
field_purge_batch(1000);
}
0
Nadeem Khan