You are here

API.txt in Chaos Tool Suite (ctools) 6

Same filename and directory in other branches
  1. 7 API.txt
API.txt: $Id$

This file contains a log of changes to the API.
API version 1.9
  Introduce 'object factory' to export schema, allowing modules to control
    how the exportable objects are instantiated.
  Introduce 'hook_ctools_math_expression_functions_alter'.

API version 1.8
  Introduce 'get base contexts' callback to all tasks to facilitate
    Page Manager's site template extracting contexts from the environment.
  Introduce 'ctools_content_editable' function and the corresponding
    'check editable' callback on all content types to determine if a
    content type can be edited based upon configuration.
  Introduce utility.inc and move some code to it.
  Introduce page-wizard.inc and a "page_wizard" type plugin for Page Manager.

API version 1.7.2
  Allow Export UI to automatically have wizards by setting 'use wizard' => TRUE
  Moved the Panels Stylizer module into CTools so that the UI can be
    used to manage styles for modules other than Panels.
  Introduce ctools_access_ruleset module for customizable access rulesets.
  Introduce ctools_custom_content module for customizable content panes.
  Add 'convert default' as a converter keyword for context implementations.
    Instead of reverting $context->title this will cause %context without
    :converter to use a default converter.
  
API version 1.7.1
  Introduce 'modal return' and 'ajax return' to wizard.inc to allow
    wizard owners to process their own ajax/modal output.
  Introduce math-expr.inc to allow simple math expression parsing.

API version 1.7
  Introduce the export-ui plugin. This introduces new keys to the 'export'
    section of schema: 'primary key', 'key name'.
  Introduce ctools_export_crud_ functions to provide CRUD access to most
    exportables. This introduces several optional callback keys to the
    'export' section of the schema to provide overrides.
  Introduce auto-submit.js. Forms may now be set to auto submit just by
    adding appropriate classes.
  Provide new default functions for bulk export. This may make items that
    were previously not bulk exportable due to missing 'list' callback
    appear in the bulk export UI.
  
API version 1.5
  Add two new alter hooks: page_manager_operations_alter and 
      page_manager_variant_operations_alter to allow modules to add tabs
      to any page manager page.

API version 1.4:
  Allow themes to provide APIs which includes default pages of all types.
  Intorduce ctools_css_add_css() to allow private file systems to have generated CSS.
  Introduce initial build of stylizer.inc to allow UI configurable styles.
  Introduce 'cache warming' feature. Use 'ctools-use-ajax-cache' or
    'ctools-use-modal-cache'. Doing so will cause content to be fetched
    via AJAX on page load and kept warm in a cache for instant responses
    to clicks.
  Generalized ctools_add_css().
  Generalized ctools_add_js().
  Generalized ctools_image_path().
  Make global hooks for plugin definition optional through a 'use hooks'
    plugin option.

API version 1.3.2:
  Introduce 'export callback' to individual fields in export.inc

API version 1.3.1:
  #649144 by neclimdul: Expand ctools_include() to work for other modules.

API version 1.3:
  Introduce ctools_jump_menu().
  Change plugins to no longer need magic function. Can now use $plugin = array(...) instead.

API version 1.2:
  Introduce ctools_set_variable_token().
  Introduce ctools_set_callback_token().
  Introduce cleanstring tool. See cleanstring.inc
  Introduce page_manager_get_current_page().
  Introduce ctools_ajax_command_redirect().
  Introduce ctools_ajax_command_reload().
  Introduce ctools_ajax_command_submit().
  Introduce ctools_static().
  Introduce ctools_modal_command_loading().

API version 1.1.1:
  Introduce ctools_plugin_get_class() and ctools_plugin_load_class()
  Introduce ctools_ajax_command_attr().
  Introduce ctools_set_page_token().

API version 1.1.0:
  delegator module destroyed, replaced by page manager. All 'task' and 'task_handler' plugins
  now owned by page_manager. Update plugin hooks accordingly. The filename for defaults
  for pages and handlers should now be MODULE.pages_default.inc

  The task_type plugin has been removed.

  Task handlers no longer have a separate UI. While task handlers can still
  be separated from pages for other purposes, they will probably need
  to implement their own UI to do it.

API version 1.0:
  Initial CTools API version.

File

API.txt
View source
  1. API.txt: $Id$
  2. This file contains a log of changes to the API.
  3. API version 1.9
  4. Introduce 'object factory' to export schema, allowing modules to control
  5. how the exportable objects are instantiated.
  6. Introduce 'hook_ctools_math_expression_functions_alter'.
  7. API version 1.8
  8. Introduce 'get base contexts' callback to all tasks to facilitate
  9. Page Manager's site template extracting contexts from the environment.
  10. Introduce 'ctools_content_editable' function and the corresponding
  11. 'check editable' callback on all content types to determine if a
  12. content type can be edited based upon configuration.
  13. Introduce utility.inc and move some code to it.
  14. Introduce page-wizard.inc and a "page_wizard" type plugin for Page Manager.
  15. API version 1.7.2
  16. Allow Export UI to automatically have wizards by setting 'use wizard' => TRUE
  17. Moved the Panels Stylizer module into CTools so that the UI can be
  18. used to manage styles for modules other than Panels.
  19. Introduce ctools_access_ruleset module for customizable access rulesets.
  20. Introduce ctools_custom_content module for customizable content panes.
  21. Add 'convert default' as a converter keyword for context implementations.
  22. Instead of reverting $context->title this will cause %context without
  23. :converter to use a default converter.
  24. API version 1.7.1
  25. Introduce 'modal return' and 'ajax return' to wizard.inc to allow
  26. wizard owners to process their own ajax/modal output.
  27. Introduce math-expr.inc to allow simple math expression parsing.
  28. API version 1.7
  29. Introduce the export-ui plugin. This introduces new keys to the 'export'
  30. section of schema: 'primary key', 'key name'.
  31. Introduce ctools_export_crud_ functions to provide CRUD access to most
  32. exportables. This introduces several optional callback keys to the
  33. 'export' section of the schema to provide overrides.
  34. Introduce auto-submit.js. Forms may now be set to auto submit just by
  35. adding appropriate classes.
  36. Provide new default functions for bulk export. This may make items that
  37. were previously not bulk exportable due to missing 'list' callback
  38. appear in the bulk export UI.
  39. API version 1.5
  40. Add two new alter hooks: page_manager_operations_alter and
  41. page_manager_variant_operations_alter to allow modules to add tabs
  42. to any page manager page.
  43. API version 1.4:
  44. Allow themes to provide APIs which includes default pages of all types.
  45. Intorduce ctools_css_add_css() to allow private file systems to have generated CSS.
  46. Introduce initial build of stylizer.inc to allow UI configurable styles.
  47. Introduce 'cache warming' feature. Use 'ctools-use-ajax-cache' or
  48. 'ctools-use-modal-cache'. Doing so will cause content to be fetched
  49. via AJAX on page load and kept warm in a cache for instant responses
  50. to clicks.
  51. Generalized ctools_add_css().
  52. Generalized ctools_add_js().
  53. Generalized ctools_image_path().
  54. Make global hooks for plugin definition optional through a 'use hooks'
  55. plugin option.
  56. API version 1.3.2:
  57. Introduce 'export callback' to individual fields in export.inc
  58. API version 1.3.1:
  59. #649144 by neclimdul: Expand ctools_include() to work for other modules.
  60. API version 1.3:
  61. Introduce ctools_jump_menu().
  62. Change plugins to no longer need magic function. Can now use $plugin = array(...) instead.
  63. API version 1.2:
  64. Introduce ctools_set_variable_token().
  65. Introduce ctools_set_callback_token().
  66. Introduce cleanstring tool. See cleanstring.inc
  67. Introduce page_manager_get_current_page().
  68. Introduce ctools_ajax_command_redirect().
  69. Introduce ctools_ajax_command_reload().
  70. Introduce ctools_ajax_command_submit().
  71. Introduce ctools_static().
  72. Introduce ctools_modal_command_loading().
  73. API version 1.1.1:
  74. Introduce ctools_plugin_get_class() and ctools_plugin_load_class()
  75. Introduce ctools_ajax_command_attr().
  76. Introduce ctools_set_page_token().
  77. API version 1.1.0:
  78. delegator module destroyed, replaced by page manager. All 'task' and 'task_handler' plugins
  79. now owned by page_manager. Update plugin hooks accordingly. The filename for defaults
  80. for pages and handlers should now be MODULE.pages_default.inc
  81. The task_type plugin has been removed.
  82. Task handlers no longer have a separate UI. While task handlers can still
  83. be separated from pages for other purposes, they will probably need
  84. to implement their own UI to do it.
  85. API version 1.0:
  86. Initial CTools API version.