Browse Source

Parameters documented for viewer functions.

pull/230/head
Nigel Banks 12 years ago
parent
commit
777dab1511
  1. 13
      includes/solution_packs.inc

13
includes/solution_packs.inc

@ -435,6 +435,12 @@ function islandora_check_object_status(NewFedoraObject $object_definition) {
/** /**
* A form construct to create a viewer selection table. * A form construct to create a viewer selection table.
* *
* The list of selectable viewers is limited by the $mimetype and the $model
* parameters. When neither are given all defined viewers are listed. If only
* $mimetype is given only viewers that support that mimetype will be listed,
* the same goes for the $model parameter. If both are given, than any viewer
* that supports either the give $mimetype or $model will be listed.
*
* @param string $variable_id * @param string $variable_id
* The ID of the Drupal variable to save the viewer settings in * The ID of the Drupal variable to save the viewer settings in
* @param string $mimetype * @param string $mimetype
@ -527,6 +533,13 @@ function islandora_viewers_form($variable_id = NULL, $mimetype = NULL, $model =
/** /**
* Returns all defined viewers. * Returns all defined viewers.
* *
* The list of selectable viewers is limited by the $mimetype and the
* $content_model parameters. When neither are given all defined viewers are
* listed. If only $mimetype is given only viewers that support that mimetype
* will be listed, the same goes for the $content_model parameter. If both are
* given, than any viewer that supports either the give $mimetype or $model will
* be listed.
*
* @param string $mimetype * @param string $mimetype
* Specify a mimetype to return only viewers that support this certain * Specify a mimetype to return only viewers that support this certain
* mimetype. * mimetype.

Loading…
Cancel
Save