API.txt

  1. cis7 sites/all/modules/ulmus/pathauto/API.txt
  2. cis7 sites/all/modules/ulmus/security_review/API.txt
  3. cis7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  4. cis7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  5. cis7 sites/all/modules/ulmus/ctools/API.txt
  6. cis7 sites/all/modules/ulmus/context/API.txt
  7. cis7 sites/all/modules/ulmus/aes/API.txt
  8. cis7 sites/all/modules/ulmus/media/API.txt
  9. cis7 sites/all/modules/ulmus/features/API.txt
  10. cle7 sites/all/modules/ulmus/security_review/API.txt
  11. cle7 sites/all/modules/ulmus/features/API.txt
  12. cle7 sites/all/modules/ulmus/media/API.txt
  13. cle7 sites/all/modules/ulmus/pathauto/API.txt
  14. cle7 sites/all/modules/ulmus/context/API.txt
  15. cle7 sites/all/modules/ulmus/ctools/API.txt
  16. cle7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  17. cle7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  18. cle7 sites/all/modules/ulmus/aes/API.txt
  19. cle7 sites/all/modules/local_contrib/votingapi/API.txt
  20. ecd7 sites/all/modules/ulmus/aes/API.txt
  21. ecd7 sites/all/modules/ulmus/ctools/API.txt
  22. ecd7 sites/all/modules/ulmus/security_review/API.txt
  23. ecd7 sites/all/modules/ulmus/context/API.txt
  24. ecd7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  25. ecd7 sites/all/modules/ulmus/media/API.txt
  26. ecd7 sites/all/modules/ulmus/features/API.txt
  27. ecd7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  28. ecd7 sites/all/modules/ulmus/pathauto/API.txt
  29. elmsmedia7 sites/all/modules/ulmus/security_review/API.txt
  30. elmsmedia7 sites/all/modules/ulmus/aes/API.txt
  31. elmsmedia7 sites/all/modules/ulmus/features/API.txt
  32. elmsmedia7 sites/all/modules/ulmus/ctools/API.txt
  33. elmsmedia7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  34. elmsmedia7 sites/all/modules/ulmus/media/API.txt
  35. elmsmedia7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  36. elmsmedia7 sites/all/modules/ulmus/pathauto/API.txt
  37. elmsmedia7 sites/all/modules/ulmus/context/API.txt
  38. harmony7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  39. harmony7 sites/all/modules/ulmus/features/API.txt
  40. harmony7 sites/all/modules/ulmus/context/API.txt
  41. harmony7 sites/all/modules/ulmus/media/API.txt
  42. harmony7 sites/all/modules/ulmus/pathauto/API.txt
  43. harmony7 sites/all/modules/ulmus/ctools/API.txt
  44. harmony7 sites/all/modules/ulmus/aes/API.txt
  45. harmony7 sites/all/modules/ulmus/security_review/API.txt
  46. harmony7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  47. icor7 sites/all/modules/ulmus/security_review/API.txt
  48. icor7 sites/all/modules/ulmus/context/API.txt
  49. icor7 sites/all/modules/ulmus/pathauto/API.txt
  50. icor7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  51. icor7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  52. icor7 sites/all/modules/ulmus/ctools/API.txt
  53. icor7 sites/all/modules/ulmus/features/API.txt
  54. icor7 sites/all/modules/ulmus/media/API.txt
  55. icor7 sites/all/modules/ulmus/aes/API.txt
  56. meedjum_blog7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  57. meedjum_blog7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
  58. meedjum_blog7 sites/all/modules/ulmus/aes/API.txt
  59. meedjum_blog7 sites/all/modules/ulmus/security_review/API.txt
  60. meedjum_blog7 sites/all/modules/ulmus/ctools/API.txt
  61. meedjum_blog7 sites/all/modules/ulmus/context/API.txt
  62. meedjum_blog7 sites/all/modules/ulmus/pathauto/API.txt
  63. meedjum_blog7 sites/all/modules/ulmus/media/API.txt
  64. meedjum_blog7 sites/all/modules/ulmus/features/API.txt
  65. mooc7 sites/all/modules/ulmus/aes/API.txt
  66. mooc7 sites/all/modules/ulmus/ctools/API.txt
  67. mooc7 sites/all/modules/elmsln_contrib/outline_designer/API.txt
  68. mooc7 sites/all/modules/ulmus/security_review/API.txt
  69. mooc7 sites/all/modules/ulmus/context/API.txt
  70. mooc7 sites/all/modules/ulmus/pathauto/API.txt
  71. mooc7 sites/all/modules/ulmus/media/API.txt
  72. mooc7 sites/all/modules/ulmus/features/API.txt
  73. mooc7 sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
/**
 * This hook allows you to define a relationship between content types for highlighting.
 *These relationships then create permissions as to what roles have the ability to utilize the highlighter.
 * This example shows how to tell the system that pages can be highlighted by timeline and poll content types.
 * perm is the permission for this, highlight will be added to the front of it
 * The ref_field is the field that will reference the page thats being highlighted. If ref_field is set to -auto-detect- then it will scan every page against nodes that are allowed to be displayed at that time.
 * The text_field is the field that should be prepopulated with the text that has been highlighted.
 * js_callback is an optional callback that will coopt the click to pop open a link handling that is normally in use.  There is a core example implementing this for the typo module.
 * linktype is how to render the reference if its been found.  anchor is the default and will need to be processed by other modules to make sense of the relationship.  'link' is an additional option that will convert it into a direct link to the referenced item.
 * limit will allow you to define how many time to highlight the text when it matches. 0 is unlimited, any other number will limit to only that many matches per page.
 * classes is an array of classes that you want to have applied to links found in the content.
 */
function hook_define_highlight_relationship() {
  $relationships['mymodule'] = array(
    'name' => t('Display name'),
    'types' => array('page'),
    'perm' => 'display name for permission',
    'highlight_types' => array(
      'timeline_item' => array(
        'id' => 'machinename',
        'ref_field' => 'field_node_reference',
        'text_field' => 'field_text_highlighted',
        'icon' => 'path/to/icon/file.png',
        'display_text' => t('Text to display in title info'),
        'linktype' => 'link',
        'limit' => 2,
        'classes' => array('cool', 'stuff', 'things'),
      ),
      'poll' => array(
        'ref_field' => '-auto-detect-',
        'text_field' => 'field_text_highlighted',
        'icon' => 'path/to/icon/file.png',
        'display_text' => t('Text to display in title info'),
        'linktype' => 'anchor',
        'limit' => 0,
        'classes' => array('cool', 'stuff', 'things'),
      ),
      'page' => array(
        'id' => 'page_typo',
        'ref_field' => '-auto-detect-',
        'text_field' => 'field_title',
        'icon' => drupal_get_path('module', 'typo') .'/images/typo.png',
        'display_text' => t('Indicate this is a typo'),
        'js_callback' => "jQuery.fn.typo_report_window();",
      ),
    ),
  );
  return $relationships;
}
/**
 * This allows you to alter relationships defined by other projects
 * This shows how to alter the type and icon values
 */
function hook_define_highlight_relationship_alter(&$relationships) {
  $relationships['mymodule']['types'][] = 'folder'; //adds folder to types
  $relationships['mymodule']['highlight_types']['poll']['icon'] = 'my/new/icon/location.png';
}

File

sites/all/modules/elmsln_contrib/nodereference_highlight/API.txt
View source
  1. /**
  2. * This hook allows you to define a relationship between content types for highlighting.
  3. *These relationships then create permissions as to what roles have the ability to utilize the highlighter.
  4. * This example shows how to tell the system that pages can be highlighted by timeline and poll content types.
  5. * perm is the permission for this, highlight will be added to the front of it
  6. * The ref_field is the field that will reference the page thats being highlighted. If ref_field is set to -auto-detect- then it will scan every page against nodes that are allowed to be displayed at that time.
  7. * The text_field is the field that should be prepopulated with the text that has been highlighted.
  8. * js_callback is an optional callback that will coopt the click to pop open a link handling that is normally in use. There is a core example implementing this for the typo module.
  9. * linktype is how to render the reference if its been found. anchor is the default and will need to be processed by other modules to make sense of the relationship. 'link' is an additional option that will convert it into a direct link to the referenced item.
  10. * limit will allow you to define how many time to highlight the text when it matches. 0 is unlimited, any other number will limit to only that many matches per page.
  11. * classes is an array of classes that you want to have applied to links found in the content.
  12. */
  13. function hook_define_highlight_relationship() {
  14. $relationships['mymodule'] = array(
  15. 'name' => t('Display name'),
  16. 'types' => array('page'),
  17. 'perm' => 'display name for permission',
  18. 'highlight_types' => array(
  19. 'timeline_item' => array(
  20. 'id' => 'machinename',
  21. 'ref_field' => 'field_node_reference',
  22. 'text_field' => 'field_text_highlighted',
  23. 'icon' => 'path/to/icon/file.png',
  24. 'display_text' => t('Text to display in title info'),
  25. 'linktype' => 'link',
  26. 'limit' => 2,
  27. 'classes' => array('cool', 'stuff', 'things'),
  28. ),
  29. 'poll' => array(
  30. 'ref_field' => '-auto-detect-',
  31. 'text_field' => 'field_text_highlighted',
  32. 'icon' => 'path/to/icon/file.png',
  33. 'display_text' => t('Text to display in title info'),
  34. 'linktype' => 'anchor',
  35. 'limit' => 0,
  36. 'classes' => array('cool', 'stuff', 'things'),
  37. ),
  38. 'page' => array(
  39. 'id' => 'page_typo',
  40. 'ref_field' => '-auto-detect-',
  41. 'text_field' => 'field_title',
  42. 'icon' => drupal_get_path('module', 'typo') .'/images/typo.png',
  43. 'display_text' => t('Indicate this is a typo'),
  44. 'js_callback' => "jQuery.fn.typo_report_window();",
  45. ),
  46. ),
  47. );
  48. return $relationships;
  49. }
  50. /**
  51. * This allows you to alter relationships defined by other projects
  52. * This shows how to alter the type and icon values
  53. */
  54. function hook_define_highlight_relationship_alter(&$relationships) {
  55. $relationships['mymodule']['types'][] = 'folder'; //adds folder to types
  56. $relationships['mymodule']['highlight_types']['poll']['icon'] = 'my/new/icon/location.png';
  57. }
Error | ELMSLN API

Error

×

Error message

  • Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/elmsln_community/api.elmsln.org/includes/common.inc:2791) in drupal_send_headers() (line 1499 of /var/www/html/elmsln_community/api.elmsln.org/includes/bootstrap.inc).
  • Error: Call to undefined function apc_delete() in DrupalAPCCache->clear() (line 289 of /var/www/html/elmsln_community/api.elmsln.org/sites/all/modules/apc/drupal_apc_cache.inc).
The website encountered an unexpected error. Please try again later.