<<

NAME

C4::Output - Functions for managing output, is slowly being deprecated

FUNCTIONS

pagination_bar
   pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)

Build an HTML pagination bar based on the number of page to display, the current page and the url to give to each page link.

$base_url is the URL for each page link. The $startfrom_name=page_number is added at the end of the each URL.

$nb_pages is the total number of pages available.

$current_page is the current page number. This page number won't become a link.

This function returns HTML, without any language dependency.

output_with_http_headers
   &output_with_http_headers($query, $cookie, $data, $content_type[, $status[, $extra_options]])

Outputs $data with the appropriate HTTP headers, the authentication cookie $cookie and a Content-Type specified in $content_type.

If applicable, $cookie can be undef, and it will not be sent.

$content_type is one of the following: 'html', 'js', 'json', 'opensearchdescription', 'xml', 'rss', or 'atom'.

$status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.

$extra_options is hashref. If the key 'force_no_caching' is present and has a true value, the HTTP headers include directives to force there to be no caching whatsoever.

output_and_exit_if_error
    output_and_exit_if_error( $query, $cookie, $template, $params );

To executed at the beginning of scripts to stop the script at this point if some errors are found.

A series of tests can be run for a given module, or a specific check. Params "module" and "check" are mutually exclusive.

Tests for modules: * members: - Patron is not defined (we are looking for a patron that does no longer exist/never existed) - The logged in user cannot see patron's infos (feature 'cannot_see_patron_infos')

Tests for specific check: * csrf_token will test if the csrf_token CGI param is valid

Others will be added here depending on the needs (for instance biblio does not exist will be useful).

output_and_exit
    output_and_exit( $query, $cookie, $template, $error );

    $error is a blocking error like biblionumber not found or so.
    We should output the error and exit.

AUTHOR

Koha Development Team <http://koha-community.org/>

<<