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