drupal8におけるViewsプログラミング

■ 関連API

検索フォームを変更する

function MODULE_NAME_form_views_exposed_form_alter(&$form, FormStateInterface $form_state, $form_id);

検索フォーム入力値を変更する

function MODULE_NAME_views_pre_view(ViewExecutable $view, $display_id, array &$args);

Viewsのクエリを加工する

function MODULE_NAME_views_query_alter(ViewExecutable $view, QueryPluginBase $query);

最終的なクエリを変更する

function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query);

■ 例

プルダウンをチェックボックスに変更する

function MODULE_NAME_form_views_exposed_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $form[FIELD_NAME]['#type'] = 'checkboxes';
}

空白区切りのtextフィールドを改行区切りのtextareaにする

function MODULE_NAME_form_views_exposed_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $form[FIELD_NAME]['#type'] = 'textarea';
  $form[FIELD_NAME]['#rows'] = 5;
}
function MODULE_NAME_views_pre_view(ViewExecutable $view, $display_id, array &$args) {
  $_SESSION[MODULE_NAME][ANY_NAME][FIELD_NAME] = $_REQUEST[FIELD_NAME];
  unset($_GET[FIELD_NAME], $_POST[FIELD_NAME], $_REQUEST[FIELD_NAME]);
}
function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query){
  // フィールド内ORの場合
  if ($view->id() == MY_VIEW) {
    $or = new Condition('OR');
    foreach ($_SESSION[MODULE_NAME][ANY_NAME][FIELD_NAME] as $val) {
      $or->condition('node__FIELD_NAME_value', $val);
    }
    $query->addWhere($whereGroup++, $or);
  }
}

hook_views_query_alter()では完結できないクエリ補整を行う

function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query){

  if ($view->id() == MY_VIEW) {
    $query->addTag('this_is_my_views_query');
}
function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query) {
  if ($query->hasTag('this_is_my_views_query')) {
    $tables =& $query->getTables();
    foreach ($tables[ALIAS]['arguments'] as &$value) {
      if ($value == THIS) {
        $value = VALUE;
      }
    }
  }
}

クエリ情報を保存しておいてあとで使う

function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query){
  $q = $query->query();
  $_SESSION[MODULE_NAME][ANY] = [
    'string' => $q->__toString(),
    'arguments' => $q->arguments(),
  ];
}
〜
  $p = $_SESSION[MODULE_NAME][ANY];
  $result = \Drupal::database()->query($p['string'], $p['arguments']);
〜

フォームを持たないViewsに場合に応じて条件を付ける

function MODULE_NAME_query_alter(\Drupal\Core\Database\Query\AlterableInterface $query){
  if ($view->id() == MY_VIEW) {
    $whereGroup = 2;
    $and = new Condition('AND');
    $and->condition(
      "watchdog.timestamp",
      \Drupal::configFactory()->getEditable('image_manager.setting')->get('log_error_mailed_datetime'),
      '>');
    $query->addWhere($whereGroup++, $and);
  }
}