danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /*
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Working sample module to demonstrate CTools 3 plugins
danielebarchiesi@0:  *
danielebarchiesi@0:  * This sample module is only intended to demonstrate how external modules can
danielebarchiesi@0:  * provide ctools plugins. There is no useful functionality, and it's only
danielebarchiesi@0:  * intended for developers or for educational use.
danielebarchiesi@0:  *
danielebarchiesi@0:  * As far as possible, everything is kept very simple, not exercising all of
danielebarchiesi@0:  * the capabilities of CTools or Panels.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Although the ctools documentation suggests that strict naming conventions
danielebarchiesi@0:  * be followed, this code attempts to follow only the conventions which are
danielebarchiesi@0:  * required (the hooks), in order to demonstrate the difference. You can
danielebarchiesi@0:  * certainly use the conventions, but it's important to know the difference
danielebarchiesi@0:  * between a convention and a requirement.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The advanced_help module is required, because both CTools and this module
danielebarchiesi@0:  * provide help that way.
danielebarchiesi@0:  *
danielebarchiesi@0:  * There is a demonstration panel provided at /ctools_plugin_example/123
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_menu
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_plugin_example_menu() {
danielebarchiesi@0:   $items = array();
danielebarchiesi@0: 
danielebarchiesi@0:   $items["admin/settings/ctools_plugin_example"] = array(
danielebarchiesi@0:     'title' => 'CTools plugin example',
danielebarchiesi@0:     'description' => t("Demonstration code, advanced help, and a demo panel to show how to build ctools plugins."),
danielebarchiesi@0:     'page callback' => 'ctools_plugin_example_explanation_page',
danielebarchiesi@0:     'access arguments' => array('administer site configuration'),
danielebarchiesi@0:     'type' => MENU_NORMAL_ITEM,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_ctools_plugin_directory().
danielebarchiesi@0:  *
danielebarchiesi@0:  * It simply tells panels where to find the .inc files that define various
danielebarchiesi@0:  * args, contexts, content_types. In this case the subdirectories of
danielebarchiesi@0:  * ctools_plugin_example/panels are used.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_plugin_example_ctools_plugin_directory($module, $plugin) {
danielebarchiesi@0:   if ($module == 'ctools' && !empty($plugin)) {
danielebarchiesi@0:     return "plugins/$plugin";
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implement hook_ctools_plugin_api().
danielebarchiesi@0:  *
danielebarchiesi@0:  * If you do this, CTools will pick up default panels pages in
danielebarchiesi@0:  * <modulename>.pages_default.inc
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_plugin_example_ctools_plugin_api($module, $api) {
danielebarchiesi@0:   // @todo -- this example should explain how to put it in a different file.
danielebarchiesi@0:   if ($module == 'panels_mini' && $api == 'panels_default') {
danielebarchiesi@0:     return array('version' => 1);
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($module == 'page_manager' && $api == 'pages_default') {
danielebarchiesi@0:     return array('version' => 1);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Just provide an explanation page for the admin section
danielebarchiesi@0:  * @return unknown_type
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_plugin_example_explanation_page() {
danielebarchiesi@0:   $content = '<p>' . t("The CTools Plugin Example is simply a developer's demo of how to create plugins for CTools. It provides no useful functionality for an ordinary user.") . '</p>';
danielebarchiesi@0: 
danielebarchiesi@0:   $content .= '<p>' . t(
danielebarchiesi@0:     'There is a demo panel demonstrating much of the functionality provided at
danielebarchiesi@0:     <a href="@demo_url">CTools demo panel</a>, and you can find documentation on the examples at
danielebarchiesi@0:     !ctools_plugin_example_help.
danielebarchiesi@0:     CTools itself provides documentation at !ctools_help. Mostly, though, the code itself is intended to be the teacher.
danielebarchiesi@0:     You can find it in %path.',
danielebarchiesi@0:     array(
danielebarchiesi@0:       '@demo_url' => url('ctools_plugin_example/xxxxx'),
danielebarchiesi@0:       '!ctools_plugin_example_help' => theme('advanced_help_topic', array('module' => 'ctools_plugin_example', 'topic' => 'Chaos-Tools--CTools--Plugin-Examples', 'type' => 'title')),
danielebarchiesi@0:       '!ctools_help' => theme('advanced_help_topic', array('module' => 'ctools', 'topic' => 'plugins', 'type' => 'title')),
danielebarchiesi@0:       '%path' => drupal_get_path('module', 'ctools_plugin_example'),
danielebarchiesi@0:     )) . '</p>';
danielebarchiesi@0: 
danielebarchiesi@0:   return $content;
danielebarchiesi@0: }