web-dev-qa-db-ja.com

Ctoolsプラグインとは何ですか（コンテンツタイプ、アクセスなど）、どのように作成しますか？

Ctoolsプラグインとは何ですか？どのように作成しますか？

panelschaos-tool-suite
56
Letharion

Ctools Page manager 、および Panels を使用する場合は、カスタムCtoolsプラグインを追加すると便利です。

Ctoolsプラグインには多数の形式があり、 Feeds 、 Addressfield および Openlayers などの他のモジュールはすべてCtoolsを使用してプラグインを提供します他のモジュールによって拡張可能です。ただし、プラグインの最も一般的な形式は、おそらく「コンテンツタイプ」と「アクセス」です。最初のものは、エンティティ「コンテンツ」とそのバンドル（コンテンツタイプとも呼ばれます）と混同しないでください。

最初に、ボイラープレート：

どのモジュールもctoolsプラグインを提供するために、最初にCtoolsにそれらを探す場所を指示する必要があります。以下のフックは、「content_types」および「access」タイプのctoolsのプラグインを提供することを示しています。関数を単純化することもできますが、こうすることで、適切なモジュールのみがプラグインについて通知されるようにし、要求されたプラグインのタイプを実際に提供するときに、ファイルのディスクのみをスキャンさせるようにします。

function HOOK_ctools_plugin_directory($owner, $plugin_type) {
  // We'll be Nice and limit scandir() calls.
  if ($owner == 'ctools' && ($plugin_type == 'content_types' || $plugin_type == 'access')) {
    return 'plugins/' . $plugin_type;
  }
}

以下は、2つのプラグインを提供するモジュールのディレクトリ構造の例です。 1つのコンテンツタイプと1つのアクセスプラグイン。

module/
module/module.info
module/module.module
module/plugins/
module/plugins/content_types/
module/plugins/content_types/two_views_in_one.inc
module/plugins/access/
module/plugins/access/term_depth.inc

コンテンツタイププラグイン

Ctoolsボキャブラリのコンテンツタイプは、たとえばビューによって提供されるように、「ペイン」としてよく知られています。この質問： ビューによって作成されたNIDのリストをインターセプトし、それらを別のビューのフィルターとして使用する方法はありますか？ 、作成者はプログラムでビューに引数をフィードすることについて尋ねます。それ自体はそれほど難しくありませんが、フォローアップの質問はすぐに「結果を表示するにはどうすればよいですか？」になります。

1つの答えは、新しい「コンテンツタイプ」を作成することです。

これで、実際のコンテンツタイププラグインは、上からのビューの質問を再び使用して、次のようになります。

$plugin = array(
  'title' => t('Render a View with arguments from another'),
  'single' => TRUE,
  'category' => array(t('My custom category'), -9),
  // Despite having no "settings" we need this function to pass back a form, or we'll loose the context and title settings.
  'edit form' => 'module_content_type_edit_form',
  'render callback' => 'module_content_type_render',
);

function module_content_type_render($subtype, $conf, $args, $context = NULL) {
  $block = new stdClass;
  $block->title = 'My View';

  $view = views_get_view('get_nids');
  $view->preview('display_machine_name', array($arg1, $arg2));

  $nids = '';
  foreach($view->result as $node) {
    $nids += $node->nid . ',';
  }
  $nids = rtrim($nids, ',');
  $view = views_get_view('get_related');
  $view->execute_display('display_machine_name', array($nids));
  $block->content = $view->render();

  return $block;
}

/**
 * 'Edit form' callback for the content type.
 */
function module_content_type_edit_form($form, &$form_state) {
  // No settings beyond context, which has already been handled.
  return $form;
}

このモジュールを有効にすると、Panelsに「My custom category」という新しいカテゴリができます。そこに単一のペインがあり、上からコードをレンダリングします。

Accessプラグイン

以下のアクセスプラグインは、語彙のルートから測定された用語の深さに基づいて、バリアントやペインをファイリングする機能を提供します。

<?php
/**
 * @file
 * Plugin to provide access control based upon a parent term.
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
$plugin = array(
  'title' => t("Taxonomy: term depth"),
  'description' => t('Control access by the depth of a term.'),
  'callback' => 'term_depth_term_depth_ctools_access_check',
  'default' => array('vid' => array(), 'depth' => 0),
  'settings form' => 'term_depth_term_depth_ctools_access_settings',
  'settings form validation' => 'term_depth_term_depth_ctools_access_settings_validate',
  'settings form submit' => 'term_depth_term_depth_ctools_access_settings_submit',
  'summary' => 'term_depth_term_depth_ctools_access_summary',
  'required context' => new ctools_context_required(t('Term'), array('taxonomy_term', 'terms')),
);

/**
 * Settings form for the 'term depth' access plugin.
 */
function term_depth_term_depth_ctools_access_settings($form, &$form_state, $conf) {
  // If no configuration was saved before, set some defaults.
  if (empty($conf)) {
    $conf = array(
      'vid' => 0,
    );
  }
  if (!isset($conf['vid'])) {
    $conf['vid'] = 0;
  }

  // Loop over each of the configured vocabularies.
  foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
    $options[$vid] = $vocabulary->name;
  }

  $form['settings']['vid'] = array(
    '#title' => t('Vocabulary'),
    '#type' => 'select',
    '#options' => $options,
    '#description' => t('Select the vocabulary for this form. If there exists a parent term in that vocabulary, this access check will succeed.'),
    '#id' => 'ctools-select-vid',
    '#default_value' => $conf['vid'],
    '#required' => TRUE,
  );

  $form['settings']['depth'] = array(
    '#title' => t('Depth'),
    '#type' => 'textfield',
    '#description' => t('Set the required depth of the term. If the term exists at the right depth, this access check will succeed.'),
    '#default_value' => $conf['depth'],
    '#required' => TRUE,
  );

  return $form;
}

/**
 * Submit function for the access plugins settings.
 *
 * We cast all settings to numbers to ensure they can be safely handled.
 */
function term_depth_term_depth_ctools_access_settings_submit($form, $form_state) {
  foreach (array('depth', 'vid') as $key) {
    $form_state['conf'][$key] = (integer) $form_state['values']['settings'][$key];
  }
}

/**
 * Check for access.
 */
function term_depth_term_depth_ctools_access_check($conf, $context) {
  // As far as I know there should always be a context at this point, but this
  // is safe.
  if (empty($context) || empty($context->data) || empty($context->data->vid) || empty($context->data->tid)) {
    return FALSE;
  }

  // Get the $vid.
  if (!isset($conf['vid'])) {
    return FALSE;
  }
  $depth = _term_depth($context->data->tid);

  return ($depth == $conf['depth']);
}

/**
 * Provide a summary description based upon the checked terms.
 */
function term_depth_term_depth_ctools_access_summary($conf, $context) {
  $vocab = taxonomy_vocabulary_load($conf['vid']);

  return t('"@term" has parent in vocabulary "@vocab" at @depth', array(
    '@term' => $context->identifier,
    '@vocab' => $vocab->name,
    '@depth' => $conf['depth'],
  ));
}

/**
 * Find the depth of a term.
 */
function _term_depth($tid) {
  static $depths = array();

  if (!isset($depths[$tid])) {
    $parent = db_select('taxonomy_term_hierarchy', 'th')
      ->fields('th', array('parent'))
      ->condition('tid', $tid)
      ->execute()->fetchField();

    if ($parent == 0) {
      $depths[$tid] = 1;
    }
    else {
      $depths[$tid] = 1 + _term_depth($parent);
    }
  }

  return $depths[$tid];
}
84
Letharion

CToolsプラグインは、その機能を拡張する方法として任意のモジュールの一部にすることができる小さなファイルです。これらを使用して、コンポーネント（ペイン）を提供したり、パネルにスタイルオプションを追加したりできます。

段階的なドキュメントについては、 パネルのないCToolsプラグイン ページを確認してください。簡単に言うと、次のようになります。

  1. CToolsの依存関係を.infoファイルに次のように追加する必要があります。

    dependencies[] = ctools
dependencies[] = panels

  2. CToolsにプラグインの場所を伝えます。

    <?php
function MYMODULE_ctools_plugin_directory($module, $plugin) {
  if (($module == 'ctools') && ($plugin == 'content_types')) {
    return 'plugins/content_types';
  }
}
?>

  3. プラグインを.incファイルに実装します（デフォルトでは$module.$api.incとして）。プラグインコードの例：

    <?php
$plugin = array(
  'title' => t('Twitter feed'),
  'description' => t('Twitter feed'),
  'category' => 'Widgets',
  'icon' => '',
  'render callback' => 'Twitter_block',
  'defaults' => array(),
);

// render callback
function Twitter_block() {
  // Add Twitter widget javascript
  $url = Twitter_USER
  $widget_id = Twitter_WIDGET_ID;
  $data = array();

  $data['url'] = $url;
  $data['widget_id'] = $widget_id;

  $content = array(
    '#theme' => 'my_block',
    '#content' => $data,
  );

  $block = new stdClass();
  $block->content = $content;
  $block->title = '';
  $block->id = 'Twitter_block';

  return $block;
}
?>

プラグインのデフォルトの場所は次のようになります。

MYMODULE/
    plugins/
        content_types/
        templates/
    MYMODULE.info
    MYMODULE.module

その他の例については、CToolsモジュールの一部である ctools_plugin_example モジュールを確認するか、ヘルプページをチェックアウトしてください（CToolsプラグインの例）モジュールを有効にした後のDrupal UI。

Drupal 8では、これはコアの一部になり（参照： Drupal\Component\Plugin ）、オブジェクトの継承、オブジェクトインターフェース、および単一ファイルのカプセル化を提供します。参照： Drupal 8 Now：オブジェクト指向プラグインのDrupal 7

1
kenorb