print.api.php 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <?php
  2. /**
  3. * @file
  4. * Main API entry point for the Printer, email and PDF versions
  5. *
  6. * @ingroup print
  7. */
  8. /**
  9. * @defgroup print Files
  10. *
  11. * Files used by the print module, grouped by sub-module
  12. *
  13. * - Printer-friendly pages
  14. * - @link print.api.php API @endlink
  15. * - @link print.module Module main file @endlink
  16. * - @link print.pages.inc HTML generation @endlink
  17. * - @link print.admin.inc Settings form @endlink
  18. * - @link print.install (Un)Install routines @endlink
  19. * - @link print.tpl.php Page generation template @endlink
  20. * - @link print.views.inc Views integration @endlink
  21. * - @link print_join_page_counter.inc Views join handler @endlink
  22. * - Send by email
  23. * - @link print_mail.module Module main file @endlink
  24. * - @link print_mail.inc Mail form and send mail routine @endlink
  25. * - @link print_mail.admin.inc Settings form @endlink
  26. * - @link print_mail.install (Un)Install routines @endlink
  27. * - @link print_mail.views.inc Views integration @endlink
  28. * - PDF version
  29. * - @link print_pdf.api.php API @endlink
  30. * - @link print_pdf.module Module main file @endlink
  31. * - @link print_pdf.pages.inc PDF generation @endlink
  32. * - @link print_pdf.admin.inc Settings form @endlink
  33. * - @link print_pdf.install (Un)Install routines @endlink
  34. * - @link print_pdf.drush.inc Drush commands @endlink
  35. * - @link print_pdf.views.inc Views integration @endlink
  36. * - PDF library handlers:
  37. * - dompdf
  38. * - @link print_pdf_dompdf.module Module main file @endlink
  39. * - @link print_pdf_dompdf.pages.inc PDF generation @endlink
  40. * - @link print_pdf_dompdf.admin.inc Settings form @endlink
  41. * - @link print_pdf_dompdf.install (Un)Install routines @endlink
  42. * - @link print_pdf_dompdf.drush.inc Drush commands @endlink
  43. * - mPDF
  44. * - @link print_pdf_mpdf.module Module main file @endlink
  45. * - @link print_pdf_mpdf.pages.inc PDF generation @endlink
  46. * - @link print_pdf_mpdf.drush.inc Drush commands @endlink
  47. * - TCPDF
  48. * - @link print_pdf_tcpdf.module Module main file @endlink
  49. * - @link print_pdf_tcpdf.pages.inc PDF generation @endlink
  50. * - @link print_pdf_tcpdf.admin.inc Settings form @endlink
  51. * - @link print_pdf_tcpdf.install (Un)Install routines @endlink
  52. * - @link print_pdf_tcpdf.class.inc Auxiliary PHP5 class @endlink
  53. * - @link print_pdf_tcpdf.drush.inc Drush commands @endlink
  54. * - wkhtmltopdf
  55. * - @link print_pdf_wkhtmltopdf.module Module main file @endlink
  56. * - @link print_pdf_wkhtmltopdf.pages.inc PDF generation @endlink
  57. * - @link print_pdf_wkhtmltopdf.admin.inc Settings form @endlink
  58. * - @link print_pdf_wkhtmltopdf.install (Un)Install routines @endlink
  59. * - @link print_pdf_wkhtmltopdf.drush.inc Drush commands @endlink
  60. * - EPUB version
  61. * - @link print_epub.api.php API @endlink
  62. * - @link print_epub.module Module main file @endlink
  63. * - @link print_epub.pages.inc EPUB generation @endlink
  64. * - @link print_epub.admin.inc Settings form @endlink
  65. * - @link print_epub.install (Un)Install routines @endlink
  66. * - @link print_epub.drush.inc Drush commands @endlink
  67. * - @link print_epub.views.inc Views integration @endlink
  68. * - EPUB library handlers:
  69. * - phpepub
  70. * - @link print_epub_phpepub.module Module main file @endlink
  71. * - @link print_epub_phpepub.pages.inc EPUB generation @endlink
  72. * - @link print_epub_phpepub.drush.inc Drush commands @endlink
  73. * - User Interface (Links)
  74. * - @link print_ui.api.php API @endlink
  75. * - @link print_ui.module Module main file @endlink
  76. * - @link print_ui.admin.inc Settings form @endlink
  77. */
  78. /**
  79. * @defgroup print_hooks Hooks
  80. *
  81. * Hooks used in the print module
  82. */
  83. /**
  84. * @defgroup print_themeable Themeable functions
  85. *
  86. * Default theme implementations of the print module
  87. */
  88. /**
  89. * @defgroup print_api API
  90. *
  91. * Functions that are provided for use by third-party code.
  92. */
  93. /**
  94. * @addtogroup hooks
  95. * @{
  96. */
  97. /**
  98. * Alters the URL in the URL list.
  99. *
  100. * This hook is useful for third-party modules that would prefer to display
  101. * something other than the naked URL in the URL list (e.g. glossary terms,
  102. * etc.).
  103. *
  104. * @param string $url
  105. * the url to be modified.
  106. *
  107. * @ingroup print_hooks
  108. */
  109. function hook_print_url_list_alter(&$url) {
  110. $url = 'foo';
  111. }
  112. /**
  113. * @} End of "addtogroup hooks".
  114. */