Drupalのモジュール（VBO）の各種処理（Operation）に独自（カスタムオ）のプションの追加方法

やりたいこと：モジュール（VBO/Rules）で新規コンテンツの作成及び選択したノードのタイトルのセット

• 背景：Drupal7.55、Views７．ｘ－３．１６、Views Bulk Operation（VBO）７．ｘ－３．４、Rules７．ｘー２．１０
• Viewsで記事一覧から特定の記事を選択する
  • その記事のタイトルを取得
  • 新しいコンテンツに選択したタイトルを設定して作成します

解決：VBOがRulesでノード作成アクションコンポーネントでノード新規作成します

• Rulesでアクションコンポーネントを作成します　⇒ VBOがコンポーネントの利用ができます
• Rulesで特定なノードをパラメータとして指定します ⇒ ノード新規作成時に「タイトル」のコピーが可能となります
  
• VBOがノード選択して、アクションコンポーネントにパラメータとして渡します

モジュール（VBO）の動作後にページを遷移させる（redirect）オプション追加のカスタマイズ

• 前回紹介したVBO動作後にページを遷移させるオプション追加（drupalのモジュール（vbo）の一括処理後にページ遷移させる方法）
• 最後の課題として：各オペレーションごとに画面遷移設定オプションを追加すべき
  
  • 画面遷移設定オプションを全体（Bulk Operation Setting）に追加すると、各オペレーションに影響を与えます
• 各オペレーションに拡張条件追加する方法を調査し続きましたが、なかなかやり方がわからなかったです

VBOの新規作成したアクションに拡張オプション追加ができます

• VBOでは各オペレーション（アクション）に初期としてオプションを四つつけています
  • Enqueue the operation instead of executing it directly
  • 確認のステップをスキップ
  • Skip permission step
  • Override label
• これらのオプションに、画面遷移設定オプションの追加ができればいいなあと思っていました
• 気になる記事がありまして：Views Bulk Operations development guide (Drupal 7)
  • その中に新規作成したアクションの拡張オプション追加方法がありました
• 拡張オプション追加する関数：function mymodule_my_custom_action_views_bulk_operations_form($options)
  • これはどのように命名したか、どのように呼び出されるかは、さっぱりわかりませんでした
  • そして、hook_views_bulk_operations_form_alter() がありまして、どのような関連/区別があるかはわかりませんでした
• この例を丸ごとコピーして、ローカル環境に実装して、デバッガーで止めて確認しながら、やっとその中の秘密を解明しました

VBOのオペレーション単位の拡張オプション追加関数名： ACTION_NAME＋'_views_bulk_operations_form'

• 今まで、D7でのhook命名規則（hook　= module名）と全く関係なく、独特な命名になりました

  　// \sites\all\modules\views_bulk_operations\plugins\operation_types\action.class.php
  　// 147～167行のあたりに、以下のオプション追加関数があります
    public function adminOptionsForm($dom_id, $field_handler) {
      $form = parent::adminOptionsForm($dom_id, $field_handler);
  
  　　// 拡張オプション定義関数名を以下のように作成
      $settings_form_callback = $this->operationInfo['callback'] . '_views_bulk_operations_form';
      if (function_exists($settings_form_callback)) {
        $settings = $this->getAdminOption('settings', array());
  
        $form['settings'] = array(
          '#type' => 'fieldset',
          '#title' => t('Operation settings'),
          '#collapsible' => TRUE,
          '#dependency' => array(
            $dom_id . '-selected' => array(1),
          ),
        );
        $settings_dom_id = $dom_id . '-settings';
        $form['settings'] += $settings_form_callback($settings, $this->entityType, $settings_dom_id);
      }
  
      return $form;
    }

  • 7行目のコールバック関数に '_views_bulk_operations_form' 追加しました
• 紹介された例の新規アクション関数と拡張オプション関数を見てみると
  
  • 拡張オプションの関数名： ACTION_NAME＋"_views_bulk_operations_form" になることがわかりました
• 各アクション名を利用して、拡張オプションの追加は論理上としてできます

結論/感想：D7の寄与モジュール（Contribulte Module）のやり方が様々で、統一性が足りない

• VBOのhookが一つだけです（hook_views_bulk_operations_form_alte）
• D7では、この拡張オプションの実装ではhookの形で提供すべきだと思います
  • 解放したくないから、このような形になったかもしれないですね
• VBOだけではなく、いろいろな寄与モジュールを見てみると、さまざまのコーティングルールがあって、統一感が欠けています
• この点として、D8では大分改善されるでしょう（少なくともコアーモジュールの統一がしているはず）

やりたいこと：モジュール（VBO）の各処理（Operation）に独自（カスタム）オプションを追加したい

• 前回モジュール（VBO）にたいして処理（Operation）オプション追加を紹介しました
  •  Drupalのモジュール（VBO）の一括処理後にページ遷移させる方法
  • このオプションは全VBOに対して作成したものですが、すべての処理に影響を与えています
• 各種処理（Operation）に対してどのようにオプションを追加するか前回の課題として残っています
• 今回はこの課題を解決に新しいカスタムモジュール（vbo_redirect_option）を作成して、紹介します
  

hook_formとCtoolsのdepent systemより各オペレーションに独自のオプションを追加

• VBOのオペレーション設定フォームがカスタマイズとして開放していないです（前回も説明した）
• ここで、Drupalのhook_formでVBOのオペレーション設定画面を特定して、カスタムオプション追加することになりました

  function vbo_redirect_option_form_alter(&$form, &$form_state, $form_id)
  {
      if( isset($form_state['id']) && $form_state['id'] === "views_bulk_operations"){
  
          foreach( $form_state['input']['options']['vbo_operations'] as $key => $operation) {
              if( $operation['redirect_check'] && strlen( trim($operation['redirect_url']))>0 ) {
                  variable_set( $key, $operation['redirect_url'] );
              } else {
                  if( !empty( variable_get($key) ) ) variable_del( $key ) ;
              }
          }
  
  
          foreach( $form['options']['vbo_operations'] as $key => &$operation ){
              if( !is_array($operation) ) continue ;
  
              $redirect_url = variable_get($key);
              $dep_key = "edit-options-vbo-operations-" . str_replace("_", "-", str_replace("::","",$key) ) ;
  
              $operation['redirect_check'] = array(
                  '#type' => 'checkbox',
                  '#title' => t('Redirect page to after operation'),
                  '#default_value' =>  $redirect_url ? 1 : 0 ,
                  '#dependency' => array(　　　　// Ctoolsのdependent systemに依存
                      $dep_key."-selected" => array(1),
                  ),
              );
              $operation['redirect_url'] = array(
                  '#type' => 'textfield',
                  '#title' => t('Provide label'),
                  '#title_display' => 'invisible',
                  '#default_value' => empty($redirect_url) ? "" : $redirect_url,
                  '#dependency' => array(　　　　// Ctoolsのdependent systemに依存
                      $dep_key."-selected" => array(1),
                      $dep_key . '-redirect-check' => array(1),
                  ),
                  '#dependency_count' => 2,
              );
          }
      }
  }

  • 設定フォームにチェックボックスをチェックしたら、画面遷移URL入力フィールドが現れるダイナミックフォームはモジュール（Ctools）のdependent systemを利用しています

処理（Operation）確認ステップをスキップがあるかないかを確認してhook_views_bulk_operations_form_alter()実装でオプションの設定を行う

• VBOの処理（Operation）が確認ステップがあるかないかは2種類あります（この二種類をの処理プロセスが違うのでしっかりテストする必要がある）
• hook_views_bulk_operations_form_alter()を実装して、各処理ステップにカスタマイズを行います

  function vbo_redirect_option_views_bulk_operations_form_alter(&$form, &$form_state, $vbo)
  {
      // collect all operations that has contained redirect_rul
      $redirect_arr = array();
      foreach( $vbo->options['vbo_operations'] as $key => $operation ) {
          if( !empty( variable_get($key) ) ){
              $redirect_arr[$key] = $key ;
          }
      }
  
      // add redirect step to #submit element
      if(isset($form['select'])) {
  
          // this is the form start step
          foreach( $form['select'] as $key => &$element ){
              if( isset($redirect_arr[$key]) ){
                  // we check if there is any operation has redirect_url
                  $element['#submit'][] = 'vbo_redirect_after_operation';
                  // only one is enough, we will detect witch one in the callback function
                  break;
              }
          }
  
          // do operation with confirmation step
          // this is the confirmation step
      } else if( !$form_state['operation']->getAdminOption('skip_confirmation') ) {
          $form['actions']['submit']['#submit'][] = "vbo_redirect_after_operation_with_confirmation";
          $form_state['redirect_to_after_operation'] = $form_state['operation']->getAdminOption('redirect_url');
      }
  
  }
  
  
  /**
   * callback function that has called by operation
   * this is the form start step, we don't know if it has confirmation step or not
   * @param $form
   * @param $form_state
   */
  function vbo_redirect_after_operation(&$form, &$form_state){
      // the are multiple element can be operated
      // the right one that has be sent to this step
      // we need get redirect_url if the it has
      if( isset($form_state['operation']) ){
          // get redirect_url by operation_id
          $redirec=variable_get($form_state['operation']->operationId) ;
          if( !empty($redirec) ){
              if( $form_state['operation']->getAdminOption('skip_confirmation') ) {
                  $form_state['redirect'] = $redirec;
              }
          }
      }
  }
  
  /**
   * callback function that has be called by operation with confirmation step
   * @param $form
   * @param $form_state
   */
  function vbo_redirect_after_operation_with_confirmation( $form, &$form_state ){
      // there is only operation that has be sent here with the confirmation step
      if( isset($form_state['redirect_to_after_operation']) ){
          // set redirect_url that should be stored in $form_state
          $form_state['redirect'] = $form_state['redir　ect_to_after_operation'];
      }
  }

感想と結論：VBOの処理オプション設定はカスタマイズに開放していないため、各種処理（Operation）のオプションの取得、設定に苦労します

• VBOの処理オプション設定はユーザーにカスタマイズに開放していないです
• オペレーションの各ステップに$form、$form_state、$vbo変数から必要な情報を取得したり、セットしたりしました
• 必要な情報がどこにあるかは不明だし（その時dsm($vbo)などで確認）、特定するまでに、時間がかかりました。