You are here

entity.inc in Linkit 7.2

Linkit Entity Plugin.

File

plugins/linkit_plugins/entity.inc
View source
<?php

/**
 * @file
 * Linkit Entity Plugin.
 */

/**
 * Plugin structure is an associative array containing:
 * - ui_title: The title of the plugin used in the admin UI.
 * - ui_description: A description used in the admin UI.
 * - entity_type: Only required if the plugin extends LinkitPluginEntity. The
 *     entity type this plugin will be used for.
 * - handler: Describes the class to be used for this plugin.
 */
$plugin = array(
  'get child' => 'linkit_entity_ctools_linkit_get_child',
  'get children' => 'linkit_entity_ctools_linkit_get_children',
  'handler' => array(
    'class' => 'LinkitPluginEntity',
    'file' => 'linkit-plugin-entity.class.php',
  ),
);
function linkit_entity_ctools_linkit_get_child($plugin, $parent, $child) {
  $plugins = linkit_entity_ctools_linkit_get_children($plugin, $parent);
  return $plugins[$parent . ':' . $child];
}
function linkit_entity_ctools_linkit_get_children($plugin, $parent) {
  $entities = entity_get_info();
  $plugins = array();
  foreach ($entities as $entity_type => $entity) {

    // The entity must be linkit compatible and have an URI CALLBACK defined.
    // See linkit_entity_info_alter().
    if (!isset($entity['linkit']) || !$entity['linkit'] || !isset($entity['uri callback'])) {
      continue;
    }
    $plugin['ui_title'] = $entity['label'];
    $plugin['ui_description'] = t('Extend Linkit with @entity support.', array(
      '@entity' => $entity_type,
    ));
    $plugin['name'] = $parent . ':' . $entity_type;
    $plugin['entity_type'] = $entity_type;
    drupal_alter('linkit_plugin_entity', $plugin, $entity);
    $plugins[$parent . ':' . $entity_type] = $plugin;
  }
  drupal_alter('linkit_plugin_entities', $plugins);
  return $plugins;
}